Get Sales Channel Coverage
GET/api/reporting/sales-channel-coverage/paginated
Returns paginated sales channel coverage data per product using Spatie QueryBuilder. Shows which products are listed on which sales channels.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token
Filters: filter[search] (matches SKU OR supplier name), filter[product_types] (comma-separated: standard|blemished|kit), filter[integration_ids] (comma-separated), filter[instance_ids] (comma-separated)
Flags:
- by_integration (1/0) — group coverage by integration vs instance
- show_count (1/0) — return numeric coverage counts vs boolean 0/1
- in_stock_only (1/0) — restrict to products with on-hand stock at warehouse 0 (default 1)
Sort: sku, type, id
Request
Responses
- 200
- 401
- 403
- 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.
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.