Skip to main content

Replace Channel Category Map

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

Replace the channel's map in full. Every row in the payload with a category is saved; a row with a null category — or a leaf type absent from the payload — loses its mapping. Every category must belong to this channel and be a leaf (products cannot list into a parent category); violations answer 422 keyed on rows.N.sales_channel_category_id.

Required scope: products:write

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

Send the version from your last read. If the map changed in between, nothing is written and the response is 409 with the current rows and a fresh version — re-apply your changes to those rows and retry. Omit version to skip the check.

Responds with the saved map in the same shape as Get Channel Category Map.

Authentication: Requires Bearer token.

Fields:

  • rows (required, array, max 2000)
  • rows[].product_type_id (required, integer) — a leaf product type
  • rows[].sales_channel_category_id (nullable, integer) — a leaf category of this channel; null clears the mapping
  • version (nullable, string, max 64) — the token from the last read

Requires permission: listings.update

Request​

Responses​

OK

Response Headers
    Content-Type