/shipments

get

https://api.dev.orbit.do/v5/shipments

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from

number

The earliest start date of the shipments to retrieve as epoch timestamp.

number

The latest start date of the shipments to retrieve as epoch timestamp.

status

string

enum

The status of the shipments to retrieve. PartiallyRouted and AtHub occur only for multi-leg shipments — see the Tour, Shipment & Order Status page.

tour

string

The tour id of the shipments to retrieve. Includes multi-leg shipments with any leg routed on the tour, not only shipments the tour carries in full. A tour carries a bounded number of shipments, so the complete set is returned as a single page — cursor is not used with this filter.

sorted

string

enum

Sorting direction for shipments. Shipments are always sorted by start date.

Allowed:

cursor

string

Cursor to retrieve next page.

limit

number

Defaults to 500

Maximum count of items in one page.

Responses

400

bad request

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200page of shipments