Export Orders
GET {{baseUrl}}/exports/orders?filter_orders=month&template_id=-1&format=csv&from_date=<dateTime>&to_date=<dateTime>
This endpoint allows you to export orders in excel format (xlsx or csv). Advance configurations are possible using the available query parameters.
Scope: orders.read- Orders Read Only
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter_orders | string | (Required) Filter orders by specifying one of the enum values | |
template_id | number | (Required) Provide the template_id if the store has order-export-templates feature enabled on the store. Query the list of templates from this endpoint. Default export template_id is set to -1 | |
format | string | (Required) Choose a format from the enum values, either xlsx or csv, if the store has order-export-templates feature enabled on the store. Recommended format is xlsx | |
from_date | string | Filter from date. Required if the query parameter filter_orders is set to dates | |
to_date | string | Filter to date. Required if the query parameter filter_orders is set to dates |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"message":"\u003cstring\u003e"}}