Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("carrier_code","fedex")
queryParams.UpdateString("tracking_number","555671072708")
http.SetRequestHeader("API-Key","{{API_KEY}}")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.shipengine.com/v1/tracking",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
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")
i = 0
count_i = jResp.SizeOfArray("events")
while i < count_i
jResp.put_I(i)
occurred_at = jResp.stringOf("events[i].occurred_at")
description = jResp.stringOf("events[i].description")
city_locality = jResp.stringOf("events[i].city_locality")
state_province = jResp.stringOf("events[i].state_province")
postal_code = jResp.stringOf("events[i].postal_code")
country_code = jResp.stringOf("events[i].country_code")
company_name = jResp.stringOf("events[i].company_name")
signer = jResp.stringOf("events[i].signer")
event_code = jResp.stringOf("events[i].event_code")
i = i + 1
end
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}"
}
]
}
