List Customer Addresses

GET/store/:storeCode/customers/me/addresses
publishable keyJWT

List addresses for the logged-in customer.

Path Parameters
storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

Query Parameters
limitnumber

Maximum number of items to return.

offsetnumber

Number of items to skip before collecting the result set.

orderstring

Field to sort by. Prefix with `-` for descending order (e.g. `-created_at`).

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

qstring

Search query.

citystring

Filter by city.

country_codestring

Filter by country code.

provincestring

Filter by province.

postal_codestring

Filter by postal code.

Response

Status

200OK

Schema

Copy
HttpTypes.StoreCustomerAddressListResponse

Properties

addressesrequiredStoreCustomerAddress[]

Customer addresses.

countrequirednumber

Total count.

offsetrequirednumber

Offset applied.

limitrequirednumber

Limit applied.