Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
trackers

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}

Path parameters

idstring required

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

tracker_idstring required

The order tracking ID.

Headers

Authorizationstring

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.

Holds authorization information for external API calls.

PayPal-Auth-Assertionstring

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.

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.

Request body

op'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' required

The operation.

pathstring

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location at which to complete the operation.

{"stackTrail":"components:schemas:patch:properties:value","oasType":"schema","type":"unknown","title":"Patch Value","description":"The value to apply. The <code>remove</code> operation does not require a value."}
fromstring

The <a href="https://tools.ietf.org/html/rfc6901">JSON Pointer</a> to the target document location from which to move the value. Required for the <code>move</code> operation.

Response

No Content.