Last updated

Ocean LCL Visibility

Ocean LCL Visibility is a service that provides real-time tracking and status updates for Less than Container Load (LCL) shipments. It allows shippers to monitor the movement of their cargo throughout the supply chain, ensuring transparency and efficiency.

Overview of Workflow

The workflows to create, get tracking information for, update, and delete an Ocean LCL shipment are the same as for any other Ocean shipment. Nuances specific to Ocean LCL Visibility are called out in the sections below.

Create a Shipment

Follow the steps to Create an Ocean Shipment for tracking.

Requirements

  • Booking Number or Bill of Lading
  • Supported Carrier SCAC.

Example of identifiers needed to track a Vanguard shipment

{
  "identifiers": [
    {
      "type": "BOOKING_NUMBER",
      "value": "string"
    },
    {
      "type": "CARRIER_SCAC",
      "value": "string"
    }
  ]
}

Fields and Objects

The table below describes only the relevant POST request fields. For more information, please see our API Reference documentation.

ElementDescriptionTypeNotes
identifiers.typeThe type of identifier for the shipment.stringYou must use the Carrier SCAC along with either the Booking Number or the Master Bill of Lading. Valid values are BOOKING_NUMBER, CARRIER_SCAC, and BILL_OF_LADING.
identifiers.valueThe identifier value.string

See Ocean LCL Visibility Supported Carrier Scacs in the Appendix for a complete list of supported carrier scacs. The section describes supported carrier scacs according to the data provider.

Error

If there was a problem with your request, you will receive one of the following error codes

  • 400 Invalid request
  • 401 Invalid or missing credentials
  • 403 User not authorized to perform this operation

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Get Ocean LCL visibility Tracking Updates

Follow the steps to Get Ocean Shipment Update.

Requirements

  • Create a shipment. A shipment must have been created to retrieve Ocean LCL Visibility data.
  • project44-generated Shipment ID (this is the id returned in the 200 OK response during shipment creation)

Sample GET Response

The following is a sample response that is returned when using the /api/v4/shipments/{shipmentId}/tracking/history endpoint.

