Customer Address
Get all customer addresses
Returns all addresses of the authenticated customer. Requires Bearer token.
get/customer-addresses
Request
- Base URLhttp://localhost:8000/api/shop
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
sort'id' | 'created_at' | 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc'
Column to sort by: id (default) or created_at. Compound form also accepted, e.g. created_at-desc.
order'asc' | 'desc'
Sort direction: asc (default) or desc. Use desc to show the most recently added addresses first.
pageinteger
The collection page number
per_pageinteger
The number of items per page
Headers
X-STOREFRONT-KEYstring required
Storefront API Key for authentication. Required for all shop/storefront API requests.
X-Localestring
Example:en
Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.
X-Channelstring
Example:default
Channel code (e.g. "default"). Defaults to the current channel.
X-Currencystring
Example:USD
Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.
Response
List of customer addresses.
Changes
No recorded changes to this operation across all 13 revisions of this API.