Get order statistics

get

https://api.scalev.com/v3/orders/statistics

Requires the order:statistics:read scope. Retrieves descriptive statistics about orders, such as total orders, total revenue, and other aggregated data. Can be filtered using the same parameters as the orders list endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

datetime_type

string

enum

Defaults to draft_time

Type of datetime for statistics (defaults to 'draft_time')

string

Defaults to Asia/Jakarta

Timezone for datetime adjustment (defaults to 'Asia/Jakarta')

breakdown_date

string

enum

Defaults to off

Date breakdown for statistics (defaults to 'off')

Allowed:

is_breakdown_status

string

enum

Defaults to false

Include breakdown by order status (defaults to 'false')

Allowed:

custom_breakdown_key

string

enum

Defaults to off

Custom breakdown key for statistics (defaults to 'off')

Allowed:

minimum_days

integer

Defaults to 0

Minimum number of days for statistics (defaults to 0)

string

Search term for the selected search_field. Defaults to order ID search when search_field is omitted or unsupported.

search_field

string

enum

Defaults to order_id

Field used by search. Defaults to order_id when omitted or unsupported.

status

string

Filter by order status

payment_status

string

Filter by payment status

business_id

string

Filter by business ID

store_id

string

Filter by store ID

shipped_time_since

string

Filter by shipped time since (ISO 8601 format)

shipped_time_until

string

Filter by shipped time until (ISO 8601 format)

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Order statistics with breakdown

401Unauthorized

403Forbidden