Skip to main content

Search shipments with filtering, sorting, cursor pagination, and an AWBs filter

POST
/api/v1/shipments/list

Returns the matching shipment rows for the requested columns. Pagination is cursor-first: the response carries hasMore and an opaque nextCursor. To page forward, replay the returned nextCursor value in the request body cursor field (do NOT also send page). A nextCursor is only minted on the default newest-first order — when a custom sortBy, an awbs filter, or a free-text search is supplied, nextCursor is null; fall back to page/limit and use hasMore to drive paging. No total count is returned. When isExport=true (or limit > 100) the endpoint returns 202 with a status message instead of rows.

Request

Responses

200 OK

Successfully retrieved shipments

202 Accepted

Export accepted — a background CSV export was dispatched (isExport / limit > 100).

401 Unauthorized

Unauthorized - Authentication required

403 Forbidden

Forbidden - Insufficient permissions

500 Internal Server Error

Internal Server Error