The tracking number for the shipment. This property supports only ASCII characters and does not allow URL, phone number, or email formats. Carrier information (`carrier`) is required if a tracking number is provided.

Match^.*$Length1 <= length <= 64

tracking_number_typeenum<tracking_number_type>Optional

The type of tracking number.

Match^[0-9A-Z_]+$Length1 <= length <= 64

Allowed values

"CARRIER_PROVIDED"
"E2E_PARTNER_PROVIDED"

statusenum<tracking_status>Required

The status of the item shipment. For allowed values, see Shipping Statuses.

Match^[A-Z_]+$Length1 <= length <= 64

Allowed values

"CANCELLED"
"DELIVERED"
"LOCAL_PICKUP"
"ON_HOLD"
"SHIPPED"
"SHIPMENT_CREATED"
"DROPPED_OFF"
"IN_TRANSIT"
"RETURNED"
"LABEL_PRINTED"
"ERROR"
"UNCONFIRMED"

shipment_datestring<date_no_time>Optional

The date when the shipment occurred, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

carrierstring<carrier>Optional

The carrier for the shipment. Carrier information is required when tracking_number is provided. Some carriers have a global version as well as local subsidiaries. The subsidiaries are repeated over many countries and might also have an entry in the global list. Choose the carrier for your country. If the carrier is not available for your country, choose the global version of the carrier. If your carrier name is not in the list, set `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For allowed values, see Carriers.

Match^.*$Length1 <= length <= 64

carrier_name_otherstringOptional

The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER.

Match^.*$Length1 <= length <= 64

postage_payment_idstringOptional

The postage payment ID.

Match^.*$Length1 <= length <= 64

notify_buyerbooleanOptional

If true , sends an email notification to the buyer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.

Defaultfalse

quantityintegerOptional

The quantity of items shipped.

Range1 <= value <= 22

tracking_number_validatedbooleanOptional

Indicates whether the carrier validated the tracking number.

last_updated_timestring<date_time>Optional

The date and time when the tracking information was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

shipment_directionenumOptional

To denote whether the shipment is sent forward to the receiver or returned back.

Match^[A-Z]*$Length1 <= length <= 50

Allowed values

"FORWARD"
"RETURN"

shipment_uploaderenumOptional

To denote which party uploaded the shipment tracking info.

Match^[A-Z]*$Length1 <= length <= 50

Allowed values

"MERCHANT"
"CONSUMER"
"PARTNER"

account_idstringOptional

Encrypted PayPal Account ID of the buyer or seller.

Match^[2-9A-HJ-NP-Z]{13}$Length13 <= length <= 13

tracking_urlstringOptional

Tracking Link of the shipment.

Match^.*$FormaturiLength1 <= length <= 250

fulfillment_providerstringOptional

Indicates the fulfillment service used to deliver an order.

Match^.*$Length1 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 2

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this link, in [URI template format](https://tools.ietf.org/html/rfc6570). Include the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

methodenumOptional

The HTTP method required to make the related call.

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 2

link_description properties

3 properties

hrefstringRequired

relstringRequired

methodenumOptional

The HTTP method required to make the related call.

Back to top

Tracker Collection

The add tracking information for one or more transactions response details.

trackersobject<tracker>[]Optional

An array of tracking information for shipments.

Items1 <= length <= 20

tracker properties

18 properties

transaction_idstringRequired

The PayPal transaction ID.

Match^[a-zA-Z0-9]*$Length1 <= length <= 50

tracking_numberstringOptional

Match^.*$Length1 <= length <= 64

tracking_number_typeenum<tracking_number_type>Optional

The type of tracking number.

Match^[0-9A-Z_]+$Length1 <= length <= 64

Allowed values

"CARRIER_PROVIDED"
"E2E_PARTNER_PROVIDED"

statusenum<tracking_status>Required

The status of the item shipment. For allowed values, see Shipping Statuses.

Match^[A-Z_]+$Length1 <= length <= 64

Allowed values

"CANCELLED"
"DELIVERED"
"LOCAL_PICKUP"
"ON_HOLD"
"SHIPPED"
"SHIPMENT_CREATED"
"DROPPED_OFF"
"IN_TRANSIT"
"RETURNED"
"LABEL_PRINTED"
"ERROR"
"UNCONFIRMED"

shipment_datestring<date_no_time>Optional

The date when the shipment occurred, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Formatppaas_date_notime_v2Length10 <= length <= 10

carrierstring<carrier>Optional

Match^.*$Length1 <= length <= 64

carrier_name_otherstringOptional

The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER.

Match^.*$Length1 <= length <= 64

postage_payment_idstringOptional

The postage payment ID.

Match^.*$Length1 <= length <= 64

notify_buyerbooleanOptional

If true , sends an email notification to the buyer of the PayPal transaction. The email contains the tracking information that was uploaded through the API.

Defaultfalse

quantityintegerOptional

The quantity of items shipped.

Range1 <= value <= 22

tracking_number_validatedbooleanOptional

Indicates whether the carrier validated the tracking number.

last_updated_timestring<date_time>Optional

The date and time when the tracking information was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

shipment_directionenumOptional

To denote whether the shipment is sent forward to the receiver or returned back.

Match^[A-Z]*$Length1 <= length <= 50

Allowed values

"FORWARD"
"RETURN"

shipment_uploaderenumOptional

To denote which party uploaded the shipment tracking info.

Match^[A-Z]*$Length1 <= length <= 50

Allowed values

"MERCHANT"
"CONSUMER"
"PARTNER"

account_idstringOptional

Encrypted PayPal Account ID of the buyer or seller.

Match^[2-9A-HJ-NP-Z]{13}$Length13 <= length <= 13

tracking_urlstringOptional

Tracking Link of the shipment.

Match^.*$FormaturiLength1 <= length <= 250

fulfillment_providerstringOptional

Indicates the fulfillment service used to deliver an order.

Match^.*$Length1 <= length <= 64

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 2

link_description properties

3 properties

hrefstringRequired

relstringRequired

methodenumOptional

The HTTP method required to make the related call.

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Items1 <= length <= 2

link_description properties

3 properties

hrefstringRequired

relstringRequired

methodenumOptional

The HTTP method required to make the related call.

Tracker Collection

tracker properties

link_description properties

link_description properties

Back to top

On this page

On this page

Tracker Collection

tracker properties

link_description properties

link_description properties

Back to top

On this page

Tracker Collection

tracker properties

link_description properties

link_description properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Tracker Collection

tracker properties

link_description properties

link_description properties

Back to top

On this page