Add tracking information for multiple PayPal transactions

POST

/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.

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Header 参数

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.

示例值:

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.

示例值:

Body 参数application/json

trackers

array [object {10}]

必需

transaction_id

string

可选

status

string

可选

tracking_number

string

可选

carrier

string

可选

tracking_number_type

string

可选

shipment_date

string

可选

carrier_name_other

string

可选

notify_buyer

boolean

可选

quantity

integer

可选

tracking_number_validated

boolean

可选

示例

{
  "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
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-m.sandbox.paypal.com/v1/shipping/trackers-batch' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "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
        }
    ]
}'

返回响应

🟢200200 - Add Tracking For Captured Transaction

application/json

Body

tracker_identifiers

array [object {3}]

必需

transaction_id

string

可选

tracking_number

string

可选

links

array [object {4}]

可选

errors

array

必需

links

array [object {4}]

必需

href

string

可选

rel

string

可选

method

string

可选

encType

string

可选

示例

{
  "tracker_identifiers": [
    {
      "transaction_id": "52909142TS941641N",
      "tracking_number": "1681230549",
      "links": [
        {
          "href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/52909142TS941641N-1681230549",
          "rel": "self",
          "method": "GET",
          "encType": "application/json"
        },
        {
          "href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers/52909142TS941641N-1681230549",
          "rel": "replace",
          "method": "PUT",
          "encType": "application/json"
        }
      ]
    }
  ],
  "errors": [],
  "links": [
    {
      "href": "https://api-m.sandbox.paypal.com/v1/shipping/trackers-batch",
      "rel": "self",
      "method": "POST",
      "encType": "application/json"
    }
  ]
}

🟢200200 - Captured Transaction Not Found

🟢200200 - Insufficient Permissions

🟠401401 Unauthorized - Invalid Token

修改于 2023-08-16 07:18:59

Delete webhook

Show tracking information