Skip to content

Get Checkout Addresses

Retrieve guest / the authenticated customer's checkout saved addresses so they can select one as their shipping or billing address during checkout. This endpoint returns previously saved addresses — it does not create new ones.

Endpoint

GET /api/shop/checkout/addresses

Request Headers

HeaderRequiredDescription
Content-TypeYesapplication/json
X-STOREFRONT-KEYYesYour storefront API key
AuthorizationYesBearer token (customer login required)

Response Fields (200 OK)

FieldTypeDescription
addressesarrayList of customer addresses
defaultShippingIdintegerID of default shipping address
defaultBillingIdintegerID of default billing address

Address Fields

FieldTypeDescription
idintegerAddress ID
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
addressstringStreet address
citystringCity
statestringState/Province
countrystringCountry code
postcodestringPostal code
phonestringPhone number

Use Cases

  • Populate shipping address dropdown
  • Populate billing address dropdown
  • Show saved addresses in checkout
  • Allow address selection during checkout
  • Set default addresses

Fetching Customer Addresses

To retrieve the full list of a customer's saved addresses (outside of checkout), use the dedicated customer address queries:

Released under the MIT License.