Get Tracking Updates

Get tracking information about an Extended Ocean shipment. A shipment must be created and added to project44's network before we can return tracking information. If you have not done so, please Create a Shipment. project44 offers four targeted endpoints for returning shipment tracking information. This allows you to fetch the specific information you need when you need it.

1. The /api/v4/shipments/{shipmentId}/eventhistory endpoint returns shipment events, or milestones.
2. The /api/v4/shipments/{shipmentId}/positionhistory endpoint returns shipment positions.
3. The /api/v4/shipments/{shipmentId}/tracking endpoint returns only route segment and stop information for a shipment.
4. The /api/v4/shipments/{shipmentId}/tracking/history endpoint returns all shipment tracking information including events, positions, and stops and route segments.

All 4 endpoints have the same requirements and workflow. The only difference is the information returned in the response. So we will only describe the workflow once for the 4th API endpoint, which returns all shipment tracking information.

Get Full Tracking History

Get an Ocean shipment's full tracking history including route information and stops, states, events, and positions.

Requirements

Have the following information available:

• Master Shipment ID (this is the id returned in the 200 OK response during shipment creation).

Workflow

Complete the following steps.

1. Prepare a GET request to /api/v4/shipments/{shipmentId}/tracking/history using the Master Shipment ID. For example, GET /api/v4/shipments/93294f58-f87a-48e0-9f68-7d3f6e0aaa2f/tracking/history.
2. Send the request.

Expected System Response

You have successfully submitted the request when you receive a 200 OK response. Here is a sample of the response schema:

{
  "shipment": {
    "id": "string",
    "identifiers": [
      {
        "type": "HOUSE_BILL_OF_LADING",
        "value": "string"
      }
    ],
    "routeInfo": {
      "stops": [
        {
          "id": "string",
          "type": "UNKNOWN",
          "location": {
            "id": "string",
            "name": "string",
            "identifiers": [
              {
                "type": "PORT_UN_LOCODE",
                "value": "string"
              }
            ],
            "address": {
              "postalCode": "string",
              "addressLines": [
                "string"
              ],
              "city": "string",
              "state": "string",
              "country": "US"
            },
            "coordinates": {
              "latitude": 0,
              "longitude": 0
            },
            "timeZone": "string"
          }
        }
      ],
      "routeSegments": [
        {
          "id": "string",
          "fromStopId": "string",
          "toStopId": "string",
          "transportationMode": "AIR",
          "identifiers": [
            {
              "type": "AIR_WAYBILL",
              "value": "string"
            }
          ]
        }
      ]
    },
    "attributes": [
      {
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "relatedShipments": [
      {
        "id": "string",
        "identifiers": [
          {
            "type": "CONTAINER_ID",
            "value": "string"
          }
        ],
        "attributes": [
          {
            "name": "string",
            "value": "string",
            "values": [
              "string"
            ]
          }
        ],
        "shipmentShareLink": "string",
        "createdDateTime": "string",
        "lastModifiedDateTime": "string"
      }
    ],
    "shipmentShareLink": "string",
    "createdDateTime": "string",
    "lastModifiedDateTime": "string"
  },
  "states": [
    {
      "type": "UNKNOWN",
      "startDateTime": "string",
      "endDateTime": "string",
      "stopId": "string",
      "routeSegmentId": "string"
    }
  ],
  "events": [
    {
      "dateTime": "string",
      "receivedDateTime": "string",
      "type": "UNKNOWN",
      "description": "string",
      "stopId": "string",
      "routeSegmentId": "string",
      "estimateDateTime": "string",
      "estimateLastCalculatedDateTime": "string",
      "plannedDateTime": "string",
      "plannedEndDateTime": "string"
    }
  ],
  "positions": [
    {
      "dateTime": "string",
      "receivedDateTime": "string",
      "routeSegmentId": "string",
      "latitude": 0,
      "longitude": 0
    }
  ]
}

This is an example of what could be returned in the response. Null fields will not show up in the response. Please refer to the reference data for more information on required and potential null fields.

Errors

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
• 404 Not Found

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

Fields and Objects

The fields and objects returned in the response are explained in detail in our Shipment Schema documentation. Please refer to the Ocean Shipment Schema for more information.

Expected Ocean Milestones

With Extended Ocean visibility, you can expect to see all General, LCL & Info milestones mentioned under $.events schema guide

Expected Stops & Route

With Extended Ocean visibility, you can expect to see all the stops mentioned under $.shipment.routeInfo.stops schema guide.

Expected Identifiers

• If the connection with freight forwarder is capable of discovering ocean carrier identifiers, you can expect to see identifiers like CARRIER_SCAC, BILL_OF_LADING or BOOKING_NUMBER if not given during the creation of shipment.
• Additional identifiers like CARRIER_NAME, CARRIER_MASTER_ID, FFW_MASTER_ID and FFW_NAME can be expected in the response as well.

More information on identifiers can be found in the $.shipment.identifiers guide.

Expected Related Shipments

After the shipment has been created, project44 will discover related shipments and return their information in the relatedShipments array in the GET responses. Related shipments will not be identified immediately after creation, however. If you want to see the related shipments immediately after shipment creation, you will need to include the related shipment identifier information in the identifiers array of the shipment creation endpoint. Follow the steps in Create an extended ocean shipment with associated containers to see how this works.