Chilkat Online Tools

unicodeC / ShipEngine Walkthrough / Track a package

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *occurred_at;
    const wchar_t *description;
    const wchar_t *city_locality;
    const wchar_t *state_province;
    const wchar_t *postal_code;
    const wchar_t *country_code;
    const wchar_t *company_name;
    const wchar_t *signer;
    const wchar_t *event_code;
    const wchar_t *tracking_number;
    const wchar_t *status_code;
    const wchar_t *status_description;
    const wchar_t *carrier_status_code;
    const wchar_t *carrier_status_description;
    const wchar_t *ship_date;
    const wchar_t *estimated_delivery_date;
    const wchar_t *actual_delivery_date;
    const wchar_t *exception_description;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"carrier_code",L"fedex");
    CkJsonObjectW_UpdateString(queryParams,L"tracking_number",L"555671072708");

    CkHttpW_SetRequestHeader(http,L"API-Key",L"{{API_KEY}}");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.shipengine.com/v1/tracking",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

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

    // {
    //   "tracking_number": "789830651142",
    //   "status_code": "DE",
    //   "status_description": "Delivered",
    //   "carrier_status_code": "DL",
    //   "carrier_status_description": "Delivered",
    //   "ship_date": "2019-09-16T21:55:00Z",
    //   "estimated_delivery_date": null,
    //   "actual_delivery_date": "2019-09-17T20:02:00Z",
    //   "exception_description": null,
    //   "events": [
    //     {
    //       "occurred_at": "2019-09-17T20:02:00Z",
    //       "description": "Delivered",
    //       "city_locality": "Austin",
    //       "state_province": "TX",
    //       "postal_code": "78702",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": "Signature not required",
    //       "event_code": "DL"
    //     },
    //     {
    //       "occurred_at": "2019-09-17T13:13:00Z",
    //       "description": "On FedEx vehicle for delivery",
    //       "city_locality": "AUSTIN",
    //       "state_province": "TX",
    //       "postal_code": "78721",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "OD"
    //     },
    //     {
    //       "occurred_at": "2019-09-17T12:09:00Z",
    //       "description": "At local FedEx facility",
    //       "city_locality": "AUSTIN",
    //       "state_province": "TX",
    //       "postal_code": "78721",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "AR"
    //     },
    //     {
    //       "occurred_at": "2019-09-17T08:05:00Z",
    //       "description": "Departed FedEx location",
    //       "city_locality": "FORT WORTH",
    //       "state_province": "TX",
    //       "postal_code": "76177",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "DP"
    //     },
    //     {
    //       "occurred_at": "2019-09-17T06:22:00Z",
    //       "description": "Arrived at FedEx location",
    //       "city_locality": "FORT WORTH",
    //       "state_province": "TX",
    //       "postal_code": "76177",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "AR"
    //     },
    //     {
    //       "occurred_at": "2019-09-17T03:27:00Z",
    //       "description": "Departed FedEx location",
    //       "city_locality": "OAKLAND",
    //       "state_province": "CA",
    //       "postal_code": "94621",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "DP"
    //     },
    //     {
    //       "occurred_at": "2019-09-17T01:04:00Z",
    //       "description": "Arrived at FedEx location",
    //       "city_locality": "OAKLAND",
    //       "state_province": "CA",
    //       "postal_code": "94621",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "AR"
    //     },
    //     {
    //       "occurred_at": "2019-09-17T00:10:00Z",
    //       "description": "Left FedEx origin facility",
    //       "city_locality": "PETALUMA",
    //       "state_province": "CA",
    //       "postal_code": "94954",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "DP"
    //     },
    //     {
    //       "occurred_at": "2019-09-16T21:55:00Z",
    //       "description": "Picked up",
    //       "city_locality": "PETALUMA",
    //       "state_province": "CA",
    //       "postal_code": "94954",
    //       "country_code": "US",
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "PU"
    //     },
    //     {
    //       "occurred_at": "2019-09-16T15:31:38Z",
    //       "description": "Shipment information sent to FedEx",
    //       "city_locality": null,
    //       "state_province": null,
    //       "postal_code": null,
    //       "country_code": null,
    //       "company_name": null,
    //       "signer": null,
    //       "event_code": "OC"
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    tracking_number = CkJsonObjectW_stringOf(jResp,L"tracking_number");
    status_code = CkJsonObjectW_stringOf(jResp,L"status_code");
    status_description = CkJsonObjectW_stringOf(jResp,L"status_description");
    carrier_status_code = CkJsonObjectW_stringOf(jResp,L"carrier_status_code");
    carrier_status_description = CkJsonObjectW_stringOf(jResp,L"carrier_status_description");
    ship_date = CkJsonObjectW_stringOf(jResp,L"ship_date");
    estimated_delivery_date = CkJsonObjectW_stringOf(jResp,L"estimated_delivery_date");
    actual_delivery_date = CkJsonObjectW_stringOf(jResp,L"actual_delivery_date");
    exception_description = CkJsonObjectW_stringOf(jResp,L"exception_description");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"events");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        occurred_at = CkJsonObjectW_stringOf(jResp,L"events[i].occurred_at");
        description = CkJsonObjectW_stringOf(jResp,L"events[i].description");
        city_locality = CkJsonObjectW_stringOf(jResp,L"events[i].city_locality");
        state_province = CkJsonObjectW_stringOf(jResp,L"events[i].state_province");
        postal_code = CkJsonObjectW_stringOf(jResp,L"events[i].postal_code");
        country_code = CkJsonObjectW_stringOf(jResp,L"events[i].country_code");
        company_name = CkJsonObjectW_stringOf(jResp,L"events[i].company_name");
        signer = CkJsonObjectW_stringOf(jResp,L"events[i].signer");
        event_code = CkJsonObjectW_stringOf(jResp,L"events[i].event_code");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -G -d "carrier_code=fedex"
	-d "tracking_number=555671072708"
	-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/tracking

