Update or cancel tracking information for PayPal transaction

Updates or cancels the tracking information for a PayPal transaction, by ID. To cancel tracking information, call this method and set the status to CANCELLED. A maximum of 5 updates are allowed for each tracking information. For more information, see Update or cancel tracking information.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

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

Scopes

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

Path Parameters

id*string

The ID of the tracker in the transaction_id-tracking_number format.

Match^[a-zA-Z0-9-_]*$

Length1 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://api-m.paypal.com/v1/shipping/v1/shipping/trackers/string" \  -H "Content-Type: application/json" \  -d '{    "transaction_id": "string",    "status": "CANCELLED"  }'

Empty

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

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

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

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

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

Path Parameters

id*string

The ID of the tracker in the transaction_id-tracking_number format.

Match^[a-zA-Z0-9-_]*$

Length1 <= length <= 100

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

transaction_id*string

The PayPal transaction ID.

Match^[a-zA-Z0-9]*$

Length1 <= length <= 50

tracking_number?string

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_type?Tracking Number Type

The type of tracking number.

Match^[0-9A-Z_]+$

Length1 <= length <= 64

Value in"CARRIER_PROVIDED" | "E2E_PARTNER_PROVIDED"

status*Tracking Status

The status of the item shipment. For allowed values, see Shipping Statuses.

Match^[A-Z_]+$

Length1 <= length <= 64

Value in

"CANCELLED" | "DELIVERED" | "LOCAL_PICKUP" | "ON_HOLD" | "SHIPPED" | "SHIPMENT_CREATED" | "DROPPED_OFF" | "IN_TRANSIT" | "RETURNED" | "LABEL_PRINTED" | "ERROR" | "UNCONFIRMED" | "PICKUP_FAILED" | "DELIVERY_DELAYED" | "DELIVERY_SCHEDULED" | "DELIVERY_FAILED" | "INRETURN" | "IN_PROCESS" | "NEW" | "VOID" | "PROCESSED" | "NOT_SHIPPED" | "COMPLETED"

shipment_date?date_no_time

The date when the shipment occurred, in Internet date and time format.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Formatppaas_date_notime_v2

Length10 <= length <= 10

carrier?Carrier

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_other?string

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

Match^.*$

Length1 <= length <= 64

notify_buyer?boolean

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_time?date_time

The date and time when the tracking information was last updated, in Internet date and time format.

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_v3

Length20 <= length <= 64

shipment_direction?string

To denote whether the shipment is sent forward to the receiver or returned back.

Match^[A-Z]*$

Length1 <= length <= 50

Value in"FORWARD" | "RETURN"

tracking_url?string

Tracking Link of the shipment.

Match^.*$

Formaturi

Length1 <= length <= 250

fulfillment_provider?string

Indicates the fulfillment service used to deliver an order.

Match^.*$

Length1 <= length <= 64

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

Update or cancel tracking information for PayPal transaction

204

400application/json

403application/json

422application/json

500application/json

defaultapplication/json

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Update or cancel tracking information for PayPal transaction

204

400application/json

403application/json

422application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`