(Perl) Shippo Create Shipment Object

Create a Shipment object to retrieve rates. It represents a request to ship a given package from the sender to the recipient address.

For more information, see https://goshippo.com/docs/shipping-labels/

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/shipments/  \
#     -H "Authorization: ShippoToken <API_TOKEN>" \
#     -H "Content-Type: application/json"  \
#     -d '{
#        "address_from":{
#           "name":"Mr. Hippo",
#           "street1":"215 Clayton St.",
#           "city":"San Francisco",
#           "state":"CA",
#           "zip":"94117",
#           "country":"US"
#        },
#        "address_to":{
#           "name":"Mrs. Hippo",
#           "street1":"965 Mission St.",
#           "city":"San Francisco",
#           "state":"CA",
#           "zip":"94105",
#           "country":"US"
#        },
#        "parcels":[{
#           "length":"5",
#           "width":"5",
#           "height":"5",
#           "distance_unit":"in",
#           "weight":"2",
#           "mass_unit":"lb"
#        }],
#        "async": false
#     }'

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "address_from": {
#     "name": "Mr. Hippo",
#     "street1": "215 Clayton St.",
#     "city": "San Francisco",
#     "state": "CA",
#     "zip": "94117",
#     "country": "US"
#   },
#   "address_to": {
#     "name": "Mrs. Hippo",
#     "street1": "965 Mission St.",
#     "city": "San Francisco",
#     "state": "CA",
#     "zip": "94105",
#     "country": "US"
#   },
#   "parcels": [
#     {
#       "length": "5",
#       "width": "5",
#       "height": "5",
#       "distance_unit": "in",
#       "weight": "2",
#       "mass_unit": "lb"
#     }
#   ],
#   "async": false
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("address_from.name","Mr. Hippo");
$json->UpdateString("address_from.street1","215 Clayton St.");
$json->UpdateString("address_from.city","San Francisco");
$json->UpdateString("address_from.state","CA");
$json->UpdateString("address_from.zip","94117");
$json->UpdateString("address_from.country","US");
$json->UpdateString("address_to.name","Mrs. Hippo");
$json->UpdateString("address_to.street1","965 Mission St.");
$json->UpdateString("address_to.city","San Francisco");
$json->UpdateString("address_to.state","CA");
$json->UpdateString("address_to.zip","94105");
$json->UpdateString("address_to.country","US");
$json->UpdateString("parcels[0].length","5");
$json->UpdateString("parcels[0].width","5");
$json->UpdateString("parcels[0].height","5");
$json->UpdateString("parcels[0].distance_unit","in");
$json->UpdateString("parcels[0].weight","2");
$json->UpdateString("parcels[0].mass_unit","lb");
$json->UpdateBool("async",0);

$http->SetRequestHeader("Authorization","ShippoToken <API_TOKEN>");
$http->SetRequestHeader("Content-Type","application/json");

# resp is a HttpResponse
$resp = $http->PostJson3("https://api.goshippo.com/shipments/","application/json",$json);
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)

