---
title: "Get order statistics"
method: GET
path: "/v3/orders/statistics"
tags: ["Orders"]
---

# Get order statistics

`GET /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.

## 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'
- `tz` string
- `breakdown_date` 'off' | 'day' | 'week' | 'month'
- `is_breakdown_status` 'true' | 'false'
- `custom_breakdown_key` 'off' | 'handler_id' | 'advertiser_id' | 'page_id' | 'city' | 'province'
- `minimum_days` integer
- `search` string
- `search_field` 'order_id' | 'shipment_receipt' | 'external_id' | 'pg_reference_id' | 'gross_revenue' | 'customer_name' | 'customer_email' | 'customer_phone'
- `status` string
- `payment_status` string
- `business_id` string
- `store_id` string
- `shipped_time_since` string, datetime
- `shipped_time_until` string, datetime

## Response `200`

Order statistics with breakdown

- GetOrderStatisticsResponseBody — Paginated list payload for v3.
  - `data` CollectionItem[], required
    - `count` integer
    - `custom_breakdown_id` integer
    - `custom_breakdown_name` string
    - `day` string
    - `gross_revenue` number
    - `month` string
    - `status` 'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'shipped' | 'completed' | 'canceled' | 'rts' | 'closed' — Order status
    - `week` string
  - `is_paginated` true, required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/scalev/apis/nexus-commerce-api.md) · [All operations](https://skmtc.net/scalev/apis/nexus-commerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalev/nexus-commerce-api/versions/4354959d76dc/schema)