Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
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;
const wchar_t *events;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_SetRequestHeader(http,L"API-Key",L"{{API_KEY}}");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://api.shipengine.com/v1/labels/se-123456/track",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "tracking_number": "9405511899564298877610",
// "status_code": "NY",
// "status_description": "Not Yet In System",
// "carrier_status_code": "-2147219283",
// "carrier_status_description": "A status update is not yet available for this tracking number. More information will become available when USPS receives the tracking information, or when the package is received by USPS.",
// "ship_date": null,
// "estimated_delivery_date": null,
// "actual_delivery_date": null,
// "exception_description": null,
// "events": null
// }
// 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");
events = CkJsonObjectW_stringOf(jResp,L"events");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/labels/se-123456/track
Postman Collection Item JSON
{
"name": "Track using a label ID",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/{{label_id}}/track",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"{{label_id}}",
"track"
]
},
"description": "If you created the shipping label using ShipEngine, then tracking a package is even easier. No need to specify the `carrier_code` and `tracking_number`. All you need is the `label_id`."
},
"response": [
{
"name": "Track using a label ID",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.shipengine.com/v1/labels/{{label_id}}/track",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"labels",
"{{label_id}}",
"track"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 18:53:59 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "531"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "853bc684-6123-43aa-91ab-5ce1a8da908b"
}
],
"cookie": [
],
"body": "{\n \"tracking_number\": \"9405511899564298877610\",\n \"status_code\": \"NY\",\n \"status_description\": \"Not Yet In System\",\n \"carrier_status_code\": \"-2147219283\",\n \"carrier_status_description\": \"A status update is not yet available for this tracking number. More information will become available when USPS receives the tracking information, or when the package is received by USPS.\",\n \"ship_date\": null,\n \"estimated_delivery_date\": null,\n \"actual_delivery_date\": null,\n \"exception_description\": null,\n \"events\": null\n}"
}
]
}
