Get Checkout Addresses
Retrieve all saved addresses for the authenticated customer.
Authentication
This mutation supports both authenticated customers and guest users:
- Authenticated customers: Provide a valid customer authentication token in the
Authorizationheader. Obtain this token via the Customer Login API. - Guest users: Provide the Guest Cart Token
cartTokenobtained from the Create Cart mutation.
Authorization: Bearer <accessToken>Arguments
| Name | Type | Required | Description |
|---|---|---|---|
first | Int | ❌ No | Number of addresses to fetch (default: 10, max: 100) |
after | String | ❌ No | Cursor for forward pagination |
last | Int | ❌ No | Number of addresses to fetch backward |
before | String | ❌ No | Cursor for backward pagination |
Response
| Field | Type | Description |
|---|---|---|
id | String | Address ID |
firstName | String | First name |
lastName | String | Last name |
address | String | Street address |
city | String | City |
state | String | State/Province |
country | String | Country code |
zipCode | String | Postal/Zip code |
phone | String | Phone number |
isDefault | Boolean | Is this the default address |
createdAt | DateTime | When address was created |
Pagination
Uses cursor-based pagination:
first+afterfor forward paginationlast+beforefor backward paginationpageInfocontainshasNextPageandendCursor
Use Cases
- Display address list in checkout
- Pre-fill address selection dropdown
- Allow customers to select shipping/billing address
- Manage saved addresses
Error Responses
json
{
"errors": {
"authentication": ["Unauthorized: Invalid or expired token"]
}
}
