Ruby

Shippo Track Individual Shipments

See more Shippo Examples

Demonstrates how to submit an individual tracking request for a single shipment. Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

# Implements the following CURL command:

# curl https://api.goshippo.com/tracks/usps/92701902416755000000000015 \
#     -H "Authorization: ShippoToken <API_TOKEN>"

http.SetRequestHeader("Authorization","ShippoToken <API_TOKEN>")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.goshippo.com/tracks/usps/92701902416755000000000015",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "object_state": "VALID",
#   "status": "SUCCESS",
#   "object_created": "2014-11-29T16:31:19.512Z",
#   "object_updated": "2014-11-29T16:31:19.512Z",
#   "object_id": "5695ae3a5eda41ba9abdbf347fd545f3",
#   "object_owner": "test@goshippo.com",
#   "test": false,
#   "rate": "693ea14a541f44e090291b929c171d5a",
#   "tracking_number": "9102969010383081813033",
#   "tracking_status": "DELIVERED",
#   "eta": "2014-11-24T00:00:00Z",
#   "tracking_url_provider": "https:\/\/tools.usps.com\/go\/TrackConfirmAction_input?origTrackNum=9102969010383081813033",
#   "label_url": "https:\/\/shippo-delivery-east.s3.amazonaws.com\/5695ae3a5eda41ba9abdbf347fd545f3.pdf?Signature=AyiitLq2g%2F2R9fjboCTVxi5z7JQ%3D&Expires=1534873886&AWSAccessKeyId=AKIAJGLCC5MYLLWIG42A",
#   "commercial_invoice_url": null,
#   "messages": [
#   ],
#   "order": "ca760ef0099040b4a2b7feec827bca88",
#   "metadata": "",
#   "parcel": "e0de043b2f7f4b6d8e6f23ad69641cc1",
#   "billing": {
#     "payments": [
#     ]
#   }
# }

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

object_state = jResp.stringOf("object_state")
status = jResp.stringOf("status")
object_created = jResp.stringOf("object_created")
object_updated = jResp.stringOf("object_updated")
object_id = jResp.stringOf("object_id")
object_owner = jResp.stringOf("object_owner")
test = jResp.BoolOf("test")
rate = jResp.stringOf("rate")
tracking_number = jResp.stringOf("tracking_number")
tracking_status = jResp.stringOf("tracking_status")
eta = jResp.stringOf("eta")
tracking_url_provider = jResp.stringOf("tracking_url_provider")
label_url = jResp.stringOf("label_url")
commercial_invoice_url = jResp.stringOf("commercial_invoice_url")
order = jResp.stringOf("order")
metadata = jResp.stringOf("metadata")
parcel = jResp.stringOf("parcel")
i = 0
count_i = jResp.SizeOfArray("messages")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("billing.payments")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end