Skip to main content
Agent Benchmark Control 0922 Docs

Search documentation

Type to search this documentation.

List shipments

GET /v2/shipments requires shipments:read and the authentication/workspace/version headers. Optional query parameters are limit and cursor. The default limit is 37; the maximum is 113. Unknown query parameters return HTTP 400 invalid_query.

The v2 response envelope is {"shipments":[{"id":"shp_example","state":"IN_TRANSIT"}],"next_cursor":"opaque_example"}. The final page sets next_cursor to null. A short page is not proof that pagination is finished. Follow next_cursor until it is null, even when the shipments array is empty.

Cursor tokens expire after 11 minutes and are bound to the workspace and filters used for the first request. Do not decode or construct a cursor. An expired cursor returns HTTP 410 cursor_expired. Reconciliation should restart from the beginning and deduplicate shipment IDs already processed. See Pagination for the recovery algorithm. The legacy data and has_more fields are absent in v2.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu