When Vizion provides an update what will I receive?

Here you will find information on objects, keys, and values present in a reference update.

Updates received from the ocean visibility API will be in JSON format. Each update will contain all available data sourced by Vizion after cleaning, standardization, and enrichment have taken place. Each payload follows a standard schema for easy parsing.

The objects included in the schema are:

  • Reference information
  • Reference update information
  • Inland origin
  • Origin port
  • Destination port
  • Inland destination
  • Milestone array

Reference updates will adhere to the follow example:

{
"reference_id": "c5a6fa6c-6ac8-48ce-bdf8-d628b8d28e66",
"payload": {
"reference_id": "a6ba62e5-9c13-4dc1-8296-7805fb775e4b",
"carrier_scac": "MSCU",
"container_id": "UETU2639747",
"container_type": "D5",
"container_iso": "20' DRY VAN",
"inland_origin": {
"name": "TAICHUNG",
"city": "Taichung",
"country": "Taiwan",
"unlocode": "TWTXG",
"geolocation": {
"latitude": 24.26661530594205,
"longitude": 120.5146744955646
}
},
"origin_port": {
"name": "TAICHUNG",
"city": "Taichung",
"country": "Taiwan",
"unlocode": "TWTXG",
"geolocation": {
"latitude": 24.26661530594205,
"longitude": 120.5146744955646
}
},
"destination_port": {
"name": "ISTANBUL",
"city": "İstanbul",
"country": "Turkey",
"unlocode": "TRIST",
"geolocation": {
"latitude": 40.95942343598934,
"longitude": 28.66892493620864
}
},
"inland_destination": {
"name": "ISTANBUL",
"city": "İstanbul",
"country": "Turkey",
"unlocode": "TRIST",
"geolocation": {
"latitude": 40.95942343598934,
"longitude": 28.66892493620864
}
},
"milestones": [
{
"description": "Loaded on vessel",
"location": {
"name": "TAICHUNG",
"city": "Taichung",
"country": "Taiwan",
"unlocode": "TWTXG",
"geolocation": {
"latitude": 24.26661530594205,
"longitude": 120.5146744955646
}
},
"vessel": "CMA CGM LITANI",
"vessel_imo": 9705055,
"vessel_mmsi": 256033000,
"voyage": "0TN2QN1MA",
"timestamp": "2021-01-13T08:44:00.000+09:00",
"planned": false,
"raw_description": "Loaded on board"
},
{
"description": "Vessel arrival",
"location": {
"name": "ISTANBUL",
"city": "İstanbul",
"country": "Turkey",
"unlocode": "TRIST",
"geolocation": {
"latitude": 40.95942343598934,
"longitude": 28.66892493620864
}
},
"vessel": "CMA CGM LITANI",
"vessel_imo": 9705055,
"vessel_mmsi": 256033000,
"voyage": "0TN2QN1MA",
"timestamp": "2021-01-24T08:44:00.000+09:00",
"planned": true,
"raw_description": "Vessel Arrived"
}
]
},
"organization_id": "29c06aad-efb1-4871-b173-b3022343d1c1",
"status": "data_received",
"id": "79c8f2cd-4e54-46a4-a29b-7ea6a5357e88",
"created_at": "2021-01-21T00:04:39.519Z",
"updated_at": "2021-01-21T00:04:39.519Z",
}

If data is not available for any portion of a shipment the object will return a null value. If data for any portion of a carrier is not yet supported by that carrier the object will not be present.