Developers
API referenceBusiness sign in

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

Query parameters
NameInTypeDescription
statusOptionalquerystringInternal status, or several separated by commas.
milestoneOptionalquerystringCurrent milestone code, for example READY_FOR_PICKUP.
serviceCodeOptionalqueryServiceCodeProduct (alias product).
storeIdOptionalquerystringShipments created for this store's orders.Pattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$
orderReferenceOptionalquerystringExact Business order reference (case-insensitive).At most 100 characters
createdFromOptionalquerystringCreated at or after.
createdToOptionalquerystringCreated before.
limitOptionalqueryintegerPage size.1 to 100Default 25
cursorOptionalquerystringOpaque cursor from nextCursor.

Response

Success responses
StatusMeaning
200A page of shipments

The body is { "status": "success", "data": … }. Fields of data (ShipmentList):

Response data
FieldTypeDescription
shipmentsRequiredarray of ShipmentListItem
nextCursorRequiredstring or null
environmentRequiredEnvironmentThe key environment. TEST never touches live custody, payments, dispatch or notifications.

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
400The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed.
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The 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).
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.