tracking.v1 report type exports the current tracking status of labels purchased through Shippo. Each row is one tracking number on one label. The row also contains the carrier status, the delivery milestones, and the shipment context of the label.
Call GET /v2/reporting/reports/tracking.v1 to list all columns, the default set, and the available date range. See Discover available reports.
Included labels
- Labels purchased through Shippo with a
transaction_statusofSUCCESS,REFUNDPENDING,REFUNDREJECTED, orREFUNDED. - Tracking numbers you registered with
POST /tracksfor labels purchased outside of Shippo are not included.
Date interval
Theinterval selects labels by transaction_created_at. A label stays in the same interval even as its tracking status changes.
Each row shows the latest tracking status at the time the run is processed. To get newer statuses, create a new run for the same interval.
tracking_status uses the same values as the Tracking API. See Event definitions.
Reporting API data is refreshed periodically throughout the day, so recent tracking events may not appear immediately.
Row key
A label can have more than one tracking number, sotransaction_object_id alone does not identify a row. Each row is unique by transaction_object_id, carrier, tracking_number, and tracking_registered_at.
Milestone columns, such as first_delivered_at and transit_time_hours, are empty until the carrier reports that event.
Example
cURL
201 Created with status: QUEUED.
Next steps
- Create and poll a run: poll until the run is terminal
- Download report files: get the file from
result.download.url - Errors and run failures: handle error responses