Skip to main content

Get Template Readiness Matrix

GET 
/api/v2/sales-channel-product-templates/:template/readiness

Readiness matrix behind a template's Invalid products count: one row per product the template serves, one column per required field.

Required scope: products:read

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

Unpaged by design. Every routed product comes back in one response, because the matrix is read by scanning it and a caller who has to page cannot see the shape of the problem. page / per_page are not honoured. A cap of 2000 rows exists as a backstop for a pathological catalogue; when it bites, truncated is true and row_cap says where it stopped, so a short matrix can never masquerade as a complete one.

Rows are ordered by default supplier (nulls last) then SKU, so the caller can group consecutive rows without regrouping. fields[].missing and summary are computed over the whole routed set, so they are unaffected by the filters below; the rows are. Every cell is resolved through the publish-time value resolver, so a cell can never disagree with what publishing actually does.

Which products a template serves follows the publish path: a per-channel category override wins over the product type's mapping, a variant with no type of its own inherits the family parent's, and a template that is not its category's default is reachable only by an explicit pin. Archived products are excluded.

cells is keyed by the channel's own field name (fields[].key). ok false means nothing resolves for that product, so it cannot publish. provenance names the layer the value came from (template, profile_mapping, channel_mapping, integration_mapping, channel_default).

Request​

Responses​

OK

Response Headers
    Content-Type