Chilkat Online Tools

Python / ShipEngine Walkthrough / Track using a label ID

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

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

sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://api.shipengine.com/v1/labels/se-123456/track",sbResponseBody)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = http.get_LastStatus()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(http.lastHeader())
    print("Failed.")
    sys.exit()

# 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

tracking_number = jResp.stringOf("tracking_number")
status_code = jResp.stringOf("status_code")
status_description = jResp.stringOf("status_description")
carrier_status_code = jResp.stringOf("carrier_status_code")
carrier_status_description = jResp.stringOf("carrier_status_description")
ship_date = jResp.stringOf("ship_date")
estimated_delivery_date = jResp.stringOf("estimated_delivery_date")
actual_delivery_date = jResp.stringOf("actual_delivery_date")
exception_description = jResp.stringOf("exception_description")
events = jResp.stringOf("events")

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}"
    }
  ]
}