Objective-C

Shippo Create Transaction Object

See more Shippo Examples

Creates a Transaction object that represents a shipping label purchase and is based on the shipping rate. Objective-C

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoHttpResponse.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/transactions \
//     -H "Authorization: ShippoToken <API_TOKEN>" \
//     -d rate="478fb066930e4e3195a3686f7ea5b612"
//     -d label_file_type="PDF"
//     -d async=false

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/transactions";
req.ContentType = @"application/x-www-form-urlencoded";
[req AddParam: @"rate" value: @"478fb066930e4e3195a3686f7ea5b612"];
[req AddParam: @"label_file_type" value: @"PDF"];
[req AddParam: @"async" value: @"false"];

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

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpReq: @"https://api.goshippo.com/transactions" request: req 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": "2019-06-28T18:04:08.679Z",
//   "object_updated": "2019-06-28T18:04:10.516Z",
//   "object_id": "6178e155da304f10aa4b4271fdca84fb",
//   "object_owner": "admin@chilkatsoft.com",
//   "test": true,
//   "rate": "dd7556c284e8444294d2ab7099e662d2",
//   "tracking_number": "92701902416755000000000015",
//   "tracking_status": "UNKNOWN",
//   "eta": null,
//   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92701902416755000000000015",
//   "label_url": "https://shippo-delivery-east.s3.amazonaws.com/6178e155da304f10aa4b4271fdca84fb.pdf?Signature=1LU0Qf11nQJGei%2FeLZr%2BQ5EwJS4%3D&Expires=1593281050&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
//   "commercial_invoice_url": null,
//   "messages": [
//   ],
//   "order": null,
//   "metadata": "",
//   "parcel": "5af766ff15684a4186b0e3c833348fac",
//   "billing": {
//     "payments": [
//     ]
//   }
// }

// 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 test = [jResp BoolOf: @"test"];
NSString *rate = [jResp StringOf: @"rate"];
NSString *tracking_number = [jResp StringOf: @"tracking_number"];
NSString *tracking_status = [jResp StringOf: @"tracking_status"];
NSString *eta = [jResp StringOf: @"eta"];
NSString *tracking_url_provider = [jResp StringOf: @"tracking_url_provider"];
NSString *label_url = [jResp StringOf: @"label_url"];
NSString *commercial_invoice_url = [jResp StringOf: @"commercial_invoice_url"];
NSString *order = [jResp StringOf: @"order"];
NSString *metadata = [jResp StringOf: @"metadata"];
NSString *parcel = [jResp StringOf: @"parcel"];
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: @"billing.payments"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    i = i + 1;
}