List Customer's Addresses

GET

/store/customers/me/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.

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

Header Params

Responses

🟢200OK

application/json

Body

🟠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