Skip to main content

Update or cancel tracking information for an order

PATCH 
/orders/:id/trackers/:tracker_id

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

AttributeOpNotes
itemsreplaceUsing replace op for items will replace the entire items object with the value sent in request.
notify_payerreplace, add
statusreplaceOnly patching status to CANCELLED is currently supported.

Request​

Path Parameters

    id stringrequired

    Possible values: non-empty and <= 36 characters, Value must match regular expression ^[A-Z0-9]+$

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

    tracker_id stringrequired

    Possible values: non-empty and <= 36 characters, Value must match regular expression ^[A-Z0-9]+$

    The order tracking ID.

Header Parameters

    Authorization stringrequired

    To make REST API calls, include the bearer token in this header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id:secret>.

    PayPal-Auth-Assertion string

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

    Content-Type stringrequired

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9/+-]+$

    The media type. Required for operations with a request body. The value is application/<format>, where format is json.

Body

    any

Responses​

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

Loading...