POST /v2/checkout/orders/{id}/track
Adds tracking information for an Order.
Servers
- https://api-m.sandbox.paypal.com
- https://api-m.paypal.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
String | Yes |
The ID of the order that the tracking information is associated with. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
PayPal-Auth-Assertion |
String | No |
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
capture_id |
String | Yes |
The PayPal capture ID. |
notify_payer |
Boolean | No |
If true, PayPal will send an email notification to the payer of the PayPal transaction. The email contains the tracking details provided through the Orders tracking API request. Independent of any value passed for Default value: false |
carrier |
String | No |
The carrier for the shipment. 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 Possible values:
|
items[] |
Array | No |
An array of details of items in the shipment. |
items[].name |
String | No |
The item name or title. |
items[].sku |
String | No |
The stock keeping unit (SKU) for the item. This can contain unicode characters. |
items[].url |
String | No |
The URL to the item being purchased. Visible to buyer and used in buyer experiences. |
items[].quantity |
String | No |
The item quantity. Must be a whole number. |
items[].upc |
Object | No |
The Universal Product Code of the item. |
items[].upc.type |
String | Yes |
The Universal Product Code type. Possible values:
|
items[].upc.code |
String | Yes |
The UPC product code of the item. |
items[].image_url |
String | No |
The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. |
carrier_name_other |
String | No |
The name of the carrier for the shipment. Provide this value only if the carrier parameter is OTHER. This property supports Unicode. |
tracking_number |
String | No |
The tracking number for the shipment. This property supports Unicode. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.