Customer Management/
Addresses API/
Addresses API Overview

Addresses API Overview

The Addresses API allows you to organize customer and account addresses. Addresses are a sub-resource of a customer and account resources. A customer or account can have multiple addresses, such as home, work, and neighbour.

You can use a customer address with an implicit Bearer token, which is recommended for client-side interactions. You can also use client_credentials Bearer token, which is recommended for back-end interactions.

You can use an account address with either client_credentials Bearer token or a combination of implicit Bearer token and Account Management authentication token.

The Address Object

idstringThe unique identifier for this address.
typestringThe type represents the object being returned.
first_namestringThe first name of the recipient on this address.
last_namestringThe last name of the recipient on this address.
namestringThe name for the address saved, such as home, work or wife’s office.
phone_numberstringA phone number for this address.
instructionsstringAny delivery instructions associated with this addresses.
company_namestringThe company name at this address.
line_1stringUsually the street name.
line_2stringUsually the unit or apartment number.
citystringThe city for this address.
countystringThe county for this address.
regionstringThe state, province, or region for this address.
postcodestringThe ZIP, postcode or other postal reference for this address.
countrystringA two digit code for this country address. This is a ISO 3166-2 standard.

Sample response

    "id": "5f8da740-6680-463e-b31c-190b2db4bf9d",
    "type": "address",
    "name": "Home",
    "first_name": "Ron",
    "last_name": "Swanson",
    "company_name": "",
    "phone_number": "(555) 555-1234",
    "line_1": "1 Sunny Street",
    "line_2": "Sunny Place",
    "city": "Sunny Town",
    "postcode": "SU33 1YY",
    "county": "Sunnyville",
    "region": "Peterborough",
    "country": "GB",
    "instructions": "Leave in the shed",
    "links": {
    "meta": {
        "timestamps": {
            "created_at": "2018-05-04T15:20:09.734Z",
            "updated_at": "2018-05-04T15:20:09.734Z"

Was this helpful?