This endpoint is used to create new address by passing JSON request payload.
...
Type | Name | Description | Schema |
---|---|---|---|
Body | address optional | Address request payload | AddressPayload |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | OK | AddressPublicProjection |
201 | Created | No Content |
401 | Unauthorized | No Content |
403 | Forbidden | No Content |
404 | Not Found | No Content |
...
AddressPayload
Name | Description | Schema |
---|---|---|
addressLine1 optional | Address line 1 | string |
addressLine2 optional | Address line 2 | string |
company optional | Address company name | string |
customerCarrierAccountCode optional | Customer carrier account code | string |
optional | Address email | string |
firstName optional | Address first name | string |
lastName optional | Address last name | string |
location optional | Location identifier | integer (int64) |
notes optional | Address notes | string |
phone optional | Address phone number | string |
senderCode optional | Sender code | string |
AddressPublicProjection
Name | Description | Schema |
---|---|---|
addressLine1 optional | Address line 1 | string |
addressLine2 optional | Address line 2 | string |
company optional | Address company name | string |
customerCarrierAccountCode optional | Customer carrier account code | string |
optional | Address email | string |
firstName optional | Address first name | string |
id optional | Address identifier | integer (int64) |
lastName optional | Address last name | string |
latitude optional | Address latitude | number (double) |
location optional | Location identifier | Location |
longitude optional | Address longitude | number (double) |
notes optional | Address notes | string |
phone optional | Address phone number | string |
...