Add tracking information for multiple PayPal transactions
POST {{base_url}}/v1/shipping/trackers-batch
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.
Request Body
{"trackers"=>[{"transaction_id"=>"{{capture_id}}", "status"=>"SHIPPED", "tracking_number"=>"{{tracking_number}}", "carrier"=>"FEDEX", "tracking_number_type"=>"CARRIER_PROVIDED", "shipment_date"=>"{{todays_date}}", "carrier_name_other"=>"FEDEX Ground", "notify_buyer"=>true, "quantity"=>1, "tracking_number_validated"=>true}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | |
PayPal-Request-Id | string | The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. | |
PayPal-Client-Metadata-Id | string | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | |
PayPal-Partner-Attribution-Id | string | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | |
PayPal-Auth-Assertion | string | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: OK
{"tracker_identifiers":[{"transaction_id":"48X89590M5437603C","tracking_number":"1643783291","links":[{"href":"https://api.sandbox.paypal.com/v1/shipping/trackers/48X89590M5437603C-1643783291","rel":"self","method":"GET","encType":"application/json"},{"href":"https://api.sandbox.paypal.com/v1/shipping/trackers/48X89590M5437603C-1643783291","rel":"replace","method":"PUT","encType":"application/json"}]}],"errors":[],"links":[{"href":"https://api.sandbox.paypal.com/v1/shipping/trackers-batch","rel":"self","method":"POST","encType":"application/json"}]}