This endpoint is used to create new address by passing JSON request payload.

Resource URL

Cluster	URL

Cluster	URL
Australia	https://api.bbamastro.com/address/address
US	https://api-us.bbamastro.com/address/address

Request Payload

Field	Data Type	Required	Description

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
email	String	Yes	Email address

Request Payload Sample

{
    "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

HTTP Code	Description	Schema
200	OK	AddressPublicProjection
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Response Payload

Field	Data Type	Description

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
email	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

{
    "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
}

Please refer to the Additional Reference section for more information on BBA Integration API objects.

API Integration

POST /address

Analytics

Resource URL

Request Payload

Request Payload Sample

Response statuses

Response Payload

Response Payload Sample

Related content