(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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"
//     }
//   ]
// }

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

[http SetRequestHeader: @"Authorization" value: @"ShippoToken shippo_test_3af5d574e2f845d30efcaf9b2f47d9c2aef4807a"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://api.goshippo.com/batches/" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"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

NSString *object_id = [jResp StringOf: @"object_id"];
NSString *object_owner = [jResp StringOf: @"object_owner"];
NSString *status = [jResp StringOf: @"status"];
NSString *object_created = [jResp StringOf: @"object_created"];
NSString *object_updated = [jResp StringOf: @"object_updated"];
NSString *metadata = [jResp StringOf: @"metadata"];
NSString *default_carrier_account = [jResp StringOf: @"default_carrier_account"];
NSString *default_servicelevel_token = [jResp StringOf: @"default_servicelevel_token"];
NSString *label_filetype = [jResp StringOf: @"label_filetype"];
NSString *batch_shipmentsNext = [jResp StringOf: @"batch_shipments.next"];
NSString *batch_shipmentsPrevious = [jResp StringOf: @"batch_shipments.previous"];
int object_resultsPurchase_succeeded = [[jResp IntOf: @"object_results.purchase_succeeded"] intValue];
int object_resultsPurchase_failed = [[jResp IntOf: @"object_results.purchase_failed"] intValue];
int object_resultsCreation_failed = [[jResp IntOf: @"object_results.creation_failed"] intValue];
int object_resultsCreation_succeeded = [[jResp IntOf: @"object_results.creation_succeeded"] intValue];
int i = 0;
int count_i = [[jResp SizeOfArray: @"batch_shipments.results"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"label_url"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    i = i + 1;
}