Export Sales Channel Coverage (Async)

GET 
/api/reporting/sales-channel-coverage/export

Dispatches an async job (a background job) that builds the full unpaginated sales channel coverage CSV in the background. Returns immediately with a tracked_job_log_id that the frontend uses to poll progress via the tracked job log endpoints.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token

Flow:

1. Client calls this endpoint with the same filters/flags supported by the paginated endpoint.
2. Server queues the job and returns { data: { tracked_job_log_id }, message }.
3. Frontend subscribes via the tracked job log endpoints; when job completes, log.results.file contains the filename on the model-exports disk.
4. Client downloads the file via GET /api/export/download?file={filename}.

CSV columns: SKU, Product Name, Supplier, Type, Stock, Valuation, Total Coverage, plus one column per integration (or instance when by_integration=0) covering the union of channels across all returned rows. Channel columns are computed from the union of all rows in the result set.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.