MCP Server and Resource Metrics

  • Server URL: https://<domain>/appmarketplace/mcp
  • Total Tools: 57
  • Total Error Codes: 6

Server Overview

The MCP server offers a robust suite of 57 tools designed to manage app configurations, pricing, installations, webhooks, caching, and business associations, providing businesses with streamlined operations, enhanced customization, and efficient data handling capabilities.

Tools

The following table lists the available MCP tools for App Marketplace service along with their descriptions and required/optional parameters:

Tool Name Tool Description Required Parameters Optional Parameters
updateWebhookStoreApp This tool updates webhook details based on the subscription ID, with customizable parameters and detailed response properties.
  • subscriptionId
  • x-auth-token
  • x-api-key
  • appId
  • appVersion
  • storeId
  • businessId
  • serviceCollectionId
  • serviceName
  • webhookId
  • webhookName
  • webhookType
  • webhookUrl
  • webhookTestUrl
  • priority
  • active
  • x-version
  • locale
patchUpdateWebhookStoreApp This tool updates specified or all webhook fields based on a unique subscription ID, with detailed response properties and parameters.
  • subscriptionId
  • x-auth-token
  • x-api-key
  • webhookUrl
  • webhookTestUrl
  • priority
  • active
  • archive
  • x-version
  • locale
findAppDetailsById This tool retrieves app details for a business using a unique app ID, with locale-specific responses and authentication properties.
  • x-auth-token
  • x-appVersion
  • appId
  • businessId
  • x-api-key
  • x-version
  • x-config-flag
  • locale
updateApp This tool enables users logged into the Infosys Equinox Commerce platform to update their business app using specific parameters and detailed response properties.
  • x-auth-token
  • x-appVersion
  • appId
  • businessId
  • x-api-key
  • appName
  • appCategory
  • appGoal
  • appShortDescription
  • appSummary
  • visibilityType
  • appSupport
  • appImages
  • tags
  • processType
  • x-version
  • locale
  • developerOrg
  • pricingType
  • appDisplayType
  • properties
Patch_Update_a_App This tool updates specified app fields based on the request body, with responses in the defined locale format.
  • x-auth-token
  • appId
  • x-appVersion
  • businessId
  • x-api-key
  • appName
  • appCategory
  • appGoal
  • appShortDescription
  • appSummary
  • visibilityType
  • appSupport
  • appImages
  • tags
  • appStatus
  • processType
  • remarks
  • x-version
  • locale
  • developerOrg
  • pricingType
  • appDisplayType
  • properties
updateAppInstall This tool updates an installed app using store and app identifiers, with locale-based responses.
  • x-auth-token
  • storeId
  • appId
  • x-api-key
  • x-version
  • locale
  • x-appVersion
  • appConfigData
updateAppPricing This tool updates app pricing details using appId and locale parameters, returning a JSON response with app ID, version, and price list.
  • x-auth-token
  • x-appVersion
  • appId
  • x-api-key
  • x-version
  • locale
  • priceList
patchUpdateAppPricing This tool updates specified pricing details of an app using the request body, with locale-based responses and auto-generated app IDs.
  • x-auth-token
  • x-appVersion
  • appId
  • x-api-key
  • x-version
  • locale
  • priceList
putAppDescription This tool updates an app’s description using its unique ID and supports locale-specific responses.
  • x-auth-token
  • businessId
  • x-appVersion
  • appId
  • x-api-key
  • x-version
  • locale
  • appDescriptionList
patchAppDescription This tool updates specified or all app description fields based on request data, using appId and optional locale parameters, returning a JSON response with app details.
  • x-auth-token
  • businessId
  • x-appVersion
  • appId
  • x-api-key
  • x-version
  • locale
  • appDescriptionList
updateAppConfig This tool updates app configuration details using appId and optional locale parameters, returning a 202 success response with app-specific data.
  • x-auth-token
  • appId
  • businessId
  • x-appVersion
  • x-api-key
  • x-version-id
  • locale
  • apiConfig
  • appScopes
  • properties
  • webhookHeaders
  • webhooksConfig
  • extensionConfig
