Get Tracking Updates

Get tracking information about an 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.

The Get Event History endpoint returns shipment events, or milestones.
The Get Position History endpoint returns shipment positions.
The Get Route Information endpoint returns only route segment and stop information for a shipment.
The Get Tracking History endpoint returns all shipment tracking information including events, positions, and stops and route segments.

note

Our Shipment Tracking APIs are designed to be used in an asynchronous manner. This means that a behavior or functionality may not be immediately available upon submission to our API because our system processes data asynchronously.

For more information about how to use the specific endpoints and features, please consult our user guide and API Reference documentation.

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 a Shipment and Track Specific Containers workflow to see how this works.

Get Event History

Get information about shipment milestones (events) that have occurred and are planned to occur.

Requirements

Have the following information available:

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

Workflow

Complete these steps:

Prepare a GET request to /api/v4/shipments/{shipmentId}/eventhistory and include the Master Shipment ID. For example: GET /api/v4/shipments/93294f58-f87a-48e0-9f68-7d3f6e0aaa2f/eventhistory.To return stop information in the response, include the includeRouteInfo query parameter in your request. For example, GET /api/v4/shipments/sample-p44-id-11111/eventhistory?includeRouteInfo=true
Send the request.

Expected System Response

The request is successfully submitted and confirmed when a 200 OK response is received.

Copy

Copied

