Objective-C
Objective-C
Shippo Label Purchase
See more Shippo Examples
Demonstrates how to create a shipping label in one API call through Shippo.Chilkat Objective-C Downloads
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
BOOL success = NO;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
// Implements the following CURL command:
// curl https://api.goshippo.com/transactions/ \
// -H "Authorization: ShippoToken <API_Token>" \
// -H "Content-Type: application/json" \
// -d '{
// "shipment": {
// "address_from": {
// "name": "Mr. Hippo",
// "street1": "215 Clayton St.",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94117",
// "country": "US",
// "phone": "+1 555 341 9393",
// "email": "support@goshippo.com"
// },
// "address_to": {
// "name": "Mrs. Hippo",
// "street1": "965 Mission St.",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94105",
// "country": "US",
// "phone": "+1 555 341 9393",
// "email": "support@goshippo.com"
// },
// "parcels": [{
// "length": "5",
// "width": "5",
// "height": "5",
// "distance_unit": "in",
// "weight": "2",
// "mass_unit": "lb"
// }]
// },
// "carrier_account": "b741b99f95e841639b54272834bc478c",
// "servicelevel_token": "usps_priority"
// }'
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "shipment": {
// "address_from": {
// "name": "Mr. Hippo",
// "street1": "215 Clayton St.",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94117",
// "country": "US",
// "phone": "+1 555 341 9393",
// "email": "support@goshippo.com"
// },
// "address_to": {
// "name": "Mrs. Hippo",
// "street1": "965 Mission St.",
// "city": "San Francisco",
// "state": "CA",
// "zip": "94105",
// "country": "US",
// "phone": "+1 555 341 9393",
// "email": "support@goshippo.com"
// },
// "parcels": [
// {
// "length": "5",
// "width": "5",
// "height": "5",
// "distance_unit": "in",
// "weight": "2",
// "mass_unit": "lb"
// }
// ]
// },
// "carrier_account": "b741b99f95e841639b54272834bc478c",
// "servicelevel_token": "usps_priority"
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"shipment.address_from.name" value: @"Mr. Hippo"];
[json UpdateString: @"shipment.address_from.street1" value: @"215 Clayton St."];
[json UpdateString: @"shipment.address_from.city" value: @"San Francisco"];
[json UpdateString: @"shipment.address_from.state" value: @"CA"];
[json UpdateString: @"shipment.address_from.zip" value: @"94117"];
[json UpdateString: @"shipment.address_from.country" value: @"US"];
[json UpdateString: @"shipment.address_from.phone" value: @"+1 555 341 9393"];
[json UpdateString: @"shipment.address_from.email" value: @"support@goshippo.com"];
[json UpdateString: @"shipment.address_to.name" value: @"Mrs. Hippo"];
[json UpdateString: @"shipment.address_to.street1" value: @"965 Mission St."];
[json UpdateString: @"shipment.address_to.city" value: @"San Francisco"];
[json UpdateString: @"shipment.address_to.state" value: @"CA"];
[json UpdateString: @"shipment.address_to.zip" value: @"94105"];
[json UpdateString: @"shipment.address_to.country" value: @"US"];
[json UpdateString: @"shipment.address_to.phone" value: @"+1 555 341 9393"];
[json UpdateString: @"shipment.address_to.email" value: @"support@goshippo.com"];
[json UpdateString: @"shipment.parcels[0].length" value: @"5"];
[json UpdateString: @"shipment.parcels[0].width" value: @"5"];
[json UpdateString: @"shipment.parcels[0].height" value: @"5"];
[json UpdateString: @"shipment.parcels[0].distance_unit" value: @"in"];
[json UpdateString: @"shipment.parcels[0].weight" value: @"2"];
[json UpdateString: @"shipment.parcels[0].mass_unit" value: @"lb"];
[json UpdateString: @"carrier_account" value: @"b741b99f95e841639b54272834bc478c"];
[json UpdateString: @"servicelevel_token" value: @"usps_priority"];
[http SetRequestHeader: @"Authorization" value: @"ShippoToken <API_Token>"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpJson: @"POST" url: @"https://api.goshippo.com/transactions/" json: json contentType: @"application/json" response: resp];
if (success == 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_state": "VALID",
// "status": "SUCCESS",
// "object_created": "2013-12-27T19:14:48.273Z",
// "object_updated": "2013-12-27T19:14:48.273Z",
// "object_id": "64bba01845ef40d29374032599f22588",
// "object_owner": "shippotle@goshippo.com",
// "was_test": false,
// "rate": {
// "object_id": "cf6fea899f1848b494d9568e8266e076",
// "amount": "5.50",
// "currency": "USD",
// "amount_local": "5.50",
// "currency_local": "USD",
// "provider": "USPS",
// "servicelevel_name": "Priority Mail",
// "servicelevel_token": "usps_priority",
// "carrier_account": "078870331023437cb917f5187429b093"
// },
// "tracking_number": "ZW70QJC",
// "tracking_status": {
// "object_created": "2013-12-27T23:17:41.411Z",
// "object_id": "a21b3d6831c14ceaba6730179ce6e784",
// "status": "UNKNOWN",
// "status_details": "",
// "status_date": "2013-12-28T12:04:04.214Z"
// },
// "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=ZW70QJC",
// "eta": "2013-12-30T12:00:00.000Z",
// "label_url": "https://shippo-delivery.s3.amazonaws.com/96.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
// "commercial_invoice_url": "",
// "metadata": "",
// "messages": [
// ]
// }
// 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_state = [jResp StringOf: @"object_state"];
NSString *status = [jResp StringOf: @"status"];
NSString *object_created = [jResp StringOf: @"object_created"];
NSString *object_updated = [jResp StringOf: @"object_updated"];
NSString *object_id = [jResp StringOf: @"object_id"];
NSString *object_owner = [jResp StringOf: @"object_owner"];
BOOL was_test = [jResp BoolOf: @"was_test"];
NSString *rateObject_id = [jResp StringOf: @"rate.object_id"];
NSString *rateAmount = [jResp StringOf: @"rate.amount"];
NSString *rateCurrency = [jResp StringOf: @"rate.currency"];
NSString *rateAmount_local = [jResp StringOf: @"rate.amount_local"];
NSString *rateCurrency_local = [jResp StringOf: @"rate.currency_local"];
NSString *rateProvider = [jResp StringOf: @"rate.provider"];
NSString *rateServicelevel_name = [jResp StringOf: @"rate.servicelevel_name"];
NSString *rateServicelevel_token = [jResp StringOf: @"rate.servicelevel_token"];
NSString *rateCarrier_account = [jResp StringOf: @"rate.carrier_account"];
NSString *tracking_number = [jResp StringOf: @"tracking_number"];
NSString *tracking_statusObject_created = [jResp StringOf: @"tracking_status.object_created"];
NSString *tracking_statusObject_id = [jResp StringOf: @"tracking_status.object_id"];
NSString *tracking_statusStatus = [jResp StringOf: @"tracking_status.status"];
NSString *tracking_statusStatus_details = [jResp StringOf: @"tracking_status.status_details"];
NSString *tracking_statusStatus_date = [jResp StringOf: @"tracking_status.status_date"];
NSString *tracking_url_provider = [jResp StringOf: @"tracking_url_provider"];
NSString *eta = [jResp StringOf: @"eta"];
NSString *label_url = [jResp StringOf: @"label_url"];
NSString *commercial_invoice_url = [jResp StringOf: @"commercial_invoice_url"];
NSString *metadata = [jResp StringOf: @"metadata"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"messages"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
i = i + 1;
}