How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Virto Commerce Catalog API

Easily manage your products, categories, variations, and properties

Virto Commerce Catalog API is one of 13 APIs that Virto Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Catalog. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 92 operations across 70 paths, and defines 87 schemas. It is described by OpenAPI 3.0.4, at version v1.

Requests are made against the base URL https://virtostart-demo-admin.govirto.com/api.

92 operations 70 paths 87 schemas 11 DELETE26 GET11 PATCH40 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
v1
Base URL
https://virtostart-demo-admin.govirto.com/api
Authentication
OAuth 2.0, API Key, API Key, HTTP Signature, HTTP Basic
Resource Areas
1

Authentication & Security 5

Virto Commerce Catalog API declares 5 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the password and clientCredentials flows. An API key is passed in the query as api_key (api_key). An API key is passed in the header as api_key (api_key_header). It uses HTTP signature authentication (http-signature). It accepts HTTP basic authentication (basic).

  • oauth2 — OAuth2 Resource Owner Password Grant flow
  • api_key — API Key authentication
  • api_key_header — API Key authentication (alternative via header)
  • http-signature — HTTP Signature authentication using Authorization header
  • basic — Basic authentication using username and password

Paths & Operations 92

Across 70 paths, the API surfaces 92 operations — 11 DELETE, 26 GET, 11 PATCH, 40 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Catalog 92

Easily manage your products, categories, variations, and properties

