Skip to main content
PATCH
/
v2
/
checkout
/
orders
/
{id}
Update order
curl --request PATCH \
  --url https://api-m.sandbox.paypal.com/v2/checkout/orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "op": "add",
    "path": "<string>",
    "value": "<any>",
    "from": "<string>"
  }
]'
This response does not have an example.

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 <a href="https://developer.paypal.com/api/rest/requests/#paypal-auth-assertion">PayPal-Auth-Assertion</a>.

Path Parameters

id
string
required

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

Required string length: 1 - 36

Body

application/json · Patch · object[]

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

op
enum<string>
required

The operation.

Available options:
add,
remove,
replace,
move,
copy,
test
path
string

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

value
any

The value to apply. The <code>remove</code>, <code>copy</code>, and <code>move</code> operations do not require a value. Since <a href="https://www.rfc-editor.org/rfc/rfc69021">JSON Patch</a> allows any type for <code>value</code>, the <code>type</code> property is not specified.

from
string

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

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

I