(Objective-C) Shippo Adding Metadata

Demonstrates how to add metadata to the tracking request through a POST request.

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

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.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;

// Implements the following CURL command:

// curl https://api.goshippo.com/tracks/ \
//     -H "Authorization: ShippoToken <API_TOKEN>" \
//     -d carrier="shippo" \
//     -d tracking_number="SHIPPO_TRANSIT" \
//     -d metadata="Order 000123"

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/tracks/";
req.ContentType = @"application/x-www-form-urlencoded";
[req AddParam: @"carrier" value: @"shippo"];
[req AddParam: @"tracking_number" value: @"SHIPPO_TRANSIT"];
[req AddParam: @"metadata" value: @"Order 000123"];

[req AddHeader: @"Authorization" value: @"ShippoToken <API_TOKEN>"];

CkoHttpResponse *resp = [http PostUrlEncoded: @"https://api.goshippo.com/tracks/" req: req];
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)

// {
//   "messages": [
//   ],
//   "carrier": "shippo",
//   "tracking_number": "SHIPPO_TRANSIT",
//   "address_from": {
//     "city": "San Francisco",
//     "state": "CA",
//     "zip": "94103",
//     "country": "US"
//   },
//   "address_to": {
//     "city": "Chicago",
//     "state": "IL",
//     "zip": "60611",
//     "country": "US"
//   },
//   "eta": "2019-07-07T17:07:44.989Z",
//   "original_eta": "2019-07-07T17:07:44.989Z",
//   "servicelevel": {
//     "token": "shippo_priority",
//     "name": "Priority Mail"
//   },
//   "metadata": "Shippo test tracking",
//   "tracking_status": {
//     "object_created": "2019-07-04T17:07:45.003Z",
//     "object_updated": null,
//     "object_id": "ee35fb56f5d04021b36168abedc04573",
//     "status": "TRANSIT",
//     "status_details": "Your shipment has departed from the origin.",
//     "status_date": "2019-07-03T15:02:45.003Z",
//     "substatus": null,
//     "location": {
//       "city": "San Francisco",
//       "state": "CA",
//       "zip": "94103",
//       "country": "US"
//     }
//   },
//   "tracking_history": [
//     {
//       "object_created": "2019-07-04T17:07:45.005Z",
//       "object_updated": null,
//       "object_id": "2121a59f53ed42e0ae0436f636179156",
//       "status": "UNKNOWN",
//       "status_details": "The carrier has received the electronic shipment information.",
//       "status_date": "2019-07-02T12:57:45.005Z",
//       "substatus": null,
//       "location": {
//         "city": "San Francisco",
//         "state": "CA",
//         "zip": "94103",
//         "country": "US"
//       }
//     },
//     {
//       "object_created": "2019-07-04T17:07:45.005Z",
//       "object_updated": null,
//       "object_id": "06f949db1a8245beaa28df264b368a76",
//       "status": "TRANSIT",
//       "status_details": "Your shipment has departed from the origin.",
//       "status_date": "2019-07-03T15:02:45.005Z",
//       "substatus": null,
//       "location": {
//         "city": "San Francisco",
//         "state": "CA",
//         "zip": "94103",
//         "country": "US"
//       }
//     }
//   ],
//   "transaction": null,
//   "test": true
// }

// 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_created = 0;
NSString *object_updated = 0;
NSString *object_id = 0;
NSString *status = 0;
NSString *status_details = 0;
NSString *status_date = 0;
NSString *substatus = 0;
NSString *locationCity = 0;
NSString *locationState = 0;
NSString *locationZip = 0;
NSString *locationCountry = 0;

NSString *carrier = [jResp StringOf: @"carrier"];
NSString *tracking_number = [jResp StringOf: @"tracking_number"];
NSString *address_fromCity = [jResp StringOf: @"address_from.city"];
NSString *address_fromState = [jResp StringOf: @"address_from.state"];
NSString *address_fromZip = [jResp StringOf: @"address_from.zip"];
NSString *address_fromCountry = [jResp StringOf: @"address_from.country"];
NSString *address_toCity = [jResp StringOf: @"address_to.city"];
NSString *address_toState = [jResp StringOf: @"address_to.state"];
NSString *address_toZip = [jResp StringOf: @"address_to.zip"];
NSString *address_toCountry = [jResp StringOf: @"address_to.country"];
NSString *eta = [jResp StringOf: @"eta"];
NSString *original_eta = [jResp StringOf: @"original_eta"];
NSString *servicelevelToken = [jResp StringOf: @"servicelevel.token"];
NSString *servicelevelName = [jResp StringOf: @"servicelevel.name"];
NSString *metadata = [jResp StringOf: @"metadata"];
NSString *tracking_statusObject_created = [jResp StringOf: @"tracking_status.object_created"];
NSString *tracking_statusObject_updated = [jResp StringOf: @"tracking_status.object_updated"];
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_statusSubstatus = [jResp StringOf: @"tracking_status.substatus"];
NSString *tracking_statusLocationCity = [jResp StringOf: @"tracking_status.location.city"];
NSString *tracking_statusLocationState = [jResp StringOf: @"tracking_status.location.state"];
NSString *tracking_statusLocationZip = [jResp StringOf: @"tracking_status.location.zip"];
NSString *tracking_statusLocationCountry = [jResp StringOf: @"tracking_status.location.country"];
NSString *transaction = [jResp StringOf: @"transaction"];
BOOL test = [jResp BoolOf: @"test"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"messages"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"tracking_history"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    object_created = [jResp StringOf: @"tracking_history[i].object_created"];
    object_updated = [jResp StringOf: @"tracking_history[i].object_updated"];
    object_id = [jResp StringOf: @"tracking_history[i].object_id"];
    status = [jResp StringOf: @"tracking_history[i].status"];
    status_details = [jResp StringOf: @"tracking_history[i].status_details"];
    status_date = [jResp StringOf: @"tracking_history[i].status_date"];
    substatus = [jResp StringOf: @"tracking_history[i].substatus"];
    locationCity = [jResp StringOf: @"tracking_history[i].location.city"];
    locationState = [jResp StringOf: @"tracking_history[i].location.state"];
    locationZip = [jResp StringOf: @"tracking_history[i].location.zip"];
    locationCountry = [jResp StringOf: @"tracking_history[i].location.country"];
    i = i + 1;
}