Updates one of an existing customer’s saved addresses. Identify the customer by ID or login and the address by CustomerAddress_ID.
Before you begin#
- The API token needs
CustomerAddress_Update, 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’s
Customer_ID,Customer_LoginorEdit_Customer, and theCustomerAddress_IDof the address.CustomerAddressList_Load_Queryreturns the address ID.
Example requests#
Update a customer address#
Replaces the details of the address with this ID.
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "CustomerAddress_Update",
"Customer_ID": "{{Customer_ID}}",
"Address1": "5060 Santa Fe Street",
"Address2": "",
"City": "San Diego",
"Company": "MivaCorp",
"Country": "US",
"CustomerAddress_ID": "{{CustomerAddress_ID}}",
"Description": "5060 Santa Fe St",
"Email": "[email protected]",
"Fax": "555-555-1212",
"FirstName": "Jane",
"LastName": "Doe",
"Phone": "555-555-5555",
"Residential": true,
"State": "CA",
"Zip": "92109"
}
Request parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
customer_idedit_customercustomer_login |
Number String String |
The customer id The customer login The customer login |
|
address1 |
String | No | The first address field |
address2 |
String | No | The second address field |
city |
String | No | The city for the address |
company |
String | No | The company name for the address |
country |
String | No | The country for the address |
customeraddress_id |
Number | The address id number of the customer to be updated | |
description |
String | No | The description for the address |
email |
String | No | The email for the address |
fax |
String | No | The fax number for the address |
firstname |
String | No | The first name for the address |
lastname |
String | No | The last name for the address |
phone |
String | No | The phone number for the address |
residential |
Boolean | No | Boolean value indicating if the address is residential |
state |
String | No | The state for the address |
zip |
String | No | The zip code for the address |
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 and current values |
CustomerAddress_Insert |
Add a new address to a customer |
CustomerAddress_Delete |
Delete a saved address |
Customer_Update |
Change the customer’s main shipping and billing details |
Try in Postman#
In the Miva: JSON API: Authenticated collection, open Customers > CustomerAddress_Update. See Set Up Postman.