Ecartapi.com Public API Documentation
Get all orders
GET https://api.ecartapi.com/api/v2/orders
Note:
Filters are available depending of the ecommerce
Body
PARAM
| 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 uppe Curl curl -X GET 'https://api.ecartapi.com/api/v2/orders?page=String || Integer.&limit=Integer.&ids=String.&sinceId=String.&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[financial]=Values subject to ecommerce.&status[ecartapi]=[ pending, authorized, paid, partially_paid, refunded, partially_refunded, cancelled, delete, shipped, other ]&fulfillmentStatus=Values subject to ecommerce.&allStores=Boolean. [true, false]&offset=Integer. [1...1000]&search=String. [ customer@email.com ]&recent=Boolean. [true, false]&sort=String. [ asc, desc ]&draft=Boolean. [true, false]&status[status]=Values subject to ecommerce.' -H 'Authorization: access_token' ENDPOINTS |