Skip to main content

Get Channel Category Map

GET 

/api/v2/sales-channels/:salesChannel/category-map

The channel's product type → category map: one row per active leaf product type, path-ordered. Each row carries the type, how many active products carry it, the channel category it maps to (or null), category_missing (true when a taxonomy re-sync removed the mapped category — the row counts as unmapped until it is re-mapped), the mapped category's default template and how many templates that category has.

Required scope: products:read

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

include=suggestions adds up to 3 suggested categories to each unmapped row, matched from the type's name and a sample of its products' names (confidence 0–1, source). Suggestions are cached for a day.

version is a concurrency token for the whole map — send it back with Replace Channel Category Map. taxonomy_synced is false when the channel's categories have not been synced yet, in which case no row can be mapped.

Authentication: Requires Bearer token.

Requires permission: listings.index

Request

Responses

OK

Response Headers
    Content-Type