Track Shipment

Use this endpoint to retrieve carrier tracking information about a particular shipment. The endpoint currently supports the following carriers: USPS, UPS, FedEx, DHL, Globegistics, and TNT

REST Endpoint

GET /restapi/v1/customers/:customerId/shipments/:bookNumber/tracking-information

Response Status Code

200 OK

Response Content Type

application/json

Response JSON

[
    {
        "trackingNumber": "12345678910",
        "carrier": "ups",
        "event": "Delivered",
        "eventStatus": "Delivered",
        "eventTime": "2020-09-15 12:21:57",
        "serviceArea": "FORT MYERS",
        "serviceAreaCountry": "US"
    },
    {
        "trackingNumber": "12345678910",
        "carrier": "ups",
        "event": "Out For Delivery Today",
        "eventStatus": "Out for Delivery",
        "eventTime": "2020-09-15 09:34:35",
        "serviceArea": "Fort Myers",
        "serviceAreaCountry": "US"
    },
    {
        "trackingNumber": "12345678910",
        "carrier": "ups",
        "event": "Departed from Facility",
        "eventStatus": "In Transit",
        "eventTime": "2020-09-11 02:00:00",
        "serviceArea": "Dallas",
        "serviceAreaCountry": "US"
    },
    {
        "trackingNumber": "12345678910",
        "carrier": "ups",
        "event": "Origin Scan",
        "eventStatus": "In Transit",
        "eventTime": "2020-09-10 19:19:23",
        "serviceArea": "Dallas",
        "serviceAreaCountry": "US"
    },
    {
        "trackingNumber": "12345678910",
        "carrier": "ups",
        "event": "Order Processed: Ready for UPS ",
        "eventStatus": "Info Received",
        "eventTime": "2020-09-10 14:46:28",
        "serviceArea": "",
        "serviceAreaCountry": "US"
    }
]

Explanation of eventStatus

The eventStatus of each tracking event is a discrete list:

  • Info Received: The shipment has been booked through the carrier and a label has been printed, but the package is not yet recieved
  • In Transit: The package is in transit
  • Out for Delivery: The package is out for delivery
  • Delivery Arragned: A delivery has been arranged for the package
  • With Delivery Courier: The package is in possession of the delivery courier
  • Delivered to Broker: The package has been delivered to the broker
  • Failed Attempt: A delivery was attempted, but failed
  • Delivered: The package was successfully delivered
  • Exception: There is an issue or delay with the shipment