PHP (Extension) / ShipEngine Walkthrough / Validate an address (warning)
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$jarr->AddObjectAt(-1);$jsonObj_1->UpdateString('address_line1','Studio Tour Drive, Leavesden WD25 7LR, UK');$jsonObj_1->UpdateString('country_code','GB');$jarr->EmitSb($sbRequestBody);$resp->GetBodySb($sbResponseBody);$jarrResp->LoadSb($sbResponseBody);$jarrResp->put_EmitCompact(false);// json is a CkJsonObject
$json = $jarrResp->ObjectAt($i);$status = $json->stringOf('status');$Name = $json->stringOf('original_address.name');$Phone = $json->stringOf('original_address.phone');$Company_name = $json->stringOf('original_address.company_name');$Address_line1 = $json->stringOf('original_address.address_line1');$Address_line2 = $json->stringOf('original_address.address_line2');$Address_line3 = $json->stringOf('original_address.address_line3');$City_locality = $json->stringOf('original_address.city_locality');$State_province = $json->stringOf('original_address.state_province');$Postal_code = $json->stringOf('original_address.postal_code');$Country_code = $json->stringOf('original_address.country_code');$Address_residential_indicator = $json->stringOf('original_address.address_residential_indicator');$matched_addressName = $json->stringOf('matched_address.name');$matched_addressPhone = $json->stringOf('matched_address.phone');$matched_addressCompany_name = $json->stringOf('matched_address.company_name');$matched_addressAddress_line1 = $json->stringOf('matched_address.address_line1');$matched_addressAddress_line2 = $json->stringOf('matched_address.address_line2');$matched_addressAddress_line3 = $json->stringOf('matched_address.address_line3');$matched_addressCity_locality = $json->stringOf('matched_address.city_locality');$matched_addressState_province = $json->stringOf('matched_address.state_province');$matched_addressPostal_code = $json->stringOf('matched_address.postal_code');$matched_addressCountry_code = $json->stringOf('matched_address.country_code');$matched_addressAddress_residential_indicator = $json->stringOf('matched_address.address_residential_indicator');$j = 0;$count_j = $json->SizeOfArray('messages');$json->put_J($j);$code = $json->stringOf('messages[j].code');$message = $json->stringOf('messages[j].message');$v_type = $json->stringOf('messages[j].type');$detail_code = $json->stringOf('messages[j].detail_code');$j = $j + 1;$i = $i + 1;
?>
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '[
{
"address_line1": "Studio Tour Drive, Leavesden WD25 7LR, UK",
"country_code": "GB"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (warning)",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n \"address_line1\": \"Studio Tour Drive, Leavesden WD25 7LR, UK\",\n \"country_code\": \"GB\"\n\t}\n]"
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
},
"description": "This request shows how ShipEngine responds when an address can be verified, but there are warnings such as major corrections. The `status` field is `verified`, and the `messages` array lists the warnings and other information about the corrected the address."
},
"response": [
{
"name": "Validate an address (warning)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n \"address_line1\": \"Studio Tour Drive, Leavesden WD25 7LR, UK\",\n \"country_code\": \"GB\"\n\t}\n]",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Tue, 22 Oct 2019 20:32:43 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "1614"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "12327571-2884-4f7d-bb9f-ad2cf9331d98"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"verified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"Studio Tour Drive, Leavesden WD25 7LR, UK\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": null,\n \"state_province\": null,\n \"postal_code\": null,\n \"country_code\": \"GB\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": \"WARNER BROS STUDIO TOUR\",\n \"address_line1\": \"Studio Tour Drive\",\n \"address_line2\": \"\",\n \"address_line3\": \"\",\n \"city_locality\": \"Watford\",\n \"state_province\": \"Hertfordshire\",\n \"postal_code\": \"WD25 7LR\",\n \"country_code\": \"GB\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"messages\": [\n {\n \"code\": \"a1003\",\n \"message\": \"There was a change or addition to the state/province.\",\n \"type\": \"warning\",\n \"detail_code\": \"state_province_changed_or_added\"\n },\n {\n \"code\": \"a1007\",\n \"message\": \"This address has been verified down to the suite/PO box level (highest possible accuracy with the provided data)\",\n \"type\": \"info\",\n \"detail_code\": \"verified_to_suite_level\"\n },\n {\n \"code\": \"a1008\",\n \"message\": \"This record was successfully geocoded to the community level (ZIP centroid in the US, 3 digit postal code for Canada)\",\n \"type\": \"info\",\n \"detail_code\": \"coded_to_community_level\"\n }\n ]\n }\n]"
}
]
}
