# Tracking APIs

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


Version: 0.1

## Servers

```
https://api-dev.sendpro360.pitneycloud.com/shippingtracking
```

```
https://api-qa.sendpro360.pitneycloud.com/shippingtracking
```

Sandbox Server
```
https://api-sandbox.sendpro360.pitneybowes.com/shippingtracking
```

Production Server (uses live data)
```
https://api.sendpro360.pitneybowes.com/shippingtracking
```

Sandbox Server for Canada
```
https://api-ppd.shipping360.pitneybowes.com/ca/shippingtracking
```

Production Server for Canada
```
https://api.shipping360.pitneybowes.com/ca/shippingtracking
```

## Security

### basicAuth

Type: http
Scheme: basic

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Tracking APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/tracking.yaml)

## Tracking

APIs for retrieving shipment tracking details and managing tracking subscriptions.

### Get Shipment Tracking Details

 - [GET /api/v1/tracking/{trackingNumber}](https://docs.sendpro360.pitneycloud.com/openapi/tracking/tracking/getshipmenttrackingdetails.md): Get Shipment Tracking Details

### Subscribe Tracking Details

 - [GET /api/v1/track/{trackingNumber}/subscribe](https://docs.sendpro360.pitneycloud.com/openapi/tracking/tracking/subscribeshipmenttrackingdetails.md): Subscribe To Shipment Tracking Details