patchUpdateAppConfig This tool updates app configuration details based on the request body, supporting locale-specific responses and providing app-related metadata upon success.
  • x-auth-token
  • appId
  • businessId
  • x-appVersion
  • x-api-key
  • x-version-id
  • locale
  • apiConfig
  • appScopes
  • properties
  • webhookHeaders
  • webhooksConfig
  • extensionConfig
getAllwebhooks This tool retrieves webhooks by name, supports pagination, locale settings, and returns detailed webhook and pageable information.
  • x-auth-token
  • x-api-key
  • x-version
  • webhookName
  • includeAll
  • locale
  • page
  • size
createWebhookStoreApp This tool generates app and webhook details for a store, including IDs, names, URLs, and statuses.
  • x-auth-token
  • x-api-key
  • appId
  • appVersion
  • storeId
  • businessId
  • serviceCollectionId
  • serviceName
  • webhookId
  • webhookName
  • webhookType
  • webhookUrl
  • webhookTestUrl
  • priority
  • active
  • x-version
  • locale
refreshApi This tool updates secret keys without restart, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
getAllPrivateAppAssociation This tool retrieves a list of all Private Apps linked to a business using its business ID, with options for filtering, pagination, and sorting.
  • x-auth-token
  • associatedBusinessId
  • x-api-key
  • x-version
  • locale
  • filters
  • page
  • sort
  • size
createPrivateAppAssociation This tool links a private app to a business by ID, enabling app access extension to other businesses while remaining visible only to selected ones.
  • appId
  • x-appVersion
  • businessId
  • x-auth-token
  • x-api-key
  • associatedBusinessId
  • x-version
createPrivateAppAssociation_1 This tool manages the association status of private apps, enabling selected businesses to access them, with responses detailing app ID, version, status, and business identifiers.
  • appId
  • x-appVersion
  • businessId
  • x-auth-token
  • x-api-key
  • associatedStatus
  • x-version
  • associatedBusinessId
appInvocationApi This tool retrieves app details like appID and appVersion for a third-party app using a webhook name and invocation URL, returning a JSON response.
  • appId
  • storeId
  • x-auth-token
  • x-api-key
  • url
  • webookName
  • x-appVerison
  • actionType
  • appClassName
  • requestPayload
cacheClear This tool clears cached data for specified cache names, supports string-type keys, and can clear all cache if no key or pattern is provided.
  • x-auth-token
  • cacheName
  • x-api-key
  • cacheKey
  • pattern
cacheClear_1 This tool clears cached data using dynamic cache keys and provides a JSON response with status, message, and timestamp.
  • x-api-key
  • cacheNames
  • cacheKey
  • simpleKey
  • pattern
browseApp This tool retrieves all apps for a business using its ID, with options for filtering, sorting, and pagination.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version
  • locale
  • filters
  • sort
  • page
  • size
createApp This tool enables users to create business apps on the Infosys Equinox Commerce platform after logging in with valid credentials.
  • x-auth-token
  • businessId__header
  • x-api-key
  • businessId
  • appName
  • appKey
  • appCategory
  • appGoal
  • appShortDescription
  • appSummary
  • visibilityType
  • appVersion
  • appSupport
  • appImages
  • x-version
  • locale
  • parentAppId
  • developerOrg
  • pricingType
  • appDisplayType
  • tags
  • properties
  • processType
generateApiKeyAndSecret This tool generates the key and secret for an app using appId and businessId parameters, with locale customization and detailed response properties.
  • x-auth-token
  • appId
  • x-appVersion
  • businessId
  • x-api-key
  • email
  • x-version
  • locale
saveAppInstallation This tool installs an app with its configuration details using a unique app ID for a store.
  • x-auth-token
  • x-appVersion
  • appId
  • x-api-key
  • x-version
  • locale
  • merchantId
  • storeList
  • appConfigData
  • installs
  • businessId
  • businessEmail
  • clientId
  • merchantEmailId
  • isDefault
