Light Mode

Export Orders

GET/exports/orders

Last modified: 16 days ago

This endpoint allows you to export orders in excel format (xlsx or csv).

:::tip[Note]
Advance configurations are possible using the available query parameters.
:::

`orders.read`- Orders Read Only

Request

Query Params

filter_orders

enum<string>

required

Filter orders by specifying one of the enum values

Allowed values:

todayweekmonthdates

Example:

week

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

Default:

-1

Example:

-1

format

enum<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

Allowed values:

xlsxcsv

Example:

xlsx

from_date

string <date-time>

optional

Filter from date. Required if the query parameter filter_orders is set to dates

Example:

2024-01-01 12:00:00

to_date

string <date-time>

optional

Filter to date. Required if the query parameter filter_orders is set to dates

Example:

2024-12-31 23:59:59

Request samples

Responses

Progress In-Action(200)

Error Validation(422)

Progress In-Action

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

{
  "status": 200,
  "success": true,
  "data": {
    "message": "سوف يتم ارسال التقرير علي بريدك الالكتروني بعد قليل"
  }
}

Last modified: 16 days ago