GET
/
admin
/
customers
/
{id}
/
addresses
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.customer.listAddresses("cus_123")
.then(({ addresses }) => {
  console.log(addresses)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "addresses": [
    {
      "id": "<string>",
      "address_name": "<string>",
      "is_default_shipping": true,
      "is_default_billing": true,
      "customer_id": "<string>",
      "company": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "country_code": "us",
      "province": "us-ca",
      "postal_code": "<string>",
      "phone": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The customer's ID.

Query Parameters

​
fields
string

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.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

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 -.

​
q
string

Search term to apply on the address's searchable properties.

​
company

Filter by a company.

​
city

Filter by a city.

​
country_code

Filter by a currency code.

​
province

Filter by an ISO 3166-2 province code. Must be lower-case.

Example:

"us-ca"

​
postal_code

Filter by a postal code.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of customer addresses.