Skip to content

Customer Addresses

All saved addresses for a customer — read-only sub-resource used by the Create-Order screen's billing/shipping picker.

EndpointMethod
/api/admin/customers/{customerId}/addressesGET

Response Fields

Returns the standard { data, meta } envelope. Each row in data:

FieldTypeDescription
idintegerAddress ID.
addressTypestringAddress type (e.g. customer).
firstName, lastNamestringRecipient name.
companyNamestring | nullCompany name.
addressstringStreet address.
city, state, country, postcodestringLocation.
emailstring | nullContact email.
phonestringContact phone.
vatIdstring | nullVAT identifier.
defaultAddressbooleanWhether this is the customer's default address.

The meta object carries currentPage, perPage, lastPage, total, from, and to. Not paginated by the UI but wrapped for consistency. 404 if the customer doesn't exist; 401 without an admin Bearer token.

TIP

For default-address semantics and the address-book overview, see the Addresses overview.

Released under the MIT License.