Skip to main content

Get shipments

GET
/api/v1/shipments

Retrieve shipments with filtering, sorting and pagination. Multi-value filters (status, cmpService, businessLocationId) can be separated by commas.

Pagination is cursor-first: the response returns hasMore and an opaque nextCursor. To fetch the next page, replay the returned nextCursor value via the cursor query param (do NOT also send page). A nextCursor is only minted on the default newest-first order — when a custom sort or a free-text searchInput is supplied, nextCursor is null and you should fall back to page/limit paging, using hasMore to decide whether to request the next page. No total count is returned.

Request​

Responses​

200 OK

Shipments retrieved successfully

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal Server Error