Read best-selling products
readTopProductsThe products that earned the most over the last days, best first, up to limit (10 by default, 50 at most): each with its title, orders, units and revenue. For the store's totals use readStoreOverview; for product pages that need work, readListings.
Only for a workspace with a store connected: listWorkspaces says which are stores.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "readTopProducts"
}
}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` | |
| limit | No | ||
| 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 |
|---|---|---|---|
| products | Yes | Most revenue first |