Ecartapi.com Public API Documentation
Get all orders
GET https://api.ecartapi.com/api/v2/orders
Request to consult All Amazon orders. Information about shipping address and customer might be incomplete. By default this request will fetch only the merchant fulfillable orders (to comply with the use case of creating shipments) if you require all of the order information you must make the Get a single order request Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If age next token is present, that will be used to retrieve the orders instead of other criteria. Amazon has different channels to define the type of orders MFN orders are the only ones available to do fulfillments via third party carriers the rest of the orders Amazon handles them internally
Body
PARAM
| Key | Datatype | Required | Description |
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[ecartapi
|
string | Filter by ecartapi's order general status. | |
status[status]
|
string | Filter by Amazon's order general status | |
limit
|
string | Default value: 50. The maximum number of documents returned in the response | |
page
|
string | Index of page of results to be returned. | |
channel
|
string | Filter orders by channel. |
HEADERS
| Key | Datatype | Required | Description |
Authorization
|
string |
RESPONSES
status OK
| {
"success": true,
"orders": [
{
"id": "407-0094532-5578752",
"number": "407-0094532-5578752",
"marketPlaceId": null,
"groupId": null,
"name": "407-0094532-5578752",
"packsId": null,
"fulfillmentStatus": {
"id": null,
"status": null,
"ecartapi": "unfulfilled",
"ecartapiId": "3",
"partiallAvailable": "true"
},
"currency": null,
"totals": {
"subtotal": null,
"total": null,
"tax": null,
"discount": null,
"weight": null,
"shipping": null
},
"taxesIncluded": "false",
"taxLines": [],
"units": {
"weight": null
},
"status": {
"id": null,
"status": "Canceled",
"financial": "refunded",
"ecartapi": "cancelled",
"ecartapiId": "4"
},
"locationId": null,
"reference": null,
"tags": [],
"payment": {
"method": "Standard",
"status": "pending"
},
"customer": {},
"refunds": [],
"billingAddress": {},
"shippingMethod": "std-in-3",
"shippingOptionReference": null,
"shippingLabel": null,
"shippingAddress": {},
"items": [],
"packages": [],
"meta": null,
"dates": {
"deliveredAt": null,
"canceledAt": null,
"closedAt": null,
"createdAt": "2022-08-16T11:26:25Z",
"updatedAt": "2022-08-16T14:09:40Z",
"paidAt": null
},
"cancelReason": null,
"note": null,
"locations": [],
"localizationExtensions": [],
"checkoutId": null
},
{
"id": "406-3303930-7193129",
"number": "406-3303930-7193129",
"marketPlaceId": null,
"groupId": null,
"name": "406-3303930-7193129",
"packsId": null,
"fulfillmentStatus": {
"id": null,
"status": null,
"ecartapi": "unfulfilled",
"ecartapiId": "3",
"partiallAvailable": "true"
},
"currency": "INR",
"totals": {
"subtotal": null,
"total": "229.00",
"tax": null,
"discount": null,
"weight": null,
"shipping": null,
"discounts": null
},
"taxesIncluded": "false",
"taxLines": [],
"units": {
"weight": null
},
"status": {
"id": null,
"status": "Canceled",
"financial": "refunded",
"ecartapi": "cancelled",
"ecartapiId": "4"
},
"locationId": null,
"reference": null,
"tags": [],
"payment": {
"method": "Standard",
"status": "pending"
},
"customer": {},
"refunds": [],
"billingAddress": {},
"shippingMethod": "std-in-2",
"shippingOptionReference": null,
"shippingLabel": null,
"shippingAddress": {},
"items": [],
"packages": [],
"meta": null,
"dates": {
"deliveredAt": null,
"canceledAt": null,
"closedAt": null,
"createdAt": "2022-08-19T12:17:22Z",
"updatedAt": "2022-08-19T17:19:23Z",
"paidAt": null
},
"cancelReason": null,
"note": null,
"locations": [],
"localizationExtensions": [],
"checkoutId": null
}
],
"page": {
"next": "MtYUsw3RO/KaJqJYLDm0ZAmQazDrhw3CH78zoH+/KhZUojdU4H46tsNI3HOI22PIxqXyQLkGMBs8VhF73Xgy+6+TtJlDlUR5lXub4U9q/932j7w2mEMp7fmDOU6fp6slInTAy+XKVmRZBY+oaVuycwQFure81U/CSPXU3xBX78KdhRjq3crm1Cd7N77Ogfbef2GLmUGyr9UGnxD0RJmrryegoU0IPZxXaD3bvkWLVmuS9sulxl4QFQ0WQaIqQbjEMBO/reDY2s+lLK7IMTJG+oWZaQSHenVJIIYkgmdzyCpNQzRAUqdu/lLe5xTjsfs3Wh6eH2mzao3l3wab3IU13PyAULdxUEMyfKBDPy9ngn0+HfCRefHrbeeEJX/Dp0PtwTLE59NoSBE07YaF+iPCJCmqjtrNH5lJgQNSshBto/xC0eb58D6EUR9rkOl2dKXs/SW4RnODDKo=",
"previous": null
}
} |
Curl
curl -X GET 'https://api.ecartapi.com/api/v2/orders?createdAt[from]=Date. [YYYY-MM-DD]&createdAt[to]=Date. [YYYY-MM-DD]&updatedAt[from]=Date. [YYYY-MM-DD]&updatedAt[to]=Date. [YYYY-MM-DD]&status[ecartapi=String. [pending,shipped,cancelled,on_hold,partially_fulfilled]&status[status]=String. [Pending, Shipped, Canceled,Unshipped,PartiallyShipped]&limit=Integer. [1...100]&page=String. [Page token value]&channel=String [ALL, MFN]' -H 'Authorization: access_token'
ENDPOINTS