POST
/api/catalog/automatic-link-queries/search
AutomaticLinkQuery_Search body → 200401403
POST
/api/catalog/automatic-link-queries
AutomaticLinkQuery_Create body → 200401403
PUT
/api/catalog/automatic-link-queries
AutomaticLinkQuery_Update body → 200401403
DELETE
/api/catalog/automatic-link-queries
AutomaticLinkQuery_Delete 1 param → 204401403
GET
/api/catalog/automatic-link-queries/{id}
AutomaticLinkQuery_Get 2 params → 200401403
GET
/api/catalog/products/associations/{productId}
Returns list of associations for specified product
CatalogModuleAssociations_GetProductAssociations 1 param → 200401403
POST
/api/catalog/products/associations/get/multiple
Returns list of associations for specified products
CatalogModuleAssociations_GetProductsAssociations body → 200401403
POST
/api/catalog/products/associations
Updates the specified association
CatalogModuleAssociations_UpdateAssociations body → 200401403
DELETE
/api/catalog/products/associations
Deletes specified associations
CatalogModuleAssociations_Delete 1 param → 200401403
POST
/api/catalog/products/associations/search
Returns associations by search criteria
CatalogModuleAssociations_Search body → 200401403
PATCH
/api/catalog/products/associations/{id}
Partial update for the specified association by id
CatalogModuleAssociations_PatchAssociation 1 param body → 204401403
GET
/api/brand-settings/store/{storeId}
CatalogModuleBrandSetting_GetByStoreId 1 param → 200401403
PUT
/api/brand-settings
CatalogModuleBrandSetting_Update body → 204401403
POST
/api/catalog/catalogs/search
CatalogModuleCatalogs_SearchCatalogs body → 200401403
GET
/api/catalog/catalogs/{id}
Gets Catalog by id
CatalogModuleCatalogs_GetCatalog 2 params → 200401403
DELETE
/api/catalog/catalogs/{id}
Deletes catalog by id
CatalogModuleCatalogs_DeleteCatalog 1 param → 204401403
PATCH
/api/catalog/catalogs/{id}
Partial update for the specified Catalog by id
CatalogModuleCatalogs_PatchCatalog 1 param body → 204401403
GET
/api/catalog/catalogs/outer/{outerId}
Gets catalog by outer id.
CatalogModuleCatalogs_GetCatalogByOuterId 2 params → 200401403
GET
/api/catalog/catalogs/getnew
Gets the template for a new catalog
CatalogModuleCatalogs_GetNewCatalog → 200401403
GET
/api/catalog/catalogs/getnewvirtual
Gets the template for a new virtual catalog
CatalogModuleCatalogs_GetNewVirtualCatalog → 200401403
POST
/api/catalog/catalogs
Creates the specified catalog
CatalogModuleCatalogs_CreateCatalog body → 200401403
PUT
/api/catalog/catalogs
Updates the specified catalog
CatalogModuleCatalogs_UpdateCatalog body → 200401403
GET
/api/catalog/categories/{id}
Gets category by id.
CatalogModuleCategories_GetCategory 2 params → 200401403
PATCH
/api/catalog/categories/{id}
Partial update for the specified Category by id
CatalogModuleCategories_PatchCategory 1 param body → 204401403
GET
/api/catalog/categories/outer/{outerId}
Gets category by outer id.
CatalogModuleCategories_GetCategoryByOuterId 2 params → 200401403
GET
/api/catalog/categories
Gets categories by ids
CatalogModuleCategories_GetCategoriesByIdsAsync 2 params → 200401403
POST
/api/catalog/categories
Creates or updates the specified category.
CatalogModuleCategories_CreateOrUpdateCategory body → 200401403
DELETE
/api/catalog/categories
Deletes the specified categories by id.
CatalogModuleCategories_DeleteCategory 1 param → 204401403
POST
/api/catalog/categories/plenty
Get categories by plenty ids
CatalogModuleCategories_GetCategoriesByPlentyIds 1 param body → 200401403
POST
/api/catalog/{catalogId}/categories-by-codes
Gets categories by codes
CatalogModuleCategories_GetCategoriesByCodes 2 params body → 200401403
GET
/api/catalog/{catalogId}/categories/newcategory
Gets the template for a new category.
CatalogModuleCategories_GetNewCategory 2 params → 200401403
POST
/api/catalog/categories/batch
Create/Update the specified categories.
CatalogModuleCategories_SaveCategories body → 200401403
POST
/api/catalog/categories/{id}/automatic-links
CatalogModuleCategories_UpdateAutomaticLinks 1 param → 204401403
DELETE
/api/catalog/categories/{id}/automatic-links
CatalogModuleCategories_DeleteAutomaticLinks 1 param → 204401403
GET
/api/catalog/products/configurations/{id}
Get configuration by id.
CatalogModuleConfigurations_GetConfiguration 1 param → 200401403
PATCH
/api/catalog/products/configurations/{id}
Partial update for the specified Configuration by id
CatalogModuleConfigurations_PatchConfiguration 1 param body → 204401403
POST
/api/catalog/products/configurations/search
Search configurations
CatalogModuleConfigurations_SearchConfigurations body → 200401403
POST
/api/catalog/products/configurations
Create or update the specified configuration.
CatalogModuleConfigurations_CreateOrUpdateConfiguration body → 200401403
POST
/api/catalog/search/products
CatalogModuleIndexedSearch_SearchProducts body → 200401403
POST
/api/catalog/search/products/suggestions
CatalogModuleIndexedSearch_GetProductSuggestions 3 params → 200401403
POST
/api/catalog/search/categories
CatalogModuleIndexedSearch_SearchCategories body → 200401403
POST
/api/catalog/listentries
Searches for the items by complex criteria.
CatalogModuleListEntry_ListItemsSearchAsync body → 200401403
POST
/api/catalog/listentrylinks
Creates links for categories or items to parent categories and catalogs.
CatalogModuleListEntry_CreateLinks body → 200401403
POST
/api/catalog/listentrylinks/bulkcreate
Creates category links in bulk for catalog entries based on the specified search criteria.
CatalogModuleListEntry_BulkCreateLinks body → 200401403
POST
/api/catalog/listentrylinks/search
CatalogModuleListEntry_SearchLinks body → 200401403
POST
/api/catalog/listentrylinks/delete
Unlinks the linked categories or items from parent categories and catalogs.
CatalogModuleListEntry_DeleteLinks body → 204401403
POST
/api/catalog/listentries/move
Move categories or products to another location.
CatalogModuleListEntry_Move body → 204401403
POST
/api/catalog/listentries/delete
Bulk delete by the search criteria.
CatalogModuleListEntry_Delete body → 204401403
GET
/api/catalog/measures/{id}
CatalogModuleMeasures_GetMeasureById 1 param → 200401403
PATCH
/api/catalog/measures/{id}
Partial update for the specified Measure by id
CatalogModuleMeasures_PatchMeasure 1 param body → 204401403
POST
/api/catalog/measures/search
CatalogModuleMeasures_SearchMeasures body → 200401403
POST
/api/catalog/measures
CatalogModuleMeasures_CreateMeasure body → 200401403
PUT
/api/catalog/measures
CatalogModuleMeasures_UpdateMeasure body → 204401403
DELETE
/api/catalog/measures
CatalogModuleMeasures_DeleteMeasures 1 param → 204401403
GET
/api/catalog/measures/default
CatalogModuleMeasures_GetDefaultMeasures → 200401403
GET
/api/catalog/products/{id}
Gets product by id.
CatalogModuleProducts_GetProductById 2 params → 200401403
PATCH
/api/catalog/products/{id}
Partial update for the specified Product by id
CatalogModuleProducts_PatchProduct 1 param body → 204401403
GET
/api/catalog/products/outer/{outerId}
Gets product by outer id.
CatalogModuleProducts_GetProductByOuterId 2 params → 200401403
POST
/api/catalog/{catalogId}/products-by-codes
CatalogModuleProducts_GetByCodes 2 params body → 200401403
GET
/api/catalog/products
Gets products by ids
CatalogModuleProducts_GetProductByIds 2 params → 200401403
POST
/api/catalog/products
Create/Update the specified product.
CatalogModuleProducts_SaveProduct body → 204200401403
DELETE
/api/catalog/products
Deletes the specified items by id.
CatalogModuleProducts_DeleteProduct 1 param → 200401403
PATCH
/api/catalog/products
Partial update for multiple products. Each patch document must contain a replace /id operation to identify the target product.
CatalogModuleProducts_BulkPatchProducts body → 204401403
POST
/api/catalog/products/plenty
Gets products by plenty ids
CatalogModuleProducts_GetProductByPlentyIds 1 param body → 200401403
GET
/api/catalog/{catalogId}/products/getnew
Gets the template for a new product (outside of category).
CatalogModuleProducts_GetNewProductByCatalog 1 param → 200401403
GET
/api/catalog/{catalogId}/categories/{categoryId}/products/getnew
Gets the template for a new product (inside category).
CatalogModuleProducts_GetNewProductByCatalogAndCategory 2 params → 200401403
GET
/api/catalog/products/{productId}/getnewvariation
Gets the template for a new variation.
CatalogModuleProducts_GetNewVariation 1 param → 200401403
GET
/api/catalog/products/{productId}/clone
CatalogModuleProducts_CloneProduct 1 param → 200401403
PATCH
/api/catalog/products/{productId}/{language}
Updates only given properties
CatalogModuleProducts_ProductPartialUpdate 2 params body → 200401403
POST
/api/catalog/products/batch
Create/Update the specified products.
CatalogModuleProducts_SaveProducts body → 200401403
GET
/api/catalog/properties/{propertyId}
Gets property metainformation by id.
CatalogModuleProperties_GetProperty 1 param → 200401403
GET
/api/catalog/{catalogId}/properties/getnew
Gets the template for a new catalog property.
CatalogModuleProperties_GetNewCatalogProperty 1 param → 200401403
GET
/api/catalog/categories/{categoryId}/properties/getnew
Gets the template for a new category property.
CatalogModuleProperties_GetNewCategoryProperty 1 param → 200401403
POST
/api/catalog/properties
Creates or updates the specified property.
CatalogModuleProperties_SaveProperty body → 204401403
DELETE
/api/catalog/properties
Deletes property by id.
CatalogModuleProperties_DeleteProperty 2 params → 204401403
POST
/api/catalog/properties/validate-name
Validate name for Product-level (unmanaged) property
CatalogModuleProperties_ValidateName body → 200401403
POST
/api/catalog/properties/validate-property-name
CatalogModuleProperties_ValidatePropertyName body → 200401403
PATCH
/api/catalog/properties/{id}
Partial update for the specified Property by id
CatalogModuleProperties_PatchProperty 1 param body → 204401403
POST
/api/catalog/dictionaryitems/search
Search property dictionary items
CatalogModulePropertyDictionaryItems_SearchPropertyDictionaryItems body → 200401403
POST
/api/catalog/dictionaryitems
Creates or updates the specified property dictionary items
CatalogModulePropertyDictionaryItems_SaveChanges body → 200401403
DELETE
/api/catalog/dictionaryitems
Delete property dictionary items by ids
CatalogModulePropertyDictionaryItems_DeletePropertyDictionaryItems 1 param → 200401403
PATCH
/api/catalog/dictionaryitems/{id}
Partial update for the specified PropertyDictionaryItem by id
CatalogModulePropertyDictionaryItems_PatchPropertyDictionaryItem 1 param body → 204401403
GET
/api/catalog/propertygroups/{id}
CatalogModulePropertyGroups_Get 2 params → 200401403
POST
/api/catalog/propertygroups/search
CatalogModulePropertyGroups_Search body → 200401403
POST
/api/catalog/propertygroups
CatalogModulePropertyGroups_Update body → 200401403
DELETE
/api/catalog/propertygroups
CatalogModulePropertyGroups_Delete 1 param → 204401403
GET
/api/catalog/videos/options
Get video options from configuration
CatalogModuleVideos_GetOptions → 200401403
POST
/api/catalog/videos/create
Create video
CatalogModuleVideos_CreateVideo body → 200400401403
POST
/api/catalog/videos/search
Search videos
CatalogModuleVideos_SearchVideos body → 200401403
POST
/api/catalog/videos
Create new or update existing videos
CatalogModuleVideos_Update body → 200401403
DELETE
/api/catalog/videos
Delete videos by ids
CatalogModuleVideos_Delete 1 param → 204401403
PATCH
/api/catalog/videos/{id}
Partial update for the specified Video by id
CatalogModuleVideos_PatchVideo 1 param body → 204401403

