List shipments
list_shipmentsList or search the company's own tracked shipments, newest first. Use it to find a shipment (free-text q: reference, customer reference, container number, vessel) or to filter by status (default active), carrier SCAC, phase, tag, ETA window (eta_after / eta_before, ISO 8601) or predicted eta_risk. For one shipment's full detail use get_shipment; for the next N days use arriving_soon; for slipped ETAs use delayed_shipments; shipments other companies share with you are in list_shared_shipments. All arguments are optional. Returns: shipments[] {id, reference, ref_type, carrier, customer_reference, status, tracking_status, phase, pol, pod, eta, original_eta, delay_hours, predicted_eta, eta_risk, vessel, containers}, has_more, next_cursor. Paging: limit 1-100 (default 20); pass next_cursor as cursor for the next page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search text: reference, customer reference, container number or vessel name. | |
| tag | No | Only shipments with this tag (exact tag name, as shown in the web app). | |
| limit | No | Page size, 1-100 (default 20). | |
| phase | No | Only shipments in this phase: pending (no carrier data yet), booked, in_transit, arrived or delivered. | |
| cursor | No | next_cursor from a previous call. | |
| status | No | active (default) = being tracked; archived; or all. | active |
| carrier | No | Carrier SCAC, e.g. MSCU, MAEU. | |
| company | No | Which company to act for: its id, @handle or exact name (see list_companies). Omit for the connection's default company. | |
| eta_risk | No | Predicted ETA risk (estimate based on vessel position). | |
| eta_after | No | Only ETAs at or after this (ISO 8601). | |
| eta_before | No | Only ETAs at or before this (ISO 8601). |