(JavaScript) Shippo Create Transaction Object

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

For more information, see https://goshippo.com/docs/shipping-labels/

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="478fb066930e4e3195a3686f7ea5b612"
//     -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","478fb066930e4e3195a3686f7ea5b612");
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": "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

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 test = jResp.BoolOf("test");
var rate = jResp.StringOf("rate");
var tracking_number = jResp.StringOf("tracking_number");
var tracking_status = jResp.StringOf("tracking_status");
var eta = jResp.StringOf("eta");
var tracking_url_provider = jResp.StringOf("tracking_url_provider");
var label_url = jResp.StringOf("label_url");
var commercial_invoice_url = jResp.StringOf("commercial_invoice_url");
var order = jResp.StringOf("order");
var metadata = jResp.StringOf("metadata");
var parcel = jResp.StringOf("parcel");
var i = 0;
var count_i = jResp.SizeOfArray("messages");
while (i < count_i) {
    jResp.I = i;
    i = i+1;
}

i = 0;
count_i = jResp.SizeOfArray("billing.payments");
while (i < count_i) {
    jResp.I = i;
    i = i+1;
}