Read store performance
readStoreOverviewOrders, gross and net revenue, refunds, units and average order value over the last days (30 by default), with the change against the period before in deltas (null when there is nothing to compare). currency is the most common order currency; when currencyCount is above 1 the totals mix currencies, so say so. For the best sellers use readTopProducts, for a day-by-day line readSalesTrend.
Only for a workspace with a store connected: listWorkspaces says which are stores.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Last day of the range, YYYY-MM-DD, today at the latest; a range is two years at most | |
| days | No | Reporting window in days | |
| from | No | First day of a custom range, YYYY-MM-DD. With `to`, it takes the place of `days` | |
| workspaceId | No | The workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deltas | Yes | ||
| currency | Yes | The most common order currency; null with no orders | |
| refunded | Yes | Refunds, in the order currency, unconverted | |
| unitsSold | Yes | ||
| netRevenue | Yes | Gross revenue minus refunds, in the order currency, unconverted | |
| orderCount | Yes | ||
| grossRevenue | Yes | Order totals, in the order currency, unconverted | |
| avgOrderValue | Yes | Gross revenue per order, 0 with no orders, in the order currency, unconverted | |
| currencyCount | Yes | How many currencies the orders were in; above 1 the totals mix them |