Skip to main content

Set Product Channel Category Override

PUT 
/api/v2/products/:product/channel-categories/:salesChannel

Pin the product to a category on this channel — and optionally to a listing template — regardless of what its product type's map says. Replaces any existing override for the product on the channel. Responds with the product's resolution on the channel (provenance = override).

Required scope: products:write

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

Authentication: Requires Bearer token.

Fields:

  • sales_channel_category_id (required, integer) — a leaf category belonging to this channel
  • sales_channel_product_template_id (nullable, integer) — a template of this channel that belongs to that category (or to no category); omit to use the category's default template

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

Requires permission: products.update

Request​

Responses​

OK

Response Headers
    Content-Type