Update Channel Catalog

PUT 
/api/v2/listings/catalogs/:channelCatalog

Update a catalog. Sending rules REPLACES the entire rule set rather than appending; omitting the key leaves the existing rules untouched. The same applies to sales_channel_ids.

Field rules are identical to Create, except name is optional here.

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

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.