Purpose

It receivs the tracking details by the carrier.

Access

An access token is required to POST to this end-point. Contact [support@cargobase.com] to obtain your token.

Core details for identifying and tracking the shipment.

Field Name	Mandatory	Type	Description
`shipment_id`	Yes	string	Cargobase shipment
`tracking_number`	Yes	string	Carrier-provided tracking number
`tracking_type`	Yes	string	Source of tracking (e.g., Omni, AfterShip)
`tracking_update_text`	Yes	string	Latest update message
`tracking_status_tag`	Yes	string	Status tag like `BOOKED`, `DELIVERED`
`mode_of_transport`	Yes	string	Freight mode (e.g., air_freight, road_freight)
`created_time`	Yes	datetime	When the tracking update was recorded
`event_time`	Yes	datetime	Event UTC timestamp
`event_time_with_timezone`	No	datetime	Event timestamp with original timezone
`expected_departure_time`	No	datetime	Planned departure time
`expected_arrival_time`	No	datetime	Planned arrival time
`actual_departure_time`	No	datetime	Actual departure time
`actual_arrival_time`	No	datetime	Actual arrival time

Field Name	Mandatory	Type	Description
`bill_of_lading`	No	object	BOL number, SCAC, container number
`flight_information`	No	object	Flight number and airline

from and to are optional in schema but often used; location is also optional.

Field Name	Mandatory	Type	Description
`location`	No	object	Current event location
`from`	No	object	Pickup location
`to`	No	object	Delivery location

Field Name	Mandatory	Type	Description
`event_weight`	No	integer	Weight reported at time of event
`event_piece`	No	integer	Pieces reported at time of event
`weight`	No	integer	Total shipment weight
`piece`	No	integer	Total pieces in shipment

Field Name	Mandatory	Type	Description
`additional_info`	No	object	Hazmat, temp control, etc.
`pod_acceptor`	No	string	Person who accepted the shipment

Field Name	Mandatory	Type	Description
`milestone_details`	No	object	Event type, location type, and time markers

Depending on the value of mode_of_transport, the range of event_type values differ. Refer to the table below for possible pairings:

mode_of_transport	event_type
`air_freight`	booked_for_transport, consignment_received, received_from_shipper, manifested_on_flight, departed, transferred_to_another_airline, received_from_another_airline, received_from_flight, arrived_at_destination, consignee_notified_of_arrival, documentation_delivered_to_consignee, consignment_to_be_transferred, consignment_cleared_by_customs, delivered_to_consignee, discrepancy_details, prepared_for_loading_on_flights, documentation_received, freight_on_hand, freight_waybill_process
`ocean_freight` or `rail_freight`	booked, pickup, gatein, load, depart, arrive, unload, gateout, deliver, return, pod_berthing, ts_berthing
`road_freight`	booked, pickup, departure, pre_customs_clearance, customs_check_in, customs_clearance, arrival, unloading, delivery

Field Name	Mandatory	Type	Description
`routes`	No	array	List of route segments
`sequence_id`	No	string	Sequence ID of the route leg
`status`	No	string	Status of that leg
`transport_type`	No	string	Transport type (air, sea, etc.)
`weight`	No	integer	Weight for the segment