Tracking APIs (0.1)

The Tracking APIs provide operations to retrieve shipment tracking details and manage tracking subscriptions across supported carriers. These APIs enable access to shipment status and event history using a tracking number, supporting visibility into shipment progress and delivery.

They support both on-demand tracking retrieval and subscription-based tracking, allowing systems to monitor shipment progress and receive updates as tracking events occur.

Tracking Number

A unique identifier assigned to a shipment, used to retrieve tracking details.

Carrier

Identifies the shipping carrier associated with the tracking number. Supported values include USPS, UPS, FEDEX, and DHLEXP.

Tracking Events

A collection of shipment status updates representing the lifecycle of a shipment (e.g., accepted, in transit, out for delivery, delivered).

• Tracking details are retrieved using the trackingNumber and carrier parameter
• The response includes a list of tracking events representing shipment progress
• Subscription API allows enabling or disabling tracking updates using the subscribe parameter:
  • true: Subscribes to tracking updates
  • false: Unsubscribes from tracking updates
• Subscribed tracking provides updated tracking event information in the response
• Each request includes a unique X-PB-TransactionId for tracking and auditing