Skip to main content
GET
Orders report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string<date>
required

Start date of the date range to report on

Example:

"2025-01-01"

end_date
string<date>
required

End date of the date range to report on

Example:

"2025-01-31"

include
string

Optional parameter to specify which fields to return in the report (status, count, products). Separate multiple fields with commas.

Example:

"status,count"

Response

200 - application/json

Successful response with order report

date_range
string
Example:

"2025-01-01 to 2025-01-31"

total_orders
integer
Example:

179

orders_by_status
object[]
orders_by_product
object

Order counts by product