put
https://api.ecartapi.com/api/v2/orders/
Updates an Order.
The body should only contain the fields that need to be updated.
The fields that are omitted will not be changed.
To remove a product from an order, set that product’s quantity to 0.
Important information:
The order's Identifier must exist.
Request payload options.
| Key | Values |
|---|---|
| Status | pending, in process, paid, cancelled, refunded |
Order Status Descriptions
THE STATUSES LISTED IN THE TABLE DO NOT REPRESENT ECARTAPI STATUSES THIS IS A DETAILED LIST OF BIGCOMMERCE STATUSES FOR REFERENCE.
| STATUS ID | NAME | DESCRIPTION |
|---|---|---|
| 0 | Incomplete | An incomplete order happens when a shopper reached the payment page, but did not complete the transaction. |
| 1 | Pending | Customer started the checkout process, but did not complete it. |
| 2 | Shipped | Order has been shipped, but receipt has not been confirmed; seller has used the Ship Items action. |
| 3 | Partially Shipped | Only some items in the order have been shipped, due to some products being pre-order only or other reasons. |
| 4 | Refunded | Seller has used the Refund action. |
| 5 | Cancelled | Seller has cancelled an order, due to a stock inconsistency or other reasons. |
| 6 | Declined | Seller has marked the order as declined for lack of manual payment, or other reasons. |
| 7 | Awaiting Payment | Customer has completed checkout process, but payment has yet to be confirmed. |
| 8 | Awaiting Pickup | Order has been pulled, and is awaiting customer pickup from a seller-specified location. |
| 9 | Awaiting Shipment | Order has been pulled and packaged, and is awaiting collection from a shipping provider. |
| 10 | Completed | Client has paid for their digital product and their file(s) are available for download. |
| 11 | Awaiting Fulfillment | Customer has completed the checkout process and payment has been confirmed. |
| 12 | Manual Verification Required | Order is on hold while some aspect needs to be manually confirmed. |
| 13 | Disputed | Customer has initiated a dispute resolution process for the PayPal transaction that paid for the order. |
| 14 | Partially Refunded | Seller has partially refunded the order. |