Track Using a Label ID

With ShipStation API, you can retrieve real-time tracking events for any package, even if you created the label outside of ShipStation API.

There are two methods you can use for tracking shipments:

Use the label endpoint to track by Label ID. We recommend this method for tracking labels created via ShipStation.
Use the tracking endpoint. This option requires you to specify the carrier_code and the tracking_number of the package. If you don’t know a carrier’s carrier_code, you can find it by listing carriers.

This page provides details about tracking using the label ID. See the Track a Package page for details about using the tracking endpoint method.

Requirements

You will need the label_id from a Create Label request.

Example Request & Response

GET /v1/labels/:label_id/track

This endpoint allows you to track a specific label that was generated with ShipStation API.

1
2
3
4
GET /v1/labels/se-324658/track HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Cache-Control: no-cache

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "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"
    }
  ]
}

About the Tracking Response

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. This event property is not yet fully supported across all carriers.
occurred_at is our best effort at converting the carrier_occurred_at field to UTC, based on the time of the event's occurrence.

Tracking Status Codes

Here's how the status_code and status_description fields correspond to each other and how they correspond to the tracking_status field of a label:

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
`NY`	Not Yet In System	`in_transit`
`SP`	Delivered To The Collection Location	`delivered_to_service_point`