Dart
Dart
Shippo Create a Batch
See more Shippo Examples
Demonstrates how to create and purchase up to 10,000 shipments in a single API request.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
final http = CkHttp();
// 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"
// }
// ]
// }
final json = CkJsonObject();
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');
final resp = CkHttpResponse();
try {
http.httpJson('POST', 'https://api.goshippo.com/batches/', json, 'application/json', resp);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
final sbResponseBody = CkStringBuilder();
resp.getBodySb(sbResponseBody);
final jResp = CkJsonObject();
jResp.loadSb(sbResponseBody);
jResp.emitCompact = false;
print('Response Body:');
print(jResp.emit());
final respStatusCode = resp.statusCode;
print('Response Status Code = $respStatusCode');
if (respStatusCode >= 400) {
print('Response Header:');
print(resp.header);
print('Failed.');
return;
}
// 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
final objectId = jResp.stringOf('object_id');
final objectOwner = jResp.stringOf('object_owner');
final status = jResp.stringOf('status');
final objectCreated = jResp.stringOf('object_created');
final objectUpdated = jResp.stringOf('object_updated');
final metadata = jResp.stringOf('metadata');
final defaultCarrierAccount = jResp.stringOf('default_carrier_account');
final defaultServicelevelToken = jResp.stringOf('default_servicelevel_token');
final labelFiletype = jResp.stringOf('label_filetype');
final batchShipmentsNext = jResp.stringOf('batch_shipments.next');
final batchShipmentsPrevious = jResp.stringOf('batch_shipments.previous');
final objectResultsPurchaseSucceeded = jResp.intOf('object_results.purchase_succeeded');
final objectResultsPurchaseFailed = jResp.intOf('object_results.purchase_failed');
final objectResultsCreationFailed = jResp.intOf('object_results.creation_failed');
final objectResultsCreationSucceeded = jResp.intOf('object_results.creation_succeeded');
var i = 0;
var countI = jResp.sizeOfArray('batch_shipments.results');
while (i < countI) {
jResp.i = i;
i++;
}
i = 0;
countI = jResp.sizeOfArray('label_url');
while (i < countI) {
jResp.i = i;
i++;
}
}