Sales report
sales_reportCompute sales metrics for any date range: order count, revenue, average order value, units sold, unique customers, a time series, and top products. Canceled and draft orders are excluded.
Instructions
Computes sales for a period: order count, revenue, average order value, units sold, unique customers, a time series (day/week/month) and top products. Amounts are per currency. Canceled and draft orders are excluded.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | To date (inclusive), e.g. 2026-09-30 | |
| from | Yes | From date, e.g. 2026-09-01 | |
| top_n | No | How many top products to return | |
| group_by | No | day | |
| timezone | No | IANA timezone used for date boundaries and buckets | UTC |
| only_paid | No | Only count paid orders (captured / partially_refunded / partially_captured) |