Update Order (Magento 2)

Updates the order provided with the information sent in the payload.

Payload specifications

status.status allowed values:

on_hold, pending, paid, cancelled, refunded.

Status value reference table:

You will find the comparisson between the ecartapi status required to be sent on the payload and its Magento 2 equivalent with a short description.

EcartAPIMagento 2Status description
on_holdpending_paymentThe payment is pending, and still to be paid
pendingprocessingThe order is paid and is currently in process
paidprocessingThe order is paid and is currently in process
cancelledcanceledThe order has been cancelled
refundedrefundedThe payment has been refunded
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the order.

Body Params
order
object

Order fields to update.

Response

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