Extended Ocean Visibility

project44's Extended Ocean Visibility converges data from multiple sources to give you visibility into tracking milestones for pre- and on-carriage shipments.

Overview of Workflow

The workflows to create, get updates about, update, and delete ocean shipments with extended visibility are similar to the workflows for Ocean Visibility. This documentation provides information on how to use the create a shipment and get milestone updates specifically for Extended Ocean Visibility.

1. Create a Shipment with the necessary identifier information to add the shipment to the project44 system and discover other identifiers including Master Bill of Lading (MBOL), Ocean Carrier SCAC, and Container IDs. These identifiers will return in the relatedShipments array in the response for creating a shipment.

2. View Extended Visibility Events with a pull request using the Get Event History endpoint or the Get Full Tracking History response. If you have created a webhook, you will receive push tracking notifications for extended visibility events.

Create a Shipment

Create a shipment to be tracked in project44's network. This step is necessary to receive extended visibility milestone updates. The response to the request to create a shipment will include identifiers for related shipments.

Requirements

• Freight Forwarder (FFW) or Non-vessel Vessel Operating Common Carrier (NVOCC) SCAC
• One of the following:
  • House Bill of Lading (HBOL)
  • Booking Number
  • FFW Tracking Number

Workflow

1. Prepare a POST request to /api/v4/shipments/tracking.
2. Add the HBOL and FFW or NVOCC SCAC. For example,

{
  "identifiers": [
    {
      "type": "HOUSE_BILL_OF_LADING",
      "value": "string"
    },
    {
      "type": "FFW_SCAC",
      "value": "string"
    }
  ]
}

3. Send the request.

Fields and Objects

Expected System Response

You have successfully submitted the response when you receive a 200 OK response.

It will take time for the source data to return related shipment information (found in the relatedShipments array) like Master Bill of Lading (MBOL), Ocean Carrier SCAC, and Container IDs.

Here is an sample of the minimum response schema:

{
  "id": "string",
  "identifiers": [
    {
      "type": "HOUSE_BILL_OF_LADING",
      "value": "string"
    },
    {
      "type": "FFW_SCAC",
      "value": "string"
    },
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    }
  ],
  "relatedShipments": [
    {
      "id": "45db2fd9-9f3a-4a67-a6ab-db70c255ced1",
      "identifiers": [
        {
          "type": "CONTAINER_ID",
          "value": "string"
        },
        {
          "type": "CARRIER_SCAC",
          "value": "string"
        }
      ]
    }
  ]
}

Fields and Objects

Get Shipment Updates for Extended Visibility Events

Follow the Get Event History or Get Full Tracking History workflows to return extended ocean visibility events.

Requirements

• Shipment ID (The id returned in the Create a Shipment response.)

Workflow

PULL Request Workflow

1. Use the endpoint in either the Get Event History workflow or the Get Full Tracking History workflow.

2. Send the request.

PUSH Request Workflow

If you have created a webhook, you will receive event data in the push tracking notification. In addition to the Ocean Visibility event types, responses for Extended Ocean Visibility will include additional event types for inland door milestones.

Expected System Response

View the full sample responses for either the Get Event History endpoint or the Get Full Tracking History endpoint. Extended Ocean Visibility milestone information can be found in the events array of the GET response and is identifiable by specific event types (type). See Minimum Expected Event Types for Extended Ocean Visibility below for more information.

{
    "events": [
        {
            "type": "string"
        }
    ]
}

Fields and Objects

Minimum Expected Event Types for Extended Ocean Visibility

Additional Event Types for Extended Ocean Visibility