Order Update

PUT https://api.ecartapi.com/api/v2/orders/{{id}}

Update an order's information.

Important information:

The order's ID must exist

Request Body

{"order"=>{"billingAddress"=>{"address1"=>"Fake Street", "city"=>"Fake", "company"=>"Inc", "country"=>{"code"=>"CA", "name"=>"Canada"}, "firstName"=>"Jane", "lastName"=>"Doe", "phone"=>"555-555-5555", "postalCode"=>"K2P 1L4", "state"=>{"code"=>"ON", "name"=>"Ontario"}}, "payment"=>{"method"=>"Venmo"}, "currency"=>"MXN", "items"=>[{"discount"=>"0", "quantity"=>"1", "sku"=>"3452345", "taxable"=>"false", "variantId"=>"52"}], "shippingAddress"=>{"address1"=>"Fake Street", "city"=>"Fake", "company"=>"Inc", "country"=>{"code"=>"CA", "name"=>"Canada"}, "firstName"=>"Jane", "lastName"=>"Doe", "phone"=>"555-555-5555", "postalCode"=>"K2P 1L4", "state"=>{"code"=>"ON", "name"=>"Ontario"}}, "status"=>{"status"=>"paid"}, "tags"=>["imported"], "taxesIncluded"=>"false", "totals"=>{"discount"=>"0", "subtotal"=>"90", "tax"=>"10", "total"=>"100", "weight"=>"300"}, "note"=>"New note"}}

HEADERS

Key Datatype Required Description
Authorization string
Content-Type string

RESPONSES

status: OK

{"success":true,"order":{"id":"804","number":"804","marketPlaceId":null,"groupId":null,"name":"804","email":null,"fulfillmentStatus":{"id":null,"status":"unfulfilled","ecartapi":"unfulfilled","partiallAvailable":"false"},"currency":"MXN","totals":{"subtotal":"16","total":"16.00","tax":"0.00","discount":"0.00","weight":null,"shipping":null},"taxesIncluded":"false","taxLines":[],"units":{"weight":null},"status":{"id":null,"status":"processing","financial":"paid","ecartapi":"paid","ecartapiId":"1"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"Venmo","status":"paid"},"customer":{"id":0,"email":null,"firstName":null,"lastName":null,"phone":null,"ecartapiUrl":"https://api.ecartapi.com/api/v2/customers/0","company":null},"billingAddress":{"id":null,"firstName":"Jane","lastName":"Doe","dni":null,"address1":"Fake Street","address2":null,"address3":null,"country":{"code":"CA","name":"Canada","codeIso2":"CA","codeIso3":"CAN"},"state":{"code":"ON","name":"Ontario","codeIso2":null,"codeIso3":null},"city":"Fake","postalCode":"K2P 1L4","phone":"555-555-5555","company":"Inc","references":null},"shippingMethod":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"Jane","lastName":"Doe","dni":null,"address1":"Fake Street","address2":null,"address3":null,"country":{"code":"CA","name":"Canada","codeIso2":"CA","codeIso3":"CAN"},"state":{"code":"ON","name":"Ontario","codeIso2":null,"codeIso3":null},"city":"Fake","postalCode":"K2P 1L4","phone":"555-555-5555","company":"Inc","references":null},"items":[{"id":"320","variantId":null,"productId":"52","sku":"3452345","fulfillment":{"quantity":null,"service":null,"status":null},"name":"Test Product","upc":null,"requiresShipping":null,"quantity":"1","price":"8","discount":null,"associatedItems":[],"bundled":null,"tax":null,"taxable":"false","weight":null,"vendor":null,"imageUrl":null,"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/52"},{"id":"321","variantId":null,"productId":"52","sku":"3452345","fulfillment":{"quantity":null,"service":null,"status":null},"name":"Test Product","upc":null,"requiresShipping":null,"quantity":"1","price":"8","discount":null,"associatedItems":[],"bundled":null,"tax":null,"taxable":"false","weight":null,"vendor":null,"imageUrl":null,"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/52"}],"packages":[],"meta":{"_new_order_email_sent":"true"},"dates":{"canceledAt":null,"closedAt":null,"createdAt":"2021-12-02T19:39:47","updatedAt":"2021-12-02T19:43:49","paidAt":"2021-12-02T19:43:49"},"cancelReason":null,"note":null,"locations":[],"checkoutId":null,"partialFulfillment":null}}