Chilkat Online Tools

Perl / ShipEngine Walkthrough / Add funds to a carrier

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

# 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"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateInt("amount",100);
$json->UpdateString("currency","usd");

$http->SetRequestHeader("API-Key","{{API_KEY}}");
$http->SetRequestHeader("Content-Type","application/json");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://api.shipengine.com/v1/carriers/se-963358/add_funds",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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

$Amount = $jResp->stringOf("balance.amount");
$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}"
    }
  ]
}