Skip to content

Get Customer Addresses

Retrieve all saved addresses for the authenticated customer.

Endpoint

GET /api/shop/customers/addresses

Request Headers

HeaderRequiredDescription
X-STOREFRONT-KEYYesYour storefront API key
AuthorizationYesBearer token (customer login required)

Response Fields (200 OK)

FieldTypeDescription
addressesarrayList of customer addresses

Address Fields

FieldTypeDescription
idintegerAddress ID
firstNamestringFirst name
lastNamestringLast name
addressstringStreet address
citystringCity
statestringState/Province
countrystringCountry code
postcodestringPostal code
phonestringPhone number
isDefaultbooleanIs default address
addressTypestringType (residential/commercial)

Use Cases

  • Display saved addresses in checkout
  • Allow customer to select address
  • Populate address dropdown
  • Show customer's address book
  • Select shipping address
  • Select billing address

Released under the MIT License.