# {
#   "carrier_accounts": [
#   ],
#   "object_created": "2019-06-28T17:45:20.441Z",
#   "object_updated": "2019-06-28T17:45:20.511Z",
#   "object_id": "17b01795a4884d8a9002ccc17c9d09d1",
#   "object_owner": "admin@chilkatsoft.com",
#   "status": "SUCCESS",
#   "address_from": {
#     "object_id": "427489906b604f498f7bd2429ab7d9a1",
#     "is_complete": true,
#     "name": "Mr. Hippo",
#     "company": "",
#     "street_no": "",
#     "street1": "215 Clayton St.",
#     "validation_results": {},
#     "street2": "",
#     "street3": "",
#     "city": "San Francisco",
#     "state": "CA",
#     "zip": "94117",
#     "country": "US",
#     "phone": "",
#     "email": "",
#     "is_residential": null,
#     "test": true
#   },
#   "address_to": {
#     "object_id": "3d7166269a2844b7842ef9ace942ec7c",
#     "is_complete": true,
#     "name": "Mrs. Hippo",
#     "company": "",
#     "street_no": "",
#     "street1": "965 Mission St.",
#     "validation_results": {},
#     "street2": "",
#     "street3": "",
#     "city": "San Francisco",
#     "state": "CA",
#     "zip": "94105",
#     "country": "US",
#     "phone": "",
#     "email": "",
#     "is_residential": null,
#     "test": true
#   },
#   "parcels": [
#     {
#       "object_state": "VALID",
#       "object_created": "2019-06-28T17:45:20.411Z",
#       "object_updated": "2019-06-28T17:45:20.455Z",
#       "object_id": "5af766ff15684a4186b0e3c833348fac",
#       "object_owner": "admin@chilkatsoft.com",
#       "template": null,
#       "extra": {},
#       "length": "5.0000",
#       "width": "5.0000",
#       "height": "5.0000",
#       "distance_unit": "in",
#       "weight": "2.0000",
#       "mass_unit": "lb",
#       "value_amount": null,
#       "value_currency": null,
#       "metadata": "",
#       "line_items": [
#       ],
#       "test": true
#     }
#   ],
#   "shipment_date": "2019-06-28T17:45:20.511Z",
#   "address_return": {
#     "object_id": "427489906b604f498f7bd2429ab7d9a1",
#     "is_complete": true,
#     "name": "Mr. Hippo",
#     "company": "",
#     "street_no": "",
#     "street1": "215 Clayton St.",
#     "validation_results": {},
#     "street2": "",
#     "street3": "",
#     "city": "San Francisco",
#     "state": "CA",
#     "zip": "94117",
#     "country": "US",
#     "phone": "",
#     "email": "",
#     "is_residential": null,
#     "test": true
#   },
#   "alternate_address_to": null,
#   "customs_declaration": null,
#   "extra": {},
#   "rates": [
#     {
#       "object_created": "2019-06-28T17:45:20.789Z",
#       "object_id": "dd7556c284e8444294d2ab7099e662d2",
#       "object_owner": "admin@chilkatsoft.com",
#       "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
#       "attributes": [
#         "FASTEST"
#       ],
#       "amount": "22.78",
#       "currency": "USD",
#       "amount_local": "22.78",
#       "currency_local": "USD",
#       "provider": "USPS",
#       "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
#       "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
#       "servicelevel": {
#         "name": "Priority Mail Express",
#         "token": "usps_priority_express",
#         "terms": ""
#       },
#       "estimated_days": 2,
#       "arrives_by": null,
#       "duration_terms": "Overnight delivery to most U.S. locations.",
#       "messages": [
#       ],
#       "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
#       "test": true,
#       "zone": "1"
#     },
#     {
#       "object_created": "2019-06-28T17:45:20.786Z",
#       "object_id": "ec11cc297e2f4583986097f6d409e5c6",
#       "object_owner": "admin@chilkatsoft.com",
#       "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
#       "attributes": [
#         "BESTVALUE",
#         "CHEAPEST",
#         "FASTEST"
#       ],
#       "amount": "6.95",
#       "currency": "USD",
#       "amount_local": "6.95",
#       "currency_local": "USD",
#       "provider": "USPS",
#       "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
#       "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
#       "servicelevel": {
#         "name": "Priority Mail",
#         "token": "usps_priority",
#         "terms": ""
#       },
#       "estimated_days": 2,
#       "arrives_by": null,
#       "duration_terms": "Delivery within 1, 2, or 3 days based on where your package started and where it’s being sent.",
#       "messages": [
#       ],
#       "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
#       "test": true,
#       "zone": "1"
#     },
#     {
#       "object_created": "2019-06-28T17:45:20.785Z",
#       "object_id": "d256586f539f4c93a2f02cc11f4942ac",
#       "object_owner": "admin@chilkatsoft.com",
#       "shipment": "17b01795a4884d8a9002ccc17c9d09d1",
#       "attributes": [
#       ],
#       "amount": "7.32",
#       "currency": "USD",
#       "amount_local": "7.32",
#       "currency_local": "USD",
#       "provider": "USPS",
#       "provider_image_75": "https://shippo-static.s3.amazonaws.com/providers/75/USPS.png",
#       "provider_image_200": "https://shippo-static.s3.amazonaws.com/providers/200/USPS.png",
#       "servicelevel": {
#         "name": "Parcel Select",
#         "token": "usps_parcel_select",
#         "terms": ""
#       },
#       "estimated_days": 7,
#       "arrives_by": null,
#       "duration_terms": "Delivery in 2 to 8 days.",
#       "messages": [
#       ],
#       "carrier_account": "1f3dc340ad6c4991ad61f14fa3e4b82e",
#       "test": true,
#       "zone": "1"
#     }
#   ],
#   "messages": [
#     {
#       "source": "DHLExpress",
#       "code": "",
#       "text": "Shippo's DHL Express master account doesn't support shipments to inside of the US"
#     }
#   ],
#   "metadata": "",
#   "test": true,
#   "order": null
# }

