API - Address

Created by KloudShip Support, Modified on Thu, 7 Mar, 2024 at 2:25 PM by KloudShip Support Admin

Get: Address

The Get Address Get API allows you to retrieve detailed address information based on the provided parameters. This information is useful for various shipping, communication, and location-related purposes.

Endpoint

GET /{{BaseURL}}/Address/{address_id}

- {address_id}: The ID of the address for which you want to retrieve the info.

Parameters

- None

Response

Upon a successful request, the API returns address information in JSON format.

{
    "type": "ShipTo",
    "verificationStatus": "Success",
    "id": "649018e1703a221b756fb974",
    "name": "Mr Test",
    "company": "Test",
    "street1": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62",
    "street2": "",
    "street3": "",
    "city": "Noida",
    "stateCode": "UP",
    "zip": "201309",
    "countryCode": "IN",
    "phone": "9999900000",
    "email": "manoj.kumar@impledge.com",
    "save": true,
    "verify": true,
    "isResidential": true,
    "latitude": 0.0,
    "longitude": 0.0,
    "streetAddress": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62"
}
...

Response Fields

`type` (string): Specifies the type of address, e.g., "ShipTo".
`verificationStatus` (string): Indicates the verification status of the address, e.g., "Success".
`id` (string): Unique identifier for the address.
`name` (string): Name associated with the address.
`company` (string): Company name associated with the address.
`street1`, `street2`, `street3` (string): Address street lines.
`city` (string): City of the address.
`stateCode` (string): State code of the address.
`zip` (string): Postal code of the address.
`countryCode` (string): Country code of the address.
`phone` (string): Phone number associated with the address.
`email` (string): Email address associated with the address.
`save` (boolean): Indicates if the address is marked for saving.
`verify` (boolean): Indicates if the address needs verification.
`isResidential` (boolean): Specifies if the address is a residential location.
`latitude` (float): Latitude coordinate of the address.
`longitude` (float): Longitude coordinate of the address.
`streetAddress` (string): Consolidated street address.

Example Response

{
    "type": "ShipTo",
    "verificationStatus": "Success",
    "id": "649018e1703a221b756fb974",
    "name": "Mr Test",
    "company": "Test",
    "street1": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62",
    "street2": "",
    "street3": "",
    "city": "Noida",
    "stateCode": "UP",
    "zip": "201309",
    "countryCode": "IN",
    "phone": "9999900000",
    "email": "manoj.kumar@impledge.com",
    "save": true,
    "verify": true,
    "isResidential": true,
    "latitude": 0.0,
    "longitude": 0.0,
    "streetAddress": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62"
}
```

Additional Notes

The latitude and longitude values are provided as float data types.
The `save` and `verify` fields are boolean values indicating save and verification statuses, respectively.
The `isResidential` field indicates whether the address is a residential location (boolean).
Street lines are represented by `street1`, `street2`, and `street3` fields.
The `streetAddress` field provides the consolidated street address.
If the address needs verification, it is recommended to use the `verify` field to ensure accuracy before using the address for critical purposes.

Post: Address

The Post Address Create API allows you to create a new shipping address for a specific type of recipient. This API enables you to provide detailed information about the address, including recipient name, company, street details, city, state, postal code, country, contact phone, email, and various optional parameters. The address can also be verified, saved, and marked as residential. This documentation provides a comprehensive guide on how to use the API effectively.

Endpoint

```

POST /{{BaseURL}}/Address

```

Request Headers

Content-Type: application/json
Authorization: Bearer [Your_Auth_Token]

Request Body

The request body should be a JSON object containing the details of the address you want to create. Below is an example of a request body:

{
    "type": "ShipTo",
    "verificationStatus": "Success",
    "id": "64dc9341822cae68cb08eb03",
    "name": "Mr Test",
    "company": "Test",
    "street1": "Regus, 5th Floor, Tower C, Green Boulevard,B-Block Sector 62",
    "street2": "",
    "street3": "",
    "city": "Noida",
    "stateCode": "UP",
    "zip": "201309",
    "countryCode": "IN",
    "phone": "9999900000",
    "email": "manoj.kumar@impledge.com",
    "save": true,
    "verify": true,
    "isResidential": true,
    "latitude": 0.0,
    "longitude": 0.0,
    "streetAddress": "Regus, 5th Floor, Tower C, Green Boulevard,B-Block Sector 62"
}
```

Request Parameters

type: Type of recipient (e.g., "ShipTo").
verificationStatus**: Status of address verification (e.g., "Success").
id: Unique identifier for the address.
name: Name of the recipient.
company: Name of the company associated with the recipient (optional).
street1: First line of the street address.
street2: Second line of the street address (optional).
street3: Third line of the street address (optional).
city: City of the recipient.
stateCode: State code of the recipient's location.
zip: Postal/ZIP code of the recipient's location.
countryCode: Country code of the recipient's location (e.g., "IN" for India).
phone: Contact phone number of the recipient.
email: Contact email address of the recipient.
save: Boolean indicating whether to save the address.
verify: Boolean indicating whether the address is verified.
isResidential: Boolean indicating if the address is residential.
latitude: Latitude coordinate of the address (optional).
longitude: Longitude coordinate of the address (optional).
streetAddress: Concatenated street address (optional).

