Objective-C

Shippo List All Orders

See more Shippo Examples

Demonstrates how to list all orders created by sending a GET request to the orders endpoint. Objective-C

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.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/orders/ \
//     -H "Authorization: ShippoToken <API_Token>"

[http SetRequestHeader: @"Authorization" value: @"ShippoToken <API_Token>"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.goshippo.com/orders/" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

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

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

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "count": 1382,
//   "next": "https://api.goshippo.com/orders/?page=2",
//   "previous": null,
//   "results": [
//     {
//       "object_id": "4f2bc588e4e5446cb3f9fdb7cd5e190b",
//       "object_owner": "shippotle@goshippo.com",
//       "order_number": "#1068",
//       "order_status": "PAID",
//       "placed_at": "2016-09-23T01:28:12Z",
//       "to_address": {
//         "object_created": "2016-09-23T01:38:56Z",
//         "object_updated": "2016-09-23T01:38:56Z",
//         "object_id": "d799c2679e644279b59fe661ac8fa488",
//         "object_owner": "shippotle@goshippo.com",
//         "is_complete": true,
//         "validation_results": {},
//         "name": "Mr Hippo",
//         "company": "Shippo",
//         "street1": "215 Clayton St.",
//         "street2": "",
//         "city": "San Francisco",
//         "state": "CA",
//         "zip": "94117",
//         "country": "US",
//         "phone": "15553419393",
//         "email": "shippotle@goshippo.com",
//         "is_residential": null,
//         "metadata": ""
//       },
//       "from_address": null,
//       "line_items": [
//         {
//           "object_id": "abf7d5675d744b6ea9fdb6f796b28f28",
//           "title": "Hippo Magazines",
//           "variant_title": "",
//           "sku": "HM-123",
//           "quantity": 1,
//           "total_price": "12.10",
//           "currency": "USD",
//           "weight": "0.40",
//           "weight_unit": "lb",
//           "manufacture_country": null,
//           "max_ship_time": null,
//           "max_delivery_time": null,
//           "description": null
//         }
//       ],
//       "shipping_cost": "12.83",
//       "shipping_cost_currency": "USD",
//       "shipping_method": "USPS First Class Package",
//       "shop_app": "Shippo",
//       "subtotal_price": "12.10",
//       "total_price": "24.93",
//       "total_tax": "0.00",
//       "currency": "USD",
//       "transactions": [
//       ],
//       "weight": "0.40",
//       "weight_unit": "lb",
//       "notes": null
//     },
//     ...
//   ]
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

int intVal;
int j;
int count_j;
NSString *object_id = 0;
NSString *title = 0;
NSString *variant_title = 0;
NSString *sku = 0;
int quantity;
NSString *total_price = 0;
NSString *currency = 0;
NSString *weight = 0;
NSString *weight_unit = 0;
NSString *manufacture_country = 0;
NSString *max_ship_time = 0;
NSString *max_delivery_time = 0;
NSString *description = 0;

int count = [[jResp IntOf: @"count"] intValue];
NSString *next = [jResp StringOf: @"next"];
NSString *previous = [jResp StringOf: @"previous"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"results"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    intVal = [[jResp IntOf: @"results[i]"] intValue];
    j = 0;
    count_j = [[jResp SizeOfArray: @"results[i].line_items"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        object_id = [jResp StringOf: @"results[i].line_items[j].object_id"];
        title = [jResp StringOf: @"results[i].line_items[j].title"];
        variant_title = [jResp StringOf: @"results[i].line_items[j].variant_title"];
        sku = [jResp StringOf: @"results[i].line_items[j].sku"];
        quantity = [[jResp IntOf: @"results[i].line_items[j].quantity"] intValue];
        total_price = [jResp StringOf: @"results[i].line_items[j].total_price"];
        currency = [jResp StringOf: @"results[i].line_items[j].currency"];
        weight = [jResp StringOf: @"results[i].line_items[j].weight"];
        weight_unit = [jResp StringOf: @"results[i].line_items[j].weight_unit"];
        manufacture_country = [jResp StringOf: @"results[i].line_items[j].manufacture_country"];
        max_ship_time = [jResp StringOf: @"results[i].line_items[j].max_ship_time"];
        max_delivery_time = [jResp StringOf: @"results[i].line_items[j].max_delivery_time"];
        description = [jResp StringOf: @"results[i].line_items[j].description"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"results[i].transactions"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    i = i + 1;
}