Update an address
const url = 'https://apibase.ecomweb.app/api/v1/tenant/stores/example/customers/address/1';const options = { method: 'PATCH', headers: { 'x-storefront-api-key': '<x-storefront-api-key>', Authorization: 'Bearer <token>', '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}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://apibase.ecomweb.app/api/v1/tenant/stores/example/customers/address/1 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'x-storefront-api-key: <x-storefront-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 }'Changes the fields sent and leaves the others as they are. Setting is_default to true makes it the default and clears the flag on the shopper’s other addresses. Returns 403 when the address belongs to another customer and 404 when it does not exist.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The address ID, as returned when the address was created or listed.
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 or additional location info
Province code (e.g., “79”, “01”, “11”)
Example
79Postal code.
Country code.
Whether this is the customer’s default address. Setting it true makes it the default and clears the flag on the others.
Responses
Section titled “Responses”object
Address ID.
ID of the customer the address belongs to.
A short label such as Home or Office, or null.
Name of the person receiving deliveries.
Contact phone number.
First address line.
Second address line, or null.
Ward code.
Ward name, when it can be resolved from the code.
District, or null.
City, or null.
Province code.
Province name, when it can be resolved from the code.
Postal code, or null.
Country code.
Whether this is the customer’s default address.
When the address was created, as an ISO 8601 timestamp.
When the address was last updated, as an ISO 8601 timestamp.
Example generated
{ "id": 1, "customer_id": 1, "label": "example", "recipient_name": "example", "phone_number": "example", "address_line1": "example", "address_line2": "example", "ward": "example", "ward_name": "example", "district": "example", "city": "example", "province": "example", "province_name": "example", "postal_code": "example", "country": "example", "is_default": true, "created_at": "example", "updated_at": "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"}