Sign in
Customers

Retrieve all addresses for a customer

get/customers/{id}/addresses

Path parameters

idinteger required

The SamCart ID for the customer

Response

Successful operation. Response will return an array of 0 or more addresses

type'shipping' | 'billing'

The type of address for the customer

streetstring

The street for the customer

postal_codestring

The postal code for the customer

citystring

The city name for the customer

statestring nullable

The 2-letter state code for US customers. For non-US addresses this value will be null.

regionstring nullable

The optional sub-divided area of a country for international customers. For US addresses this value will be null.

countrystring

The country for the customer

Example response

[
  {
    "type": "shipping",
    "street": "221B Baker Street",
    "postal_code": "1234",
    "city": "Austin",
    "state": "TX",
    "region": "Quebec",
    "country": "United States"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.