# 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");
$object_owner = $jResp->stringOf("object_owner");
$status = $jResp->stringOf("status");
$address_fromObject_id = $jResp->stringOf("address_from.object_id");
$address_fromIs_complete = $jResp->BoolOf("address_from.is_complete");
$address_fromName = $jResp->stringOf("address_from.name");
$address_fromCompany = $jResp->stringOf("address_from.company");
$address_fromStreet_no = $jResp->stringOf("address_from.street_no");
$address_fromStreet1 = $jResp->stringOf("address_from.street1");
$address_fromStreet2 = $jResp->stringOf("address_from.street2");
$address_fromStreet3 = $jResp->stringOf("address_from.street3");
$address_fromCity = $jResp->stringOf("address_from.city");
$address_fromState = $jResp->stringOf("address_from.state");
$address_fromZip = $jResp->stringOf("address_from.zip");
$address_fromCountry = $jResp->stringOf("address_from.country");
$address_fromPhone = $jResp->stringOf("address_from.phone");
$address_fromEmail = $jResp->stringOf("address_from.email");
$address_fromIs_residential = $jResp->stringOf("address_from.is_residential");
$address_fromTest = $jResp->BoolOf("address_from.test");
$address_toObject_id = $jResp->stringOf("address_to.object_id");
$address_toIs_complete = $jResp->BoolOf("address_to.is_complete");
$address_toName = $jResp->stringOf("address_to.name");
$address_toCompany = $jResp->stringOf("address_to.company");
$address_toStreet_no = $jResp->stringOf("address_to.street_no");
$address_toStreet1 = $jResp->stringOf("address_to.street1");
$address_toStreet2 = $jResp->stringOf("address_to.street2");
$address_toStreet3 = $jResp->stringOf("address_to.street3");
$address_toCity = $jResp->stringOf("address_to.city");
$address_toState = $jResp->stringOf("address_to.state");
$address_toZip = $jResp->stringOf("address_to.zip");
$address_toCountry = $jResp->stringOf("address_to.country");
$address_toPhone = $jResp->stringOf("address_to.phone");
$address_toEmail = $jResp->stringOf("address_to.email");
$address_toIs_residential = $jResp->stringOf("address_to.is_residential");
$address_toTest = $jResp->BoolOf("address_to.test");
$shipment_date = $jResp->stringOf("shipment_date");
$address_returnObject_id = $jResp->stringOf("address_return.object_id");
$address_returnIs_complete = $jResp->BoolOf("address_return.is_complete");
$address_returnName = $jResp->stringOf("address_return.name");
$address_returnCompany = $jResp->stringOf("address_return.company");
$address_returnStreet_no = $jResp->stringOf("address_return.street_no");
$address_returnStreet1 = $jResp->stringOf("address_return.street1");
$address_returnStreet2 = $jResp->stringOf("address_return.street2");
$address_returnStreet3 = $jResp->stringOf("address_return.street3");
$address_returnCity = $jResp->stringOf("address_return.city");
$address_returnState = $jResp->stringOf("address_return.state");
$address_returnZip = $jResp->stringOf("address_return.zip");
$address_returnCountry = $jResp->stringOf("address_return.country");
$address_returnPhone = $jResp->stringOf("address_return.phone");
$address_returnEmail = $jResp->stringOf("address_return.email");
$address_returnIs_residential = $jResp->stringOf("address_return.is_residential");
$address_returnTest = $jResp->BoolOf("address_return.test");
$alternate_address_to = $jResp->stringOf("alternate_address_to");
$customs_declaration = $jResp->stringOf("customs_declaration");
$metadata = $jResp->stringOf("metadata");
$test = $jResp->BoolOf("test");
$order = $jResp->stringOf("order");
$i = 0;
$count_i = $jResp->SizeOfArray("carrier_accounts");
while ($i < $count_i) {
    $jResp->put_I($i);
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray("parcels");
while ($i < $count_i) {
    $jResp->put_I($i);
    $object_state = $jResp->stringOf("parcels[i].object_state");
    $object_created = $jResp->stringOf("parcels[i].object_created");
    $object_updated = $jResp->stringOf("parcels[i].object_updated");
    $object_id = $jResp->stringOf("parcels[i].object_id");
    $object_owner = $jResp->stringOf("parcels[i].object_owner");
    $template = $jResp->stringOf("parcels[i].template");
    $length = $jResp->stringOf("parcels[i].length");
    $width = $jResp->stringOf("parcels[i].width");
    $height = $jResp->stringOf("parcels[i].height");
    $distance_unit = $jResp->stringOf("parcels[i].distance_unit");
    $weight = $jResp->stringOf("parcels[i].weight");
    $mass_unit = $jResp->stringOf("parcels[i].mass_unit");
    $value_amount = $jResp->stringOf("parcels[i].value_amount");
    $value_currency = $jResp->stringOf("parcels[i].value_currency");
    $metadata = $jResp->stringOf("parcels[i].metadata");
    $test = $jResp->BoolOf("parcels[i].test");
    $j = 0;
    $count_j = $jResp->SizeOfArray("parcels[i].line_items");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $j = $j + 1;
    }

    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray("rates");
while ($i < $count_i) {
    $jResp->put_I($i);
    $object_created = $jResp->stringOf("rates[i].object_created");
    $object_id = $jResp->stringOf("rates[i].object_id");
    $object_owner = $jResp->stringOf("rates[i].object_owner");
    $shipment = $jResp->stringOf("rates[i].shipment");
    $amount = $jResp->stringOf("rates[i].amount");
    $currency = $jResp->stringOf("rates[i].currency");
    $amount_local = $jResp->stringOf("rates[i].amount_local");
    $currency_local = $jResp->stringOf("rates[i].currency_local");
    $provider = $jResp->stringOf("rates[i].provider");
    $provider_image_75 = $jResp->stringOf("rates[i].provider_image_75");
    $provider_image_200 = $jResp->stringOf("rates[i].provider_image_200");
    $servicelevelName = $jResp->stringOf("rates[i].servicelevel.name");
    $servicelevelToken = $jResp->stringOf("rates[i].servicelevel.token");
    $servicelevelTerms = $jResp->stringOf("rates[i].servicelevel.terms");
    $estimated_days = $jResp->IntOf("rates[i].estimated_days");
    $arrives_by = $jResp->stringOf("rates[i].arrives_by");
    $duration_terms = $jResp->stringOf("rates[i].duration_terms");
    $carrier_account = $jResp->stringOf("rates[i].carrier_account");
    $test = $jResp->BoolOf("rates[i].test");
    $zone = $jResp->stringOf("rates[i].zone");
    $j = 0;
    $count_j = $jResp->SizeOfArray("rates[i].attributes");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf("rates[i].attributes[j]");
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray("rates[i].messages");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $j = $j + 1;
    }

    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray("messages");
while ($i < $count_i) {
    $jResp->put_I($i);
    $source = $jResp->stringOf("messages[i].source");
    $code = $jResp->stringOf("messages[i].code");
    $text = $jResp->stringOf("messages[i].text");
    $i = $i + 1;
}