3.3 KiB
3.3 KiB
name, description
| name | description |
|---|---|
| catalog-routes | Handle 14 OpenAPI operation(s) under /v2/catalog for the catalog route group. |
catalog API Routes
Handle 14 OpenAPI operation(s) under /v2/catalog for the catalog 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
batch_delete_catalog_objects
- Operation ID:
batch_delete_catalog_objects - Route:
POST /v2/catalog/batch-delete - Mode: WRITE
- Summary: BatchDeleteCatalogObjects
- Body: JSON request body accepted.
batch_retrieve_catalog_objects
- Operation ID:
batch_retrieve_catalog_objects - Route:
POST /v2/catalog/batch-retrieve - Mode: WRITE
- Summary: BatchRetrieveCatalogObjects
- Body: JSON request body accepted.
batch_upsert_catalog_objects
- Operation ID:
batch_upsert_catalog_objects - Route:
POST /v2/catalog/batch-upsert - Mode: WRITE
- Summary: BatchUpsertCatalogObjects
- Body: JSON request body accepted.
create_catalog_image
- Operation ID:
create_catalog_image - Route:
POST /v2/catalog/images - Mode: WRITE
- Summary: CreateCatalogImage
- Body: JSON request body accepted.
update_catalog_image
- Operation ID:
update_catalog_image - Route:
PUT /v2/catalog/images/{image_id} - Mode: WRITE
- Summary: UpdateCatalogImage
- Parameters:
image_idinpathrequired
- Body: JSON request body accepted.
catalog_info
- Operation ID:
catalog_info - Route:
GET /v2/catalog/info - Mode: READ
- Summary: CatalogInfo
list_catalog
- Operation ID:
list_catalog - Route:
GET /v2/catalog/list - Mode: READ
- Summary: ListCatalog
- Parameters:
cursorinquerytypesinquerycatalog_versioninquery
upsert_catalog_object
- Operation ID:
upsert_catalog_object - Route:
POST /v2/catalog/object - Mode: WRITE
- Summary: UpsertCatalogObject
- Body: JSON request body accepted.
delete_catalog_object
- Operation ID:
delete_catalog_object - Route:
DELETE /v2/catalog/object/{object_id} - Mode: WRITE
- Summary: DeleteCatalogObject
- Parameters:
object_idinpathrequired
retrieve_catalog_object
- Operation ID:
retrieve_catalog_object - Route:
GET /v2/catalog/object/{object_id} - Mode: READ
- Summary: RetrieveCatalogObject
- Parameters:
object_idinpathrequiredinclude_related_objectsinquerycatalog_versioninqueryinclude_category_path_to_rootinquery
search_catalog_objects
- Operation ID:
search_catalog_objects - Route:
POST /v2/catalog/search - Mode: WRITE
- Summary: SearchCatalogObjects
- Body: JSON request body accepted.
search_catalog_items
- Operation ID:
search_catalog_items - Route:
POST /v2/catalog/search-catalog-items - Mode: WRITE
- Summary: SearchCatalogItems
- Body: JSON request body accepted.
update_item_modifier_lists
- Operation ID:
update_item_modifier_lists - Route:
POST /v2/catalog/update-item-modifier-lists - Mode: WRITE
- Summary: UpdateItemModifierLists
- Body: JSON request body accepted.
update_item_taxes
- Operation ID:
update_item_taxes - Route:
POST /v2/catalog/update-item-taxes - Mode: WRITE
- Summary: UpdateItemTaxes
- Body: JSON request body accepted.