ShopEazydevelopers
API referenceMerchant API BetaReports

Sales by product, month, channel or seller

Beta
Credentials
  • OAuth access token
Scopes
store:read
Role
Owners and admins only. Staff get 403 forbidden.
Add-on
Analytics plus
GET
/v1/merchant/stores/{storeId}/reports/sales

The same tables as the console's Reports page. rows follow by. Products are capped at 50.

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.

Authorization

merchantOAuth store:read
headerAuthorizationBearer <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

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Query Parameters

by*string
Value in"product""month""channel""person"
days?integer

How many days back, up to now.

Range1 <= value <= 730
Default90

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/reports/sales?by=product' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "by": "product",    "days": 30,    "rows": []  }}