Export Orders

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

Note

Advance configurations are possible using the available query parameters.

Scopes

exports.read- Exports Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

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

Responses

🟢200Progress In-Action

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object

optional

message

string

optional

A text or data communication generated by a system or application in response to a request.

Examples

SuccessSuccess Response but no orders found for the selected date range

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

🟠422Error Validation

🟠401Unauthorized

Request

Request samples

Responses