Parcel Visibility

Easily track parcel shipments within project44's network by providing shipment identifiers and receive real-time updates throughout the transportation journey.

Overview

project44's Parcel Visibility enables users to:

• Access configurable push notifications to ensure internal and external teams have access to the same shipment information
• Reduce excess inventory and the need for safety stock with accurate delivery data
• Accelerate the time it takes to update customers on deliveries
• Integrate directly with other modes for full E2E shipment visibility

Use the following information to write a client application to integrate your TMS or other system to the project44 platform through our Unified Shipment Tracking API.

Prerequisites

Before creating a parcel shipment, ensure you have the following:

1. Authentication: Set up proper authentication to access project44's APIs.
2. Shipment Identifiers: Have valid parcel tracking identifiers you want to start tracking.

Create a Shipment

Easily create a parcel shipment to be tracked within project44's network by providing at least one shipment identifier. Complete these steps to create and view your parcel shipment:

1. Make a POST request to /api/v4/shipments/tracking with your parcel identifiers as part of the request payload. For parcel tracking, use TRACKING_NUMBER, CAPACITY_PROVIDER_ACCOUNT_CODE and CAPACITY_PROVIDER_ACCOUNT_GROUP together. Example request payload:

{
  "identifiers": [
    {
      "type": "TRACKING_NUMBER",
      "value": "1Z999AA1234567890"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_CODE",
      "value": "12345"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_GROUP",
      "value": "GROUP123"
    }
  ]
}

2. After making the request, check for a 200 OK HTTP response status code, indicating your shipment was successfully created.
3. Examine the response payload and locate the shipmentShareLink property. This link directs you to the Movement application, where you can view the shipment details and monitor real-time updates as they occur.
4. Save the id field from the response payload - this is the project44-generated shipment ID (UUID format) that you'll need for subsequent operations.
5. Optionally, integrate with our shipment webhook to receive real-time updates programmatically.

Get Shipment

Retrieve detailed information about your parcel shipment including tracking data, events, and status throughout its transportation journey. Complete these steps to retrieve your shipment information:

1. Prepare a GET request to /api/v4/shipments/{shipmentId}/tracking.
2. Replace {shipmentId} in the URL path with the project44-generated shipment ID (UUID format) that you received when creating the shipment.
3. Send the request with proper authentication headers.
4. Check for a 200 OK HTTP response status code, indicating the request was successful.
5. Examine the response payload for detailed shipment information including stops, events, tracking updates, and current status.

Delete a Shipment

Stop tracking a parcel shipment and completely remove it from the project44 system and UI. Complete these steps to delete your shipment:

1. Prepare a DELETE request to /api/v4/shipments/{shipmentId}/tracking.
2. Replace {shipmentId} in the URL path with the project44-generated shipment ID (UUID format) of the shipment you want to delete.
3. Send the request with proper authentication headers.
4. Check for a 200 OK HTTP response status code, indicating your shipment was successfully deleted and removed from the system.