Postman Collection Item JSON

{
  "name": "Track a package",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.shipengine.com/v1/tracking?carrier_code=fedex&tracking_number=555671072708",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "tracking"
      ],
      "query": [
        {
          "key": "carrier_code",
          "value": "stamps_com",
          "disabled": true
        },
        {
          "key": "tracking_number",
          "value": "{{tracking_number}}",
          "disabled": true
        },
        {
          "key": "carrier_code",
          "value": "fedex"
        },
        {
          "key": "tracking_number",
          "value": "555671072708"
        }
      ]
    },
    "description": "This request demonstrates how to get tracking information for a package. The `carrier_code` and `tracking_number` are provided via query parameters."
  },
  "response": [
    {
      "name": "Track a package",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.shipengine.com/v1/tracking?carrier_code=fedex&tracking_number=789830651142",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "tracking"
          ],
          "query": [
            {
              "key": "carrier_code",
              "value": "fedex"
            },
            {
              "key": "tracking_number",
              "value": "789830651142"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 18 Sep 2019 18:50:08 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "3515"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "f4e88104-edb8-4a8f-bd1c-a5d85334bdb1"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"tracking_number\": \"789830651142\",\n    \"status_code\": \"DE\",\n    \"status_description\": \"Delivered\",\n    \"carrier_status_code\": \"DL\",\n    \"carrier_status_description\": \"Delivered\",\n    \"ship_date\": \"2019-09-16T21:55:00Z\",\n    \"estimated_delivery_date\": null,\n    \"actual_delivery_date\": \"2019-09-17T20:02:00Z\",\n    \"exception_description\": null,\n    \"events\": [\n        {\n            \"occurred_at\": \"2019-09-17T20:02:00Z\",\n            \"description\": \"Delivered\",\n            \"city_locality\": \"Austin\",\n            \"state_province\": \"TX\",\n            \"postal_code\": \"78702\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": \"Signature not required\",\n            \"event_code\": \"DL\"\n        },\n        {\n            \"occurred_at\": \"2019-09-17T13:13:00Z\",\n            \"description\": \"On FedEx vehicle for delivery\",\n            \"city_locality\": \"AUSTIN\",\n            \"state_province\": \"TX\",\n            \"postal_code\": \"78721\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"OD\"\n        },\n        {\n            \"occurred_at\": \"2019-09-17T12:09:00Z\",\n            \"description\": \"At local FedEx facility\",\n            \"city_locality\": \"AUSTIN\",\n            \"state_province\": \"TX\",\n            \"postal_code\": \"78721\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"AR\"\n        },\n        {\n            \"occurred_at\": \"2019-09-17T08:05:00Z\",\n            \"description\": \"Departed FedEx location\",\n            \"city_locality\": \"FORT WORTH\",\n            \"state_province\": \"TX\",\n            \"postal_code\": \"76177\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"DP\"\n        },\n        {\n            \"occurred_at\": \"2019-09-17T06:22:00Z\",\n            \"description\": \"Arrived at FedEx location\",\n            \"city_locality\": \"FORT WORTH\",\n            \"state_province\": \"TX\",\n            \"postal_code\": \"76177\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"AR\"\n        },\n        {\n            \"occurred_at\": \"2019-09-17T03:27:00Z\",\n            \"description\": \"Departed FedEx location\",\n            \"city_locality\": \"OAKLAND\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"94621\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"DP\"\n        },\n        {\n            \"occurred_at\": \"2019-09-17T01:04:00Z\",\n            \"description\": \"Arrived at FedEx location\",\n            \"city_locality\": \"OAKLAND\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"94621\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"AR\"\n        },\n        {\n            \"occurred_at\": \"2019-09-17T00:10:00Z\",\n            \"description\": \"Left FedEx origin facility\",\n            \"city_locality\": \"PETALUMA\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"94954\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"DP\"\n        },\n        {\n            \"occurred_at\": \"2019-09-16T21:55:00Z\",\n            \"description\": \"Picked up\",\n            \"city_locality\": \"PETALUMA\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"94954\",\n            \"country_code\": \"US\",\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"PU\"\n        },\n        {\n            \"occurred_at\": \"2019-09-16T15:31:38Z\",\n            \"description\": \"Shipment information sent to FedEx\",\n            \"city_locality\": null,\n            \"state_province\": null,\n            \"postal_code\": null,\n            \"country_code\": null,\n            \"company_name\": null,\n            \"signer\": null,\n            \"event_code\": \"OC\"\n        }\n    ]\n}"
    }
  ]
}