PHP (Extension) / ShipEngine Walkthrough / Validate an address (unverified)
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
$jarr->AddObjectAt(-1);$jsonObj_1->UpdateString('address_line1','525 S Winchester Blvd');$jsonObj_1->UpdateString('city_locality','San Jose');$jsonObj_1->UpdateString('state_province','CA');$jsonObj_1->UpdateString('postal_code','95128');$jsonObj_1->UpdateString('country_code','USA');$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_address = $json->stringOf('matched_address');$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": "525 S Winchester Blvd",
"city_locality": "San Jose",
"state_province": "CA",
"postal_code": "95128",
"country_code": "USA"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (unverified)",
"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\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\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 cannot be verified. The `status` field is `unverified`, and the `messages` array lists the problems with the address."
},
"response": [
{
"name": "Validate an address (unverified)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\"city_locality\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\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:28:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "951"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "118b96e8-1e29-4ded-ba33-62a661e55038"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"unverified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 S Winchester Blvd\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"country_code\": \"USA\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": null,\n \"messages\": [\n {\n \"code\": \"a1005\",\n \"message\": \"Length of property 'country_code' must equal exactly 2\",\n \"type\": \"error\",\n \"detail_code\": \"country_invalid_length\"\n },\n {\n \"code\": \"a1001\",\n \"message\": \"country_code is not currently a supported country, please check the documentation for acceptable 2-letter country codes.\",\n \"type\": \"error\",\n \"detail_code\": \"unsupported_country\"\n }\n ]\n }\n]"
}
]
}