Sign in

v2

OpenAPI 3.0.3Proprietary2026-07-263483431.1 MB
Orders

Get order 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.

get/v3/orders/statistics

Query parameters

datetime_type'draft_time' | 'pending_time' | 'confirmed_time' | 'in_process_time' | 'ready_time' | 'canceled_time' | 'shipped_time' | 'shipped_rts_time' | 'completed_time' | 'rts_time' | 'closed_time'

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

tzstring

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

breakdown_date'off' | 'day' | 'week' | 'month'

Date breakdown for statistics (defaults to 'off')

is_breakdown_status'true' | 'false'

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

custom_breakdown_key'off' | 'handler_id' | 'advertiser_id' | 'page_id' | 'city' | 'province'

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

minimum_daysinteger

Minimum number of days for statistics (defaults to 0)

searchstring

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

search_field'order_id' | 'shipment_receipt' | 'external_id' | 'pg_reference_id' | 'gross_revenue' | 'customer_name' | 'customer_email' | 'customer_phone'

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

statusstring

Filter by order status

payment_statusstring

Filter by payment status

business_idstring

Filter by business ID

store_idstring

Filter by store ID

shipped_time_sincestring datetime

Filter by shipped time since (ISO 8601 format)

shipped_time_untilstring datetime

Filter by shipped time until (ISO 8601 format)

Response

Order statistics with breakdown

is_paginatedtrue required

Example response

{
  "is_paginated": true
}