UpdateOrder
Summary
Change the contents of an Authorized but not Captured order. Use this call to add or remove items in an existing Order, without creating a new orderNumber.
You must provide the entire body of the query, in the same format as Authorize, including all Order Items.
(If you added an item, Update Order must contain previously Authorized items as well. If you removed an item, Update Order must contain the new full list of Order Items.)
If the TotalGrossAmount has increased compared to the Authorize call for this orderNumber, a new Risk Check will be made for the additional amount.
If the additional Risk Check returns a rejection, the original Authorize will remain valid.
Resource URL | /api/v3/orders/{orderNumber}/updateOrder |
---|---|
HTTP method | POST |
Content type | application/json; text/json; |
Input parameters
Parameter name | Location | Type / Model | Description |
---|---|---|---|
orderNumber | path |
required
Order number |
|
request | body | UpdateOrderRequest |
required
Request object |
Responses
HTTP status code | Model | Comment |
---|---|---|
OK(200) | UpdateOrderResponse | Update Order Response |
BadRequest (400) | array of ResponseMessage | Request failed. Check response model for list of Errors. |
Unauthorized (401) | API user is unauthorized. Make sure X-Auth-Key header is sent. | |
InternalServerError (500) | Request failed due internal error. Retry request later. |