...
This endpoint is used to create new address by passing JSON request payload.
Resource URL
Cluster | URL |
|---|---|
Australia | |
US |
UK
Request Payload
Field | Data Type | Required | Description |
|---|---|---|---|
company | String | Yes | Company name |
firstName | String | Yes | First name |
lastName | String | Yes | Last name |
addressLine1 | String | Yes | Address line 1 |
addressLine2 | String | No | Address line 2 |
location | Long | Yes | Location id |
phone | String | Yes | Phone number |
String | Yes | Email address |
Request Payload Sample
| Code Block |
|---|
{
"company": "Test company",
"firstName": "John",
"lastName": "Doe",
"addressLine1": "Test address 1",
"addressLine2": null,
"location": 1549606,
"phone": "12334",
"email": "john.doe@mailinator.com"
} |
Response statuses
HTTP Code | Description | Schema |
|---|---|---|
200 | OK | |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
Response Payload
Field | Data Type | Description |
|---|---|---|
addressLine1 | string | Address line 1 |
addressLine2 | string | Address line 2 |
company | string | Address company name |
customerCarrierAccountCode | string | Customer carrier account code |
string | Address email | |
firstName | string | Address first name |
id | Long | Address identifier |
lastName | string | Address last name |
latitude | decimal | Address latitude |
location | Object | Location identifier |
longitude | decimal | Address longitude |
notes | string | Address notes |
phone | string | Address phone number |
Response Payload Sample
| Code Block |
|---|
{
"notes": null,
"firstName": "John",
"lastName": "Doe",
"addressLine1": "Test address 1",
"addressLine2": null,
"phone": "12334",
"email": "john.doe@mailinator.com",
"company": "Test company 999",
"senderCode": null,
"receiverCode": null,
"latitude": 54.204836,
"longitude": 37.6184915,
"customerCarrierAccountCode": null,
"location": {
"id": 1549606,
"name": "Tula",
"code": "300000",
"country": {
"id": 174,
"name": "Russian Federation",
"code": "RU",
"enabled": true
},
"state": null,
"latitude": null,
"longitude": null,
"zoneId": null,
"enabled": true,
"oldLocation": {
"id": 1549606,
"name": "Tula",
"code": "300000",
"country": {
"id": 174,
"name": "Russian Federation",
"code": "RU",
"enabled": true
},
"state": null,
"latitude": null,
"longitude": null,
"zoneId": null,
"enabled": true,
"oldLocation": null
}
},
"id": 2586750
} |
...