updateApp_1 This tool updates specific or all fields of an app or uninstalls it using appId and optional locale parameters.
  • x-auth-token
  • x-appVersion
  • appId
  • x-api-key
  • x-version
  • locale
  • merchantId
  • category
  • clientId
  • storeList
  • active
  • appDisplayType
  • appConfigData
  • installs
  • reason
  • status
  • merchantTriggered
  • isDefault
createAppPricing This tool stores app pricing details, supports locale-based responses, and returns a JSON with app ID, version, and price list upon success.
  • x-auth-token
  • x-api-key
  • appId
  • appVersion
  • x-version
  • locale
  • priceList
createAppDescription This tool stores app metadata details, supports locale-based responses, and provides app ID, version, and descriptions in JSON format.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version
  • locale
  • appId
  • appVersion
  • appDescriptionList
createAppConfig This tool saves app configuration details and responds with a unique app ID, version, and related settings upon successful creation.
  • x-auth-token
  • businessId
  • x-api-key
  • locale
  • appId
  • appVersion
  • apiConfig
  • appScopes
  • properties
  • webhookHeaders
  • webhooksConfig
  • extensionConfig
getAppHistory This tool retrieves app history details using appId, appVersion, and businessId with options for filtering, pagination, and sorting.
  • appId
  • x-appVersion
  • x-auth-token
  • businessId
  • x-api-key
  • x-version
  • locale
  • filters
  • page
  • sort
  • size
createAppHistory This tool creates a record for app configuration details including appId, appVersion, businessId, file URL, timestamp, and status.
  • appId
  • x-appVersion
  • businessId
  • x-auth-token
  • x-api-key
  • timestamp
  • appHistoryStatus
  • x-version
  • fileUrl
  • reason
createJsonInfo This tool generates UIJsonInfo for app configuration based on business ID, with locale-specific responses and detailed app properties.
  • x-auth-token
  • businessId
  • x-api-key
  • appId
  • appVersion
  • x-version
  • locale
  • appName
  • uiSchema
bulkPatchUpdateWebhook This tool bulk updates webhook information based on a store ID, with locale and app ID parameters.
  • x-auth-token
  • storeId
  • appId
  • x-appVersion
  • x-api-key
  • active
  • archive
  • locale
  • x-version
getWebhookStoreApp This tool retrieves active Webhook details based on storeId and WebhookName, with support for filters, pagination, and locale-specific responses.
  • storeId
  • x-auth-token
  • x-api-key
  • x-version
  • filters
  • locale
  • page
  • size
getWebhookByServiceCollectionId This tool retrieves active Webhook details based on service collection ID and Webhook Name, with pagination and locale options.
  • serviceCollectionId
  • x-auth-token
  • x-api-key
  • x-version
  • serviceName
  • webhookName
  • locale
  • page
  • size
  • isAppMasterRequired
  • appId
  • x-appVersion
  • storeId
getAllwebhooks_1 This tool retrieves distinct active and async events, returning a list of webhook names in JSON format based on the specified locale.
  • x-auth-token
  • x-api-key
  • x-version
  • locale
getWebhookLogs This tool retrieves Webhook logs using appID, appVersion, and other parameters for a business, returning a JSON response on success.
  • appId
  • x-appVersion
  • storeId
  • x-auth-token
  • businessId
  • x-api-key
  • webhookType
  • startTime
  • endTime
  • nextToken
refreshApi_1 This tool updates secret keys without restart, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
rabbitMQUpdateCredentials This tool updates RabbitMQ credentials, clears instance data for AWS updates, and requires keyName and resetRequired parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
None
getAllStandrdRoles This tool retrieves and filters standard roles and privileges from a JSON file based on `roleName`, but has been deprecated since Infosys Equinox Commerce Release 8.3.0.
  • x-auth-token
  • roleName
