Skip to content

Customer Address Detail

Returns a single saved address for a customer.

EndpointMethod
/api/admin/customers/{customerId}/addresses/{id}GET

Response Fields

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

An address whose owner doesn't match the path customerId is rejected with 403; an unknown address → 404.

TIP

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

Released under the MIT License.