Get all orders

GET https://api.ecartapi.com/api/v2/orders

FILTERS

FilterDescription
limitLimit size of the search
pagePagination number.
nameFilter orders by name
'status[status]'Filter orders by status
offetDefinte the quantity of elements to skip in the next filtering
'createdAt[from]'Filter orders by date created from. When used createdAt[to]
'createdAt[to]'Filter orders by date created to. When used createdAt[from]

Request Params

KeyDatatypeRequiredDescription
limitstring
pagestring
namestring
createdAt[from]string
createdAt[to]string
updatedAt[from]string
updatedAt[to]string

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"success":true,"orders":[{"id":"247","number":"247","marketPlaceId":null,"groupId":null,"name":"247","packsId":null,"email":"daniela.zapata@envia.com","fulfillmentStatus":{"id":null,"status":"unfulfilled","ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"false"},"currency":"USD","discountsCoupon":[],"totals":{"subtotal":"34","total":"34.00","tax":"0.00","discount":"0.00","weight":null,"shipping":"0.00"},"taxesIncluded":"false","taxLines":[],"units":{"weight":null},"status":{"id":null,"status":"pending","financial":"pending","ecartapi":"pending","ecartapiId":"2"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"bacs","status":"pending","ecartapi":null},"customer":{"id":"2","email":"daniela.zapata@envia.com","firstName":"Daniela","lastName":"Zapata","phone":"8111111111","identificationNumber":null,"company":null,"ecartapiUrl":"http://localhost:3000/api/v2/customers/2"},"refunds":[],"billingAddress":{"id":null,"firstName":"Daniela","lastName":"Zapata","dni":null,"identificationNumber":null,"address1":"Av 2","address2":"905","address3":null,"country":{"code":"MX","name":null,"codeIso2":null,"codeIso3":null},"state":{"code":"CO","name":null,"codeIso2":null,"codeIso3":null},"city":"Monclova","postalCode":"25720","phone":"8111111111","email":"daniela.zapata@envia.com","company":null,"references":null},"logistic":{"mode":null,"type":null,"free":"false","direction":null},"shippingMethod":null,"shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"Daniela","lastName":"Zapata","dni":null,"identificationNumber":null,"address1":"Av 2","address2":"905","address3":null,"country":{"code":"MX","name":null,"codeIso2":null,"codeIso3":null},"state":{"code":"CO","name":null,"codeIso2":null,"codeIso3":null},"city":"Monclova","postalCode":"25720","phone":"8111111111","email":"daniela.zapata@envia.com","company":null,"references":null},"items":[{"id":"44","variantId":null,"productId":"119","offerId":null,"inventoryId":null,"sku":"abc122010","fulfillment":{"quantity":null,"service":null,"status":null},"name":"Test Product 10","upc":null,"requiresShipping":null,"quantity":"1","currentQuantity":null,"price":"17.00","discount":null,"associatedItems":[],"bundled":null,"tax":"0.00","taxable":"false","weight":null,"vendor":null,"imageUrl":null,"ecartapiUrl":"http://localhost:3000/api/v2/products/119"},{"id":"45","variantId":null,"productId":"93","offerId":null,"inventoryId":null,"sku":"abc123022","fulfillment":{"quantity":null,"service":null,"status":null},"name":"Test Product4","upc":null,"requiresShipping":null,"quantity":"1","currentQuantity":null,"price":"17.00","discount":null,"associatedItems":[],"bundled":null,"tax":"0.00","taxable":"false","weight":null,"vendor":null,"imageUrl":null,"ecartapiUrl":"http://localhost:3000/api/v2/products/93"}],"packages":[],"meta":{},"dates":{"estimatedDeliveryIn":null,"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2023-07-13T19:39:29","updatedAt":"2023-07-13T19:42:21","paidAt":null},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":null,"fraudRisk":null,"events":[]}]}