Objective-C

Shippo Create a Refund

See more Shippo Examples

Demonstrates how to refund a shipping label. 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/refunds/ \
//     -H "Authorization: ShippoToken <API_Token>" \
//     -d transaction="4503427478ea45a899e9b54abc4c5803"

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/refunds/";
req.ContentType = @"application/x-www-form-urlencoded";
[req AddParam: @"transaction" value: @"4503427478ea45a899e9b54abc4c5803"];

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

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpReq: @"https://api.goshippo.com/refunds/" 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_created": "2014-04-21T07:12:41.044Z",
//   "object_id": "bd7b8379a2e847bcb0818125943dde5d",
//   "object_owner": "shippotle@goshippo.com",
//   "object_updated": "2014-04-21T07:12:41.045Z",
//   "status": "QUEUED",
//   "transaction": "35ed59f23a514ecfa2faeaed93a00086"
// }

// 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 = [jResp StringOf: @"object_created"];
NSString *object_id = [jResp StringOf: @"object_id"];
NSString *object_owner = [jResp StringOf: @"object_owner"];
NSString *object_updated = [jResp StringOf: @"object_updated"];
NSString *status = [jResp StringOf: @"status"];
NSString *transaction = [jResp StringOf: @"transaction"];