{
  "shipment": {
    "id": "973281a1-97c8-4922-a02a-c77fa19053ee",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "string"
      },
      {
        "type": "CARRIER_SCAC",
        "value": "string"
      },
      {
        "type": "CARRIER_NAME",
        "value": "string"
      }
    ],
    "shipmentShareLink": "https://movement.project44.com/share/1234-5678-9012",
    "createdDateTime": "2023-04-06T17:02:25+0000",
    "lastModifiedDateTime": "2023-04-08T00:17:20+0000",
    "routeInfo": {
      "stops": [
        {
          "id": "string",
          "type": "ORIGIN",
          "location": {
            "name": "string",
            "identifiers": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "address": {
              "city": "string",
              "state": "string",
              "country": "string"
            },
            "coordinates": {
              "latitude": 0,
              "longitude": 0
            },
            "timeZone": "Europe/Brussels"
          }
        },
        {
          "id": "string",
          "type": "PORT_OF_LOADING",
          "location": {
            "name": "string",
            "identifiers": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "address": {
              "city": "string",
              "state": "string-Natal",
              "country": "string"
            },
            "coordinates": {
              "latitude": 0,
              "longitude": 0
            },
            "timeZone": "Europe/Brussels"
          }
        },
        {
          "id": "string",
          "type": "PORT_OF_DISCHARGE",
          "location": {
            "name": "string",
            "identifiers": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "address": {
              "city": "string",
              "state": "string",
              "country": "string"
            },
            "coordinates": {
              "latitude": 0,
              "longitude": 0
            },
            "timeZone": "Africa/Johannesburg"
          }
        },
        {
          "id": "string",
          "type": "DESTINATION",
          "location": {
            "name": "string",
            "identifiers": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "address": {
              "city": "string",
              "state": "string-Natal",
              "country": "string"
            },
            "coordinates": {
              "latitude": 0,
              "longitude": 0
            },
            "timeZone": "Africa/Johannesburg"
          }
        }
      ],
      "routeSegments": [
        {
          "id": "string",
          "fromStopId": "string",
          "toStopId": "string",
          "transportationMode": "UNKNOWN"
        },
        {
          "id": "string",
          "fromStopId": "string",
          "toStopId": "string",
          "transportationMode": "OCEAN",
          "identifiers": [
            {
              "type": "VOYAGE_NUMBER",
              "value": "string"
            },
            {
              "type": "VESSEL_NAME",
              "value": "string"
            },
            {
              "type": "VESSEL_IMO",
              "value": "string"
            },
            {
              "type": "CARRIER_NAME",
              "value": "string"
            }
          ]
        },
        {
          "id": "string",
          "fromStopId": "string",
          "toStopId": "string",
          "transportationMode": "UNKNOWN"
        }
      ]
    },
    "relatedShipments":[]
  },
  "states": [
    {
      "type": "IN_TRANSIT",
      "startDateTime": "2023-03-09T16:50:00+0000",
      "endDateTime": "2023-04-06T01:52:00+0000",
      "stopId": "string",
      "routeSegmentId": "string"
    },
    {
      "type": "AT_STOP",
      "startDateTime": "2023-04-06T01:52:00+0000",
      "endDateTime": "2023-04-07T22:14:00+0000",
      "stopId": "string",
      "routeSegmentId": "stringa"
    },
    {
      "type": "COMPLETED",
      "startDateTime": "string"
    }
  ],
  "events": [
    {
      "dateTime": "2023-03-09T16:50:00+0000",
      "receivedDateTime": "2023-04-07T22:14:00+0000",
      "type": "INFO",
      "stopId": "string",
      "routeSegmentId": "string"
    },
    {
      "dateTime": "2023-03-09T16:50:00+0000",
      "receivedDateTime": "2023-04-07T22:14:00+0000",
      "type": "DEPARTURE_FROM_STOP",
      "stopId": "string",
      "routeSegmentId": "string"
    },
    {
      "dateTime": "2023-04-06T01:52:00+0000",
      "receivedDateTime": "2023-04-07T22:14:00+0000",
      "type": "ARRIVAL_AT_STOP",
      "stopId": "string",
      "routeSegmentId": "string",
      "estimateDateTime": "2023-04-06T01:52:00+0000",
      "estimateLastCalculatedDateTime": "2023-04-08T00:17:21+0000",
      "plannedDateTime": "2023-04-07T00:30:00+0000"
    },
    {
      "dateTime": "2023-04-07T00:30:00+0000",
      "receivedDateTime": "2023-04-07T22:14:00+0000",
      "type": "DELIVERY",
      "stopId": "string"
    },
    {
      "dateTime": "2023-04-07T22:14:00+0000",
      "receivedDateTime": "2023-04-07T22:14:00+0000",
      "type": "TRACKING_STOP"
    }
  ],
  "positions": [
    {
      "dateTime": "2023-03-09T17:10:00+0000",
      "routeSegmentId": "string",
      "latitude": 0,
      "longitude": 0
    }
  ]
}

Error

If there was a problem with your request, you will receive one of the following error codes

  • 400 Invalid request
  • 401 Invalid or missing credentials
  • 403 User not authorized to perform this operation

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Ocean LCL Visibility Event Types

See Ocean LCL Visibility Event Types in the Appendix for a complete list of event types. The section describes event types according to the data provider.

Ocean LCL Visibility Stop Types

See Ocean LCL Visibility Stop Types in the Appendix for a complete list of stop types. The section describes stop types according to the data provider.

Ocean LCL Visibility Other Info

See Ocean LCL Visibility Other Info in the Appendix for a complete list of other relevant information. The section describes other relevant info according to the data provider.

Previous page
Next page