Search shipments
search_shipmentsFind shipments in the organization, newest first. Use it to answer "which shipments are on their way", "what arrives next week", "find the shipment for booking ABC123" or "what did we ship from Guayaquil". query matches references, B/L and container numbers, parties, ports and produce. Each result is a short summary: status, route, ETD and ETA, carrier, container numbers, failed checks, and latest_event, the last thing that actually happened (milestone, time, place, vessel). That answers "where is each shipment" for a whole list, so do not call get_tracking_timeline per shipment for an overview; call it only for one shipment's full history. Pass detail: "full" for every field (parties, cargo, notes, tracking state), or use get_shipment for one shipment with its free time. Use the id (such as "shp_123") for the other tools. Each has a url: link the shipment's container or air waybill number to it, never a made-up URL. Archived shipments are excluded unless archived says otherwise. Results are paged: when has_more is true, pass the last id as starting_after.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many results to return, 1 to 100. | |
| query | No | Free text: a reference, B/L or container number, party, port or product. | |
| detail | No | "summary" (default) for the short result, "full" for every field of each shipment. | summary |
| archived | No | "false" (default) for live shipments, "true" for archived ones, "any" for both. | false |
| statuses | No | Only these statuses. Omit for all of them. | |
| eta_after | No | Only shipments whose effective ETA is on or after this ISO 8601 date or date-time. | |
| eta_before | No | Only shipments whose effective ETA is on or before this ISO 8601 date or date-time. | |
| starting_after | No | Paging cursor: the id of the last result of the previous page. Only when has_more was true. |