Order
PUT https://api.ecartapi.com/api/v2/orders/{{id}}
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. |
More information about the ecommerce's resource.
Request Body
{"order"=>{"status"=>{"id"=>"11", "status"=>"paid"}, "note"=>"This is a test note", "customer"=>{"id"=>"2"}, "billingAddress"=>{"firstName"=>"Jane", "lastName"=>"Doe", "address1"=>"123 Main Street", "address2"=>"Testing Av", "city"=>"Austin", "state"=>{"name"=>"Texas"}, "postalCode"=>"78751", "country"=>{"name"=>"United States", "code"=>"US"}, "email"=>"janedoe@email.com"}, "shippingAddress"=>{"firstName"=>"Trish", "lastName"=>"Test", "company"=>"Acme Pty Ltd", "address1"=>"666 Sussex St", "address2"=>"Testing av", "city"=>"Austin", "state"=>{"name"=>"Texas"}, "postalCode"=>"78751", "country"=>{"name"=>"United States", "code"=>"US"}, "email"=>"elsie@example.com"}, "items"=>[{"name"=>"[Sample] Fog Linen Chambray Towel - Beige Stripe", "quantity"=>"1", "price"=>"50.5", "tax"=>"0.50"}]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Authorization | string |
RESPONSES
status: OK
{"success":true,"order":{"id":"103","number":"103","marketPlaceId":null,"groupId":null,"name":null,"email":"janedoe@email.com","fulfillmentStatus":{"id":null,"status":null,"ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","totals":{"subtotal":"275.50","total":"275.50","tax":"0.50","discount":"0.00","weight":null,"shipping":null},"taxesIncluded":"true","taxLines":[],"units":{"weight":null},"status":{"id":null,"status":"Incomplete","financial":null,"ecartapi":"pending","ecartapiId":"2"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"Manual","status":"pending"},"customer":{"id":"2"},"billingAddress":{"id":null,"firstName":"Jane","lastName":"Doe","dni":null,"address1":"123 Main Street","address2":"Testing Av","address3":null,"country":{"code":"US","name":"United States","codeIso2":"US","codeIso3":"USA"},"state":{"code":"TX","name":"Texas","codeIso2":null,"codeIso3":null},"city":"Austin","postalCode":"78751","phone":"4921347491","company":null,"references":null},"shippingMethod":null,"shippingLabel":null,"shippingAddress":{},"items":[],"packages":[],"meta":null,"dates":{"canceledAt":null,"closedAt":null,"createdAt":"2021-12-10T22:56:02.000Z","updatedAt":"2021-12-10T22:57:06.000Z","paidAt":null},"cancelReason":null,"note":null,"locations":[],"checkoutId":null,"partialFulfillment":null}}