---
name: catalog-items-routes
description: Handle 12 OpenAPI operation(s) under /api/catalog-items for the catalog items route group.
---

# catalog items API Routes

Handle 12 OpenAPI operation(s) under /api/catalog-items for the catalog items route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### get_catalog_items

- Operation ID: `get_catalog_items`
- Route: `GET /api/catalog-items`
- Mode: READ
- Summary: Get Catalog Items
- Parameters:
  - `fields[catalog-item]` in `query`
  - `fields[catalog-variant]` in `query`
  - `filter` in `query`
  - `include` in `query`
  - `page[cursor]` in `query`
  - `page[size]` in `query`
  - `sort` in `query`
  - `revision` in `header` required

### create_catalog_item

- Operation ID: `create_catalog_item`
- Route: `POST /api/catalog-items`
- Mode: WRITE
- Summary: Create Catalog Item
- Parameters:
  - `fields[catalog-item]` in `query`
  - `revision` in `header` required
- Body: JSON request body accepted.

### get_catalog_item

- Operation ID: `get_catalog_item`
- Route: `GET /api/catalog-items/{id}`
- Mode: READ
- Summary: Get Catalog Item
- Parameters:
  - `id` in `path` required
  - `fields[catalog-item]` in `query`
  - `fields[catalog-variant]` in `query`
  - `include` in `query`
  - `revision` in `header` required

### update_catalog_item

- Operation ID: `update_catalog_item`
- Route: `PATCH /api/catalog-items/{id}`
- Mode: WRITE
- Summary: Update Catalog Item
- Parameters:
  - `id` in `path` required
  - `fields[catalog-item]` in `query`
  - `revision` in `header` required
- Body: JSON request body accepted.

### delete_catalog_item

- Operation ID: `delete_catalog_item`
- Route: `DELETE /api/catalog-items/{id}`
- Mode: WRITE
- Summary: Delete Catalog Item
- Parameters:
  - `id` in `path` required
  - `revision` in `header` required

### get_variants_for_catalog_item

- Operation ID: `get_variants_for_catalog_item`
- Route: `GET /api/catalog-items/{id}/variants`
- Mode: READ
- Summary: Get Variants for Catalog Item
- Parameters:
  - `id` in `path` required
  - `fields[catalog-variant]` in `query`
  - `filter` in `query`
  - `page[cursor]` in `query`
  - `page[size]` in `query`
  - `sort` in `query`
  - `revision` in `header` required

### get_variant_ids_for_catalog_item

- Operation ID: `get_variant_ids_for_catalog_item`
- Route: `GET /api/catalog-items/{id}/relationships/variants`
- Mode: READ
- Summary: Get Variant IDs for Catalog Item
- Parameters:
  - `id` in `path` required
  - `filter` in `query`
  - `page[cursor]` in `query`
  - `page[size]` in `query`
  - `sort` in `query`
  - `revision` in `header` required

### get_categories_for_catalog_item

- Operation ID: `get_categories_for_catalog_item`
- Route: `GET /api/catalog-items/{id}/categories`
- Mode: READ
- Summary: Get Categories for Catalog Item
- Parameters:
  - `id` in `path` required
  - `fields[catalog-category]` in `query`
  - `filter` in `query`
  - `page[cursor]` in `query`
  - `page[size]` in `query`
  - `sort` in `query`
  - `revision` in `header` required

### get_category_ids_for_catalog_item

- Operation ID: `get_category_ids_for_catalog_item`
- Route: `GET /api/catalog-items/{id}/relationships/categories`
- Mode: READ
- Summary: Get Category IDs for Catalog Item
- Parameters:
  - `id` in `path` required
  - `filter` in `query`
  - `page[cursor]` in `query`
  - `page[size]` in `query`
  - `sort` in `query`
  - `revision` in `header` required

### add_categories_to_catalog_item

- Operation ID: `add_categories_to_catalog_item`
- Route: `POST /api/catalog-items/{id}/relationships/categories`
- Mode: WRITE
- Summary: Add Categories to Catalog Item
- Parameters:
  - `id` in `path` required
  - `revision` in `header` required
- Body: JSON request body accepted.

### update_categories_for_catalog_item

- Operation ID: `update_categories_for_catalog_item`
- Route: `PATCH /api/catalog-items/{id}/relationships/categories`
- Mode: WRITE
- Summary: Update Categories for Catalog Item
- Parameters:
  - `id` in `path` required
  - `revision` in `header` required
- Body: JSON request body accepted.

### remove_categories_from_catalog_item

- Operation ID: `remove_categories_from_catalog_item`
- Route: `DELETE /api/catalog-items/{id}/relationships/categories`
- Mode: WRITE
- Summary: Remove Categories from Catalog Item
- Parameters:
  - `id` in `path` required
  - `revision` in `header` required
- Body: JSON request body accepted.