Add tracking information for multiple PayPal transactions

Deprecation notice: Adding tracking details for an order through /v1/shipping/trackers-batch is deprecated as its a legacy way of integration. Use the new Orders v2 API to share tracking details with PayPal.

Adds tracking information, with or without tracking numbers, for multiple PayPal transactions. Accepts up to 20 tracking IDs. For more information, see Add tracking information with tracking numbers and Add tracking information without tracking numbers.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Create or update tracking informationhttps://uri.paypal.com/services/shipping/trackers/readwrite

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

trackersobject<tracker>[]Optional

An array of tracking information for shipments.

Items1 <= length <= 20

tracker properties

12 properties

transaction_idstringRequired

The PayPal transaction ID.

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

tracking_numberstringOptional

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

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

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"

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

Response Body

`application/json`

curl -X POST "https://example.com/v1/shipping/trackers-batch" \  -H "Content-Type: application/json" \  -d '{}'

{  "tracker_identifiers": [    {      "transaction_id": "string",      "tracking_number": "string",      "links": [        {          "href": "string",          "rel": "string",          "method": "GET"        }      ]    }  ],  "errors": [    {      "name": "string",      "message": "string",      "debug_id": "string",      "information_link": "string",      "details": [        {          "field": "string",          "value": "string",          "location": "body",          "issue": "string",          "description": "string",          "links": [            {              "href": "string",              "rel": "string",              "method": "GET"            }          ]        }      ],      "links": [        {          "href": "string",          "rel": "string",          "method": "GET"        }      ]    }  ],  "links": [    {      "href": "string",      "rel": "string",      "method": "GET"    }  ]}

{ "tracker_identifiers": [ { "transaction_id": "string", "tracking_number": "string", "links": [ { "href": "string", "rel": "string", "method": "GET" } ] } ], "errors": [ { "name": "string", "message": "string", "debug_id": "string", "information_link": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string", "links": [ { "href": "string", "rel": "string", "method": "GET" } ] } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ] } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ]}

Authorization

Request Body

tracker properties

Response Body

`application/json`

`application/json`

On this page

On this page

On this page

Add tracking information for multiple PayPal transactions

Authorization

Request Body

tracker properties

Response Body

`application/json`

`application/json`

On this page

On this page

Add tracking information for multiple PayPal transactions

Authorization

Request Body

tracker properties

Response Body

200application/json

400

403

404

500

defaultapplication/json

On this page

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

Add tracking information for multiple PayPal transactions

Authorization

Request Body

tracker properties

Response Body

200application/json

400

403

404

500

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`