Add a customer address
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/customers/1/addresses';const options = { method: 'POST', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"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"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The customer ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
A short label such as Home or Office.
Name of the person receiving deliveries.
Contact phone number.
First address line.
Second address line.
Ward code (e.g., “27199”, “00001”)
Example
27199Optional district name or code
Optional city name
Province code (e.g., “79”, “01”, “11”)
Example
79Postal code.
Country code. Defaults to VN when left out.
Whether this becomes the default address.
Why the change was made. Recorded on the customer timeline.
Responses
Section titled “Responses”object
Address ID.
Example generated
{ "id": "example"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}