73 lines
2.0 KiB
Markdown
73 lines
2.0 KiB
Markdown
---
|
|
name: catalog-variants-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/catalog-variants for the catalog variants route group.
|
|
---
|
|
|
|
# catalog variants API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/catalog-variants for the catalog variants 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_variants
|
|
|
|
- Operation ID: `get_catalog_variants`
|
|
- Route: `GET /api/catalog-variants`
|
|
- Mode: READ
|
|
- Summary: Get Catalog Variants
|
|
- Parameters:
|
|
- `fields[catalog-variant]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_catalog_variant
|
|
|
|
- Operation ID: `create_catalog_variant`
|
|
- Route: `POST /api/catalog-variants`
|
|
- Mode: WRITE
|
|
- Summary: Create Catalog Variant
|
|
- Parameters:
|
|
- `fields[catalog-variant]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_catalog_variant
|
|
|
|
- Operation ID: `get_catalog_variant`
|
|
- Route: `GET /api/catalog-variants/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Catalog Variant
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[catalog-variant]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_catalog_variant
|
|
|
|
- Operation ID: `update_catalog_variant`
|
|
- Route: `PATCH /api/catalog-variants/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Catalog Variant
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[catalog-variant]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_catalog_variant
|
|
|
|
- Operation ID: `delete_catalog_variant`
|
|
- Route: `DELETE /api/catalog-variants/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Catalog Variant
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|