Schemas 87

The contract defines 87 schemas that model the data the API accepts and returns. The most detailed are CatalogProduct (59 properties), Variation (59 properties), Store (37 properties), ProductIndexedSearchCriteria (35 properties). Each schema is shown below with its type and property counts.

Category
object
33 properties
PropertyType
string
PropertyValueType
string
PropertyValidationRule
object
Represents property validation rules definition
6 properties
Aggregation
object
6 properties
PropertyGroupSearchCriteria
object
12 properties
Store
object
37 properties
BulkLinkCreationRequest
object
Information to search and create links to categories and items
3 properties
EditorialReview
object
9 properties
BrandStoreSetting
object
5 properties
Variation
object
59 properties
PropertyValue
object
18 properties
AggregationLabel
object
2 properties
ExcludedProperty
object
2 properties
AggregationStatistics
object
2 properties
ProductAssociation
object
13 properties
VideoCreateRequest
object
5 properties
PropertyDictionaryItem
object
6 properties
AutomaticLinkQuery
object
8 properties
AggregationItem
object
8 properties
MeasureUnit
object
12 properties
ObjectSettingEntry
object
20 properties
LocalizedString
object
1 property
Video
object
Video content information
16 properties
CategoryIndexedSearchCriteria
object
21 properties
StoreState
string
CatalogSearchCriteria
object
14 properties
SeoInfo
object
18 properties
Severity
string
DynamicPropertyValueType
string
PropertyValidationRequest
object
Property name validation data
3 properties
GeoDistanceFilter
object
3 properties
Property
object
29 properties
CategoryDescription
object
9 properties
AutomaticLinkQuerySearchResult
object
2 properties
ProductConfigurationSearchCriteria
object
14 properties
AutomaticLinkQuerySearchCriteria
object
12 properties
ListEntryBase
object
Base class for all entries used in catalog categories browsing.
18 properties
PropertyGroupSearchResult
object
2 properties
OutlineItem
object
Represents one outline element: catalog, category or product.
6 properties
Operation
object
4 properties
Asset
object
21 properties
Image
object
19 properties
PropertyDictionaryItemLocalizedValue
object
2 properties
PropertyAttribute
object
8 properties
ValidationFailure
object
7 properties
VideoProvidersStatus
object
2 properties
CategoryPropertyValidationRequest
object
5 properties
CatalogLanguage
object
5 properties
VideoSearchCriteria
object
13 properties
ProductAssociationSearchResult
object
2 properties
CategoryIndexedSearchResult
object
3 properties
ProductConfiguration
object
8 properties
Measure
object
9 properties
MeasureSearchResult
object
2 properties
PropertyDictionaryItemSearchResult
object
2 properties
ProductConfigurationSection
object
16 properties
PropertyDictionaryItemSearchCriteria
object
Search criteria used for search property dictionary items
13 properties
SortInfo
object
2 properties
SuggestionResponse
object
1 property
Outline
object
Represents the path from the catalog to one of the child objects (product or category): catalog/parent-category1/.../parent-categoryN/object
1 property
JsonPatchDocument
object
1 property
ProductConfigurationOption
object
13 properties
CatalogSearchResult
object
2 properties
PropertyDisplayName
object
2 properties
GeoPoint
object
2 properties
DynamicPropertyName
object
2 properties
ProductIndexedSearchResult
object
3 properties
VideoSearchResult
object
2 properties
ValidationResult
object
3 properties
ProductConfigurationSearchResult
object
2 properties
ListEntrySearchResult
object
3 properties
Catalog
object
14 properties
ProductIndexedSearchCriteria
object
35 properties
DynamicPropertyObjectValue
object
8 properties
DynamicObjectProperty
object
17 properties
CategoryLink
object
9 properties
CatalogProduct
object
59 properties
MeasureSearchCriteria
object
11 properties
ProductAssociationSearchCriteria
object
14 properties
SettingValueType
string
CatalogListEntrySearchCriteria
object
29 properties
SortDirection
string
NumericRange
object
4 properties
LinkSearchCriteria
object
14 properties
ListEntriesMoveRequest
object
Represents move list entries command
4 properties
PropertyGroup
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

virto-commerce-catalog-api-openapi.yml Raw ↑

Other APIs Virto Commerce publishes across the network.

Virto Commerce Companies and Contacts API
Virto Commerce Inventory API
Virto Commerce Marketing API
Virto Commerce Order Management API
Virto Commerce Pricing API
Virto Commerce Quotes API
Virto Commerce Shopping Cart API
Virto Commerce Store API
Virto Commerce VirtoCommerce Platform API
Virto Commerce Webhooks API
Virto Commerce Event Bus API
Virto Commerce Returns API
Where this information came from

This is an independent, third-party profile of Virto Commerce Catalog API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.