Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customers

Get all additional customer addresses

Get information about all customer addresses.

Additional addresses are stored on a customer account separately from the primary address recorded in the customer's personal information. Each additional address has an address type (for example, delivery, billing, or work) and full address detail.

Related: GET /customer-address-types

get/customers/{customer_id}/addresses

Path parameters

customer_idstring required

The unique ID of the customer.

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

customer_address_type_idstring

The unique ID of the customer address type. GET /customer-address-types

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "addresses": [
      {
        "additional_address_id": "86e05affc7a7abefcd513ab400",
        "address_type": "86e05affc7a7abefcd513ab400",
        "address": {
          "address1": "Old Town Square",
          "address2": "34",
          "address3": "1a",
          "zip": "11000",
          "city": "Prague 1",
          "country_code": "cz"
        }
      }
    ],
    "total_items": 1
  }
}