{
    "shipment": {
        "id": "cfa01403-d76d-4e01-a551-17589083d7d7",
        "identifiers": [
            {
                "type": "CONTAINER_ID",
                "value": "EISU9182565"
            },
            {
                "type": "BILL_OF_LADING",
                "value": "143266096175"
            },
            {
                "type": "CONTAINER_TYPE",
                "value": "45GP"
            },
            {
                "type": "CARRIER_SCAC",
                "value": "EVRG"
            }
        ],
        "shipmentShareLink": "https://na12.voc.project44.com/portal/v2/public/ma/tracking-details?shipmentShareToken=67920a2c-f549-4935-89f2-da2389bb3ed1",
        "createdDateTime": "2023-01-16T21:02:07+0000",
        "routeInfo": {
            "stops": [
                {
                    "id": "f5d0d694-995f-307c-9e11-a42118f71d64",
                    "type": "PORT_OF_LOADING",
                    "location": {
                        "name": "Ningbo",
                        "identifiers": [
                            {
                                "type": "PORT_UN_LOCODE",
                                "value": "CNNGB"
                            }
                        ],
                        "address": {
                            "city": "Ningbo",
                            "state": "Zhejiang",
                            "country": "CN"
                        },
                        "coordinates": {
                            "latitude": 29.895426,
                            "longitude": 121.61865
                        }
                    }
                },
                {
                    "id": "aad8730c-3ecd-3a9b-8d67-a445488d9806",
                    "type": "PORT_OF_DISCHARGE",
                    "location": {
                        "name": "Vancouver",
                        "identifiers": [
                            {
                                "type": "PORT_UN_LOCODE",
                                "value": "CAVAN"
                            }
                        ],
                        "address": {
                            "city": "Vancouver",
                            "state": "British Columbia",
                            "country": "CA"
                        },
                        "coordinates": {
                            "latitude": 49.283333,
                            "longitude": -123.11667
                        }
                    }
                }
            ],
            "routeSegments": [
                {
                    "id": "7c30a1b3-047b-378b-a921-fac0145779d2",
                    "fromStopId": "f5d0d694-995f-307c-9e11-a42118f71d64",
                    "toStopId": "aad8730c-3ecd-3a9b-8d67-a445488d9806",
                    "transportationMode": "OCEAN",
                    "identifiers": [
                        {
                            "type": "VOYAGE_NUMBER",
                            "value": "0404-160E"
                        },
                        {
                            "type": "VESSEL_NAME",
                            "value": "EVER EXCEL"
                        },
                        {
                            "type": "VESSEL_IMO",
                            "value": "9241322"
                        },
                        {
                            "type": "CARRIER_NAME",
                            "value": "Evergreen"
                        }
                    ]
                }
            ]
        },
        "relatedShipments": [
            {
                "id": "309ddd75-4f93-4649-a1c5-0a02bb95210d",
                "identifiers": [
                    {
                        "type": "BILL_OF_LADING",
                        "value": "EGLV143266096175"
                    },
                    {
                        "type": "CARRIER_SCAC",
                        "value": "EVRG"
                    }
                ],
                "shipmentShareLink": "https://na12.voc.project44.com/portal/v2/public/ma/tracking-details?shipmentShareToken=4c87e967-42df-4412-9108-c04914e972e4",
                "createdDateTime": "2023-01-16T20:59:12+0000"
            }
        ]
    },
    "states": [
        {
            "type": "IN_TRANSIT",
            "startDateTime": "2023-01-05T04:00:00+0000",
            "endDateTime": "2023-01-10T04:00:00+0000",
            "stopId": "f5d0d694-995f-307c-9e11-a42118f71d64"
        },
        {
            "type": "AT_STOP",
            "startDateTime": "2023-01-10T04:00:00+0000",
            "endDateTime": "2023-01-13T06:29:00+0000",
            "stopId": "f5d0d694-995f-307c-9e11-a42118f71d64"
        },
        {
            "type": "IN_TRANSIT",
            "startDateTime": "2023-01-13T06:29:00+0000",
            "stopId": "f5d0d694-995f-307c-9e11-a42118f71d64"
        }
    ],
    "events": [
        {
            "dateTime": "2023-01-05T04:00:00+0000",
            "receivedDateTime": "2023-02-08T07:40:00+0000",
            "type": "GATE_OUT_EMPTY",
            "stopId": "f5d0d694-995f-307c-9e11-a42118f71d64"
        },
        {
            "dateTime": "2023-01-10T04:00:00+0000",
            "receivedDateTime": "2023-02-08T07:40:00+0000",
            "type": "GATE_IN_FULL",
            "stopId": "f5d0d694-995f-307c-9e11-a42118f71d64"
        },
        {
            "dateTime": "2023-01-13T04:00:00+0000",
            "receivedDateTime": "2023-02-08T07:40:00+0000",
            "type": "LOAD",
            "stopId": "f5d0d694-995f-307c-9e11-a42118f71d64",
            "plannedDateTime": "2023-01-13T04:00:00+0000"
        },
        {
            "dateTime": "2023-01-13T06:29:00+0000",
            "receivedDateTime": "2023-02-08T07:40:00+0000",
            "type": "DEPARTURE_FROM_STOP",
            "stopId": "f5d0d694-995f-307c-9e11-a42118f71d64"
        },
        {
            "receivedDateTime": "2023-02-08T07:40:00+0000",
            "type": "ARRIVAL_AT_STOP",
            "stopId": "aad8730c-3ecd-3a9b-8d67-a445488d9806",
            "estimateDateTime": "2023-02-14T01:00:01+0000",
            "estimateLastCalculatedDateTime": "2023-02-08T11:41:18+0000",
            "plannedDateTime": "2023-02-12T20:00:00+0000"
        },
        {
            "receivedDateTime": "2023-02-08T07:40:00+0000",
            "type": "DISCHARGE",
            "stopId": "aad8730c-3ecd-3a9b-8d67-a445488d9806",
            "estimateDateTime": "2023-02-15T19:55:00+0000",
            "estimateLastCalculatedDateTime": "2023-02-08T11:41:18+0000"
        },
        {
            "receivedDateTime": "2023-02-08T07:40:00+0000",
            "type": "DELIVERY",
            "stopId": "aad8730c-3ecd-3a9b-8d67-a445488d9806",
            "plannedDateTime": "2023-02-12T20:00:00+0000"
        }
    ]
}

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.

See the Appendix for descriptions of the Ocean Shipment Event Types, Ocean Shipment State Types, and Ocean Shipment Stop Types returned by this endpoint.

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 Response Codes in the Appendix for more information on the meaning of these error codes.

Field and Objects

