Get Full Sales Channel Coverage
POST/api/reporting/sales-channel-coverage
Returns listing coverage for every product across the selected sales channels in a single unpaginated response. For each product you get its stock on hand, inventory valuation, default supplier, and a coverage map keyed by channel name plus a Total.
reports:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request fields (all required):
byIntegration(boolean) — true groups coverage by integration (e.g. all Amazon instances combined); false groups by individual integration instance.showNumberOfCoverages(boolean) — true returns the count of active listings per channel; false returns a binary indicator (1 = listed, 0 = not listed).ids(array of integers) — the integration IDs (whenbyIntegrationis true) or integration instance IDs (when false) to include in the coverage calculation.
Coverage for kit/bundle products includes listings of their parent products. This endpoint computes coverage for the entire catalog in one request and can be slow on large catalogs — prefer GET /api/reporting/sales-channel-coverage/paginated for interactive use.
Authentication: Requires Bearer token. Scope: reports (read/write).
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.