Get Product Channel Breakdown
GET/api/reporting/products/:product/channels
Server-paginated, sortable per-sales-channel breakdown for one product — the Channels tab table. Each row carries the channel's units, sales volume, profit, order count, average order value, margin, return rate, share of the product's sales and period-over-period growth. Channel-grain data is sales-side only (purchasing is not channel-attributable).
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope: reports)
Path parameter:
- product: the product ID
Accepts the same period parameters as Get Product Overview, plus sort / page / per_page.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.