Virto Commerce

Virto Commerce VirtoCommerce Platform API

B2B Innovation Platform

GitHub OpenAPI

Operations 124

GET /externalsignin External sign in sign in #
GET /externalsignin/signout External sign in sign out #
GET /externalsignin/callback External sign in sign in callback #
GET /externalsignin/providers External sign in get external login providers #
GET /api/apps/{appId}/manifest Returns the host app's plugin manifest. #
POST /api/apps/manifest/invalidate Force-invalidate the manifest cache for every `appId`. #
GET /api/platform/apps Gets the list of available apps, filtered by user permissions #
POST /revoke/token Authorization revoke current user token #
POST /connect/token Authorization exchange #
GET /connect/authorize Authorization authorize #
POST /connect/authorize Authorization authorize #
GET /connect/userinfo Authorization userinfo #
POST /connect/userinfo Authorization userinfo #
GET /connect/logout Authorization logout #
POST /api/changes/force Force set changes last modified date #
POST /api/platform-cache/reset Change log reset platform cache #
GET /api/changes/lastmodifieddate Get last modified date for given scope Used for signal of what something… #
POST /api/changes/changed-entities Change log get changed entities #
POST /api/changes/changed-entities/reset Change log reset changed entities #
POST /api/platform/changelog/search Change log search changes #
POST /api/platform/changelog/v2/search Change log search changes V2 #
GET /api/platform/changelog/{type}/changes Change log search type change history #
GET /api/platform/developer-tools Developer tools get developer tools #
GET /api/platform/diagnostics/systeminfo Diagnostics get system info #
GET /api/platform/diagnostics/errors Get installed modules with errors #
GET /api/platform/dynamic/types Get object types which support dynamic properties #
GET /api/platform/dynamic/properties Dynamic properties get all dynamic properties #
POST /api/platform/dynamic/properties Add new dynamic property #
PUT /api/platform/dynamic/properties Update existing dynamic property #
DELETE /api/platform/dynamic/properties Delete dynamic property #
POST /api/platform/dynamic/properties/search Get dynamic properties registered for object type #
POST /api/platform/dynamic Does nothing. Just a way to expose DynamicObjectProperty thru Swagger #
GET /api/platform/dynamic/dictionaryitems Dynamic properties get all dictionary items #
POST /api/platform/dynamic/dictionaryitems Add or update dictionary items #
DELETE /api/platform/dynamic/dictionaryitems Delete dictionary items #
POST /api/platform/dynamic/dictionaryitems/search Get dictionary items #
GET /api/platform/jobs/{id} Get background job status #
GET /api/platform/localizable-settings Localizable settings get settings and languages #
GET /api/platform/localizable-settings/{name}/dictionary-items/{language}/values Localizable settings get dictionary values #
POST /api/platform/localizable-settings/{name}/dictionary-items Localizable settings save dictionary items #
DELETE /api/platform/localizable-settings/{name}/dictionary-items Localizable settings delete dictionary items #
POST /api/platform/modules/reload Reload modules #
GET /api/platform/modules Get installed modules #
POST /api/platform/modules/getdependents Get all dependent modules for a module #
POST /api/platform/modules/getmissingdependencies Returns a flat expanded list of modules that depend on passed modules #
POST /api/platform/modules/localstorage Upload module package for installation or update #
POST /api/platform/modules/install Install modules #
POST /api/platform/modules/install/v2 Install modules using lightweight requests #
POST /api/platform/modules/update Update modules #
POST /api/platform/modules/update/v2 Update modules using lightweight requests #
POST /api/platform/modules/uninstall Uninstall module #
POST /api/platform/modules/uninstall/v2 Uninstall modules using lightweight requests #
POST /api/platform/modules/restart Restart web application #
POST /api/platform/modules/autoinstall Auto-install modules with specified groups #
GET /api/platform/modules/loading-order Get module loading order #
GET /api/platform/modules/{moduleId}/versions/{version}/validate Validate that a specific module version package exists at the download URL #
POST /api/platform/modules/{moduleId}/versions/{version}/install Install a specific version of a module. #
POST /api/platform/modules/{moduleId}/install Install the latest available version of a module #
POST /api/platform/modules/{moduleId}/uninstall Uninstall a module #
GET /api/platform/oauthapps/new OAuth apps new #
POST /api/platform/oauthapps OAuth apps save async #
DELETE /api/platform/oauthapps OAuth apps delete async #
POST /api/platform/oauthapps/search OAuth apps search async #
POST /api/platform/pushnotifications SearchAsync push notifications #
POST /api/platform/pushnotifications/markAllAsRead Mark all notifications as read #
POST /api/platform/security/users/{userId}/sessions/search Security search user sessions #
DELETE /api/platform/security/users/{userId}/sessions/{id} Security terminate user session #
DELETE /api/platform/security/users/{userId}/sessions Security terminate all user sessions #
POST /api/platform/security/login Sign in with user name and password #
GET /api/platform/security/logout Sign out #
GET /api/platform/security/currentuser Get current user details #
GET /api/platform/security/userinfo Security userinfo #
GET /api/platform/security/permissions Get all registered permissions #
POST /api/platform/security/roles/search SearchAsync roles by keyword #
GET /api/platform/security/roles/{roleName} Get role by ID #
DELETE /api/platform/security/roles Delete roles by ID #
PUT /api/platform/security/roles Update an existing role or create new #
POST /api/platform/security/users/search SearchAsync users by keyword #
GET /api/platform/security/users Get users by IDs #
PUT /api/platform/security/users Update user details by user ID #
DELETE /api/platform/security/users Delete users by name #
GET /api/platform/security/users/{userName} Get user details by user name #
GET /api/platform/security/users/id/{id} Get user details by user ID #
GET /api/platform/security/users/email/{email} Get user details by user email #
GET /api/platform/security/users/login/external/{loginProvider}/{providerKey} Get user details by external login provider #
POST /api/platform/security/users/create Create new user #
POST /api/platform/security/currentuser/changepassword Change password for current user #
POST /api/platform/security/users/{userName}/changepassword Change password #
POST /api/platform/security/users/{userName}/resetpassword Reset password confirmation #
POST /api/platform/security/users/{userId}/resetpasswordconfirm Reset password confirmation #
POST /api/platform/security/users/{userId}/validatepasswordresettoken Validate password reset token #
POST /api/platform/security/users/{loginOrEmail}/requestpasswordreset Send email with instructions on how to reset user password #
POST /api/platform/security/validatepassword Security validate password #
POST /api/platform/security/validateuserpassword Security validate user password #
GET /api/platform/security/users/{id}/locked Checks if user locked #
GET /api/platform/security/passwordchangeenabled Checks if manual password change is enabled #
POST /api/platform/security/users/{id}/lock Lock user #
POST /api/platform/security/users/{id}/unlock Unlock user #
GET /api/platform/security/users/{id}/apikeys Security get user api keys #
POST /api/platform/security/users/apikeys Security save user api key #
PUT /api/platform/security/users/apikeys Security update user api key #
DELETE /api/platform/security/users/apikeys Security delete user api keys #
GET /api/platform/security/logintypes Get allowed login types #
POST /api/platform/security/users/{userId}/sendVerificationEmail Verify user email #
POST /api/platform/security/users/{userId}/confirmEmail Security confirm email #
GET /api/platform/security/users/{userId}/generateChangeEmailToken Security generate change email token #
GET /api/platform/security/users/{userId}/generateEmailConfirmationToken Security generate email confirmation token #
GET /api/platform/security/users/{userId}/generatePasswordResetToken Security generate password reset token #
GET /api/platform/security/users/{userId}/generateToken Security generate user token #
POST /api/platform/security/users/{userId}/verifyToken Security verify user token #
GET /api/platform/settings Get all settings #
POST /api/platform/settings Update settings values #
GET /api/platform/settings/modules/{id} Get settings registered by specific module #
GET /api/platform/settings/{name} Get setting details by name #
GET /api/platform/settings/ui/customization Get UI customization setting #
GET /api/platform/settings/v2/global/schema Get global settings schema (metadata only, no values) #
GET /api/platform/settings/v2/global/values Get global settings values as a flat { name: value } dictionary. #
POST /api/platform/settings/v2/global/values Settings V2 save global values #
GET /api/platform/settings/v2/tenant/{tenantType}/schema Get tenant settings schema (metadata only, no values). #
GET /api/platform/settings/v2/tenant/{tenantType}/{tenantId}/values Get tenant settings values as a flat { name: value } dictionary. #
POST /api/platform/settings/v2/tenant/{tenantType}/{tenantId}/values Settings V2 save tenant values #
GET /api/platform/settings/v2/me/schema Get the current user's UserProfile settings schema (metadata only). #
GET /api/platform/settings/v2/me/values Get the current user's effective UserProfile settings values as a flat { name… #
POST /api/platform/settings/v2/me/values Settings V2 save me values #

Documentation

📖
Documentation
https://docs.virtocommerce.org/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/openapi/virto-commerce-virtocommerce-platform-api-openapi.yml

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-virtocommerce-platform-api-overlay.yaml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/graphql/virto-commerce-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/virto-commerce-virtocommerce-platform-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

virto-commerce-virtocommerce-platform-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Virto Commerce Solution REST API Documentation…
  description: Virto Commerce provides API documentation in two formats, JSON and YAML, with schema files generated as swagger.json and swagger.yaml. To ensure secure access, authorization filters can be applied using a specific key to grant access. This allows authorized users to securely interact with the API and access the necessary resources while maintaining confidentiality and data integrity.
  termsOfService: https://virtocommerce.com/terms
  contact:
    name: Virto Commerce
    url: https://virtocommerce.com
    email: support@virtocommerce.com
  license:
    name: Virto Commerce Open Software License 3.0
    url: https://virtocommerce.com/open-source-license
  version: v1
tags:


# --- truncated at 32 KB (193 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/virto-commerce/refs/heads/main/openapi/virto-commerce-virtocommerce-platform-api-openapi.yml