Qodex.ai

Get all orders

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

Gets a list of orders using the filter query.

More information about the ecommerce's resource.

Request Params

KeyDatatypeRequiredDescription
limitstringSets the max number of results to return
createdAt[from]stringFilter results by date. When this is sent alone it will filter from the date given to todays date. To filter in a range of time send createdAt[to] as a complement.
createdAt[to]stringFilter results by date. To be used with createdAt[from]
status[status]stringFilter orders by status
pagestringIndex of page of results to be returned.
sortstringDefault: desc. Sort direction. Acceptable values: asc or desc
updatedAt[from]string
updatedAt[to]string

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring

RESPONSES

status: OK

{"success":true,"orders":[{"id":"119","number":"119","marketPlaceId":null,"groupId":null,"name":null,"packsId":null,"email":"fake@ecartapi.com","fulfillmentStatus":{"id":null,"status":"Awaiting Payment","ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","discountsCoupon":[],"totals":{"subtotal":"56.84","total":"174.00","tax":"24.00","discount":0,"weight":null,"shipping":null},"taxesIncluded":"true","taxLines":[],"units":{"weight":null},"status":{"id":"7","status":"Awaiting Payment","financial":null,"ecartapi":"authorized","ecartapiId":"7"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"Pagar en la tienda","status":"pending","ecartapi":"2"},"customer":{"id":"0","email":"fake@ecartapi.com","firstName":"Rolando Eliudt","lastName":"casa","phone":"+528126196200","identificationNumber":null,"company":null,"ecartapiUrl":"http://localhost:3000/api/v2/customers/0"},"refunds":[],"billingAddress":{"id":null,"firstName":"Rolando Eliudt","lastName":"casa","dni":null,"identificationNumber":null,"address1":"Segunda casa antes de la esquina","address2":"5","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":null,"name":"Nuevo León","codeIso2":null,"codeIso3":null},"city":"CIUDAD SANTA CATARINA","postalCode":"66369","phone":"+528126196200","email":"fake@ecartapi.com","company":null,"references":null},"logistic":{"mode":null,"type":null,"free":"false","direction":null},"shippingMethod":null,"shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"Rolando Eliudt","lastName":"casa","dni":null,"identificationNumber":null,"address1":"Segunda casa antes de la esquina","address2":"5","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":null,"name":"Nuevo León","codeIso2":null,"codeIso3":null},"city":"CIUDAD SANTA CATARINA","postalCode":"66369","phone":"+528126196200","email":"fake@ecartapi.com","company":null,"references":null},"items":[],"packages":[],"meta":null,"dates":{"estimatedDeliveryIn":null,"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2023-07-06T22:49:38.000Z","updatedAt":"2023-07-06T22:49:38.000Z","paidAt":null},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":null,"fraudRisk":null,"events":[]},{"id":"118","number":"118","marketPlaceId":null,"groupId":null,"name":null,"packsId":null,"email":"fake@ecartapi.com","fulfillmentStatus":{"id":null,"status":"Awaiting Payment","ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","discountsCoupon":[],"totals":{"subtotal":"172.26","total":"172.26","tax":"23.76","discount":0,"weight":null,"shipping":null},"taxesIncluded":"true","taxLines":[],"units":{"weight":null},"status":{"id":"7","status":"Awaiting Payment","financial":null,"ecartapi":"authorized","ecartapiId":"7"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"Pagar en la tienda","status":"pending","ecartapi":"2"},"customer":{"id":"2","email":"fake@ecartapi.com","firstName":"Kamerlingh","lastName":"Mosqueda","phone":"9381717689","identificationNumber":null,"company":null,"ecartapiUrl":"http://localhost:3000/api/v2/customers/2"},"refunds":[],"billingAddress":{"id":null,"firstName":"Kamerlingh","lastName":"Mosqueda","dni":null,"identificationNumber":null,"address1":"Zacapu 35","address2":"Volcanes","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":null,"name":"Campeche","codeIso2":null,"codeIso3":null},"city":"Ciudad del carmen","postalCode":"24155","phone":"9381717689","email":"fake@ecartapi.com","company":"SIN CONTEXTO","references":null},"logistic":{"mode":null,"type":null,"free":"false","direction":null},"shippingMethod":null,"shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"Kamerlingh","lastName":"Mosqueda","dni":null,"identificationNumber":null,"address1":"Zacapu 35","address2":"Volcanes","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":null,"name":"Campeche","codeIso2":null,"codeIso3":null},"city":"Ciudad del carmen","postalCode":"24155","phone":"9381717689","email":"fake@ecartapi.com","company":"SIN CONTEXTO","references":null},"items":[],"packages":[],"meta":null,"dates":{"estimatedDeliveryIn":null,"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2023-05-22T23:35:14.000Z","updatedAt":"2023-05-22T23:35:15.000Z","paidAt":null},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":null,"fraudRisk":null,"events":[]},{"id":"117","number":"117","marketPlaceId":null,"groupId":null,"name":null,"packsId":null,"email":"fake@ecartapi.com","fulfillmentStatus":{"id":null,"status":"Shipped","ecartapi":"fulfilled","ecartapiId":"1","partiallAvailable":"true"},"currency":"MXN","discountsCoupon":[],"totals":{"subtotal":"56.84","total":"51.04","tax":"7.04","discount":"5.00","weight":null,"shipping":null},"taxesIncluded":"true","taxLines":[],"units":{"weight":null},"status":{"id":"2","status":"Shipped","financial":"pending","ecartapi":"shipped","ecartapiId":"10"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"Pagar en la tienda","status":"pending","ecartapi":"2"},"customer":{"id":"1","email":"fake@ecartapi.com","firstName":"Víctor","lastName":"Anizar","phone":null,"identificationNumber":null,"company":null,"ecartapiUrl":"http://localhost:3000/api/v2/customers/1"},"refunds":[],"billingAddress":{"id":null,"firstName":"Víctor","lastName":"Anizar","dni":null,"identificationNumber":null,"address1":"Avenida Puerto Mazatlán 225","address2":"Avenida Puerto Mazatlán 225","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":null,"name":"Ciudad de México","codeIso2":null,"codeIso3":null},"city":"Álvaro Obregón","postalCode":"01290","phone":null,"email":"fake@ecartapi.com","company":null,"references":null},"logistic":{"mode":null,"type":null,"free":"false","direction":null},"shippingMethod":null,"shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"Víctor","lastName":"Anizar","dni":null,"identificationNumber":null,"address1":"Avenida Puerto Mazatlán 225","address2":"Avenida Puerto Mazatlán 225","address3":null,"country":{"code":"MX","name":"Mexico","codeIso2":null,"codeIso3":null},"state":{"code":null,"name":"Ciudad de México","codeIso2":null,"codeIso3":null},"city":"Álvaro Obregón","postalCode":"01290","phone":null,"email":"fake@ecartapi.com","company":null,"references":null},"items":[],"packages":[],"meta":null,"dates":{"estimatedDeliveryIn":null,"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2023-04-11T17:53:29.000Z","updatedAt":"2023-06-23T18:02:16.000Z","paidAt":null},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":null,"fraudRisk":null,"events":[]}]}