PATCH /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. |
Servers
- https://api-m.sandbox.paypal.com
- https://api-m.paypal.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The ID of the order that the tracking information is associated with. |
tracker_id |
String | Yes |
The order tracking ID. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
PayPal-Auth-Assertion |
String | No |
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
[] |
Array | Yes | |
[].op |
String | Yes |
The operation. Possible values:
|
[].value |
No |
The value to apply. The |
|
[].path |
String | No |
The JSON Pointer to the target document location at which to complete the operation. |
[].from |
String | No |
The JSON Pointer to the target document location from which to move the value. Required for the |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.