Air Visibility
Overview
project44’s Air Visibility enables users to
- Get End-to-End visibility for door to door moves.
- Reduce excess inventory and the need for safety stock with accurate delivery data.
- Solve challenges with intelligent, dynamic, international transport planning, and analytics for optimized freight procurement.
Workflow
- Get proper credentials.
- Create a Shipment.
- Get Shipment Information.
- Update a Shipment.
- Delete a Shipment.
Workflow Details
Get Credentials
You must be provisioned with a tenant to have a client application within that tenant with the appropriate permissions to use any API within project44.
See here for more information on Authentication and Authorization.
Create a Shipment
Use the POST: Initialize tracking on a shipment endpoint to start a tracking job and initialize an air shipment.
Endpoint | /api/v4/shipments/tracking |
Verb | POST |
Required Fields | shipment identifier (AIR_WAYBILL or HOUSE_AIR_WAYBILL ) |
Get Shipment Information
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.
Get Events Data for a Shipment
Use the GET: Fetch the event history for a shipment endpoint to retrieve information on shipment milestones. Event history is the primary way to understand where your shipments are or what milestones they have completed.
Endpoint | /api/v4/shipments/{shipmentId}/eventhistory |
Verb | GET |
Required Fields | shipment identifier (AIR_WAYBILL or HOUSE_AIR_WAYBILL ) |
Get Position Data for a Shipment
Use the GET: Fetch the position history for a shipment endpoint to get granular information about a shipment’s location.
Endpoint | /api/v4/shipments/{shipmentId}/positionhistory |
Verb | GET |
Required Fields | shipment identifier (AIR_WAYBILL or HOUSE_AIR_WAYBILL ) |
Get a Shipment’s Route History
Use the GET: Fetch the route information for a shipment including the stops and route segments endpoint to get specific information about a shipment’s route and the stops a shipment has made.
Endpoint | /api/v4/shipments/{shipmentId}/tracking |
Verb | GET |
Required Fields | shipment identifier (AIR_WAYBILL or HOUSE_AIR_WAYBILL ) |
Get Full Shipment History
Use the GET: Get full tracking history for a shipment endpoint to get detailed information on a shipment’s stops, events, and positions throughout its transportation journey.
Endpoint | /api/v4/shipments/{shipmentId}/tracking/history |
Verb | GET |
Required Fields | shipment identifier (AIR_WAYBILL or HOUSE_AIR_WAYBILL ) |
Update a Shipment
Use the POST: Initialize a shipment for tracking endpoint to include additional information (e.g., shipment attributes, shipment identifiers) for a shipment after the shipment has been created. To update a shipment, you must either,
- Create a new shipment which will then be de-duplicated with the original, or
- Delete the shipment to stop tracking and then create a new shipment with the POST: Initialize a shipment for tracking endpoint [link to Create section].
Delete a Shipment
Use the DELETE: Delete shipment route from project44 endpoint to stop tracking on a shipment. This endpoint can also be used in the first step for updating a shipment. See Update a Shipment [link to update section] for more information.
Endpoint | /api/v4/shipments/{shipmentId}/tracking |
Verb | DELETE |
Required Fields | shipment identifier (AIR_WAYBILL or HOUSE_AIR_WAYBILL ) |