(Perl) Shippo Create a Batch

Demonstrates how to create and purchase up to 10,000 shipments in a single API request.

For more information, see https://goshippo.com/docs/batch/

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();

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

# The following JSON is sent in the request body.

# {
#   "default_carrier_account": "078870331023437cb917f5187429b093",
#   "default_servicelevel_token": "usps_priority",
#   "label_filetype": "PDF_4x6",
#   "metadata": "BATCH #170",
#   "batch_shipments": [
#     {
#       "shipment": {
#         "address_from": {
#           "name": "Mr Hippo",
#           "street1": "965 Mission St",
#           "street2": "Ste 201",
#           "city": "San Francisco",
#           "state": "CA",
#           "zip": "94103",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrhippo@goshippo.com"
#         },
#         "address_to": {
#           "name": "Mrs Hippo",
#           "company": "",
#           "street1": "Broadway 1",
#           "street2": "",
#           "city": "New York",
#           "state": "NY",
#           "zip": "10007",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrshippo@goshippo.com"
#         },
#         "parcels": [
#           {
#             "length": "5",
#             "width": "5",
#             "height": "5",
#             "distance_unit": "in",
#             "weight": "2",
#             "mass_unit": "oz"
#           }
#         ]
#       }
#     },
#     {
#       "shipment": {
#         "address_from": {
#           "name": "Mr Hippo",
#           "street1": "1092 Indian Summer Ct",
#           "city": "San Jose",
#           "state": "CA",
#           "zip": "95122",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrhippo@goshippo.com"
#         },
#         "address_to": {
#           "name": "Mrs Hippo",
#           "company": "",
#           "street1": "Broadway 1",
#           "street2": "",
#           "city": "New York",
#           "state": "NY",
#           "zip": "10007",
#           "country": "US",
#           "phone": "4151234567",
#           "email": "mrshippo@goshippo.com"
#         },
#         "parcels": [
#           {
#             "length": "5",
#             "width": "5",
#             "height": "5",
#             "distance_unit": "in",
#             "weight": "20",
#             "mass_unit": "lb"
#           }
#         ]
#       },
#       "carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
#       "servicelevel_token": "fedex_2_day"
#     }
#   ]
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("default_carrier_account","078870331023437cb917f5187429b093");
$json->UpdateString("default_servicelevel_token","usps_priority");
$json->UpdateString("label_filetype","PDF_4x6");
$json->UpdateString("metadata","BATCH #170");
$json->UpdateString("batch_shipments[0].shipment.address_from.name","Mr Hippo");
$json->UpdateString("batch_shipments[0].shipment.address_from.street1","965 Mission St");
$json->UpdateString("batch_shipments[0].shipment.address_from.street2","Ste 201");
$json->UpdateString("batch_shipments[0].shipment.address_from.city","San Francisco");
$json->UpdateString("batch_shipments[0].shipment.address_from.state","CA");
$json->UpdateString("batch_shipments[0].shipment.address_from.zip","94103");
$json->UpdateString("batch_shipments[0].shipment.address_from.country","US");
$json->UpdateString("batch_shipments[0].shipment.address_from.phone","4151234567");
$json->UpdateString("batch_shipments[0].shipment.address_from.email",'mrhippo@goshippo.com');
$json->UpdateString("batch_shipments[0].shipment.address_to.name","Mrs Hippo");
$json->UpdateString("batch_shipments[0].shipment.address_to.company","");
$json->UpdateString("batch_shipments[0].shipment.address_to.street1","Broadway 1");
$json->UpdateString("batch_shipments[0].shipment.address_to.street2","");
$json->UpdateString("batch_shipments[0].shipment.address_to.city","New York");
$json->UpdateString("batch_shipments[0].shipment.address_to.state","NY");
$json->UpdateString("batch_shipments[0].shipment.address_to.zip","10007");
$json->UpdateString("batch_shipments[0].shipment.address_to.country","US");
$json->UpdateString("batch_shipments[0].shipment.address_to.phone","4151234567");
$json->UpdateString("batch_shipments[0].shipment.address_to.email",'mrshippo@goshippo.com');
$json->UpdateString("batch_shipments[0].shipment.parcels[0].length","5");
$json->UpdateString("batch_shipments[0].shipment.parcels[0].width","5");
$json->UpdateString("batch_shipments[0].shipment.parcels[0].height","5");
$json->UpdateString("batch_shipments[0].shipment.parcels[0].distance_unit","in");
$json->UpdateString("batch_shipments[0].shipment.parcels[0].weight","2");
$json->UpdateString("batch_shipments[0].shipment.parcels[0].mass_unit","oz");
$json->UpdateString("batch_shipments[1].shipment.address_from.name","Mr Hippo");
$json->UpdateString("batch_shipments[1].shipment.address_from.street1","1092 Indian Summer Ct");
$json->UpdateString("batch_shipments[1].shipment.address_from.city","San Jose");
$json->UpdateString("batch_shipments[1].shipment.address_from.state","CA");
$json->UpdateString("batch_shipments[1].shipment.address_from.zip","95122");
$json->UpdateString("batch_shipments[1].shipment.address_from.country","US");
$json->UpdateString("batch_shipments[1].shipment.address_from.phone","4151234567");
$json->UpdateString("batch_shipments[1].shipment.address_from.email",'mrhippo@goshippo.com');
$json->UpdateString("batch_shipments[1].shipment.address_to.name","Mrs Hippo");
$json->UpdateString("batch_shipments[1].shipment.address_to.company","");
$json->UpdateString("batch_shipments[1].shipment.address_to.street1","Broadway 1");
$json->UpdateString("batch_shipments[1].shipment.address_to.street2","");
$json->UpdateString("batch_shipments[1].shipment.address_to.city","New York");
$json->UpdateString("batch_shipments[1].shipment.address_to.state","NY");
$json->UpdateString("batch_shipments[1].shipment.address_to.zip","10007");
$json->UpdateString("batch_shipments[1].shipment.address_to.country","US");
$json->UpdateString("batch_shipments[1].shipment.address_to.phone","4151234567");
$json->UpdateString("batch_shipments[1].shipment.address_to.email",'mrshippo@goshippo.com');
$json->UpdateString("batch_shipments[1].shipment.parcels[0].length","5");
$json->UpdateString("batch_shipments[1].shipment.parcels[0].width","5");
$json->UpdateString("batch_shipments[1].shipment.parcels[0].height","5");
$json->UpdateString("batch_shipments[1].shipment.parcels[0].distance_unit","in");
$json->UpdateString("batch_shipments[1].shipment.parcels[0].weight","20");
$json->UpdateString("batch_shipments[1].shipment.parcels[0].mass_unit","lb");
$json->UpdateString("batch_shipments[1].carrier_account","a4391cd4ab974f478f55dc08b5c8e3b3");
$json->UpdateString("batch_shipments[1].servicelevel_token","fedex_2_day");

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

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

