Virto Commerce Catalog API
Easily manage your products, categories, variations, and properties
Operations 92
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
POST
/api/catalog/automatic-link-queries/search
Search automatic category link rules · Automatic link query search
#
Ask an LLM
“Which automatic link rules feed products into a virtual category?”
“Can I list the saved automatic linking queries for one target category?”
Tell an agent
Search automatic link rules that target category {categoryId}.
Find automatic link queries matching {keyword}.
POST
/api/catalog/automatic-link-queries
Create an automatic category link rule · Automatic link query create
#
Ask an LLM
“How can a virtual category be filled automatically from a query on another catalog?”
“What does a new automatic link rule need, like a source catalog and a target category?”
Tell an agent
Create an automatic link rule that fills category {categoryId} from catalog {catalogId}.
Add a new rule linking products matching {query} into category {categoryId}.
PUT
/api/catalog/automatic-link-queries
Update an automatic category link rule · Automatic link query update
#
Ask an LLM
“How do I change the source query of an existing automatic link rule?”
“Can I point an automatic link rule at a different source catalog?”
Tell an agent
Update automatic link rule {id} to use source query {query}.
Change existing link rule {id} to pull from catalog {catalogId}.
DELETE
/api/catalog/automatic-link-queries
Delete automatic category link rules · Automatic link query delete
#
Ask an LLM
“Can I remove automatic link rules I no longer need?”
“What deletes several automatic link queries by id?”
Tell an agent destructive · confirm first
Delete automatic link rules {ids}.
Remove the automatic link query {ids}.
GET
/api/catalog/automatic-link-queries/{id}
Get an automatic category link rule · Automatic link query get
#
Ask an LLM
“What source query does a particular automatic link rule run?”
“How do I view one automatic link rule by id?”
Tell an agent
Show automatic link rule {id}.
Get the source catalog and query of link rule {id}.
GET
/api/catalog/products/associations/{productId}
List one product's associations · Returns list of associations for specified product
#
Ask an LLM
“Which related, accessory or cross-sell products are linked to this product?”
“What associations does a single product have?”
Tell an agent
List the associations of product {productId}.
Show related and cross-sell items for product {productId}.
POST
/api/catalog/products/associations/get/multiple
List associations for several products · Returns list of associations for specified products
#
Ask an LLM
“Can I fetch associations for a whole batch of products at once?”
“Is there a way to load related products for multiple items in one request?”
Tell an agent
Get associations for this batch of product ids.
Load related-product links for multiple products at once.
POST
/api/catalog/products/associations
Save product associations · Updates the specified association
#
Ask an LLM
“How do I link accessories or related items to a product?”
“Can I update several product associations in one call?”
Tell an agent
Save these product associations.
Link these accessory products to their main product as associations.
DELETE
/api/catalog/products/associations
Delete product associations · Deletes specified associations
#
Ask an LLM
“How can I unlink a related product from another product?”
“Can I delete several associations at once by id?”
Tell an agent destructive · confirm first
Delete product associations {ids}.
Remove the association {ids} between two products.
POST
/api/catalog/products/associations/search
Search product associations · Returns associations by search criteria
#
Ask an LLM
“Which products are associated in a particular group, like accessories?”
“Can I find associations that point to a given product?”
Tell an agent
Search associations in group {group}.
Find associations that point to products {associatedIds}.
PATCH
/api/catalog/products/associations/{id}
Partially update a product association · Partial update for the specified association by id
#
Ask an LLM
“Can I change just the priority or quantity on one association?”
“Is JSON Patch available for product associations?”
Tell an agent
Patch product association {id}.
Apply a partial update to association {id}.
GET
/api/brand-settings/store/{storeId}
Get a store's brand settings · Catalog module brand setting get by store id
#
Ask an LLM
“Are brand pages enabled for a particular store?”
“Which property and catalog does a store use for brands?”
Tell an agent
Show the brand settings for store {storeId}.
Check if brands are enabled in store {storeId}.
Ask an LLM
“How do I turn on brands for a store?”
“Can I choose which product property holds the brand name?”
Tell an agent
Enable brands for store {storeId} using property {property}.
Set the brand catalog for store {storeId} to {catalogId}.
Ask an LLM
“What catalogs exist in my Virto Commerce platform?”
“Can I list only the virtual catalogs?”
Tell an agent
Search catalogs matching {keyword}.
List catalogs where virtual is {isVirtual}.
Ask an LLM
“What languages and properties does a specific catalog have?”
“How do I load one catalog with all its details?”
Tell an agent
Get catalog {id}.
Show catalog {id} with response group {group}.
Ask an LLM
“Can I delete an entire catalog?”
“What happens when I remove a catalog by its id?”
Tell an agent destructive · confirm first
Delete catalog {id}.
Remove the whole catalog {id} permanently.
PATCH
/api/catalog/catalogs/{id}
Partially update a catalog · Partial update for the specified Catalog by id
#
Ask an LLM
“Can I change one field on a catalog without resending it all?”
“Is there a JSON Patch endpoint for catalogs?”
Tell an agent
Patch catalog {id} with only the changed fields.
Apply a partial update to catalog {id}.
Ask an LLM
“How can I find a catalog using the key from my PIM or ERP?”
“Can I look up a catalog by outer id?”
Tell an agent
Get the catalog with outer id {outerId}.
Look up catalog by integration key {outerId}.
GET
/api/catalog/catalogs/getnew
Get a template for a new catalog · Gets the template for a new catalog
#
Ask an LLM
“What does a blank common catalog look like before I save it?”
“Can I get default values for a new regular catalog?”
Tell an agent
Give me a template for a new common catalog.
Fetch the blank regular catalog object.
GET
/api/catalog/catalogs/getnewvirtual
Get a template for a new virtual catalog · Gets the template for a new virtual catalog
#
Ask an LLM
“What does an empty virtual catalog template contain?”
“Can I get default values for a new virtual catalog?”
Tell an agent
Give me a template for a new virtual catalog.
Fetch the blank virtual catalog object.
Ask an LLM
“How do I create a new product catalog?”
“Can I create a virtual catalog that aggregates other catalogs?”
Tell an agent
Create a catalog called {name}.
Create catalog {name} with virtual set to {isVirtual} and default language {language}.
Ask an LLM
“How do I add a language to an existing catalog?”
“Can I rename a catalog or change its default language?”
Tell an agent
Update catalog {id} to default language {language}.
Rename existing catalog {id} to {name}.
Ask an LLM
“What properties and SEO info does a specific category have?”
“How do I load one category by its id?”
Tell an agent
Get category {id}.
Show category {id} with response group {group}.
PATCH
/api/catalog/categories/{id}
Partially update a category · Partial update for the specified Category by id
#
Ask an LLM
“Can I deactivate a category by patching a single field?”
“Is JSON Patch supported for categories?”
Tell an agent
Patch category {id} with only the changed fields.
Apply a partial update to category {id}.
GET
/api/catalog/categories/outer/{outerId}
Get a category by external id · Gets category by outer id
#
Ask an LLM
“How can I find a category using my ERP's integration key?”
“Can I fetch a category by outer id instead of its Virto id?”
Tell an agent
Get the category with outer id {outerId}.
Look up category by integration key {outerId}.
Ask an LLM
“Can I load multiple categories at once when I have their ids?”
“What is the quickest way to fetch a handful of categories together?”
Tell an agent
Get categories {ids}.
Load categories {ids} with response group {group}.
POST
/api/catalog/categories
Create or update a single category · Creates or updates the specified category
#
Ask an LLM
“How do I add a new category to a catalog?”
“Can I create a subcategory under an existing parent category?”
Tell an agent
Create category {name} with code {code} in catalog {catalogId}.
Add subcategory {name} under parent category {parentId}.
Ask an LLM
“Can I delete several categories by id?”
“What removes a category from a catalog?”
Tell an agent destructive · confirm first
Delete categories {ids}.
Remove the category {ids}.
POST
/api/catalog/categories/plenty
Get many categories by id in one post · Get categories by plenty ids
#
Ask an LLM
“Can I fetch a very large list of categories by posting their ids?”
“What if my list of category ids is too long for a query string?”
Tell an agent
Post this long list of category ids and return the categories.
Fetch plenty of categories by id with response group {group}.
POST
/api/catalog/{catalogId}/categories-by-codes
Get categories by code within a catalog · Gets categories by codes
#
Ask an LLM
“Can I find categories in a catalog using their codes?”
“How do I map my own category codes back to Virto categories?”
Tell an agent
Get categories by these codes in catalog {catalogId}.
Look up category codes in catalog {catalogId} with response group {group}.
GET
/api/catalog/{catalogId}/categories/newcategory
Get a template for a new category · Gets the template for a new category
#
Ask an LLM
“What does a blank category look like before I create it in a catalog?”
“Can I get a new category template under a specific parent?”
Tell an agent
Give me a new category template for catalog {catalogId}.
Fetch a blank category for catalog {catalogId} under parent {parentId}.
POST
/api/catalog/categories/batch
Create or update categories in bulk · Create/Update the specified categories
#
Ask an LLM
“Can I save a whole batch of categories in one request?”
“Is there a bulk import for categories?”
Tell an agent
Save this batch of categories.
Bulk create or update all these categories at once.
POST
/api/catalog/categories/{id}/automatic-links
Run automatic links for a category · Catalog module categories update automatic links
#
Ask an LLM
“How do I refresh the automatically linked products in a category?”
“Can I re-run a category's automatic link rule now?”
Tell an agent
Update the automatic links for category {id}.
Rebuild auto-linked products in category {id}.
DELETE
/api/catalog/categories/{id}/automatic-links
Remove a category's automatic links · Catalog module categories delete automatic links
#
Ask an LLM
“Can I clear all automatically linked products from a category?”
“What undoes the automatic links created for a category?”
Tell an agent destructive · confirm first
Delete the automatic links in category {id}.
Clear auto-linked products from category {id}.
GET
/api/catalog/products/configurations/{id}
Get a product configuration · Get configuration by id
#
Ask an LLM
“What sections does a configurable product's configuration have?”
“How do I load one product configuration by id?”
Tell an agent
Get product configuration {id}.
Show the sections of configuration {id}.
PATCH
/api/catalog/products/configurations/{id}
Partially update a product configuration · Partial update for the specified Configuration by id
#
Ask an LLM
“Can I toggle a product configuration active with a patch?”
“Is JSON Patch supported for product configurations?”
Tell an agent
Patch product configuration {id}.
Apply a partial update to configuration {id}.
POST
/api/catalog/products/configurations/search
Search product configurations · Search configurations
#
Ask an LLM
“Which products have a configuration set up?”
“Can I find only the active configurations for a product?”
Tell an agent
Search configurations for product {productId}.
List product configurations where active is {isActive}.
POST
/api/catalog/products/configurations
Create or update a product configuration · Create or update the specified configuration
#
Ask an LLM
“How do I make a product configurable with option sections?”
“Can I add sections to a product's configuration?”
Tell an agent
Create a configuration for product {productId} with sections {sections}.
Save the configuration for product {productId} as active {isActive}.
POST
/api/catalog/search/products
Search products in the search index · Catalog module indexed search search products
#
Ask an LLM
“How do I run a storefront-style product search with facets and price ranges?”
“Can I search indexed products within a price range for a store?”
Tell an agent
Search the product index for {phrase} in store {storeId}.
Find indexed products in catalog {catalogId} priced {priceRange} in {currency}.
POST
/api/catalog/search/products/suggestions
Get product search suggestions · Catalog module indexed search get product suggestions
#
Ask an LLM
“Can I get autocomplete suggestions as a shopper types a product name?”
“How many product suggestions can I request for a partial query?”
Tell an agent
Suggest products for the partial query {query}.
Give me {size} autocomplete suggestions for {query} in catalog {catalogId}.
POST
/api/catalog/search/categories
Search categories in the search index · Catalog module indexed search search categories
#
Ask an LLM
“Can I search indexed categories the way the storefront does?”
“Is fuzzy matching available when searching categories?”
Tell an agent
Search the category index for {phrase} in store {storeId}.
Fuzzy search indexed categories in catalog {catalogId} for {keyword}.
POST
/api/catalog/listentries
Browse catalog entries in a category · Searches for the items by complex criteria
#
Ask an LLM
“What products and subcategories sit inside a given category?”
“Can I browse only buyable items in a catalog, including child categories?”
Tell an agent
List the categories and products in category {categoryId}.
Browse entries in catalog {catalogId} matching code {code}.
POST
/api/catalog/listentrylinks
Link products or categories to categories · Creates links for categories or items to parent categories and catalogs
#
Ask an LLM
“How do I show one product in several categories without copying it?”
“Can I link a category into a virtual catalog?”
Tell an agent
Create these links from items to their parent categories.
Link these products into additional categories and catalogs.
POST
/api/catalog/listentrylinks/bulkcreate
Bulk link search results to a category · Creates category links in bulk for catalog entries based on the specified…
#
Ask an LLM
“Can I link every product that matches a search into one category?”
“Is there a bulk way to add many items to a virtual category?”
Tell an agent
Link all entries matching {criteria} into category {categoryId}.
Bulk link search results into catalog {catalogId}.
POST
/api/catalog/listentrylinks/search
Search category and catalog links · Catalog module list entry search links
#
Ask an LLM
“Which items are linked into a given category?”
“Can I see only the links that were created automatically?”
Tell an agent
Search links into categories {categoryIds}.
List links in catalogs {catalogIds} where automatic is {isAutomatic}.
POST
/api/catalog/listentrylinks/delete
Unlink products or categories · Unlinks the linked categories or items from parent categories and catalogs
#
Ask an LLM
“How do I take a linked product out of a category without deleting it?”
“Can I unlink categories from a virtual catalog?”
Tell an agent destructive · confirm first
Unlink these items from their linked parent categories.
Remove these category and catalog links without deleting the products.
POST
/api/catalog/listentries/move
Move products or categories · Move categories or products to another location
#
Ask an LLM
“Can I move products to a different category?”
“Is it possible to move a category into another catalog?”
Tell an agent
Move these entries to category {category}.
Move entries {entries} into catalog {catalogId}.
POST
/api/catalog/listentries/delete
Bulk delete catalog entries by criteria · Bulk delete by the search criteria
#
Ask an LLM
“Can I delete every product in a category that matches a filter?”
“Is there a bulk delete driven by search criteria instead of ids?”
Tell an agent destructive · confirm first
Bulk delete all entries in category {categoryId}.
Delete every catalog entry in {catalogId} matching {keyword}.
Ask an LLM
“Which units belong to a particular measure, like weight or length?”
“How do I view one measure by id?”
Tell an agent
Get measure {id}.
Show the units defined in measure {id}.
PATCH
/api/catalog/measures/{id}
Partially update a measure · Partial update for the specified Measure by id
#
Ask an LLM
“Can I patch just the name of a measure?”
“Is JSON Patch supported for units of measure?”
Tell an agent
Patch measure {id}.
Apply a partial update to measure {id}.
POST
/api/catalog/measures/search
Search units of measure · Catalog module measures search measures
#
Ask an LLM
“What measures and units are defined in my catalog?”
“Can I search measures by keyword?”
Tell an agent
Search measures matching {keyword}.
List all defined measures.
Ask an LLM
“How do I define a new measure like volume for my products?”
“Can I add a custom measure to the catalog?”
Tell an agent
Create a new measure from these details.
Define a new custom unit of measure.
Ask an LLM
“How do I add units to an existing measure?”
“Can I rename a measure or change its code?”
Tell an agent
Update measure {id} with units {units}.
Rename existing measure {id} to {name}.
Ask an LLM
“Can I remove measures I no longer use?”
“What deletes several measures by id?”
Tell an agent destructive · confirm first
Delete measures {ids}.
Remove the measure {ids}.
GET
/api/catalog/measures/default
Get the default measures · Catalog module measures get default measures
#
Ask an LLM
“Which measures come built in by default?”
“What default units of measure does the catalog provide?”
Tell an agent
Show the default measures.
List the built-in units of measure.
Ask an LLM
“What are the properties, images and variations of a specific product?”
“How do I load one product by its id?”
Tell an agent
Get product {id}.
Show product {id} with response group {group}.
PATCH
/api/catalog/products/{id}
Partially update a product · Partial update for the specified Product by id
#
Ask an LLM
“Can I change a single product field, like its name, with a patch?”
“Is JSON Patch supported for one product?”
Tell an agent
Patch product {id} with only the changed fields.
Apply a JSON Patch to product {id}.
Ask an LLM
“How can I find a product using its ERP or PIM key?”
“Can I fetch a product by outer id?”
Tell an agent
Get the product with outer id {outerId}.
Look up product by integration key {outerId}.
POST
/api/catalog/{catalogId}/products-by-codes
Get products by SKU code in a catalog · Catalog module products get by codes
#
Ask an LLM
“Can I find products in a catalog by their SKU codes?”
“How do I map my SKUs back to Virto products?”
Tell an agent
Get products by these SKU codes in catalog {catalogId}.
Look up product codes in catalog {catalogId} with response group {group}.
Ask an LLM
“Can I load multiple products at once when I have their ids?”
“What is the quickest way to fetch a few products together?”
Tell an agent
Get products {ids}.
Load products {ids} with response group {group}.
POST
/api/catalog/products
Create or update a single product · Create/Update the specified product
#
Ask an LLM
“How do I add a new product to a category?”
“Can I set a product's GTIN, weight and minimum order quantity when saving it?”
Tell an agent
Create product {name} with SKU {code} in catalog {catalogId}.
Save product {name} in category {categoryId} with GTIN {gtin}.
Ask an LLM
“Can I delete several products by id?”
“What removes a product from the catalog?”
Tell an agent destructive · confirm first
Delete products {ids}.
Remove the product {ids}.
PATCH
/api/catalog/products
Partially update many products · Partial update for multiple products.
#
Ask an LLM
“Can I patch fields on many products in one request?”
“What must each patch document contain in a bulk product patch?”
Tell an agent
Bulk patch these products, each identified by its id operation.
Apply partial updates to multiple products at once.
POST
/api/catalog/products/plenty
Get many products by id in one post · Gets products by plenty ids
#
Ask an LLM
“Can I fetch a very long list of products by posting their ids?”
“What if I have too many product ids for a query string?”
Tell an agent
Post this long list of product ids and return the products.
Fetch plenty of products by id with response group {group}.
GET
/api/catalog/{catalogId}/products/getnew
Get a new product template for a catalog · Gets the template for a new product (outside of category)
#
Ask an LLM
“What does a blank product look like when it sits directly in a catalog?”
“Can I get a new product template without choosing a category?”
Tell an agent
Give me a new product template for catalog {catalogId}.
Fetch a blank uncategorized product for catalog {catalogId}.
GET
/api/catalog/{catalogId}/categories/{categoryId}/products/getnew
Get a new product template for a category · Gets the template for a new product (inside category)
#
Ask an LLM
“What does a blank product look like inside a specific category?”
“Can I get a new product template that inherits a category's properties?”
Tell an agent
Give me a new product template for category {categoryId} in catalog {catalogId}.
Fetch a blank product for catalog {catalogId}, category {categoryId}.
GET
/api/catalog/products/{productId}/getnewvariation
Get a template for a new product variation · Gets the template for a new variation
#
Ask an LLM
“How do I start a new size or color variation of a product?”
“What does a blank variation template include?”
Tell an agent
Give me a new variation template for product {productId}.
Fetch a blank variation of product {productId}.
GET
/api/catalog/products/{productId}/clone
Clone a product · Catalog module products clone product
#
Ask an LLM
“Can I duplicate an existing product as a starting point?”
“Does cloning a product save the copy or just return it?”
Tell an agent
Clone product {productId}.
Make a copy of product {productId} to edit.
PATCH
/api/catalog/products/{productId}/{language}
Update given product properties in a language · Updates only given properties
#
Ask an LLM
“Can I update only certain property values of a product for one language?”
“How do I change a product's localized properties without touching the rest?”
Tell an agent
Update only the given properties of product {productId} in {language}.
Set localized property values on product {productId} for language {language}.
POST
/api/catalog/products/batch
Create or update products in bulk · Create/Update the specified products
#
Ask an LLM
“Can I import a batch of products in one request?”
“Is there a bulk save for products?”
Tell an agent
Save this batch of products.
Bulk create or update all these products at once.
GET
/api/catalog/properties/{propertyId}
Get a property definition · Gets property metainformation by id
#
Ask an LLM
“What value type and validation rules does a property have?”
“How do I view one property's metadata by id?”
Tell an agent
Get property {propertyId}.
Show the metadata of property {propertyId}.
GET
/api/catalog/{catalogId}/properties/getnew
Get a template for a new catalog property · Gets the template for a new catalog property
#
Ask an LLM
“What does a blank catalog-level property look like?”
“Can I get a new property template scoped to a catalog?”
Tell an agent
Give me a new property template for catalog {catalogId}.
Fetch a blank catalog-level property for {catalogId}.
GET
/api/catalog/categories/{categoryId}/properties/getnew
Get a template for a new category property · Gets the template for a new category property
#
Ask an LLM
“What does a blank category-level property look like?”
“Can I get a new property template scoped to one category?”
Tell an agent
Give me a new property template for category {categoryId}.
Fetch a blank category-level property for {categoryId}.
POST
/api/catalog/properties
Create or update a property · Creates or updates the specified property
#
Ask an LLM
“How do I add a new product property like color to a catalog?”
“Can a property be multivalue, required or backed by a dictionary?”
Tell an agent
Create property {name} of value type {valueType} in catalog {catalogId}.
Save property {name} on category {categoryId} as required {required}.
Ask an LLM
“Can I delete a property and also remove its values from products?”
“What removes a property definition from the catalog?”
Tell an agent destructive · confirm first
Delete property {id}.
Delete property {id} and its values, with delete values set to {deleteValues}.
POST
/api/catalog/properties/validate-name
Validate a product-level property name · Validate name for Product-level (unmanaged) property
#
Ask an LLM
“Is a new unmanaged property name already used on this product?”
“Can I check a product-level property name before renaming it?”
Tell an agent
Check if property name {name} is valid on product {productId}.
Validate renaming product property {originalName} to {name}.
POST
/api/catalog/properties/validate-property-name
Validate a catalog or category property name · Catalog module properties validate property name
#
Ask an LLM
“Would a new property name clash with one already in the catalog or category?”
“Can I validate a property name and type before creating it?”
Tell an agent
Validate property name {propertyName} for catalog {catalogId}.
Check that {propertyName} of type {type} is free in category {categoryId}.
PATCH
/api/catalog/properties/{id}
Partially update a property · Partial update for the specified Property by id
#
Ask an LLM
“Can I hide a property by patching a single field?”
“Is JSON Patch available for property definitions?”
Tell an agent
Patch property {id}.
Apply a partial update to property definition {id}.
POST
/api/catalog/dictionaryitems/search
Search property dictionary values · Search property dictionary items
#
Ask an LLM
“What allowed values are in a dictionary property like color?”
“Can I search dictionary items for specific properties?”
Tell an agent
Search dictionary items for properties {propertyIds}.
Find dictionary values matching {keyword} in catalogs {catalogIds}.
POST
/api/catalog/dictionaryitems
Save property dictionary values · Creates or updates the specified property dictionary items
#
Ask an LLM
“How do I add new allowed values to a dictionary property?”
“Can I update several dictionary items at once?”
Tell an agent
Save these property dictionary items.
Add these allowed values to the dictionary property.
DELETE
/api/catalog/dictionaryitems
Delete property dictionary values · Delete property dictionary items by ids
#
Ask an LLM
“Can I remove values from a dictionary property?”
“What deletes dictionary items by id?”
Tell an agent destructive · confirm first
Delete dictionary items {ids}.
Remove the allowed value {ids} from its dictionary.
PATCH
/api/catalog/dictionaryitems/{id}
Partially update a dictionary value · Partial update for the specified PropertyDictionaryItem by id
#
Ask an LLM
“Can I change the alias of one dictionary item with a patch?”
“Is JSON Patch supported for dictionary items?”
Tell an agent
Patch dictionary item {id}.
Apply a partial update to dictionary value {id}.
Ask an LLM
“What does a property group contain, like its display order and names?”
“How do I load one property group by id?”
Tell an agent
Get property group {id}.
Show property group {id} with response group {group}.
POST
/api/catalog/propertygroups/search
Search property groups · Catalog module property groups search
#
Ask an LLM
“Which property groups are defined in a catalog?”
“Can I search property groups by keyword?”
Tell an agent
List property groups in catalog {catalogId}.
Search property groups matching {keyword}.
POST
/api/catalog/propertygroups
Create or update a property group · Catalog module property groups update
#
Ask an LLM
“How do I group product properties into sections like Specifications?”
“Can I set a property group's display order?”
Tell an agent
Save property group {name} in catalog {catalogId}.
Set display order {order} on property group {name}.
Ask an LLM
“Can I remove property groups I no longer use?”
“What deletes property groups by id?”
Tell an agent destructive · confirm first
Delete property groups {ids}.
Remove the property group {ids}.
Ask an LLM
“Is video support configured for the catalog?”
“What video settings does the platform configuration provide?”
Tell an agent
Show the video options from configuration.
Get the configured catalog video settings.
Ask an LLM
“How do I attach a video to a product from its URL?”
“Can I set the language and sort order of a product video?”
Tell an agent
Create a video from {url} for product {ownerId}.
Add video {url} to {ownerType} {ownerId} in language {language}.
Ask an LLM
“Which videos are attached to a product?”
“Can I search videos for several owners at once?”
Tell an agent
Search videos for owners {ownerIds}.
List videos of owner type {ownerType} matching {keyword}.
Ask an LLM
“Can I create or update several product videos at once?”
“Which call saves a batch of full video records?”
Tell an agent
Save this batch of video records.
Create or update all these videos at once.
Ask an LLM
“Can I remove videos from a product?”
“What deletes videos by id?”
Tell an agent destructive · confirm first
Delete videos {ids}.
Remove the product video {ids}.
PATCH
/api/catalog/videos/{id}
Partially update a video · Partial update for the specified Video by id
#
Ask an LLM
“Can I change a video's sort order with a patch?”
“Is JSON Patch supported for product videos?”
Tell an agent
Patch video {id}.
Apply a partial update to video {id}.
Documentation
Specifications
SDKs
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-catalog
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-pricing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-inventory
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-order
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-x-cart
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-customer
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-marketing
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-quote
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-module-store
📦
GitHubRepository
https://github.com/VirtoCommerce/vc-platform
Other Resources
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/overlays/virto-commerce-catalog-api-overlay.yaml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/graphql/virto-commerce-graphql.md
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/apis.yml