query · Module: Tracking · Requires trackers:read
Arguments
| Argument | Type | Description |
|---|---|---|
status | TrackingStatusEnum | Filter by status. |
statusDetail | String | Filter by status detail. |
carrier | String | Filter by carrier. |
connection | String | Filter by connection. |
trackingNumber | String | Filter by tracking number. |
shipment | String | Filter by shipment. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
Returns
TrackerList!
| Field | Type |
|---|---|
data | [Tracker!]! |
has_more | Boolean |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Trackers($limit: Int) {
trackers(limit: $limit) {
data {
id
object
status
livemode
created
updated
tracking_number
carrier
connection
shipment {
id
object
status
livemode
created
updated
}
status_detail
status_updated_at
delivered_at
estimated_delivery {
date
window {
start
end
}
source
}
origin {
city
state
postal_code
country
facility
latitude
}
destination {
city
state
postal_code
country
facility
latitude
}
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"trackers": {
"data": [
{
"id": "trk_1a2B3c",
"object": "tracker",
"status": "pre_transit",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"tracking_number": "1Z999AA10123456784",
"carrier": "dhl_express",
"connection": "conn_9f8e",
"shipment": {
"id": "shp_1a2B3c",
"object": "shipment",
"status": "draft",
"livemode": true,
"created": 1791302400,
"updated": 1791302400
},
"status_detail": "example",
"status_updated_at": 1791302400,
"delivered_at": 1791302400,
"estimated_delivery": {
"date": "2026-10-07",
"window": {
"start": "example",
"end": "example"
},
"source": "carrier"
},
"origin": {
"city": "London",
"state": "example",
"postal_code": "SW1A 2AA",
"country": "GB",
"facility": "fac_lon_hub",
"latitude": 51.5074
},
"destination": {
"city": "London",
"state": "example",
"postal_code": "SW1A 2AA",
"country": "GB",
"facility": "fac_lon_hub",
"latitude": 51.5074
}
}
],
"has_more": true
}
}
}