xclade
Store APICustomers

Get Customer's Address

Retrieve an address of the logged-in customer. You can expand the address's relations or select the fields that should be returned.

GET
/store/customers/me/addresses/{address_id}

Authorization

connect.sid<token>

In: cookie

Path Parameters

address_id*string

The address'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.

Header Parameters

x-publishable-api-key*string

Publishable API Key created in the Medusa Admin.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X GET "https://{tenant}.api.myxclade.com/store/customers/me/addresses/string" \  -H "x-publishable-api-key: string"
{
  "address": {
    "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",
    "province": "us-ca",
    "postal_code": "string",
    "phone": "string",
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

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.

Register Customer

Register a customer. Use the `/auth/customer/emailpass/register` API route first to retrieve the registration token and pass it in the header of the request.