This endpoint is used to create new address by passing JSON request payload.
Resource URL
https://api.bbamastro.com.au/address🔗
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body | address | 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 |
...
Definitions
mykey
Type: apiKey
Name: Authorization
In: HEADER
AddressPayload
Name | Description | Schema |
---|---|---|
addressLine1 | Address line 1 | string |
addressLine2 | Address line 2 | string |
company | Address company name | string |
customerCarrierAccountCode | Customer carrier account code | string |
Address email | string | |
firstName | Address first name | string |
lastName | Address last name | string |
location | Location identifier | integer (int64) |
notes | Address notes | string |
phone | Address phone number | string |
senderCode | Sender code | string |
AddressPublicProjection
Name | Description | Schema |
---|---|---|
addressLine1 | Address line 1 | string |
addressLine2 | Address line 2 | string |
company | Address company name | string |
customerCarrierAccountCode | Customer carrier account code | string |
Address email | string | |
firstName | Address first name | string |
id | Address identifier | integer (int64) |
lastName | Address last name | string |
latitude | Address latitude | number (double) |
location | Location identifier | Location |
longitude | Address longitude | number (double) |
notes | Address notes | string |
phone | Address phone number | string |
Info |
---|
Please refer to the Additional Reference section for more information on BBA Integration API objects. |