getReleaseDefinition This tool retrieves the release definition of a service and provides structured responses for success, errors, or resource unavailability.
  • x-auth-token
  • x-api-key
None
getAllPrivileges This tool fetches service privileges listed in `roles_privileges.json` within the microservice classpath, returning them as JSON upon success.
  • x-auth-token
None
getAllPrivilegeGroups This tool retrieves and filters privilege groups and privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter.
  • x-auth-token
  • x-api-key
  • privilegeGroupName
getAllPrivateAppAssociation_1 This tool retrieves businesses linked to a private app by app ID, including their association status, with options for filtering, pagination, and sorting.
  • appId
  • x-appVersion
  • x-auth-token
  • businessId
  • x-api-key
  • x-version
  • locale
  • filters
  • page
  • sort
  • size
ping This tool provides a timestamp to check the operational status of the Appmarketplace Service.
  • x-api-key
None
getCacheValue This tool retrieves cached data for a service using a specified string-based cache name and cache key.
  • cacheName
  • cacheKey
  • x-auth-token
  • x-api-key
None
getCacheKeys This tool retrieves cache keys for a service using a specified Redis-supported regex pattern, defaulting to ‘*’.
  • pattern
  • x-auth-token
  • x-api-key
None
findAppInstallation This tool retrieves installation details for an app using store ID and supports locale-specific responses.
  • x-auth-token
  • appId
  • x-appVersion
  • businessId
  • storeId
  • x-api-key
  • x-version
  • locale
findAllAppByStoreId This tool retrieves installed apps based on a store ID, with optional filters, sorting, pagination, and locale customization.
  • x-auth-token
  • storeId
  • businessId
  • x-api-key
  • x-version
  • locale
  • filters
  • sort
  • page
  • size
browsePublicApp This tool retrieves all public apps from the App Marketplace without requiring App Store login, with options for filtering, sorting, and pagination.
  • x-auth-token
  • x-api-key
  • x-version
  • locale
  • filters
  • sort
  • page
  • size
browsePrivateApp This tool retrieves all private apps for a specific business from the App Marketplace without requiring App Store login, with customizable filters, sorting, and pagination options.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version
  • locale
  • filters
  • sort
  • page
  • size
getMerchantStoresList This tool retrieves merchant app details installed in various stores with customizable query, pagination, and sorting options.
  • x-auth-token
  • appId
  • x-appVersion
  • businessId
  • x-api-key
  • x-version
  • locale
  • filters
  • page
  • size
  • sort
getAppsInstalled This tool retrieves app master details of all installed apps with customizable query, pagination, and sorting options.
  • x-auth-token
  • businessId
  • storeId
  • x-api-key
  • x-version
  • locale
  • filters
  • page
  • size
  • sort
getDeveloperAppInstallations This tool retrieves app installation details for a developer based on business ID, optional date range, locale, and sorting preferences.
  • x-collection-id
  • x-auth-token
  • locale
  • businessId
  • x-api-key
  • x-version
  • FromDate
  • ToDate
  • sort
getApps This tool retrieves apps for a store and category using specified parameters and returns paginated JSON responses.
  • x-auth-token
  • storeId
  • category
  • x-api-key
  • x-version
  • sort
  • page
  • size
  • locale
getJsonInfo This tool retrieves UI JSON details for an app using its unique app ID and supports locale-specific responses.
  • appId
  • x-auth-token
  • x-appVersion
  • x-api-key
  • x-version
  • locale
deleteUIJsonInfoByAppId This tool deletes UI JSON details using a unique UIJson ID, with locale-based responses and success indicated by a 200 status.
  • uiJsonId
  • x-auth-token
  • x-api-key
  • appId
  • x-version
  • x-appVersion
  • locale

Error Responses

The table below lists standard error codes with their corresponding descriptions for API responses.

Error Code Error Description
200 (Success): OK
201 (Success): Created
202 (Success): Accepted
400 Bad Request
403 Forbidden
404 The resource you are trying to reach is not found

Useful Resources

Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added