Tracking
Tracking and milestones
GET/shipments/{shipmentId}/tracking
Scope tracking.read
The scoped event timeline plus a stable buyer view: the current milestone, its label, the product's main steps and any exception or return track. Show milestones to buyers instead of raw statuses. promise gives the promise frozen at booking and the current one (with the reason for any change) and whether it is on time, at risk or late.
Request
Path parameters
| Name | In | Type | Description |
|---|---|---|---|
shipmentIdRequired | path | string | Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$ |
Response
| Status | Meaning |
|---|---|
200 | Tracking |
The body is { "status": "success", "data": … }. Fields of data (TrackingResult):
| Field | Type | Description |
|---|---|---|
trackingRequired | Tracking |
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
401 | Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked. |
403 | The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED). |
404 | Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404. |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |