Order

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

Update orders information.

When notification is set to true the client of the order will receive and email regarding their order being updated.

Allowed values for body.

status.status - paid, pending, refunded, cancelled, deleted, authorized, shipped:

Request Body

{"order"=>{"shippingAddress"=>{"firstName"=>"Ecart", "lastName"=>"Shipping", "email"=>"admin@ecartapi.com", "phone"=>"8120749663", "address1"=>"Line 1", "address2"=>"Line 2", "country"=>{"name"=>"Mexico", "code"=>"MEX"}, "state"=>{"name"=>"Nuevo Leon", "code"=>"NL"}, "city"=>"Monclova", "postalcode"=>"25720", "company"=>"ECartapi"}, "status"=>{"status"=>"cancelled"}, "notification"=>"true", "note"=>"Cancelled"}}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring

RESPONSES

status: OK

{"success":true,"order":{"id":"5","number":"5","marketPlaceId":null,"groupId":null,"name":null,"email":"fake@email.com","fulfillmentStatus":{"id":null,"status":null,"ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"false"},"currency":"USD","totals":{"subtotal":null,"total":"105.00","tax":null,"discount":null,"weight":null,"shipping":null},"taxesIncluded":null,"taxLines":[],"units":{"weight":null},"status":{"id":"15","status":"Processed","financial":null,"ecartapi":"authorized","ecartapiId":"7"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"Cash On Delivery","status":"paid"},"customer":{"id":null,"email":"fake@email.com","phone":"8111111111","ecartapiUrl":null},"billingAddress":{"id":null,"firstName":"Daniela","lastName":"Zapata","dni":null,"address1":"Belisario Dominguez","address2":"Obispado","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":"NL","name":"Nuevo Leon","codeIso2":null,"codeIso3":null},"city":"Monterrey","postalCode":"64060","phone":"8111111111","email":null,"company":null,"references":null},"shippingMethod":"Flat Shipping Rate","shippingLabel":null,"shippingAddress":{"id":null,"firstName":"Daniela","lastName":"Zapata","dni":null,"address1":"Belisario Dominguez","address2":"Obispado","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":"NL","name":"Nuevo Leon","codeIso2":null,"codeIso3":null},"city":"Monterrey","postalCode":"64060","phone":null,"email":null,"company":null,"references":null},"items":[],"packages":[],"meta":null,"dates":{"canceledAt":null,"closedAt":null,"createdAt":"2022-02-02 00:27:34","updatedAt":"2022-02-03 00:10:10","paidAt":null},"cancelReason":null,"note":"Testing","locations":[],"checkoutId":null,"partialFulfillment":null,"companyId":"0"}}