The table below describes only the minimum relevant fields returned in the 200 OK response from the GET: Fetch the event history for a shipment endpoint including the includeRouteInfo query parameter.

Field	Description
`relatedShipments`	A BOL/BN can consist of multiple containers. An array of all containers tracked under the overall shipment (as created by the user) is returned in the `relatedShipments` object. Each object uses an unique ID (`id`) to retrieve or identify (for PUSH) updates related to the designated container.
`routeInfo`	An overview of the shipment route includes all the necessary IDs for mapping each event to the correct stop, vessel, and segment of the journey.
`routeInfo.stops`	A stop is a set point of the journey that can be an inland location or a port. Several data fields are used to describe an array of stops as defined in the API.
`routeInfo.stops.id`	project44 ID of the stop the event is related to (referenced to as stopId in events payload).
`routeInfo.stops.type`	The type of the stop. For descriptions of specific stop types, see Ocean Stop Types. NOTE: Port locode is supplied for all types of stops to include inland locations. These locations are designated with a `UN_LOCODE` (e.g. rail terminals). Some inland locations without a `UN_LOCODE` can return a blank identifiers array that has a name.
`routeInfo.stops.location`	An object that consists of the location name, identifiers, and coordinates.
`routeInfo.stops.location.name`	The name of the location (e.g. Port of Rotterdam) – received by shipping line (no input from customer required).
`routeInfo.stops.location.identifiers`	A type:value pair – ports populate with UN LOCODE.
`routeInfo.stops.location.coordinates`	The latitude and longitude of the location.
`routeInfo.routeSegments`	An array that describes the journey between two stops.
`routeInfo.routeSegments.id`	project44 ID of the route segment the event is related to (referenced to as `routeSegmentId` in events and positions payload)
`routeInfo.routeSegments.fromStopId`	project44 ID of where the route segment originates.
`routeInfo.routeSegments.toStopId`	project44 ID of where the route segment terminates.
`routeInfo.routeSegments.transportatioinMode`	The mode of transport used for the route segment.
`routeInfo.routeSegments.identifiers`	An array that consists of type:value pairs. See Route Segment Identifiers for valid IDs and descriptions.
`events`	An array of all events related to the shipment.
`events.dateTime`	The time at which the event took place (actual). This will be returned in UTC.
`events.estimateDateTime`	project44’s latest estimated time for the event. This will be returned in UTC.
`events.plannedDateTime`	The carrier’s latest scheduled time for the event. NOTE: Timestamps related to an event do not currently include contracted time or initial planned time by carrier. This will be returned in UTC.
`events.type`	The type of event that occurs. See Ocean Shipment Event Types for a full list of supported event types and descriptions.
`events.description`	A description of the event that occurs (not available for all events)
`events.stopId`	The project44 ID of the stop the event is related to.
`events.routeSegmentsId`	The project44 ID of the route segment the stop is related to. See Route Segment Identifiers for more information on the specific identifier types.
`events.receivedDateTime`	The last time information about event was modified.
`events.estimatedLastCalculatedDateTime`	The last time the estimate date time was modified. This will be returned in UTC.
`states`	An array of all states the shipment was or currently is in.
`states.type`	The specific type of state the shipment was in. Valid values include `"UNKNOWN"`, `"AT_STOP"`, `"IN_TRANSIT"`, `"COMPLETED"`, `"SCHEDULED"`. See Ocean Shipment State Types for a full list of the supported state types and their descriptions.
`states.startDateTime`	The time this state began. This will be returned in UTC.
`states.endDateTime`	The time that this state ended. May not be populated if the shipment is still in this state. This will be returned in UTC.
`states.stopId`	The ID of the related stop.routeSegmentId: the route segment ID this state occurred along.

Get Position History

Get information about an Ocean shipment's position history.

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.

Prepare a GET request to /api/v4/shipments/{shipmentId}/positionhistory using the shipment ID. For example, GET /api/v4/shipments/3294f58-f87a-48e0-9f68-7d3f6e0aaa2f/positionhistory.To return stop information in the response, include the includeRouteInfo query parameter in your request. For example, GET /api/v4/shipments/sample-p44-id-11111/positionhistory?includeRouteInfo=true
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:

