Can you define all the fields displayed in a payload?

This article contains a list of all fields in a payload.

Status

Field Name Description
container_id Shipping container ID
reference_id The Vizion Reference ID
bill_of_lading
Bill of lading for the referenced container, if applicable, provided by the carrier
inland_origin
The inland origin Location object, if available. Door or ramp where container starts its trip
origin_port
The origin port Location object, if available. Where the container loads the vessel
inland_destination
The inland destination Location object, if available. Door or ramp where container ends its trip
destination_port
The destination port Location object, if available. Where the container is unloaded from the vessel
booking
The associated booking number, if available. Provided by the carrier when shipper places booking
milestones A list of Milestone objects for the container's journey

 

Milestone

Field Name Description
description
A standardized description of the milestone event. If Vizion is unable to match the carrier description to a currently mapped value, the carrier description will be provided instead.
raw_description The raw text description received from the carrier.
location The Location object of the milestone, if available
vessel The name of the vessel, if available
vessel_imo The vessel's IMO number, if available
vessel_mmsi The MMSI identifier for the vessel, if available
voyage The voyage identifier for the vessel, if available
timestamp An ISO 8601 formatted timestamp for the milestone
planned

Whether the event has already occurred or is scheduled (ETA or ATA)

 

Location

Field Name Description
name The location name, if available
city The location city, if available
state The location's administrative division, if available
country The location country, if available
unlocode The location UN/LOCODE, if available
facility The location's associated facility
geolocation An object containing the coordinates of the location