Best-selling listings by revenue
- Credentials
- OAuth access token
- Scopes
store:read- Role
- Owners and admins only. Staff get
403 forbidden. - Add-on
- Analytics plus
Plan: Analytics Plus (included with Growth and Scale), else 403 plan_limit. The console shows the same figures on its Sales, Products, Customers and Traffic pages only with it.
Access: OAuth scope store:read; owner or admin; not write-gated.
Paged: { items, nextCursor }, limit (default 5, at most 20) and an opaque cursor. It pages
through the top 20.
merchantOAuth store:readAuthorizationBearer <token>OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.
Scope: store:read
storeId*stringA store the person can reach. Any other id answers 404, never 403.
days?integerHow many days back, up to now.
1 <= value <= 73030cursor?stringThe nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.
limit?integerPage size: default 5, at most 20 (more is 20; a missing or unusable value is 5).
1 <= value <= 205OK
application/json- response
data*curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/reports/top-sellers' \ -H 'Authorization: Bearer <access_token>'{ "data": { "items": [ { "title": "Monstera deliciosa, 20 cm pot", "units": 1, "revenue": { "amount": 32900, "currency": "ZAR" } } ], "nextCursor": null, "days": 30 }}Sales, orders, visitors and the average order GET
Over the window, against the same length of time before it. Money is minor units. Only money that came in counts. Plan: every plan, as on the console Overview (these are its headline numbers). The other reports (`top-sellers`, `traffic`, `sales`) need Analytics Plus (included with Growth and Scale), else 403 `plan_limit`. Access: OAuth scope `store:read`; owner or admin; not write-gated.
Visitors to the shop and what they searched for GET
From the storefront's own daily tracking. Plan: Analytics Plus (included with Growth and Scale), else 403 `plan_limit`. The console shows the same figures on its Sales, Products, Customers and Traffic pages only with it. Access: OAuth scope `store:read`; owner or admin; not write-gated.