Copy

Copied

{
  "shipment": {
    "id": "sample-p44-id-11111string",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MEDUCZ810176"
      }
    ],
    "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": "OCEAN",
          "identifiers": [
            {
              "type": "BILL_OF_LADING",
              "value": "string"
            }
          ]
        }
      ]
    },
    "relatedShipments": [
      {
        "id": "string",
        "identifiers": [
          {
            "type": "CONTAINER_ID",
            "value": "string"
          }
        ]
      },
      {
        "id": "string",
        "identifiers": [
          {
            "type": "CONTAINER_ID",
            "value": "string"
          }
        ]
      },
      {
        "id": "string",
        "identifiers": [
          {
            "type": "CONTAINER_ID",
            "value": "string"
          }
        ]
      },
    ]
  },
  "positions": [
    {
      "dateTime": "string",
      "receivedDateTime": "string",
      "routeSegmentId": "string",
      "latitude": 0,
      "longitude": 0
    }
  ]
}

See the Appendix for descriptions of the Ocean Shipment Stop Types and Route Segment Identifiers.

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

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

Fields and Objects

The table below describes fields returned in the response 200 OK from the GET: Fetch the position history for a shipment endpoint.

Field	Description
`relatedShipments`	A BOL/BN can consist of multiple containers. An array of all containers tracked under the overall shipment (as created by the user) is returned in the `relatedShipments` object. Each object uses an unique ID (`id`) to retrieve or identify (for PUSH) updates related to the designated container.
`routeInfo`	An overview of the shipment route includes all the necessary IDs for mapping each event to the correct stop, vessel, and segment of the journey.
`routeInfo.stops`	A stop is a set point of the journey that can be an inland location or a port. Several data fields are used to describe an array of stops as defined in the API.
`routeInfo.stops.id`	project44 ID of the stop the event is related to (referenced to as stopId in events payload).
`routeInfo.stops.type`	The type of the stop. For descriptions of specific stop types, see Ocean Stop Types. NOTE: Port locode is supplied for all types of stops to include inland locations. These locations are designated with a `UN_LOCODE` (e.g. rail terminals). Some inland locations without a `UN_LOCODE` can return a blank identifiers array that has a name.
`routeInfo.stops.location`	An object that consists of the location name, identifiers, and coordinates.
`routeInfo.stops.location.name`	The name of the location (e.g. Port of Rotterdam) – received by shipping line (no input from customer required).
`routeInfo.stops.location.identifiers`	A type:value pair – ports populate with UN LOCODE.
`routeInfo.stops.location.coordinates`	The latitude and longitude of the location.
`routeInfo.routeSegments`	An array that describes the journey between two stops.
`routeInfo.routeSegments.id`	project44 ID of the route segment the event is related to (referenced to as `routeSegmentId` in events and positions payload)
`routeInfo.routeSegments.fromStopId`	project44 ID of where the route segment originates.
`routeInfo.routeSegments.toStopId`	project44 ID of where the route segment terminates.
`routeInfo.routeSegments.transportatioinMode`	The mode of transport used for the route segment.
`routeInfo.routeSegments.identifiers`	An array that consists of type:value pairs. See Route Segment Identifiers for valid IDs and descriptions.
`positions`	An array of all geo-positions related to the shipment.
`positions.dateTime`	The time the recorded position. This will be returned in UTC.
`positions.receivedDateTime`	The time the position was received by project44. This will be returned in UTC.
`positions.routeSegmentId`	The ID of the route segment the stop is related to.
`positions.latitude`	The geographic latitude of the shipment position.
`positions.longitude`	The geographic longitude of the shipment position.

Get Route Information

Get route information (stops and route segments) for an Ocean shipment.

Requirements

Have the following information available:

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

Worfklow

Complete the following steps.

Prepare a GET request to /api/v4/shipments/{shipmentId}/tracking using the Master Shipment ID. For example, GET /api/v4/shipments/93294f58-f87a-48e0-9f68-7d3f6e0aaa2f/tracking.
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:

