Add tracking information for an Order.

API v2

SDK

Adds tracking information for an Order.

Authorization

AuthorizationBearer <token>

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

Scopes

Manage payments and checkout workflow.https://uri.paypal.com/services/payments/payment

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tracking_numberstring<currency_code>Required

The tracking number for the shipment. This property supports Unicode.

Match^[\S\s]*$Length1 <= length <= 64

carrierenum<shipment_carrier>Required

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 `carrier` to `OTHER` and set carrier name in `carrier_name_other`. For allowed values, see Carriers.

Allowed values

"DPD_RU"
"BG_BULGARIAN_POST"
"KR_KOREA_POST"
"ZA_COURIERIT"
"FR_EXAPAQ"
"ARE_EMIRATES_POST"
"GAC"
"GEIS"
"SF_EX"
"PAGO"
"MYHERMES"
"DIAMOND_EUROGISTICS"

carrier_name_otherstring<currency_code>Optional

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

Match^[\S\s]*$Length1 <= length <= 64

capture_idstringRequired

The PayPal capture ID.

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

notify_payerbooleanOptional

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 `notify_payer`, the payer may receive tracking notifications within the PayPal app, based on the user's notification preferences.

Defaultfalse

itemsobject<tracker_item>[]Optional

An array of details of items in the shipment.

Items0 <= length <= 32767

Response Body

`application/json`

curl -X POST "https://example.com/v2/checkout/orders/5O190127TN364715T/track" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \  -H "Content-Type: application/json" \  -d '{    "capture_id": "8MC585209K746392H",    "tracking_number": "443844607820",    "carrier": "FEDEX",    "notify_payer": false,    "items": [      {        "name": "T-Shirt",        "sku": "sku02",        "quantity": "1",        "upc": {          "type": "UPC-A",          "code": "012345678901"        },        "image_url": "https://www.example.com/example.jpg",        "url": "https://www.example.com/example"      }    ]  }'

{  "id": "5O190127TN364715T",  "status": "COMPLETED",  "purchase_units": [    {      "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b",      "items": [        {          "name": "Air Jordan Shoe",          "sku": "sku01",          "quantity": "1",          "unit_amount": {            "currency_code": "USD",            "value": "50.00"          }        },        {          "name": "T-Shirt",          "sku": "sku02",          "quantity": "1",          "unit_amount": {            "currency_code": "USD",            "value": "50.00"          }        }      ],      "shipping": {        "trackers": [          {            "id": "8MC585209K746392H-443844607820",            "links": [              {                "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",                "rel": "up",                "method": "GET"              },              {                "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820",                "rel": "edit",                "method": "PATCH"              }            ],            "create_time": "2022-08-12T21:20:49Z",            "update_time": "2022-08-12T21:20:49Z"          }        ]      },      "payments": {        "captures": [          {            "id": "8MC585209K746392H",            "status": "COMPLETED",            "amount": {              "currency_code": "USD",              "value": "100.00"            },            "seller_protection": {              "status": "NOT_ELIGIBLE"            },            "final_capture": true,            "seller_receivable_breakdown": {              "gross_amount": {                "currency_code": "USD",                "value": "100.00"              },              "paypal_fee": {                "currency_code": "USD",                "value": "3.00"              },              "net_amount": {                "currency_code": "USD",                "value": "97.00"              }            },            "create_time": "2018-04-01T21:20:49Z",            "update_time": "2018-04-01T21:20:49Z",            "links": [              {                "href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H",                "rel": "self",                "method": "GET"              },              {                "href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund",                "rel": "refund",                "method": "POST"              }            ]          }        ]      }    }  ],  "links": [    {      "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T",      "rel": "self",      "method": "GET"    }  ]}

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tracking_numberstring<currency_code>Required

The tracking number for the shipment. This property supports Unicode.

Match^[\S\s]*$Length1 <= length <= 64

carrierenum<shipment_carrier>Required

Allowed values

"DPD_RU"
"BG_BULGARIAN_POST"
"KR_KOREA_POST"
"ZA_COURIERIT"
"FR_EXAPAQ"
"ARE_EMIRATES_POST"
"GAC"
"GEIS"
"SF_EX"
"PAGO"
"MYHERMES"
"DIAMOND_EUROGISTICS"

carrier_name_otherstring<currency_code>Optional

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

Match^[\S\s]*$Length1 <= length <= 64

capture_idstringRequired

The PayPal capture ID.

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

notify_payerbooleanOptional

Defaultfalse

itemsobject<tracker_item>[]Optional

An array of details of items in the shipment.

Items0 <= length <= 32767

curl -X POST "https://example.com/v2/checkout/orders/5O190127TN364715T/track" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \ -H "Content-Type: application/json" \ -d '{ "capture_id": "8MC585209K746392H", "tracking_number": "443844607820", "carrier": "FEDEX", "notify_payer": false, "items": [ { "name": "T-Shirt", "sku": "sku02", "quantity": "1", "upc": { "type": "UPC-A", "code": "012345678901" }, "image_url": "https://www.example.com/example.jpg", "url": "https://www.example.com/example" } ] }'

{ "id": "5O190127TN364715T", "status": "COMPLETED", "purchase_units": [ { "reference_id": "d9f80740-38f0-11e8-b467-0ed5f89f718b", "items": [ { "name": "Air Jordan Shoe", "sku": "sku01", "quantity": "1", "unit_amount": { "currency_code": "USD", "value": "50.00" } }, { "name": "T-Shirt", "sku": "sku02", "quantity": "1", "unit_amount": { "currency_code": "USD", "value": "50.00" } } ], "shipping": { "trackers": [ { "id": "8MC585209K746392H-443844607820", "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "up", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/trackers/8MC585209K746392H-443844607820", "rel": "edit", "method": "PATCH" } ], "create_time": "2022-08-12T21:20:49Z", "update_time": "2022-08-12T21:20:49Z" } ] }, "payments": { "captures": [ { "id": "8MC585209K746392H", "status": "COMPLETED", "amount": { "currency_code": "USD", "value": "100.00" }, "seller_protection": { "status": "NOT_ELIGIBLE" }, "final_capture": true, "seller_receivable_breakdown": { "gross_amount": { "currency_code": "USD", "value": "100.00" }, "paypal_fee": { "currency_code": "USD", "value": "3.00" }, "net_amount": { "currency_code": "USD", "value": "97.00" } }, "create_time": "2018-04-01T21:20:49Z", "update_time": "2018-04-01T21:20:49Z", "links": [ { "href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H", "rel": "self", "method": "GET" }, { "href": "https://api-m.paypal.com/v2/payments/captures/8MC585209K746392H/refund", "rel": "refund", "method": "POST" } ] } ] } } ], "links": [ { "href": "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T", "rel": "self", "method": "GET" } ]}

Authorization

Path Parameters

Header Parameters

Request Body

tracker_item properties

universal_product_code properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

On this page

Add tracking information for an Order.

Authorization

Path Parameters

Header Parameters

Request Body

tracker_item properties

universal_product_code properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

Add tracking information for an Order.

tracker_item properties

universal_product_code properties

200application/json

201application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

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 an Order.

tracker_item properties

universal_product_code properties

200application/json

201application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`