Track Using a Label ID

If you generate your labels through ShipEngine, then you can easily subscribe to real-time tracking events using the label ID.

You can also track packages for which you did not use ShipEngine to generate the label, as long as you have the tracking number. See Track a Package for details.

tip

Requirements

  • You will need a label_id from another Label Request, if you don't have one you can learn how to Create a Label.

Example

GET /v1/labels/:label_id/track

This endpoint allows you to track a specific label that was generated with ShipEngine. You just need the label_id, which you got back when you created the label.

Info

Event Timestamps

carrier_occurred_at is the timestamp of the event received from the carrier, it is assumed to be the local time of where the event occurred.

occurred_at is the UTC based time of the event's occurrence.

Warning The carried_occurred_at event property is not yet fully supported across all carriers.

Example Request

curl -iX GET https://api.shipengine.com/v1/labels/se-324658/track \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__'
GET /v1/labels/se-324658/track HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Cache-Control: no-cache
  • curl
  • http

Example Response

{
  "tracking_number": "1Z932R800390810600",
  "status_code": "DE",
  "status_description": "Delivered",
  "carrier_status_code": "D",
  "carrier_status_description": "DELIVERED",
  "shipped_date": "2019-07-27T11:59:03.289Z",
  "estimated_delivery_date": "2019-07-27T11:59:03.289Z",
  "actual_delivery_date": "2019-07-27T11:59:03.289Z",
  "exception_description": null,
  "events": [
    {
      "occurred_at": "2019-09-13T12:32:00Z",
      "carrier_occurred_at": "2019-09-13T05:32:00",
      "description": "Arrived at USPS Facility",
      "city_locality": "OCEANSIDE",
      "state_province": "CA",
      "postal_code": "92056",
      "country_code": "",
      "company_name": "",
      "signer": "",
      "event_code": "U1"
    }
  ]
}

Tracking Status Codes

status_code status_description tracking_status
AC Accepted N/A
IT In Transit in_transit
DE Delivered delivered
EX Exception error
UN Unknown unknown
AT Delivery Attempt N/A