Chilkat Online Tools

Objective-C / ShipEngine Walkthrough / Add funds to a carrier

Back to Collection Items

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

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

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

// {
//   "amount": 100,
//   "currency": "usd"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateInt: @"amount" value: [NSNumber numberWithInt: 100]];
[json UpdateString: @"currency" value: @"usd"];

[http SetRequestHeader: @"API-Key" value: @"{{API_KEY}}"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://api.shipengine.com/v1/carriers/se-963358/add_funds" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
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)

// {
//   "balance": {
//     "amount": 127.43,
//     "currency": "usd"
//   }
// }

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

NSString *Amount = [jResp StringOf: @"balance.amount"];
NSString *v_Currency = [jResp StringOf: @"balance.currency"];

Curl Command

curl -X PUT
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '{
	"amount": 100,
	"currency": "usd"
}'
https://api.shipengine.com/v1/carriers/se-963358/add_funds

Postman Collection Item JSON

{
  "name": "Add funds to a carrier",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"amount\": 100,\n\t\"currency\": \"usd\"\n}"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/carriers/{{stamps_com}}/add_funds",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "carriers",
        "{{stamps_com}}",
        "add_funds"
      ]
    },
    "description": "You can check your balance for a particular carrier by calling List Carriers endpoint. For any carrier account where `requires_funded_amount` is true, you can add funds.\n\n> **NOTE:** This endpoint must be enabled by ShipEngine support, if you'd like to utilize this resource, please contact our team."
  },
  "response": [
    {
      "name": "Add funds to a carrier",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"amount\": 100,\n\t\"currency\": \"usd\"\n}"
        },
        "url": {
          "raw": "https://api.shipengine.com/v1/carriers/{{stamps_com}}/add_funds",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "carriers",
            "{{stamps_com}}",
            "add_funds"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Tue, 17 Sep 2019 15:14:01 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "307"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "38af433e-6dee-41d8-b064-312e636760fe"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"balance\": {\n    \t\"amount\": 127.43,\n    \t\"currency\": \"usd\"\n    }\n}"
    }
  ]
}