Skip to main content

Create Channel Catalog

POST 
/api/v2/listings/catalogs

Create a catalog, optionally with its rules and channel assignments in the same call.

Fields

  • name (string, required, max 255)
  • description (string, optional, max 500)
  • rules (array, optional) — replaces the whole rule set
    • rules[].rule_type (required): include_product, exclude_product, include_category, exclude_category, include_brand, exclude_brand, include_filter, exclude_filter
    • rules[].ref_id (integer) — required for every rule type EXCEPT the filter types
    • rules[].filter_tree (object) — required for include_filter / exclude_filter, forbidden otherwise
  • sales_channel_ids (array of integers, optional) — the channels this catalog governs. Channels previously pointing at the catalog and omitted here are released back to unrestricted.

Channel catalogs limit which products a sales channel may carry.

A catalog is a named, reusable set of include/exclude rules over product, category and brand, plus an optional filter rule that is re-evaluated on every read so newly created products qualify automatically. Exclusions always win: a product is eligible when it matches at least one include (or the catalog has no include rules at all, which means everything) AND matches no exclude.

A sales channel with no catalog carries every product, so catalogs are entirely opt-in.

Authentication: Requires Bearer token.

Required scope: products:write

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

Request​

Responses​

Created

Response Headers
    Content-Type