Update order - Paypal API

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}".

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.address`	replace, add
`purchase_units[].shipping.type`	replace, add
`purchase_units[].soft_descriptor`	replace, remove
`purchase_units[].amount`	replace
`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.platform_fees`	replace, add, remove

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Path 参数

order_id

string

必需

示例值:

Header 参数

Content-Type

string

必需

The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.

示例值:

application/json

PayPal-Request-Id

string

必需

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.

示例值:

Body 参数application/json

array of:

string

必需

path

string

必需

value

object | string

必需

address_line_1

string

必需

address_line_2

string

必需

admin_area_2

string

必需

admin_area_1

string

必需

postal_code

string

必需

country_code

string

必需

示例

[
    {
        "op": "add",
        "path": "/purchase_units/@reference_id=='default'/shipping/address",
        "value": {
            "address_line_1": "123 Townsend St",
            "address_line_2": "Floor 6",
            "admin_area_2": "San Francisco",
            "admin_area_1": "CA",
            "postal_code": "94107",
            "country_code": "US"
        }
    },
    {
        "op": "add",
        "path": "/purchase_units/@reference_id=='default'/invoice_id",
        "value": "03012022-3303-01"
    }
]

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢204204 No Content - Add Invoice Number

application/json

Body

object {0}

示例

{}

🟢204204 No Content - Add Shipping Address

🟢204204 No Content - Update Amount To Include Shipping

🟢204204 No Content - Update Seller's Email Address

🟢204204 No Content - Add/Update Multiple Fields

🟠400400 Bad Request - Invalid Parameter Value

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Order Not Found

🟠422422 Unprocessable Entity - Order Already Completed

🟠422422 Unprocessable Entity - Can Not Modify Intent