Search shipments by status
POST/shipments/search
Returns a paginated list of shipments for a given status.
Use the status field to target the desired queue and payload.params for filters.
status | Meaning |
|---|---|
shipments_upcoming | Active / Upcoming — Orders received, approved and awaiting processing. |
shipments_to_pack | Pending Labels — Shipments packed but label not yet generated. |
shipments_to_handover | Pending Handover — Labels generated, awaiting courier pickup. |
shipments_in_transit | In Transit — Picked up by courier, on the way to buyer. |
shipments_delivered | Completed Orders — Delivered in last 90 days. |
Pagination: If has_more is true, increment page_num to fetch the next page.
Alternatively use next_token from the response directly in the next request.
Request
Responses
- 200
- 400
- 401
Paginated list of shipments matching the given status and filters.
Invalid request.
Missing or invalid access token.