Skip to main content

List Product Channel Categories

GET 
/api/v2/products/:product/channel-categories

Where the product would publish on every sales channel that supports listings, and why — one entry per channel (or just the one named by channel). Resolution order: the product's own override on the channel, else the category its product type is mapped to on the channel, else nothing.

Required scope: products:read

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

Each resolution carries:

  • product_id, sales_channel_id
  • sales_channel_category — {id, name, path, external_id, is_leaf}, or null when nothing resolved
  • provenance — override (the product's own override on the channel) or type_map (its product type's map row on the channel); null when nothing resolved
  • product_type — {id, name, path} of the type the product resolves under (a variant with no type of its own uses its parent's), or null
  • template — {id, name, is_default}: the template pinned by the override, else the resolved category's default template; null when there is none
  • override — {id, sales_channel_category_id, sales_channel_product_template_id, created_at} when an override is set, else null
  • type_map_category — set only while an override is in force AND the type map points at a different category, so the difference can be shown; otherwise null
  • sales_channel — {id, name, integration_name}

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type