Shipments
List shipments
GET/shipments
Scope shipments.read
The Business's shipments in the key's environment, newest first. TEST keys list simulated parcels only. Pass nextCursor back as cursor for the next page.
Request
Query parameters
| Name | In | Type | Description |
|---|---|---|---|
statusOptional | query | string | Internal status, or several separated by commas. |
milestoneOptional | query | string | Current milestone code, for example READY_FOR_PICKUP. |
serviceCodeOptional | query | ServiceCode | Product (alias product). |
storeIdOptional | query | string | Shipments created for this store's orders.Pattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$ |
orderReferenceOptional | query | string | Exact Business order reference (case-insensitive).At most 100 characters |
createdFromOptional | query | string | Created at or after. |
createdToOptional | query | string | Created before. |
limitOptional | query | integer | Page size.1 to 100Default 25 |
cursorOptional | query | string | Opaque cursor from nextCursor. |
Response
| Status | Meaning |
|---|---|
200 | A page of shipments |
The body is { "status": "success", "data": … }. Fields of data (ShipmentList):
| Field | Type | Description |
|---|---|---|
shipmentsRequired | array of ShipmentListItem | |
nextCursorRequired | string or null | |
environmentRequired | Environment | The key environment. TEST never touches live custody, payments, dispatch or notifications. |
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
400 | The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed. |
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). |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |