| Field Name | Type | Description |
|---|---|---|
container_id |
string |
Shipping container ID |
reference_id |
string |
The Vizion Reference ID |
bill_of_lading |
string | null |
Bill of lading for the referenced container, if applicable |
inland_origin |
Location | null |
The inland origin Location object, if available |
origin_port |
Location | null |
The origin port Location object, if available |
inland_destination |
Location | null |
The inland destination Location object, if available |
destination_port |
Location | null |
The destination port Location object, if available |
booking |
string | null |
The associated booking number, if available |
milestones |
Milestone[] |
A list of Milestone objects for the container's journey |
| Field Name | Type | Description |
|---|---|---|
description |
string |
A standardized description of the milestone event. If Vizion is unable to to match the carrier description to a currently mapped value, the carrier description will be provided instead. |
raw_description |
string |
The raw text description received from the carrier. |
location |
Location | null |
The Location object of the milestone, if available |
vessel |
string | null |
The name of the vessel, if available |
vessel_imo |
string | null |
The vessel's IMO number, if available |
vessel_mmsi |
string | null |
The MMSI identifier for the vessel, if available |
voyage |
string | null |
The voyage identifier for the vessel, if available |
source |
string |
(optional) present if the reporting source was AIS or carrier, returning either ais or carrier |
timestamp |
string | null |
An ISO 8601 formatted timestamp for the milestone |
planned |
boolean | null |
Whether the event has already occurred or is scheduled |
| Field Name | Type | Description |
|---|---|---|
name |
string | null |
The location name, if available |
city |
string | null |
The location city, if available |
state |
string | null |
The location's administrative division, if available |
country |
string | null |
The location country, if available |
unlocode |
string | null |
The location UN/LOCODE, if available |
facility |
string | null |
The location's associated facility |
geolocation |
{ latitude: string; longitude: string } | null |
An object containing the coordinates of the location |