Response

Upon successful creation of the address, the API will return a response with a status code of `201 Created` and a JSON object containing information about the created address. In case of errors, appropriate error status codes and error messages will be returned.

Example Response

{
    "message": "Address created successfully.",
    "data": {
        "id": "64dc9341822cae68cb08eb03",
        "type": "ShipTo",
        "name": "Mr Test",
        "company": "Test",
        "street1": "Regus, 5th Floor, Tower C, Green Boulevard,B-Block Sector 62",
        "street2": "",
        "street3": "",
        "city": "Noida",
        "stateCode": "UP",
        "zip": "201309",
        "countryCode": "IN",
        "phone": "9999900000",
        "email": "manoj.kumar@impledge.com",
        "save": true,
        "verify": true,
        "isResidential": true,
        "latitude": 0.0,
        "longitude": 0.0,
        "streetAddress": "Regus, 5th Floor, Tower C, Green Boulevard,B-Block Sector 62"
    }
}
```

Put: Address

Updates the details of an address based on the provided address ID.

Endpoint

PUT /{{BaseURL}}/Address/{address_Id}

Request Body

type (string, required): The type of address. Possible values: `"ShipTo"`.
verificationStatus** (string, required): The verification status of the address. Possible values: `"Success"`.
id (string, required): The unique identifier of the address.
name (string, required): The name associated with the address.
company (string, required): The company associated with the address.
street1 (string, required): The primary street address.
street2 (string): Additional street address information (if any).
street3 (string): Additional street address information (if any).
city (string, required): The city of the address.
stateCode (string, required): The state code of the address.
zip (string, required): The ZIP code of the address.
countryCode (string, required): The country code of the address.
phone (string, required): The phone number associated with the address.
email (string, required): The email address associated with the address.
save (boolean, required): Indicates whether to save the address. Possible values: `true`.
verify (boolean, required): Indicates whether the address should be verified. Possible values: `true`.
isResidential (boolean, required): Indicates whether the address is a residential address. Possible values: `true`.
latitude (float, required): The latitude coordinate of the address.
longitude (float, required): The longitude coordinate of the address.
streetAddress (string, required): The complete street address.

Example Request Body

{
    "type": "ShipTo",
    "verificationStatus": "Success",
    "id": "64dcaee3822cae68cb08eb09",
    "name": "Mr Aayush",
    "company": "Test",
    "street1": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62",
    "street2": "",
    "street3": "",
    "city": "Noida",
    "stateCode": "UP",
    "zip": "201309",
    "countryCode": "IN",
    "phone": "9999900000",
    "email": "manoj.kumar@impledge.com",
    "save": true,
    "verify": true,
    "isResidential": true,
    "latitude": 0.0,
    "longitude": 0.0,
    "streetAddress": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62"
}
```

Response

type (string): The type of address.
verificationStatus (string): The verification status of the address.
id (string): The unique identifier of the address.
name (string): The name associated with the address.
company (string): The company associated with the address.
street1 (string): The primary street address.
street2 (string): Additional street address information (if any).
street3 (string): Additional street address information (if any).
city (string): The city of the address.
stateCode (string): The state code of the address.
zip (string): The ZIP code of the address.
countryCode (string): The country code of the address.
phone (string): The phone number associated with the address.
email (string): The email address associated with the address.
save (boolean): Indicates whether the address is saved.
verify (boolean): Indicates whether the address is verified.
isResidential (boolean): Indicates whether the address is a residential address.
latitude (float): The latitude coordinate of the address.
longitude (float): The longitude coordinate of the address.
streetAddress (string): The complete street address.

Example Response

{
    "type": "ShipTo",
    "verificationStatus": "Success",
    "id": "64dcaee3822cae68cb08eb09",
    "name": "Mr Aayush",
    "company": "Test",
    "street1": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62",
    "street2": "",
    "street3": "",
    "city": "Noida",
    "stateCode": "UP",
    "zip": "201309",
    "countryCode": "IN",
    "phone": "9999900000",
    "email": "manoj.kumar@impledge.com",
    "save": true,
    "verify": true,
    "isResidential": true,
    "latitude": 0.0,
    "longitude": 0.0,
    "streetAddress": "Regus, 5th Floor, Tower C, Green Boulevard, B-Block Sector 62"
}
```

Additional Note

Replace `{{BaseURL}}` with the actual base URL of your API before using this documentation.

Delete: Address

The Delete Address API allows you to delete a specific address location using its unique `location_id`.

Endpoint

DELETE /{{BaseURL}}/Address/{address_ID}

Parameters

- `address_id` (path parameter) - The unique identifier of the address to be deleted.

Request

Endpoint

```
DELETE /{{BaseURL}}/Address/{address_id}
```

Example

Request

DELETE /Address/123456
```

Response

The response from the Delete Address API includes status codes 200 success status code, which signify the request was successful and the server has responded with the requested information. The response will contain either a "true" or "false" value.