List Customer's Addresses
Retrieve the addresses of the logged-in customer. The addresses can be filtered by fields such as country_code
. The addresses can also be sorted or paginated.
Authorizations
Headers
Publishable API Key created in the Medusa Admin.
Query Parameters
Comma-separated fields that should be included in the returned data. if a field is prefixed with +
it will be added to the default fields, using -
will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the Retrieve Custom Links documentation.
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -
.
Filter by the address's city. Filter by a city.
Filter by the address's postal code. Filter by a postal code.
Filter by the address's country code. Filter by a country code.
Search term to filter the address's searchable properties.
Whether to include deleted records in the result.
Response
OK
The paginated list of customer addresses.