Skip to main content

Get Publish Matrix

GET 

/api/v2/listings/publish

Catalog-wide publish matrix. Returns a paginated list of products with per-channel publish state (bucket) for each publish-capable connected channel. Returns catalog-wide publish state per product across channels.

Required scope: products:read

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

One row per product, with channels[] listing all publish-capable channels and their current bucket (live / ready / warn / idle / scheduled / publishing / draft). The channel_buckets map is a convenience for matrix cell rendering (channel_id → bucket string).

totals aggregates bucket counts across the ENTIRE catalog (every product × publish-capable channel) — this is what the summary cards above the matrix display. page_totals is the same aggregation scoped to only the products on the current page (retained for page-level tallies).

Authentication: Requires Bearer token. channel_totals breaks the same catalog-wide counts down per channel — each entry lists the channel (channel_id, name, integration_name), its total product count, and a count in each status bucket.

Request

Responses

OK