Edit an order/cart

Edit an entire order or an abandoned cart with its custom fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error cases

Order does not exist (404)

{
    "status": 404,
    "errors": [
        {
            "error_key": "id",
            "error": "wrong_value",
            "error_description": "Record not found for id {ee}."
        }
    ]
}

Update non-editable parameter (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "id",
            "error": "not_updatable_field",
            "error_description": "The field \"id\" can't be updated."
        }
    ]
}

Order validation KO (400)

See failure cases for Create an order/cart ⇒ they will result in a 400 here

Path Params
string
required
.+

Order's external identifier.

Body Params

Order data.

string
string
string
^\d\d\d\d-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01]) (00|[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$

When the order was purchased (local timezone).

number
number
number
number
string
boolean

Order is purchased or not

string
products
array of objects

empty array will erase existing order lines. In order to avoid deleting data, either don't specify 'products' or set it to null

products
custom_fields
array of objects

custom fields is patched too so you can only set some of them, other custom fields will not be changed

custom_fields
Responses

401

Authentication failed.

403

Forbidden.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json