Get all orders
GET https://api.ecartapi.com/api/v2/orders
Retrieves all order information
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | string | limit results per page Max 50 | |
page | string | Pagination position number | |
status[status] | string | Filter orders by status: created, placed, canceled, archived | |
status[financial] | string | Filter orders by financial status: pending, authorized, partially_paid, paid, partially_refunded, refunded, voided | |
fullfilmentStatus[status] | string | Filter by order status: unfulfilled, not_required, partially_fulfilled, fulfilled | |
Ids | string | Ids separated with ' , ' |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"success":true,"orders":[{"id":"ord_cl0k7c71k00009ot603g2b6ke","number":"1001","marketPlaceId":null,"groupId":null,"name":null,"email":"enrique.carreon@ecart.com","fulfillmentStatus":{"id":null,"status":"unfulfilled","ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","totals":{"subtotal":"100","total":"10100","tax":"14","discount":null,"weight":"1","shipping":null,"discounts":null},"taxesIncluded":"true","taxLines":[],"units":{"weight":"kg"},"status":{"id":null,"status":"placed","financial":"pending","ecartapi":"other","ecartapiId":"5"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"manual","status":"pending"},"customer":{"id":"cus_cl0k7dh0d0000m6o22jsj1lhk","email":"enrique.carreon@ecart.com","firstName":"Enrique","lastName":"Carreon","phone":null,"ecartapiUrl":null,"company":null},"billingAddress":{"id":null,"firstName":"Enrique Carreon","lastName":null,"dni":null,"address1":"Belisario Dominguez, Obispado","address2":"Obispado","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":"NLE","name":"Nuevo León","codeIso2":null,"codeIso3":null},"city":"Monterrey","postalCode":"64000","phone":"8180762604","email":null,"company":null,"references":null},"shippingMethod":"Envío estándar","shippingLabel":null,"shippingAddress":{"id":null,"firstName":"Enrique Carreon","lastName":null,"dni":null,"address1":"Belisario Dominguez, Obispado","address2":"Obispado","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":"NLE","name":"Nuevo León","codeIso2":null,"codeIso3":null},"city":"Monterrey","postalCode":"64000","phone":"8180762604","email":null,"company":null,"references":null},"items":[{"id":"itm_cl0k7c72100019ot6siv00tpd","variantId":"sku_cl0ipt4rd0006v8oihhi43e4s","productId":"prd_cl0ipt4q40000v8oi860o07me","offerId":null,"sku":"Azul","fulfillment":{"quantity":null,"service":null,"status":null},"name":"iMac Updated Azul","upc":null,"requiresShipping":"true","quantity":"1","price":"100","discount":null,"associatedItems":[],"bundled":null,"tax":null,"taxable":"true","weight":"1000","vendor":"Apple","imageUrl":null,"ecartapiUrl":"http://localhost:3000/api/v2/products/prd_cl0ipt4q40000v8oi860o07me"}],"packages":[],"meta":null,"dates":{"canceledAt":null,"closedAt":null,"createdAt":"2022-03-09T23:38:15.000Z","updatedAt":"2022-03-09T23:41:56.000Z","paidAt":null},"cancelReason":null,"note":null,"locations":[],"checkoutId":null,"partialFulfillment":null}]}