Skip to main content
PATCH
/
v2
/
checkout
/
orders
/
{id}
/
trackers
/
{tracker_id}
Update or cancel tracking information for an order
curl --request PATCH \
  --url https://api-m.sandbox.paypal.com/v2/checkout/orders/{id}/trackers/{tracker_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
[
  {
    "op": "replace",
    "path": "/purchase_units/@reference_id=='PUHF'/shipping/address",
    "value": {
      "address_line_1": "2211 N First Street",
      "address_line_2": "Building 17",
      "admin_area_2": "San Jose",
      "admin_area_1": "CA",
      "postal_code": "95131",
      "country_code": "US"
    }
  }
]
EOF
{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "details": [
    {
      "issue": "FIELD_NOT_PATCHABLE",
      "field": "<string>",
      "value": "<string>",
      "location": "body",
      "description": "Field cannot be patched."
    }
  ],
  "debug_id": "<string>",
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

Authorization
string
header
required

Oauth 2.0 authentication

Headers

PayPal-Auth-Assertion
string

An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.

Path Parameters

id
string
required

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

Required string length: 1 - 36
tracker_id
string
required

The order tracking ID.

Required string length: 1 - 36

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.

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.

Response

A successful request returns the HTTP 204 No Content status code with an empty object in the JSON response body.