Get Sales by Size Report
GET/api/reports/size-sales
Units and revenue sold, pivoted by vendor → silhouette (rows) × size (columns). Sizes come back in natural size-run order; sizes arrays in every row and size_totals are aligned with the top-level sizes list.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Counts lines on non-draft, non-cancelled sales orders by order date. Units are ordered less cancelled quantity; revenue is line revenue after discounts and credits. A variant without its own silhouette, category, brand or supplier inherits its parent's. Products with no size attribute fall in the — column.
vendor_options, silhouette_options and category_options list every value sold in the date range and channel, ignoring the vendor/silhouette/category/warehouse filters.
Requires access to the Sales by Size report and the reports scope.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.