Delete Address

Delete a specific address using its unique identifier.

🔒

Requires write_customer access scope.

The Delete Address API allows delete the details of a specific address for a given customer.

This API is especially useful for:

  1. Deleting a customer's address details.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Request Parameters

Public Request Parameters

📘

Path Parameters

ParameterTypeRequiredDescriptionExample
customer_idstringYesUnique identifier of the customer.165618e4-3243-4cd7-abc3-1234567890ab
address_idstringYesUnique identifier of the address.2490dc6a-d511-4e5e-bbcb-d58e913243ad

Response Explanation

Public Response Parameters

📘

Successful Response

FieldTypeExampleDescription
codestring"success"Response status code
messagestring""Descriptive message of the response
dataobject

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!