Pagination
Version 1 has no paginated endpoints, and no endpoint lists your requests.
| Endpoint | Returns |
|---|---|
GET /deals?shipmentRequestId= or ?externalReference= |
Every deal made from one request, oldest first, in items. A request has one deal, or more than one when it was awarded again after a withdrawal. |
GET /deals/{id}/documents |
The current version of every document of one deal, newest first, in items. |
Both are bounded by their parent (one request, one deal), so they come back whole in one answer, with no cursor and no page parameters.
Reading many requests
Section titled “Reading many requests”There is no list of requests to page through. Instead:
- Keep the ids from your creates, or rely on your own
externalReferenceand look each one up withGET /shipment-requests?externalReference=. - Listen to webhooks, and read a request or deal when an event names it. This is also the cheapest way to stay within the rate limit.
If a list endpoint is added to v1 later, it will come with its own pagination, as an addition that does not change the endpoints above. See Versioning.
