Get orders
GET https://api.ecartapi.com/api/v2/orders
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | Limits the number of orders in the response.The default value of this parameter is 50. The maximum value of this parameter is 100 | |
ids | string | Filters orders by their unique identification numbers. Send ID values separated by comas. EX: 1,2,3,4 | |
status[ecartapi] | string | Filters orders by the ecartapi status categories. Only allows values listed. | |
status[status] | string | Filters orders by the e-commerce status categories. Only allows the values listed. | |
createdAt[from] | string | Filters orders created after a specific date. | |
createdAt[to] | string | Required to send createdAt[from]. Filters orders created before a specific date. | |
updatedAt[from] | string | Filters orders updated after a specific date. | |
updatedAt[to] | string | Required to send updatedAt[from]. Filters orders updated before a specific date. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"success":true,"orders":[{"id":"2750000094-A","number":"2750000094-A","marketPlaceId":"Website","groupId":null,"name":"2750000094-A","packsId":null,"email":null,"fulfillmentStatus":{"id":null,"status":"SHIPPING","ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","currencyExtension":null,"discountsCoupon":[],"totals":{"subtotal":"1600","total":"800","tax":null,"discount":null,"weight":null,"shipping":"0"},"totalsExtension":{"subtotal":null,"total":null,"tax":null,"discount":null,"shipping":null},"taxesIncluded":"true","taxLines":[],"units":{"weight":null},"status":{"id":null,"status":"SHIPPING","financial":"paid","ecartapi":"other","ecartapiId":"5"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"creditCard","status":"paid","ecartapi":null},"customer":{"id":"2181750260","email":null,"firstName":"IVAN ","lastName":"GARCIA ","phone":"55-12345678","identificationNumber":null,"company":null,"ecartapiUrl":null},"refunds":[],"billingAddress":{"id":null,"firstName":"IVAN GARCIA","lastName":".","dni":null,"identificationNumber":null,"address1":"MARIO PANI NUM 200","address2":"10174501","interiorNumber":null,"address3":"ESTELLA DE SANTAFE","country":{"code":"MEX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":null,"name":"CIUDAD DE MEXICO","codeIso2":null,"codeIso3":null},"city":"ALVARO OBREGON","postalCode":"01210","phone":"52-00000000","email":null,"company":null,"references":null},"logistic":{"mode":null,"type":null,"free":"false","direction":null},"shippingMethod":"Home delivery","shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"IVAN","lastName":"GARCIA ","dni":null,"identificationNumber":null,"address1":"AZTECAS","address2":"123","interiorNumber":null,"address3":"CRUZ MANCA","country":{"code":"MEX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":null,"name":"CIUDAD DE MEXICO","codeIso2":null,"codeIso3":null},"city":"CUAJIMALPA DE MORELOS","postalCode":"05349","phone":"55-12345678","email":null,"company":null,"references":null},"items":[{"id":"2750000094-A-1","variantId":"10132","productId":"10132","offerId":null,"inventoryId":null,"sku":"1030430693","productType":null,"fulfillment":{"quantity":null,"service":null,"status":"SHIPPING"},"name":"BICICLETA ALUBIKE PRUEBA VARIANTES 03-02","upc":null,"requiresShipping":null,"quantity":"1","currentQuantity":null,"price":"1600","priceExtension":null,"discount":null,"discountExtension":null,"associatedItems":[],"bundled":null,"tax":null,"taxable":null,"weight":null,"vendor":null,"imageUrl":null,"ecartapiUrl":"http://localhost:3000/api/v2/products/10132"}],"packages":[],"dimensions":{"height":null,"length":null,"width":null},"meta":null,"dates":{"estimatedDeliveryIn":null,"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2023-10-24T23:23:04Z","updatedAt":"2023-10-27T19:36:44Z","paidAt":"2023-10-27T19:36:39.249Z"},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":null,"fraudRisk":null,"events":[]},{"id":"3710000083-A","number":"3710000083-A","marketPlaceId":"Website","groupId":null,"name":"3710000083-A","packsId":null,"email":null,"fulfillmentStatus":{"id":null,"status":"SHIPPING","ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","currencyExtension":null,"discountsCoupon":[],"totals":{"subtotal":"1600","total":"800","tax":null,"discount":null,"weight":null,"shipping":"0"},"totalsExtension":{"subtotal":null,"total":null,"tax":null,"discount":null,"shipping":null},"taxesIncluded":"true","taxLines":[],"units":{"weight":null},"status":{"id":null,"status":"SHIPPING","financial":"paid","ecartapi":"other","ecartapiId":"5"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"creditCard","status":"paid","ecartapi":null},"customer":{"id":"2181750260","email":null,"firstName":"IVAN ","lastName":"GARCIA ","phone":"55-12345678","identificationNumber":null,"company":null,"ecartapiUrl":null},"refunds":[],"billingAddress":{"id":null,"firstName":"IVAN GARCIA","lastName":".","dni":null,"identificationNumber":null,"address1":"MARIO PANI NUM 200","address2":"10174501","interiorNumber":null,"address3":"ESTELLA DE SANTAFE","country":{"code":"MEX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":null,"name":"CIUDAD DE MEXICO","codeIso2":null,"codeIso3":null},"city":"ALVARO OBREGON","postalCode":"01210","phone":"52-00000000","email":null,"company":null,"references":null},"logistic":{"mode":null,"type":null,"free":"false","direction":null},"shippingMethod":"Home delivery","shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"IVAN","lastName":"GARCIA ","dni":null,"identificationNumber":null,"address1":"AZTECAS","address2":"123","interiorNumber":null,"address3":"CRUZ MANCA","country":{"code":"MEX","name":"Mexico","codeIso2":"MX","codeIso3":"MEX"},"state":{"code":null,"name":"CIUDAD DE MEXICO","codeIso2":null,"codeIso3":null},"city":"CUAJIMALPA DE MORELOS","postalCode":"05349","phone":"55-12345678","email":null,"company":null,"references":null},"items":[{"id":"3710000083-A-1","variantId":"10132","productId":"10132","offerId":null,"inventoryId":null,"sku":"1030430693","productType":null,"fulfillment":{"quantity":null,"service":null,"status":"SHIPPING"},"name":"BICICLETA ALUBIKE PRUEBA VARIANTES 03-02","upc":null,"requiresShipping":null,"quantity":"1","currentQuantity":null,"price":"1600","priceExtension":null,"discount":null,"discountExtension":null,"associatedItems":[],"bundled":null,"tax":null,"taxable":null,"weight":null,"vendor":null,"imageUrl":null,"ecartapiUrl":"http://localhost:3000/api/v2/products/10132"}],"packages":[],"dimensions":{"height":null,"length":null,"width":null},"meta":null,"dates":{"estimatedDeliveryIn":null,"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2023-10-24T22:24:32Z","updatedAt":"2023-10-27T19:37:36Z","paidAt":"2023-10-27T19:37:30.743Z"},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":null,"fraudRisk":null,"events":[]}]}