Chilkat Online Tools

Node.js / ShipEngine Walkthrough / Subscribe to tracking updates for a package

Back to Collection Items

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;

    http.SetRequestHeader("API-Key","{{API_KEY}}");

    // resp: HttpResponse
    var resp = http.QuickRequest("POST","https://api.shipengine.com/v1/tracking/start?carrier_code=stamps_com&tracking_number=1Z6Y21Y60300230257");
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/tracking/start?carrier_code=stamps_com&tracking_number=1Z6Y21Y60300230257

Postman Collection Item JSON

{
  "name": "Subscribe to tracking updates for a package",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "url": {
      "raw": "https://api.shipengine.com/v1/tracking/start?carrier_code=stamps_com&tracking_number={{tracking_number}}",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "tracking",
        "start"
      ],
      "query": [
        {
          "key": "carrier_code",
          "value": "stamps_com"
        },
        {
          "key": "tracking_number",
          "value": "{{tracking_number}}"
        }
      ]
    },
    "description": "Once you've setup a tracking webhook, you can start subscribing to tracking updates for packages.  Your webhook will be notified whenever any tracking events occur on a subscribed package."
  },
  "response": [
  ]
}