Get shipment
get_shipmentEverything about one shipment: summary, route (POL, transshipments, POD with actual and estimated times), current position estimate, carrier ETA and predicted ETA, and the latest actual events. Use it for "where is X" questions; for the full event history use get_shipment_events. shipment (required) is the BerthTime id, the tracked reference, or a container number on the shipment. Optional events (0-50, default 5) = how many latest actual events to include. Returns: shipment {id, reference, ref_type, carrier, customer_reference, status, tracking_status, phase, pol, pod, eta, original_eta, delay_hours, predicted_eta, eta_risk, vessel, containers, last_position, container_remarks}, route {stops[] {role, name, un_locode, arrival, departure}, legs[], current_position} or null, latest_events[]. Unknown reference: an error that suggests list_shipments or track_shipment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| events | No | How many of the latest events to include. | |
| company | No | Which company to act for: its id, @handle or exact name (see list_companies). Omit for the connection's default company. | |
| shipment | Yes | BerthTime shipment id, or the tracked reference (container, bill of lading or booking number), or a container number on the shipment. |