Update or cancel tracking information for an order

Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:<br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody></tr><tr><td><code>items</code></td><td>replace</td><td>Using replace op for <code>items</code> will replace the entire <code>items</code> object with the value sent in request.</td></tr><tr><td><code>notify_payer</code></td><td>replace, add</td><td></td></tr><tr><td><code>status</code></td><td>replace</td><td>Only patching status to CANCELLED is currently supported.</td></tr></tbody></table>

PATCH /v2/checkout/orders/{id}/trackers/{tracker_id}

cURL

orders_trackers_patch_add_notify-payer

curl --request PATCH \
  --url https://api-m.paypal.com/v2/checkout/orders/{id}/trackers/{tracker_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "add",
    "path": "/notify_payer",
    "value": true
  }
]
'

400

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "debug_id": "2f541ace12987",
  "details": [
    {
      "field": "/notify_payer",
      "issue": "INVALID_PARAMETER_VALUE",
      "description": "The value of a field is invalid.",
      "location": "body"
    }
  ],
  "links": [
    {
      "href": "https://developer.paypal.com/docs/api/orders/v2/#error-INVALID_PARAMETER_VALUE",
      "rel": "information_link",
      "method": "GET"
    }
  ]
}

Authorizations

Authorization · string · header · required

Oauth 2.0 authentication

Headers

Authorization · string

Holds authorization information for external API calls. Standard headers are generally less restrictive in structure due to historical precedent across browsers, etc. This is a common schema for use in defining most standard headers.

Required string length: 1 - 16000

Pattern: ^.*$

PayPal-Auth-Assertion · string

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Required string length: 1 - 10000

Pattern: ^.*$

Path Parameters

id · string · required

The ID of the order that the tracking information is associated with.

Required string length: 1 - 36

Pattern: ^[A-Z0-9]+$

tracker_id · string · required

The order tracking ID.

Required string length: 1 - 36

Pattern: ^[A-Z0-9]+$

Body

application/json

Maximum array length: 32767

op · enum<string> · required

The operation.

Available options: add, remove, replace, move, copy, test

path · string

The JSON Pointer to the target document location at which to complete the operation.

Maximum string length: 2147483647

Pattern: ^[\S\s]*$

value · any

The value to apply. The remove, copy, and move operations do not require a value. Since JSON Patch allows any type for value, the type property is not specified.

from · string

The JSON Pointer to the target document location from which to move the value. Required for the move operation.

Maximum string length: 2147483647

Pattern: ^[\S\s]*$

Response

204

No Content.