(Node.js) Shippo Label Purchase

Demonstrates how to create a shipping label in one API call through Shippo.

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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // Implements the following CURL command:

    // curl https://api.goshippo.com/transactions/  \
    //     -H "Authorization: ShippoToken <API_Token>" \
    //     -H "Content-Type: application/json"  \
    //     -d '{
    //         "shipment": {
    //             "address_from": {
    //                 "name": "Mr. Hippo",
    //                 "street1": "215 Clayton St.",
    //                 "city": "San Francisco",
    //                 "state": "CA",
    //                 "zip": "94117",
    //                 "country": "US",
    //                 "phone": "+1 555 341 9393",
    //                 "email": "support@goshippo.com"
    //             },
    //             "address_to": {
    //                 "name": "Mrs. Hippo",
    //                 "street1": "965 Mission St.",
    //                 "city": "San Francisco",
    //                 "state": "CA",
    //                 "zip": "94105",
    //                 "country": "US",
    //                 "phone": "+1 555 341 9393",
    //                 "email": "support@goshippo.com"
    //             },
    //             "parcels": [{
    //                 "length": "5",
    //                 "width": "5",
    //                 "height": "5",
    //                 "distance_unit": "in",
    //                 "weight": "2",
    //                 "mass_unit": "lb"
    //             }]
    //         },
    //         "carrier_account": "b741b99f95e841639b54272834bc478c",
    //         "servicelevel_token": "usps_priority"
    //         }'

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

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

    // {
    //   "shipment": {
    //     "address_from": {
    //       "name": "Mr. Hippo",
    //       "street1": "215 Clayton St.",
    //       "city": "San Francisco",
    //       "state": "CA",
    //       "zip": "94117",
    //       "country": "US",
    //       "phone": "+1 555 341 9393",
    //       "email": "support@goshippo.com"
    //     },
    //     "address_to": {
    //       "name": "Mrs. Hippo",
    //       "street1": "965 Mission St.",
    //       "city": "San Francisco",
    //       "state": "CA",
    //       "zip": "94105",
    //       "country": "US",
    //       "phone": "+1 555 341 9393",
    //       "email": "support@goshippo.com"
    //     },
    //     "parcels": [
    //       {
    //         "length": "5",
    //         "width": "5",
    //         "height": "5",
    //         "distance_unit": "in",
    //         "weight": "2",
    //         "mass_unit": "lb"
    //       }
    //     ]
    //   },
    //   "carrier_account": "b741b99f95e841639b54272834bc478c",
    //   "servicelevel_token": "usps_priority"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("shipment.address_from.name","Mr. Hippo");
    json.UpdateString("shipment.address_from.street1","215 Clayton St.");
    json.UpdateString("shipment.address_from.city","San Francisco");
    json.UpdateString("shipment.address_from.state","CA");
    json.UpdateString("shipment.address_from.zip","94117");
    json.UpdateString("shipment.address_from.country","US");
    json.UpdateString("shipment.address_from.phone","+1 555 341 9393");
    json.UpdateString("shipment.address_from.email","support@goshippo.com");
    json.UpdateString("shipment.address_to.name","Mrs. Hippo");
    json.UpdateString("shipment.address_to.street1","965 Mission St.");
    json.UpdateString("shipment.address_to.city","San Francisco");
    json.UpdateString("shipment.address_to.state","CA");
    json.UpdateString("shipment.address_to.zip","94105");
    json.UpdateString("shipment.address_to.country","US");
    json.UpdateString("shipment.address_to.phone","+1 555 341 9393");
    json.UpdateString("shipment.address_to.email","support@goshippo.com");
    json.UpdateString("shipment.parcels[0].length","5");
    json.UpdateString("shipment.parcels[0].width","5");
    json.UpdateString("shipment.parcels[0].height","5");
    json.UpdateString("shipment.parcels[0].distance_unit","in");
    json.UpdateString("shipment.parcels[0].weight","2");
    json.UpdateString("shipment.parcels[0].mass_unit","lb");
    json.UpdateString("carrier_account","b741b99f95e841639b54272834bc478c");
    json.UpdateString("servicelevel_token","usps_priority");

    http.SetRequestHeader("Authorization","ShippoToken <API_Token>");
    http.SetRequestHeader("Content-Type","application/json");

    // resp: HttpResponse
    var resp = http.PostJson3("https://api.goshippo.com/transactions/","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);
    var jResp = new chilkat.JsonObject();
    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;
    }


}

chilkatExample();