(JavaScript) Shippo Generate a Return Label

Demonstrates how to generate a pay-on-use return label.

For more information, see https://goshippo.com/docs/return-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/shipments/ \
//     -H "Authorization: ShippoToken <API_Token>" \
//     -d address_from="d799c2679e644279b59fe661ac8fa488" \
//     -d address_to="42236bcf36214f62bcc6d7f12f02a849" \
//     -d parcels=["7df2ecf8b4224763ab7c71fae7ec8274"] \
//     -d shipment_date="2013-12-03T12:00:00.000Z" \
//     -d extra='{ "is_return": true}' \
//     -d async=false

var req = new CkHttpRequest();
req.HttpVerb = "POST";
req.Path = "/shipments/";
req.ContentType = "application/x-www-form-urlencoded";
req.AddParam("address_from","d799c2679e644279b59fe661ac8fa488");
req.AddParam("address_to","42236bcf36214f62bcc6d7f12f02a849");
req.AddParam("parcels","[\"7df2ecf8b4224763ab7c71fae7ec8274\"]");
req.AddParam("shipment_date","2013-12-03T12:00:00.000Z");
req.AddParam("extra","'{ \"is_return\": true}'");
req.AddParam("async","false");

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

var resp = new CkHttpResponse();
success = http.HttpReq("https://api.goshippo.com/shipments/",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)

// {}

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