(JavaScript) Shippo POST to Transaction Endpoint

Demonstrates how to POST to the Transaction endpoint with your Rate object_id to purchase your international shipping label.

For more information, see https://goshippo.com/docs/international/

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

// Implements the following CURL command:

// curl https://api.goshippo.com/transactions \
//     -H "Authorization: ShippoToken <API_TOKEN>" \
//     -d rate="ec6143e746094bcab1bdc4c17600dabf"
//     -d label_file_type="PDF"
//     -d async=false

var req = new CkHttpRequest();
req.HttpVerb = "POST";
req.Path = "/transactions";
req.ContentType = "application/x-www-form-urlencoded";
req.AddParam("rate","ec6143e746094bcab1bdc4c17600dabf");
req.AddParam("label_file_type","PDF");
req.AddParam("async","false");

req.AddHeader("Authorization","ShippoToken <API_TOKEN>");

var resp = new CkHttpResponse();
success = http.HttpReq("https://api.goshippo.com/transactions",req,resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(resp.Header);
    console.log("Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "object_state": "VALID",
//   "status": "SUCCESS",
//   "object_created": "2013-12-27T19:14:48.273Z",
//   "object_updated": "2013-12-27T19:14:48.273Z",
//   "object_id": "64bba01845ef40d29374032599f22588",
//   "object_owner": "shippotle@goshippo.com",
//   "was_test": false,
//   "rate": {
//     "object_id": "cf6fea899f1848b494d9568e8266e076",
//     "amount": "5.50",
//     "currency": "USD",
//     "amount_local": "5.50",
//     "currency_local": "USD",
//     "provider": "USPS",
//     "servicelevel_name": "Priority Mail",
//     "servicelevel_token": "usps_priority",
//     "carrier_account": "078870331023437cb917f5187429b093"
//   },
//   "tracking_number": "ZW70QJC",
//   "tracking_status": {
//     "object_created": "2013-12-27T23:17:41.411Z",
//     "object_id": "a21b3d6831c14ceaba6730179ce6e784",
//     "status": "UNKNOWN",
//     "status_details": "",
//     "status_date": "2013-12-28T12:04:04.214Z"
//   },
//   "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction.action?tLabels=ZW70QJC",
//   "eta": "2013-12-30T12:00:00.000Z",
//   "label_url": "https://shippo-delivery.s3.amazonaws.com/96.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
//   "commercial_invoice_url": "",
//   "metadata": "",
//   "messages": [
//   ]
// }

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

var object_state = jResp.StringOf("object_state");
var status = jResp.StringOf("status");
var object_created = jResp.StringOf("object_created");
var object_updated = jResp.StringOf("object_updated");
var object_id = jResp.StringOf("object_id");
var object_owner = jResp.StringOf("object_owner");
var was_test = jResp.BoolOf("was_test");
var rateObject_id = jResp.StringOf("rate.object_id");
var rateAmount = jResp.StringOf("rate.amount");
var rateCurrency = jResp.StringOf("rate.currency");
var rateAmount_local = jResp.StringOf("rate.amount_local");
var rateCurrency_local = jResp.StringOf("rate.currency_local");
var rateProvider = jResp.StringOf("rate.provider");
var rateServicelevel_name = jResp.StringOf("rate.servicelevel_name");
var rateServicelevel_token = jResp.StringOf("rate.servicelevel_token");
var rateCarrier_account = jResp.StringOf("rate.carrier_account");
var tracking_number = jResp.StringOf("tracking_number");
var tracking_statusObject_created = jResp.StringOf("tracking_status.object_created");
var tracking_statusObject_id = jResp.StringOf("tracking_status.object_id");
var tracking_statusStatus = jResp.StringOf("tracking_status.status");
var tracking_statusStatus_details = jResp.StringOf("tracking_status.status_details");
var tracking_statusStatus_date = jResp.StringOf("tracking_status.status_date");
var tracking_url_provider = jResp.StringOf("tracking_url_provider");
var eta = jResp.StringOf("eta");
var label_url = jResp.StringOf("label_url");
var commercial_invoice_url = jResp.StringOf("commercial_invoice_url");
var metadata = jResp.StringOf("metadata");
var i = 0;
var count_i = jResp.SizeOfArray("messages");
while (i < count_i) {
    jResp.I = i;
    i = i+1;
}