Add Package Tracking / Reference / Shipping Statuses

Add Tracking API Shipping Statuses

APICurrentLast updated: October 18th 2021, @ 3:21:59 pm


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.

StatusDescriptionUse status when
SHIPPEDThe item was shipped and is on the way.The recommended status.
ON_HOLDThe item is on hold.The item might be held up in customs or is on hold for another reason.
DELIVEREDWhen the tracking number was uploaded, the item had already been delivered.
CANCELLEDThe shipment was cancelled and the tracking number no longer applies.The user wants to indicate that a tracking number is no longer valid.
ReferencePayPal.comPrivacyCookiesSupportLegalContact