Skip to main content

Get Publish-Readiness Snapshot

GET 
/api/v2/products/:product/publish-readiness

Per-product, multi-channel publish readiness snapshot. Returns one entry per publish-capable, connected sales channel, grouped by bucket (live / ready / warn / idle / publishing / scheduled / draft) so the publish dialog can render confidence groups without orchestrating N parallel calls.

Read-only: does NOT speculatively create drafts. Channels with no draft and no live listing land in idle and surface recommended next actions (pick a template, create one, etc.).

Bucket resolution:

  • live — a non-archived ProductListing exists for this product on the channel
  • ready — open draft in state ready
  • scheduled — open draft in state scheduled
  • publishing — open draft in state publishing or validating
  • warn — open draft in state error, OR draft with validation errors
  • draft — open draft in state draft with no validation errors
  • idle — no open draft and no live listing

Authentication: Requires Bearer token. Feature flag: requires listing-publishing to be enabled.

quantity_to_push (int|null, per channel entry) — the stock a publish to this channel would seed right now, computed through the same SalesChannelInventoryCalculator rules the standing inventory sync uses (max/min/buffer, locations, bundles). null when quantity seeding is gated off (listing-publishing push_quantity_on_publish setting disabled, SKU.io not master of stock for the instance, no inventory rules configured) or the bucket cannot publish (live / publishing).

Request​

Responses​

OK