Copy

Copied

{
  "id": "sample-p44-id-11111string",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "MEDUCZ810176"
    }
  ],
  "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": "OCEAN",
        "identifiers": [
          {
            "type": "BILL_OF_LADING",
            "value": "string"
          }
        ]
      }
    ]
  },
  "relatedShipments": [
    {
      "id": "string",
      "identifiers": [
        {
          "type": "CONTAINER_ID",
          "value": "string"
        }
      ],
    },
    {
      "id": "string",
      "identifiers": [
        {
          "type": "CONTAINER_ID",
          "value": "string"
        }
      ],
    },
    {
      "id": "string",
      "identifiers": [
        {
          "type": "CONTAINER_ID",
          "value": "string"
        }
      ],
    }
  ]
}

See the Appendix for descriptions Ocean Shipment Stop Types and Route Segment Identifiers returned by this endpoint.

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 Response Codes in the Appendix for more information on the meaning of these error codes.

Fields and Objects

The table below describes fields returned in the response 200 OK from the GET: Fetch the route information for a shipment including the stops and route segments endpoint.

Field	Description
`relatedShipments`	A BOL/BN can consist of multiple containers. An array of all containers tracked under the overall shipment (as created by the user) is returned in the `relatedShipments` object. Each object uses an unique ID (`id`) to retrieve or identify (for PUSH) updates related to the designated container.
`routeInfo`	An overview of the shipment route includes all the necessary IDs for mapping each event to the correct stop, vessel, and segment of the journey.
`routeInfo.stops`	A stop is a set point of the journey that can be an inland location or a port. Several data fields are used to describe an array of stops as defined in the API.
`routeInfo.stops.id`	project44 ID of the stop the event is related to (referenced to as stopId in events payload).
`routeInfo.stops.type`	The type of the stop. For descriptions of specific stop types, see Ocean Stop Types. NOTE: Port locode is supplied for all types of stops to include inland locations. These locations are designated with a `UN_LOCODE` (e.g. rail terminals). Some inland locations without a `UN_LOCODE` can return a blank identifiers array that has a name.
`routeInfo.stops.location`	An object that consists of the location name, identifiers, and coordinates.
`routeInfo.stops.location.name`	The name of the location (e.g. Port of Rotterdam) – received by shipping line (no input from customer required).
`routeInfo.stops.location.identifiers`	A type:value pair – ports populate with UN LOCODE.
`routeInfo.stops.location.coordinates`	The latitude and longitude of the location.
`routeInfo.routeSegments`	An array that describes the journey between two stops.
`routeInfo.routeSegments.id`	project44 ID of the route segment the event is related to (referenced to as `routeSegmentId` in events and positions payload)
`routeInfo.routeSegments.fromStopId`	project44 ID of where the route segment originates.
`routeInfo.routeSegments.toStopId`	project44 ID of where the route segment terminates.
`routeInfo.routeSegments.transportatioinMode`	The mode of transport used for the route segment.
`routeInfo.routeSegments.identifiers`	An array that consists of type:value pairs. See Route Segment Identifiers for valid IDs and descriptions.

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.

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.
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:

Copy

Copied

{
  "shipment": {
    "id": "string",
    "identifiers": [
      {
        "type": "BILL_OF_LADING",
        "value": "MEDUCZ810176"
      }
    ],
    "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": "AIR_WAYBILL",
            "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
    }
  ]
}

note

The response returned here for the Full Tracking History is the same response returned with the webhook. For more information on setting up a webhook to receive Full Tracking History updates, see Webhooks.

See the Appendix for descriptions Ocean Shipment Stop Types, Route Segment Identifiers, Ocean Shipment State Types, and Ocean Shipment Event Types returned by this endpoint.

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

