On this page
No Headings
Last updated: August 17, 2026
When a merchant adds a tracking number, the Add Tracking API expects one of the following shipping statuses.
Note: A merchant is not required to update the shipping status each time the shipment status changes. Update the status only once when you update the tracking number.
| Status | Description | Use status when |
|---|---|---|
SHIPPED | The item was shipped and is on the way. | The recommended status. |
ON_HOLD | The item is on hold. | The item might be held up in customs or is on hold for another reason. |
DELIVERED | When the tracking number was uploaded, the item had already been delivered. | |
CANCELLED | The shipment was cancelled and the tracking number no longer applies. | The user wants to indicate that a tracking number is no longer valid. |
Use Tracking API to track
Integrate PayPal's Add Tracking API to manage tracking numbers, update or cancel tracking details, and display tracking information for your transactions.
Carriers
Choose the appropriate global or country-specific carrier when adding or updating tracking info with PayPal's Add Tracking API.