xclade
Store APICustomers

Create Address for Logged-In Customer

Create an address for the logged-in customer.

POST
/store/customers/me/addresses
connect.sid<token>

In: cookie

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.

Request Body

application/json

first_name?string

The customer's first name.

last_name?string

The customer's last name.

phone?string

The customer's phone.

company?string

The address's company.

address_1?string

The address's first line.

address_2?string

The address's second line.

city?string

The address's city.

country_code?string

The address's country code.

province?string

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

postal_code?string

The address's postal code.

address_name?string

The address's name.

is_default_shipping?boolean

Whether the address is used by default for shipping during checkout.

is_default_billing?boolean

Whether the address is used by default for billing during checkout.

metadata?object

Holds custom key-value pairs.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X POST "https://{tenant}.api.myxclade.com/store/customers/me/addresses" \  -H "x-publishable-api-key: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "customer": {
    "id": "string",
    "email": "user@example.com",
    "default_billing_address_id": "string",
    "default_shipping_address_id": "string",
    "company_name": "string",
    "first_name": "string",
    "last_name": "string",
    "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",
        "province": "us-ca",
        "postal_code": "string",
        "phone": "string",
        "metadata": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
    "phone": "string",
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_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"
}