Get all orders
GET https://api.ecartapi.com/api/v2/orders
Get's all orders from the shopify store.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | Sets the max value of documents to be returned by the requests | |
createdAt[from] | string | Filters result by the date set from til today. Can be used with createdAt[to] to set a range of dates to filter. | |
createdAt[to] | string | Must be used with createdAt[from], Filters results between a range of dates | |
updatedAt[from] | string | Filters result by the date set from til today. Can be used with updatedAt[to] to set a range of dates to filter. | |
updatedAt[to] | string | Must be used with updatedAt[from], Filters results between a range of dates | |
draft | boolean | This allows to request only draft orders | |
search | string | Filters results by the number of the order |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"success":true,"orders":[{"id":"1160942288996","number":"15","name":"#1015","fulfillmentStatus":null,"subtotalPrice":"0.00","totalPrice":"10.00","totalTax":"10.00","totalDiscounts":"0.00","currency":"MXN","taxesIncluded":"false","totalWeight":"300","weightUnit":"g","status":"paid","locationId":null,"reference":null,"tags":["imported"],"payment":null,"billingAddress":{"id":null,"firstName":"Alex","lastName":"de la Cruz","address1":"123 Fake Street","address2":null,"country":{"code":"CA","name":"Canada"},"state":{"code":"ON","name":"Ontario"},"city":"Fakecity","postalcode":"K2P 1L4","phone":"555-555-5555","company":"envia.com","references":null},"shippingAddress":{"id":null,"firstName":"John","lastName":"Silver","address1":"123 Fake Street","address2":null,"country":{"code":"CA","name":"Canada"},"state":{"code":"ON","name":"Ontario"},"city":"Fakecity","postalcode":"K2P 1L4","phone":"555-555-5555","company":"envia.com","references":null},"products":[{"id":"2479528837220","variantId":"26432842956900","sku":null,"fulfillableQuantity":"1","fulfillmentService":"manual","fulfillmentStatus":null,"name":"Burton Custom Freestyle 151","requiresShipping":"true","quantity":"1","price":"0.00","totalDiscount":"0.00","taxable":"false","vendor":"Burton"},{"id":"2479528869988","variantId":"26756554817636","sku":null,"fulfillableQuantity":"2","fulfillmentService":"manual","fulfillmentStatus":null,"name":"Burton Custom Freestyle 151","requiresShipping":"true","quantity":"2","price":"0.00","totalDiscount":"0.00","taxable":"false","vendor":"Burton"}],"cancelReason":null,"canceledAt":null,"closedAt":null,"createdAt":"2019-05-21T13:27:20-04:00","updatedAt":"2019-05-21T13:27:21-04:00","note":null},{"id":"1152569442404","number":"14","name":"#1014","fulfillmentStatus":null,"subtotalPrice":"0.00","totalPrice":"10.00","totalTax":"10.00","totalDiscounts":"0.00","currency":"MXN","taxesIncluded":"false","totalWeight":"300","weightUnit":"g","status":"paid","locationId":null,"reference":null,"tags":["imported"],"payment":null,"billingAddress":{"id":null,"firstName":"Alex","lastName":"de la Cruz","address1":"123 Fake Street","address2":null,"country":{"code":"CA","name":"Canada"},"state":{"code":"ON","name":"Ontario"},"city":"Fakecity","postalcode":"K2P 1L4","phone":"555-555-5555","company":"envia.com","references":null},"shippingAddress":{"id":null,"firstName":"John","lastName":"Silver","address1":"123 Fake Street","address2":null,"country":{"code":"CA","name":"Canada"},"state":{"code":"ON","name":"Ontario"},"city":"Fakecity","postalcode":"K2P 1L4","phone":"555-555-5555","company":"envia.com","references":null},"products":[{"id":"2464544424036","variantId":"26432842956900","sku":null,"fulfillableQuantity":"1","fulfillmentService":"manual","fulfillmentStatus":null,"name":"Burton Custom Freestyle 151","requiresShipping":"true","quantity":"1","price":"0.00","totalDiscount":"0.00","taxable":"false","vendor":"Burton"},{"id":"2464544456804","variantId":"26756554817636","sku":null,"fulfillableQuantity":"2","fulfillmentService":"manual","fulfillmentStatus":null,"name":"Burton Custom Freestyle 151","requiresShipping":"true","quantity":"2","price":"0.00","totalDiscount":"0.00","taxable":"false","vendor":"Burton"}],"cancelReason":null,"canceledAt":null,"closedAt":null,"createdAt":"2019-05-16T18:12:10-04:00","updatedAt":"2019-05-16T18:12:10-04:00","note":null},{"id":"1152569245796","number":"13","name":"#1013","fulfillmentStatus":null,"subtotalPrice":"0.00","totalPrice":"10.00","totalTax":"10.00","totalDiscounts":"0.00","currency":"MXN","taxesIncluded":"false","totalWeight":"300","weightUnit":"g","status":"paid","locationId":null,"reference":null,"tags":["imported"],"payment":null,"billingAddress":{"id":null,"firstName":"Alex","lastName":"de la Cruz","address1":"123 Fake Street","address2":null,"country":{"code":"CA","name":"Canada"},"state":{"code":"ON","name":"Ontario"},"city":"Fakecity","postalcode":"K2P 1L4","phone":"555-555-5555","company":"envia.com","references":null},"shippingAddress":{"id":null,"firstName":"John","lastName":"Silver","address1":"123 Fake Street","address2":null,"country":{"code":"CA","name":"Canada"},"state":{"code":"ON","name":"Ontario"},"city":"Fakecity","postalcode":"K2P 1L4","phone":"555-555-5555","company":"envia.com","references":null},"products":[{"id":"2464544129124","variantId":"26432842956900","sku":null,"fulfillableQuantity":"1","fulfillmentService":"manual","fulfillmentStatus":null,"name":"Burton Custom Freestyle 151","requiresShipping":"true","quantity":"1","price":"0.00","totalDiscount":"0.00","taxable":"false","vendor":"Burton"},{"id":"2464544161892","variantId":"26756554817636","sku":null,"fulfillableQuantity":"2","fulfillmentService":"manual","fulfillmentStatus":null,"name":"Burton Custom Freestyle 151","requiresShipping":"true","quantity":"2","price":"0.00","totalDiscount":"0.00","taxable":"false","vendor":"Burton"}],"cancelReason":null,"canceledAt":null,"closedAt":null,"createdAt":"2019-05-16T18:11:58-04:00","updatedAt":"2019-05-16T18:11:58-04:00","note":null}]}