Objective-C

Shippo Create an Order

See more Shippo Examples

Demonstrates how to create an order with all the information about your order by sending a POST request to the orders endpoint. Objective-C

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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>" \
//      -H "Content-Type: application/json"  \
//      -d '{
//              "to_address": {
//                  "city": "San Francisco",
//                  "company": "Shippo",
//                  "country": "US",
//                  "email": "shippotle@goshippo.com",
//                  "name": "Mr Hippo",
//                  "phone": "15553419393",
//                  "state": "CA",
//                  "street1": "215 Clayton St.",
//                  "zip": "94117"
//              },
//              "line_items": [
//                  {
//                      "quantity": 1,
//                      "sku": "HM-123",
//                      "title": "Hippo Magazines",
//                      "total_price": "12.10",
//                      "currency": "USD",
//                      "weight": "0.40",
//                      "weight_unit": "lb"
//                  }
//              ],
//              "placed_at": "2016-09-23T01:28:12Z",
//              "order_number": "#1068",
//              "order_status": "PAID",
//              "shipping_cost": "12.83",
//              "shipping_cost_currency": "USD",
//              "shipping_method": "USPS First Class Package",
//              "subtotal_price": "12.10",
//              "total_price": "24.93",
//              "total_tax": "0.00",
//              "currency": "USD",
//              "weight": "0.40",
//              "weight_unit": "lb"
//          }'

//  Use this online tool to generate code from sample JSON:
//  Generate Code to Create JSON

//  The following JSON is sent in the request body.

//  {
//    "to_address": {
//      "city": "San Francisco",
//      "company": "Shippo",
//      "country": "US",
//      "email": "shippotle@goshippo.com",
//      "name": "Mr Hippo",
//      "phone": "15553419393",
//      "state": "CA",
//      "street1": "215 Clayton St.",
//      "zip": "94117"
//    },
//    "line_items": [
//      {
//        "quantity": 1,
//        "sku": "HM-123",
//        "title": "Hippo Magazines",
//        "total_price": "12.10",
//        "currency": "USD",
//        "weight": "0.40",
//        "weight_unit": "lb"
//      }
//    ],
//    "placed_at": "2016-09-23T01:28:12Z",
//    "order_number": "#1068",
//    "order_status": "PAID",
//    "shipping_cost": "12.83",
//    "shipping_cost_currency": "USD",
//    "shipping_method": "USPS First Class Package",
//    "subtotal_price": "12.10",
//    "total_price": "24.93",
//    "total_tax": "0.00",
//    "currency": "USD",
//    "weight": "0.40",
//    "weight_unit": "lb"
//  }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"to_address.city" value: @"San Francisco"];
[json UpdateString: @"to_address.company" value: @"Shippo"];
[json UpdateString: @"to_address.country" value: @"US"];
[json UpdateString: @"to_address.email" value: @"shippotle@goshippo.com"];
[json UpdateString: @"to_address.name" value: @"Mr Hippo"];
[json UpdateString: @"to_address.phone" value: @"15553419393"];
[json UpdateString: @"to_address.state" value: @"CA"];
[json UpdateString: @"to_address.street1" value: @"215 Clayton St."];
[json UpdateString: @"to_address.zip" value: @"94117"];
[json UpdateInt: @"line_items[0].quantity" value: [NSNumber numberWithInt: 1]];
[json UpdateString: @"line_items[0].sku" value: @"HM-123"];
[json UpdateString: @"line_items[0].title" value: @"Hippo Magazines"];
[json UpdateString: @"line_items[0].total_price" value: @"12.10"];
[json UpdateString: @"line_items[0].currency" value: @"USD"];
[json UpdateString: @"line_items[0].weight" value: @"0.40"];
[json UpdateString: @"line_items[0].weight_unit" value: @"lb"];
[json UpdateString: @"placed_at" value: @"2016-09-23T01:28:12Z"];
[json UpdateString: @"order_number" value: @"#1068"];
[json UpdateString: @"order_status" value: @"PAID"];
[json UpdateString: @"shipping_cost" value: @"12.83"];
[json UpdateString: @"shipping_cost_currency" value: @"USD"];
[json UpdateString: @"shipping_method" value: @"USPS First Class Package"];
[json UpdateString: @"subtotal_price" value: @"12.10"];
[json UpdateString: @"total_price" value: @"24.93"];
[json UpdateString: @"total_tax" value: @"0.00"];
[json UpdateString: @"currency" value: @"USD"];
[json UpdateString: @"weight" value: @"0.40"];
[json UpdateString: @"weight_unit" value: @"lb"];

[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/orders/" 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)

//  {}

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