List Customer's Addresses

GET

/store/customers/me/addresses

Customers

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.

Request Example

JavaScript

Shell

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/store/customers/me/addresses' \
--header 'x-publishable-api-key;'

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "estimate_count": 0,
    "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": "usd",
            "postal_code": "string",
            "phone": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "province": "us-ca"
        }
    ]
}

Request

Query Params

fields

string

fields

optional

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

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

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

city

optional

Filter by the address's city.

One of

city

array[string]

Filter by a city.

postal_code

optional

Filter by the address's postal code.

One of

postal_code

array[string]

Filter by a postal code.

country_code

optional

Filter by the address's country code.

One of

country_code

array[string]

Filter by a country code.

string

optional

Search term to filter the address's searchable properties.

Header Params

x-publishable-api-key

string

required

Publishable API Key created in the Medusa Admin.

Responses

🟢200OK

application/json

Body

The paginated list of customer addresses.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

estimate_count

number

estimate_count

optional

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.

addresses

array[object (StoreCustomerAddress) {18}]

required

The list of addresses.

string

required

The address's ID.

address_name

string

address_name

required

The address's name.

is_default_shipping

boolean

is_default_shipping

required

Whether the address is used for shipping by default.

is_default_billing

boolean

is_default_billing

required

Whether the address is used for billing by default.

customer_id

string

customer_id

required

The ID of the customer the address belongs to.

company

string

company

required

The address's company.

first_name

string

first_name

required

The address's first name.

last_name

string

last_name

required

The address's last name.

address_1

string

address_1

required

The address's first line.

address_2

string

address_2

required

The address's second line.

city

string

city

required

The address's city.

country_code

string

country_code

required

The address's country code.

Example:

usd

postal_code

string

postal_code

required

The address's postal code.

phone

string

phone

required

The address's phone.

metadata

object

required

The address's metadata, can hold custom key-value pairs.

created_at

string <date-time>

created_at

required

The date the address was created.

updated_at

string <date-time>

updated_at

required

The date the address was updated.

province

string

province

required

The address's lower-case ISO 3166-2 province code.

Example:

us-ca

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:21:30

Create Address for Logged-In Customer

Get Customer's Address