Skip to main content
Required scopes: shipping_read

Arguments

String
Forward pagination cursor — returns trackers after it.
String
Backward pagination cursor — returns trackers before it.
Int
Forward pagination: returns the first N trackers (max 100, default 25). Use with after; mutually exclusive with last/before.
Int
Backward pagination: returns the last N trackers (max 100, default 25). Use with before; mutually exclusive with first/after.
Which key to sort by (defaults to the first key, newest-first). Combine with reverse to flip direction.
Boolean
Reverses the sort direction selected by orderBy (or its default).
ID
Only trackers for this shipmentId from purchaseCarrierShipment.
Only trackers with this status. UNKNOWN also matches statuses Redo does not recognize.
String
Only trackers with this carrier tracking number.
Only trackers whose status, status detail, latest scan, or delivery dates changed at or after this ISO-8601 instant. To poll only what changed, pass the start of your previous poll minus a few minutes and de-duplicate by id: a change can be stamped slightly before it becomes visible.

Returns

A paginated list of CarrierShipmentTracker items.

Example