Skip to content

Add a customer address

POST
/stores/{storeRef}/customers/{customerId}/addresses
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/customers/1/addresses \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "label": "example", "recipient_name": "example", "phone_number": "example", "address_line1": "example", "address_line2": "example", "ward": "27199", "district": "example", "city": "example", "province": "79", "postal_code": "example", "country": "example", "is_default": true, "reason": "example" }'

Adds a saved address to the customer. ward and province are codes, not names. Setting is_default makes it the default address. The change is recorded on the customer’s timeline against the API key.

Required scopes: write:customers

customerId
required
integer

The customer ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
label

A short label such as Home or Office.

string
nullable
recipient_name
required

Name of the person receiving deliveries.

string
phone_number
required

Contact phone number.

string
address_line1
required

First address line.

string
address_line2

Second address line.

string
nullable
ward
required

Ward code (e.g., “27199”, “00001”)

string
/^\d{3,5}$/

Example

27199
district

Optional district name or code

string
nullable
city

Optional city name

string
nullable
province
required

Province code (e.g., “79”, “01”, “11”)

string
/^\d{1,2}$/

Example

79
postal_code

Postal code.

string
nullable
country

Country code. Defaults to VN when left out.

string
is_default

Whether this becomes the default address.

boolean
reason

Why the change was made. Recorded on the customer timeline.

string
<= 500 characters
Media typeapplication/json
object
id
required

Address ID.

string

Example generated

{
"id": "example"
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}