Skip to main content
Version: 202607

List addresses

GET 
/openapi/2026-07/customers/:customer_id/addresses

Retrieve a list of all address with pagination.

Request​

Path Parameters

    customer_id stringrequired

    Customer ID

Query Parameters

    cursor string

    Cursor for pagination

    page_size int32

    Number of records per page. The default value is 10, and the maximum allowed value is 250

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    addresses object[]

    Array containing address objects

  • Array [
    • idstring

    Address ID

    customer_idstring

    ID of the customer this address belongs to

    first_namestring

    First name of the consignee

    last_namestring

    Last name of the consignee

    companystring

    Company name

    citystring

    City of the address

    provincestring

    Province or state of the address

    countrystring

    Country name of the address

    zipstring

    Postal or ZIP code

    province_codestring

    Province code

    country_codestring

    ISO country code

    genderstring

    Gender of the consignee

    phonestring

    Phone number associated with the address

    phone_area_codestring

    Area code of the phone number

    areastring

    Area or region of the address

    emailstring

    Email associated with the address

    namestring

    Full name of the consignee

    address1string

    Primary street address

    address2string

    Secondary street address

    country_namestring

    Full name of the country

    defaultboolean

    Indicates if this is the default address

  • ]
    • cursorstring

    The cursor for the next page of results

    has_moreboolean

    Whether there are more records