This function allows you to validate the shipping or billing address in runtime. If the store is not configured for Address Validation, the response will be empty.
This function allows you to validate the shipping or billing address in runtime. If the store is not configured for Address Validation, the response will be empty.
Request Body Parameters#
| Parameter | Type | Description |
|---|---|---|
Session_Type |
String | This will always be runtime |
Company |
String | Company name |
Address1 |
String | Address line one |
Address2 |
String | Address line two |
City |
String | The city of the address |
State |
String | The State code of the address |
Zip |
String | The zip code of the address |
Country |
String | The country code of the address |
Response Parameters#
| Parameter | Type | Description |
|---|---|---|
success |
Boolean | Boolean value for if the request was successful |
addr1 |
String | Address line one |
addr2 |
String | Address line two |
comp |
String | Company |
city |
String | City |
state |
String | State Code |
zip |
String | Zip Code |
country |
String | Country Code |
resdntl |
Boolean | true or false |
Note
Content-Type for the request must be ‘application/json’
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "Runtime_ValidateAddress",
"Session_Type": "runtime",
"Company": "Miva",
"Address1": "16745 W. Bernardo Dr",
"Address2": "Fourth Floor",
"City": "San Diego",
"State": "CA",
"Zip": "92127",
"Country": "US"
}
Example Response#
{
"success": 1,
"data": [
{
"addr1": "16745 W BERNARDO DR # 4",
"addr2": "",
"comp": "Miva",
"city": "SAN DIEGO",
"state": "CA",
"zip": "92127-1907",
"country": "US",
"resdntl": false
}
]
}