Deletes one saved address from a customer’s address book. To delete several addresses in one request, use CustomerAddressList_Delete.
Before you begin#
- The API token needs
CustomerAddress_Delete, either assigned directly under Functions or through a group. See Create an API token. - Requests must be signed if the token requires it. See Make a signed request with HMAC.
- You need the
Customer_IDand theCustomerAddress_IDof the address.CustomerAddressList_Load_Queryreturns both.
Example requests#
Delete a customer address#
Deletes the address with this ID from the customer.
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "CustomerAddress_Delete",
"Customer_ID": "{{Customer_ID}}",
"CustomerAddress_ID": "{{CustomerAddress_ID}}"
}
Request parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
Customer_ID |
Number | The customer id of the address to be deleted | |
CustomerAddress_ID |
Number | The customer address id to be deleted |
Example response#
{
"success": 1
}
Response parameters#
| Parameter | Type | Description |
|---|---|---|
success |
Boolean | Boolean value indicating if the API request was successful |
Related functions#
| Function | Use it to |
|---|---|
CustomerAddressList_Load_Query |
Find the address ID |
CustomerAddressList_Delete |
Delete several addresses at once |
CustomerAddress_Insert |
Add an address to a customer |
CustomerAddress_Update |
Change an address instead of deleting it |
Try in Postman#
In the Miva: JSON API: Authenticated collection, open Customers > CustomerAddress_Delete. See Set Up Postman.