Skip to content

Get Checkout Addresses

Retrieve the address associated with the current checkout session.

This query returns only the address applied to the active checkout — the one entered during guest checkout, or the one the signed-in customer selected for this order. It is not the customer's address book; read that with Get Customer Addresses.

Authentication

This query supports both authenticated customers and guest users:

  • Authenticated customers: Provide a valid customer authentication token in the Authorization header. Obtain this token via the Customer Login API.
  • Guest users: Provide the Guest Cart Token cartToken obtained from the Create Cart mutation.
Authorization: Bearer <accessToken>

Response

FieldTypeDescription
idStringAddress ID
addressTypeStringType of address (billing or shipping)
firstNameStringFirst name
lastNameStringLast name
addressStringStreet address
cityStringCity
stateStringState/Province
countryStringCountry code
postcodeStringPostal/Zip code
emailStringEmail address
phoneStringPhone number
useForShippingBooleanWhether this address is also used for shipping
defaultAddressBooleanWhether this is the customer's default address
createdAtDateTimeWhen address was created

Use Cases

  • Confirm the address applied to the current checkout session
  • Display the selected address on the order review/summary page
  • Verify guest checkout address before placing the order

Released under the MIT License.