Field	Description
`relatedShipments`	A BOL/BN can consist of multiple containers. An array of all containers tracked under the overall shipment (as created by the user) is returned in the `relatedShipments` object. Each object uses an unique ID (`id`) to retrieve or identify (for PUSH) updates related to the designated container.
`routeInfo`	An overview of the shipment route includes all the necessary IDs for mapping each event to the correct stop, vessel, and segment of the journey.
`routeInfo.stops`	A stop is a set point of the journey that can be an inland location or a port. Several data fields are used to describe an array of stops as defined in the API.
`routeInfo.stops.id`	project44 ID of the stop the event is related to (referenced to as stopId in events payload).
`routeInfo.stops.type`	The type of the stop. For descriptions of specific stop types, see Ocean Stop Types. NOTE: Port locode is supplied for all types of stops to include inland locations. These locations are designated with a `UN_LOCODE` (e.g. rail terminals). Some inland locations without a `UN_LOCODE` can return a blank identifiers array that has a name.
`routeInfo.stops.location`	An object that consists of the location name, identifiers, and coordinates.
`routeInfo.stops.location.name`	The name of the location (e.g. Port of Rotterdam) – received by shipping line (no input from customer required).
`routeInfo.stops.location.identifiers`	A type:value pair – ports populate with UN LOCODE.
`routeInfo.stops.location.coordinates`	The latitude and longitude of the location.
`routeInfo.routeSegments`	An array that describes the journey between two stops.
`routeInfo.routeSegments.id`	project44 ID of the route segment the event is related to (referenced to as `routeSegmentId` in events and positions payload)
`routeInfo.routeSegments.fromStopId`	project44 ID of where the route segment originates.
`routeInfo.routeSegments.toStopId`	project44 ID of where the route segment terminates.
`routeInfo.routeSegments.transportatioinMode`	The mode of transport used for the route segment.
`routeInfo.routeSegments.identifiers`	An array that consists of type:value pairs. See Route Segment Identifiers for valid IDs and descriptions.
`events`	An array of all events related to the shipment.
`events.dateTime`	The time at which the event took place (actual). This will be returned in UTC.
`events.estimateDateTime`	project44’s latest estimated time for the event. This will be returned in UTC.
`events.plannedDateTime`	The carrier’s latest scheduled time for the event. NOTE: Timestamps related to an event do not currently include contracted time or initial planned time by carrier. This will be returned in UTC.
`events.type`	The type of event that occurs. See Ocean Shipment Event Types for a full list of supported event types and descriptions.
`events.description`	A description of the event that occurs (not available for all events)
`events.stopId`	The project44 ID of the stop the event is related to.
`events.routeSegmentsId`	The project44 ID of the route segment the stop is related to. See Route Segment Identifiers for more information on the specific identifier types.
`events.receivedDateTime`	The last time information about event was modified. This will be returned in UTC.
`events.estimatedLastCalculatedDateTime`	The last time the estimate date time was modified.
`states`	An array of all states the shipment was or currently is in.
`states.type`	The specific type of state the shipment was in. Valid values include `"UNKNOWN"`, `"AT_STOP"`, `"IN_TRANSIT"`, `"COMPLETED"`, `"SCHEDULED"`. See Ocean Shipment State Types for a full list of the supported state types and their descriptions.
`states.startDateTime`	The time this state began. This will be returned in UTC.
`states.endDateTime`	The time that this state ended. May not be populated if the shipment is still in this state. This will be returned in UTC.
`states.stopId`	The ID of the related stop.routeSegmentId: the route segment ID this state occurred along.
`positions`	An array of all geo-positions related to the shipment.
`positions.dateTime`	The time the recorded position. This will be returned in UTC.
`positions.receivedDateTime`	The time the position was received by project44. This will be returned in UTC.
`positions.routeSegmentId`	The ID of the route segment the stop is related to.

Get Tracking Updates

note

Get Event History

Requirements

Workflow

Expected System Response

Errors

Field and Objects

Get Position History

Requirements

Workflow

Expected System Response

Error

Fields and Objects

Get Route Information

Requirements

Worfklow

Expected System Response

Errors

Fields and Objects

Get Full Tracking History

Requirements

Workflow

Expected System Response

note

Errors

Fields and Objects

Was this page helpful?