Purpose

This integration is used to gain visibility to container and vessel locations with improved accuracy through data feeds from third-party visibility data providers.

Roles

These roles describe the different systems involved in this integration:

TMS - this is the shipper or freight forwarder's system that houses shipment data. It may be a traditional transportation management system, an ERP, or even an online spreadsheet.
Visibility Data Provider - this is the system responsible for providing visibility updates for shipments that the TMS has registered an interest in.

Flow Types

Flow Type	Key	Description	Input Converter	Output Converter
Register Shipment	`vis.register_shipment`	Send shipment profile information from the TMS to the visibility provider so they know what shipments to track.	TMS	Visibility Data Provider
Receive Shipment Updates	`vis.receive_shipment_update`	Receive updates from the visibility provider and pass them along to the TMS.	Visibility Data Provider	TMS

Register Shipment

Sample payloads output by the TMS' Input Converter and sent to the Visibility Data Provider's Output Converter

Download OpenAPI Schema

{
  "tms_system_identifier": "S123141",
  "master_bill": "MOLU123181",
  "containers": [
    {
      "container_number": "MAEU1234567"
    }
  ],
  "carrier_scac": "MAEU",
  "transport_mode": "sea",
  "containerization_type": "fcl"
}

{
  "tms_system_identifier": "S123141",
  "master_bill": "MOLU123181",
  "carrier_scac": "MAEU",
  "transport_mode": "sea"
}

{
  "tms_system_identifier": "S123141",
  "containers": [
    {
      "container_number": "MAEU1234567"
    },
    {
      "container_number": "MAEU1091231"
    }
  ],
  "carrier_scac": "MAEU",
  "transport_mode": "sea"
}

{
  "tms_system_identifier": "S123141",
  "carrier_booking_number": "MOLU19879230",
  "transport_mode": "sea"
}

{
  "tms_system_identifier": "S123141",
  "master_bill": "MAWB1231",
  "transport_mode": "air"
}

Receive Shipment Update

Sample payloads output by the Visibility Provider's Input Converter and sent to the TMS' Output Converter

Download OpenAPI Schema

{
  "tms_system_identifier": "S123141",
  "milestones": [
    {
      "event_code": "DEPARTURE",
      "timestamp": "2023-01-12T10:35:00.000Z",
      "location_code": {
        "code": "CNYTN",
        "description": "Yantian Pt",
        "code_type": "un_locode"
      }
    },
    {
      "event_code": "ARRIVAL",
      "estimated_timestamp": "2023-01-27T00:00:00.000Z",
      "location_code": {
        "code": "USLAX",
        "description": "Los Angeles, CA",
        "code_type": "un_locode"
      }
    }
  ]
}

{
  "tms_system_identifier": "S123141",
  "containers": [
    {
      "container_number": "MAEU1234567",
      "milestones": [
        {
          "event_code": "GATE_IN",
          "timestamp": "2023-01-11T09:01:30.000Z"
        },
        {
          "event_code": "GATE_OUT",
          "estimated_timestamp": "2023-02-02T00:00:00.000Z",
          "location_code": {
            "code": "USLAX",
            "description": "Los Angeles, CA",
            "code_type": "un_locode"
          }
        }
      ]
    }
  ]
}

{
  "tms_system_identifier": "S123141",
  "milestones": [
    {
      "event_code": "DEPARTURE",
      "timestamp": "2023-01-12T10:35:00.000Z",
      "location_code": {
        "code": "CNYTN",
        "description": "Yantian Pt",
        "code_type": "un_locode"
      }
    },
    {
      "event_code": "ARRIVAL",
      "estimated_timestamp": "2023-01-27T00:00:00.000Z",
      "location_code": {
        "code": "USLAX",
        "description": "Los Angeles, CA",
        "code_type": "un_locode"
      }
    }
  ],
  "containers": [
    {
      "container_number": "MAEU1234567",
      "milestones": [
        {
          "event_code": "GATE_IN",
          "timestamp": "2023-01-11T09:01:30.000Z"
        },
        {
          "event_code": "GATE_OUT",
          "estimated_timestamp": "2023-02-02T00:00:00.000Z",
          "location_code": {
            "code": "USLAX",
            "description": "Los Angeles, CA",
            "code_type": "un_locode"
          }
        }
      ]
    }
  ]
}