Get all orders
GET https://api.ecartapi.com/api/v2/orders
Note:
Filters are available depending of the ecommerce
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | Pagination is numbered or by token(only when response includes page object) | |
limit | string | Max amount of documents to be returned in the response. | |
ids | string | List of order identifiers separated by comas. | |
sinceId | string | Request orders since a certain identifier. | |
createdAt[from] | string | Filter orders by range. Requires createdAt[to]. Set the lower treshold. | |
createdAt[to] | string | Filter orders by range. Requires createdAt[from]. Set the upper treshold. | |
updatedAt[from] | string | Filter orders by range. Requires updatedAt[to]. Set the lower treshold. | |
updatedAt[to] | string | Filter orders by range. Requires updatedAt[from]. Set the upper treshold. | |
status[financial] | string | Filter orders by financial status. Values subject to ecommerce | |
status[ecartapi] | string | Filter orders by status. | |
fulfillmentStatus | string | Filter orders by the fulfillment status. Values subject to ecommerce | |
allStores | string | Search items in all stores. | |
offset | string | Lower limit of the results block. Modifies the range of the results provided, range goes from offset to limit | |
search | string | Search by key-word | |
recent | string | Shows the most recent orders, including the ones with dates before e expiration_date and have not been qualified | |
sort | string | Shows orders by ascending or descending dates. | |
draft | string | Shopify Only. | |
status[status] | string | Filter orders by status. Values subject to ecommerce |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"success":true,"orders":[{"id":"4568928878769","number":"1018","marketPlaceId":null,"groupId":null,"name":"#1018","packsId":null,"email":"fake@ecartapi.com","fulfillmentStatus":{"id":null,"status":null,"ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","totals":{"subtotal":"100.00","total":"530.00","tax":"0.00","discount":"0.00","weight":"1.00","shipping":"430.00"},"taxesIncluded":"false","taxLines":[],"units":{"weight":"kg"},"status":{"id":null,"status":"any","financial":"paid","ecartapi":"paid","ecartapiId":"1"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"bogus","status":"paid"},"customer":{"id":"6116894245041","email":"fake@ecartapi.com","firstName":"Daniela","lastName":"Zapata","phone":null,"company":null,"ecartapiUrl":"https://api.ecartapi.com/api/v2/customers/6116894245041"},"refunds":[],"billingAddress":{"id":null,"firstName":"JUST","lastName":"checking out","dni":null,"address1":"Avenida Carrera","address2":null,"address3":null,"country":{"code":"CO","name":"Colombia","codeIso2":null,"codeIso3":null},"state":{"code":"DC","name":"Bogotá, D.C.","codeIso2":null,"codeIso3":null},"city":"cundinamarca","postalCode":"66C30","phone":null,"email":null,"company":null,"references":null},"shippingMethod":"Standard","shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"JUST","lastName":"checking out","dni":null,"address1":"Avenida Carrera","address2":null,"address3":null,"country":{"code":"CO","name":"Colombia","codeIso2":null,"codeIso3":null},"state":{"code":"DC","name":"Bogotá, D.C.","codeIso2":null,"codeIso3":null},"city":"cundinamarca","postalCode":"66C30","phone":null,"email":null,"company":null,"references":null},"items":[{"id":"11700012875953","variantId":"41293246628017","productId":"7096605671601","offerId":null,"inventoryId":null,"sku":"SKU002","fulfillment":{"quantity":"1","service":"manual","status":null},"name":"Ecartapi shirt","upc":null,"requiresShipping":"true","quantity":"1","currentQuantity":null,"price":"100.00","discount":"0.00","associatedItems":[],"bundled":"false","tax":null,"taxable":"true","weight":"1.00","vendor":"ecart-test1","imageUrl":null,"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/7096605671601"}],"packages":[],"meta":null,"dates":{"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2022-07-28T12:49:23-04:00","updatedAt":"2022-07-28T15:34:57-04:00","paidAt":"2022-07-28T12:49:22-04:00"},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":"26545415782577"},{"id":"4568924225713","number":"1017","marketPlaceId":null,"groupId":null,"name":"#1017","packsId":null,"email":"fake@ecartapi.com","fulfillmentStatus":{"id":null,"status":null,"ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"true"},"currency":"MXN","totals":{"subtotal":"100.00","total":"530.00","tax":"0.00","discount":"0.00","weight":"0.45","shipping":"430.00"},"taxesIncluded":"false","taxLines":[],"units":{"weight":"kg"},"status":{"id":null,"status":"any","financial":"paid","ecartapi":"paid","ecartapiId":"1"},"locationId":null,"reference":null,"tags":[],"payment":{"method":"bogus","status":"paid"},"customer":{"id":"6116894245041","email":"fake@ecartapi.com","firstName":"Daniela","lastName":"Zapata","phone":null,"company":null,"ecartapiUrl":"https://api.ecartapi.com/api/v2/customers/6116894245041"},"refunds":[],"billingAddress":{"id":null,"firstName":"JUST","lastName":"checking out","dni":null,"address1":"Avenida Carrera","address2":null,"address3":null,"country":{"code":"CO","name":"Colombia","codeIso2":null,"codeIso3":null},"state":{"code":"DC","name":"Bogotá, D.C.","codeIso2":null,"codeIso3":null},"city":"cundinamarca","postalCode":"66C30","phone":null,"email":null,"company":null,"references":null},"shippingMethod":"Standard","shippingOptionReference":null,"shippingLabel":null,"shippingAddress":{"id":null,"firstName":"JUST","lastName":"checking out","dni":null,"address1":"Avenida Carrera","address2":null,"address3":null,"country":{"code":"CO","name":"Colombia","codeIso2":null,"codeIso3":null},"state":{"code":"DC","name":"Bogotá, D.C.","codeIso2":null,"codeIso3":null},"city":"cundinamarca","postalCode":"66C30","phone":null,"email":null,"company":null,"references":null},"items":[{"id":"11700002390193","variantId":"41380545396913","productId":"7119224045745","offerId":null,"inventoryId":null,"sku":"wms00012","fulfillment":{"quantity":"1","service":"manual","status":null},"name":"Only on wms","upc":null,"requiresShipping":"true","quantity":"1","currentQuantity":null,"price":"100.00","discount":"0.00","associatedItems":[],"bundled":"false","tax":null,"taxable":"true","weight":"0.45","vendor":"ecart-test1","imageUrl":null,"ecartapiUrl":"https://api.ecartapi.com/api/v2/products/7119224045745"}],"packages":[],"meta":null,"dates":{"deliveredAt":null,"canceledAt":null,"closedAt":null,"createdAt":"2022-07-28T12:44:28-04:00","updatedAt":"2022-07-28T12:44:29-04:00","paidAt":"2022-07-28T12:44:27-04:00"},"cancelReason":null,"note":null,"locations":[],"localizationExtensions":[],"checkoutId":"26545377968305"}],"page":{"next":"eyJzdGF0dXMiOiJhbnkiLCJsYXN0X2lkIjo0NTY4OTI0MjI1NzEzLCJsYXN0X3ZhbHVlIjoiMjAyMi0wNy0yOCAxNjo0NDoyOC43MTczNzQiLCJkaXJlY3Rpb24iOiJuZXh0In0","previous":null}}