(Perl) Shippo Validate Address

Demonstrates how to validate your addresses through the Shippo API before you create labels.

For more information, see https://goshippo.com/docs/address-validation/

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

# Implements the following CURL command:

# curl https://api.goshippo.com/addresses/ \
#     -H "Authorization: ShippoToken <API_TOKEN>" \
#     -d name="Shawn Ippotle" \
#     -d company="Shippo" \
#     -d street1="215 Clayton St." \
#     -d city="San Francisco" \
#     -d state="CA" \
#     -d zip=94117 \
#     -d country="US" \
#     -d email="shippotle@goshippo.com"\
#     -d validate=true

$req = chilkat::CkHttpRequest->new();
$req->put_HttpVerb("POST");
$req->put_Path("/addresses/");
$req->put_ContentType("application/x-www-form-urlencoded");
$req->AddParam("name","Shawn Ippotle");
$req->AddParam("company","Shippo");
$req->AddParam("street1","215 Clayton St.");
$req->AddParam("city","San Francisco");
$req->AddParam("state","CA");
$req->AddParam("zip","94117");
$req->AddParam("country","US");
$req->AddParam("email",'shippotle@goshippo.com');
$req->AddParam("validate","true");

$req->AddHeader("Authorization","ShippoToken <API_TOKEN>");

# resp is a HttpResponse
$resp = $http->PostUrlEncoded("https://api.goshippo.com/addresses/",$req);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "object_created": "2015-03-30T23:47:11.574Z",
#   "object_updated": "2015-03-30T23:47:11.596Z",
#   "object_id": "67183b2e81e9421f894bfbcdc4236b16",
#   "is_complete": false,
#   "validation_results": {
#     "is_valid": false,
#     "messages": [
#       {
#         "source": "USPS",
#         "code": "Address Not Found",
#         "type": "address_error",
#         "text": "The address as submitted could not be found. Please check for excessive abbreviations in the street address line or in the City name."
#       }
#     ]
#   },
#   "object_owner": "shippotle@goshippo.com",
#   "name": "Shawn Ippotle",
#   "company": "Shippo",
#   "street_no": "",
#   "street1": "215 HIPPO ST.",
#   "street2": "",
#   "city": "SAN FRANCISCO",
#   "state": "CA",
#   "zip": "94107",
#   "country": "US",
#   "phone": ""
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$object_created = $jResp->stringOf("object_created");
$object_updated = $jResp->stringOf("object_updated");
$object_id = $jResp->stringOf("object_id");
$is_complete = $jResp->BoolOf("is_complete");
$validation_resultsIs_valid = $jResp->BoolOf("validation_results.is_valid");
$object_owner = $jResp->stringOf("object_owner");
$name = $jResp->stringOf("name");
$company = $jResp->stringOf("company");
$street_no = $jResp->stringOf("street_no");
$street1 = $jResp->stringOf("street1");
$street2 = $jResp->stringOf("street2");
$city = $jResp->stringOf("city");
$state = $jResp->stringOf("state");
$zip = $jResp->stringOf("zip");
$country = $jResp->stringOf("country");
$phone = $jResp->stringOf("phone");
$i = 0;
$count_i = $jResp->SizeOfArray("validation_results.messages");
while ($i < $count_i) {
    $jResp->put_I($i);
    $source = $jResp->stringOf("validation_results.messages[i].source");
    $code = $jResp->stringOf("validation_results.messages[i].code");
    $v_type = $jResp->stringOf("validation_results.messages[i].type");
    $text = $jResp->stringOf("validation_results.messages[i].text");
    $i = $i + 1;
}