# {
#   "object_id": "a015eb693cca465dbb6523ce6d2e3c65",
#   "object_owner": "admin",
#   "status": "VALIDATING",
#   "object_created": "2016-09-12T15:25:43.465Z",
#   "object_updated": "2016-09-12T15:25:43.465Z",
#   "metadata": "BATCH #170",
#   "default_carrier_account": "078870331023437cb917f5187429b093",
#   "default_servicelevel_token": "usps_priority",
#   "label_filetype": "PDF_4x6",
#   "batch_shipments": {
#     "next": null,
#     "previous": null,
#     "results": [
#     ]
#   },
#   "object_results": {
#     "purchase_succeeded": 0,
#     "purchase_failed": 0,
#     "creation_failed": 0,
#     "creation_succeeded": 0
#   },
#   "label_url": [
#   ]
# }

# 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_id = $jResp->stringOf("object_id");
$object_owner = $jResp->stringOf("object_owner");
$status = $jResp->stringOf("status");
$object_created = $jResp->stringOf("object_created");
$object_updated = $jResp->stringOf("object_updated");
$metadata = $jResp->stringOf("metadata");
$default_carrier_account = $jResp->stringOf("default_carrier_account");
$default_servicelevel_token = $jResp->stringOf("default_servicelevel_token");
$label_filetype = $jResp->stringOf("label_filetype");
$batch_shipmentsNext = $jResp->stringOf("batch_shipments.next");
$batch_shipmentsPrevious = $jResp->stringOf("batch_shipments.previous");
$object_resultsPurchase_succeeded = $jResp->IntOf("object_results.purchase_succeeded");
$object_resultsPurchase_failed = $jResp->IntOf("object_results.purchase_failed");
$object_resultsCreation_failed = $jResp->IntOf("object_results.creation_failed");
$object_resultsCreation_succeeded = $jResp->IntOf("object_results.creation_succeeded");
$i = 0;
$count_i = $jResp->SizeOfArray("batch_shipments.results");
while ($i < $count_i) {
    $jResp->put_I($i);
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray("label_url");
while ($i < $count_i) {
    $jResp->put_I($i);
    $i = $i + 1;
}