Update order

Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the `COMPLETED` status.

To make an update, you must provide a `reference_id`. If you omit this value with an order that contains only one purchase unit, PayPal sets the value to `default` which enables you to use the path: \"/purchase_units/@reference_id=='default'/{attribute-or-object}\". Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout.

Note: For error handling and troubleshooting, see Orders v2 errors.

Patchable attributes or objects:

Attribute	Op	Notes
`intent`	replace
`payer`	replace, add	Using replace op for `payer` will replace the whole `payer` object with the value sent in request.
`purchase_units`	replace, add
`purchase_units[].custom_id`	replace, add, remove
`purchase_units[].description`	replace, add, remove
`purchase_units[].payee.email`	replace
`purchase_units[].shipping.name`	replace, add
`purchase_units[].shipping.email_address`	replace, add
`purchase_units[].shipping.phone_number`	replace, add
`purchase_units[].shipping.options`	replace, add
`purchase_units[].shipping.address`	replace, add
`purchase_units[].shipping.type`	replace, add
`purchase_units[].soft_descriptor`	replace, remove
`purchase_units[].amount`	replace
`purchase_units[].items`	replace, add, remove
`purchase_units[].invoice_id`	replace, add, remove
`purchase_units[].payment_instruction`	replace
`purchase_units[].payment_instruction.disbursement_mode`	replace	By default, `disbursement_mode` is `INSTANT`.
`purchase_units[].payment_instruction.payee_receivable_fx_rate_id`	replace, add, remove
`purchase_units[].payment_instruction.platform_fees`	replace, add, remove
`purchase_units[].supplementary_data.airline`	replace, add, remove
`purchase_units[].supplementary_data.card`	replace, add, remove
`application_context.client_configuration`	replace, add

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage payments and checkout workflow.https://uri.paypal.com/services/payments/payment
Allows client-side integration on Create, Get, Patch, Authorize & Capture Order endpoints.https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants

Path Parameters

id*string

The ID of the order to update.

Match^[A-Z0-9]+$

Length1 <= length <= 36

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

PayPal-Auth-Assertion?string

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.

Match^.*$

Length1 <= length <= 10000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PATCH "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \  -H "Content-Type: application/json" \  -d '[    {      "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"      }    }  ]'

Empty

{
  "name": "INVALID_REQUEST",
  "details": [
    {
      "field": "/purchase_units/@reference_id=='Reference ID 2'/shipping/address",
      "value": "x",
      "location": "body",
      "issue": "INVALID_PARAMETER_SYNTAX",
      "description": "The value of a field does not conform to the expected format."
    }
  ],
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "debug_id": "f087ef02ffdb6",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-INVALID_PARAMETER_SYNTAX",
      "rel": "information_link",
      "method": "GET"
    }
  ]
}

{
  "name": "AUTHENTICATION_FAILURE",
  "debug_id": "b1d1f06c7246c",
  "message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}

{
  "name": "NOT_AUTHORIZED",
  "debug_id": "b1d1f06c7246c",
  "message": "Authorization failed due to insufficient permissions."
}

{
  "name": "RESOURCE_NOT_FOUND",
  "debug_id": "b1d1f06c7246c",
  "message": "The specified resource does not exist."
}

{
  "name": "UNPROCESSABLE_ENTITY",
  "details": [
    {
      "field": "/payer",
      "issue": "PAYER_PATCH_NOT_ALLOWED",
      "description": "Payer path patch is not allowed after payer has approved the order.",
      "location": "body"
    }
  ],
  "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
  "debug_id": "90957fca61718",
  "links": [
    {
      "href": "https://developer.paypal.com/api/orders/v2/#error-PAYER_PATCH_NOT_ALLOWED",
      "rel": "information_link",
      "method": "GET"
    }
  ]
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

Attribute

Notes

intent

replace

payer

replace, add

Using replace op for payer will replace the whole payer object with the value sent in request.

purchase_units

replace, add

purchase_units[].custom_id

replace, add, remove

purchase_units[].description

replace, add, remove

purchase_units[].payee.email

replace

purchase_units[].shipping.name

replace, add

purchase_units[].shipping.email_address

replace, add

purchase_units[].shipping.phone_number

replace, add

purchase_units[].shipping.options

replace, add

purchase_units[].shipping.address

replace, add

purchase_units[].shipping.type

replace, add

purchase_units[].soft_descriptor

replace, remove

purchase_units[].amount

replace

purchase_units[].items

replace, add, remove

purchase_units[].invoice_id

replace, add, remove

purchase_units[].payment_instruction

replace

purchase_units[].payment_instruction.disbursement_mode

replace

By default, disbursement_mode is INSTANT.

purchase_units[].payment_instruction.payee_receivable_fx_rate_id

replace, add, remove

purchase_units[].payment_instruction.platform_fees

replace, add, remove

purchase_units[].supplementary_data.airline

replace, add, remove

purchase_units[].supplementary_data.card

replace, add, remove

application_context.client_configuration

replace, add

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage payments and checkout workflow.https://uri.paypal.com/services/payments/payment
Allows client-side integration on Create, Get, Patch, Authorize & Capture Order endpoints.https://uri.paypal.com/services/payments/orders/deprecating-jssdk-migration-for-limited-merchants

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

PayPal-Auth-Assertion?string

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.

Match^.*$

Length1 <= length <= 10000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \ -H "Content-Type: application/json" \ -d '[ { "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" } } ]'

{ "name": "INVALID_REQUEST", "details": [ { "field": "/purchase_units/@reference_id=='Reference ID 2'/shipping/address", "value": "x", "location": "body", "issue": "INVALID_PARAMETER_SYNTAX", "description": "The value of a field does not conform to the expected format." } ], "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "debug_id": "f087ef02ffdb6", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-INVALID_PARAMETER_SYNTAX", "rel": "information_link", "method": "GET" } ] }

{ "name": "UNPROCESSABLE_ENTITY", "details": [ { "field": "/payer", "issue": "PAYER_PATCH_NOT_ALLOWED", "description": "Payer path patch is not allowed after payer has approved the order.", "location": "body" } ], "message": "The requested action could not be performed, semantically incorrect, or failed business validation.", "debug_id": "90957fca61718", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-PAYER_PATCH_NOT_ALLOWED", "rel": "information_link", "method": "GET" } ] }

Update order

204

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Update order

204

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`