Last updated

Extended Air Visibility

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

Overview of Workflow

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

  1. Create a Shipment with the necessary identifier information to add the shipment to the project44 system and discover other identifiers including Master Air Waybill (MAWB).

  2. View Extended Visibility Events by making a GET request to the Get Event History endpoint or by inspecting 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 the shipment.

Requirements

  • Freight Forwarder SCAC (CARRIER_SCAC)
  • House Air Waybill (HOUSE_AIR_WAYBILL)
  • Do not provide more than one HOUSE_AIR_WAYBILL in the request for creating air shipment.
  • Any event older than 30 days from the shipment creation date will not be tracked.

Workflow

  1. Prepare a POST request to /api/v4/shipments/tracking.
  2. Add the HAWB and FFW SCAC. For example
{
  "identifiers": [
    {
      "type": "HOUSE_AIR_WAYBILL",
      "value": "string"
    },
    {
      "type": "CARRIER_SCAC",
      "value": "string"
    }
  ]
}
  1. Send the request.

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

Expected System Response

Here is an sample of the minimum response schema:

{
  "id": "string",
  "createdDateTime": "string",
  "identifiers": [
    {
      "type": "HOUSE_AIR_WAYBILL",
      "value": "string"
    },
    {
      "type": "CARRIER_SCAC",
      "value": "string"
    }
  ],
  "shipmentShareLink": "string",
  "lastModifiedDateTime": "string"
}

Save the shipment unique system ID (id).

Fields and Objects

ElementDescriptionTypeNotes
idThe shipment's unique Master Shipment ID generated by project44.stringStore the Master Shipment ID to get tracking updates or delete a shipment.
identifiersA list of identifying information for the shipment.array of identifiersThis is different from the Master Shipment ID (id).
identifiers.typeThe identifier type.stringThe only valid values for Extended Air Visibility are HOUSE_AIR_WAYBILL, and CARRIER_SCAC.
identifiers.valueThe value of the shipment identifier.string

Get Shipment Updates for Extended Visibility Events

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

Requirements

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.

Expected System Response

View the full sample responses for either the Get Event History endpoint or the Get Full Tracking History endpoint in Get Tracking Updates page.

Previous page
Next page