Trackers

Use the /trackers resource to update and retrieve tracking information for PayPal orders.

Update or cancel tracking information for a PayPal order

patch

https://api-m.sandbox.paypal.comhttps://api-m.paypal.com

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

Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects:

Attribute	Op	Notes
items	replace	Using replace op for items will replace the entire items object with the value sent in request.
notify_payer	replace, add
status	replace	Only patching status to CANCELLED is currently supported.

Required scopes

This endpoint requires the following scopes:

• : Manage payments and checkout workflow.

Authorizations

Oauth2

OAuth2clientCredentialsRequired

Oauth 2.0 authentication

Token URL:

Path parameters

idstring · min: 1 · max: 36Required

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

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

tracker_idstring · min: 1 · max: 36Required

The order tracking ID.

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

Bodyobject · Patch[]

application/json

An array of JSON patch objects to apply partial updates to resources.

opstring · enumRequired

The operation.

Possible values:

pathstringOptional

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

valueanyOptional

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.

fromstringOptional

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

Responses

204

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

400

Request is not well-formed, syntactically incorrect, or violates schema.

application/json

403

Authorization failed due to insufficient permissions.

application/json

404

The specified resource does not exist.

application/json

422

The requested action could not be performed, semantically incorrect, or failed business validation.

application/json

500

An internal server error has occurred.

application/json

default

The default response.

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /v2/checkout/orders/{id}/trackers/{tracker_id} HTTP/1.1
Host: api-m.sandbox.paypal.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 250

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

No content