MCP Server and Resource Metrics
- Server URL:
https://<domain>/merchandise/mcp - Total Tools: 85
- Total Error Codes: 12
Server Overview
The MCP server offers robust project management, data retrieval, and modification capabilities through 85 specialized tools, enabling efficient handling of projects, categories, milestones, collections, and creative assets while supporting advanced filtering, sorting, and locale-specific responses to enhance operational workflows and business decision-making.
Tools
The following table lists the available MCP tools for Merchandising service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| getProject | This tool retrieves a project using valid project and collection IDs, excluding deleted projects. |
|
|
| replaceProject | This tool updates a project’s status by its ID, allowing privileged users to change it from OPEN to SUBMITTED or APPROVED. |
|
|
| deleteProject | This tool soft-deletes a project by setting its status to DELETED while retaining it in the database, using required path and optional query parameters. |
|
|
| updateProject | This tool enables privileged business users to update project fields and statuses, with specific transitions allowed from OPEN to SUBMITTED or APPROVED. |
|
|
| getCategory | This tool retrieves search overrides by ID within a collection, supporting both ACTIVE and INACTIVE statuses, with detailed response codes and properties. |
|
|
| replaceCategory | This tool updates attributes of a search override based on its ID, subject to project status and lock conditions, with detailed responses for success or errors. |
|
|
| deleteCategory | This tool deletes a search override by ID, provided it’s under an “OPEN” project, excluding default projects, and returns status codes for success or errors. |
|
|
| updateCategory | This tool updates attributes of a search override, restricted by project status and lock conditions, with detailed response codes for success or errors. |
|
|
| getCategory_1 | This tool retrieves product groups under an “OPEN” project using valid IDs, supporting both ACTIVE and INACTIVE statuses. |
|
|
| replaceCategory_1 | This tool updates attributes of product groups under “OPEN” projects, with restrictions on locked or non-editable properties. |
|
|
| deleteCategory_1 | This tool deletes a product group by ID, along with its properties, but only if the group belongs to an “OPEN” project and not a default project. |
|
|
| updateCategory_1 | This tool updates product group attributes under “OPEN” projects, excluding locked or default project groups. |
|
|
| getNavigation | This tool retrieves all navigations in a project using required parameters and provides detailed responses for success or error scenarios. |
|
|
| replaceNavigation | This tool updates navigation in a project based on a valid navigation ID and provides detailed responses for various statuses. |
|
|
| deleteNavigation | This tool deletes a navigation by its ID using specified path and query parameters, returning success or error responses. |
|
|
| updateNavigation | This tool updates navigation attributes in an open project, excluding name and deleted navigations, with detailed response codes for various outcomes. |
|
|
| getMilestone | This tool retrieves both ACTIVE and INACTIVE milestones using a valid milestone ID within a specified project. |
|
|
| replaceMilestone | This tool updates a milestone within a project using specified parameters and provides detailed responses for success or various error states. |
|
|
| deletMilestone | This tool deletes a milestone by ID for open projects (excluding default projects) and returns a string response. |
|
|
| updateMilestone | This tool updates milestone attributes but cannot modify milestones in default projects. |
|
|
| getCreative | This tool retrieves a creative from a collection using its creative ID and project ID, with responses based on success or error status. |
|
|
| replaceCreative | This tool updates creatives with valid IDs under “OPEN” projects, excluding default projects, and provides detailed response codes for various statuses. |
|
|
| deleteCreative | This tool deletes an “OPEN” creative using a valid creative ID within a specified project ID, with responses indicating success or various error statuses. |
|
|
| updateCreative | This tool updates specified attributes of a creative within an “OPEN” project using unique project and creative IDs, with responses indicating success or various error states. |
|
|
| getCategory_2 | This tool retrieves categories with ACTIVE and INACTIVE statuses under an OPEN project using valid project and category IDs. |
|
|
| replaceCategory_2 | This tool updates category attributes for “OPEN” projects using valid IDs, with restrictions on locked or deleted properties. |
|
|
| deleteCategory_2 | This tool deletes a category by ID, removing associated properties, but only for “OPEN” projects, excluding default projects. |
|
|
| updateCategory_2 | This tool updates category attributes under specific conditions, restricted by project status, category type, and lock status, with detailed response codes for errors. |
|
|
| replaceCategoryProperties | This tool updates category properties by deleting existing ones based on category ID and project ID, with locale-specific responses and detailed error handling. |
|
|
| updateCategoryProperties | This tool updates category properties based on category and attribute IDs, with responses ranging from success to various error codes. |
|
|
| getCollection | This tool retrieves a collection’s details using its ID, with parameters for business ID and locale, and provides detailed response codes and properties. |
|
|
| replaceCollection | This tool updates a microservice collection based on provided identifiers and parameters, returning detailed responses for success or errors. |
|
|
| replaceCollectionProperties | This tool updates collection properties based on provided identifiers and parameters, returning success or error responses. |
|
|
| updateCollectionProperties | This tool updates collection properties based on identifiers and parameters, returning success or error responses. |
|
|
| getCategoryAttribute | This tool retrieves category attributes using a valid category attribute ID within a collection, supporting locale-specific responses and various status codes. |
|
|
| replaceCategoryAttribute | This tool updates the category attribute using a valid identifier, with responses indicating success or various error states. |
|
|
| deleteCategoryAttribute | This tool deletes a category attribute by ID, returning a string response with various status codes indicating success or errors. |
|
|
| updateCategoryAttribute | This tool updates category attributes except for ID, locked, DELETED, and STATIC types with “rule” properties, while providing detailed response codes and error handling. |
|
|
| refreshApi | This tool updates secret keys without restarting, clears instance data for AWS updates, and uses `keyName` and `resetRequired` parameters with detailed response codes. |
|
None |
| getProjects | This tool retrieves all projects under a valid collection ID with sorting, filtering, pagination, and locale options. |
|
|
| createProject | This tool creates a new project with a unique identifier under a collection, providing locale-based responses and detailed error handling. |
|
|
| getCategories | This tool retrieves all search overrides in a collection, including deleted ones, using project and query parameters for filtering and pagination. |
|
|
| createPdpUX | This tool creates a search override using a specified project identifier and supports various response codes for success or errors. |
|
|
| getCategories_1 | This tool retrieves all product groups in a collection, including ACTIVE, INACTIVE, and deleted ones (except default project), with sorting, filtering, pagination, and locale options. |
|
|
| createPdpUX_1 | This tool creates a product group with UX data using a project identifier and supports various response codes for success or errors. |
|
|
| getNotes | This tool retrieves all notes of a project item using its unique item ID, with support for pagination, filtering, sorting, and locale-specific responses. |
|
|
| createNote | This tool allows adding notes to various project items if the project status is “OPEN” or “SUBMITTED,” with detailed response codes for different outcomes. |
|
|
| getNavigations | This tool retrieves navigation details for a project based on a valid navigation ID, with options for sorting, filtering, pagination, and locale-specific responses. |
|
|
| createNavigation | This tool creates a new navigation for a project in a collection, using specified parameters and returning detailed response codes. |
|
|
| getMilestones | This tool retrieves milestones from a project collection, filtering by status, sorting, and pagination parameters. |
|
|
| createMilestone | This tool allows creating unique milestones for projects with an OPEN status, using projectId and optional locale parameters, with detailed response codes for various outcomes. |
|
|
| getCreativies | This tool retrieves “OPEN” creatives from a project collection using parameters for sorting, filtering, paging, and locale. |
|
|
| createCreative | This tool allows creating a new creative under an “OPEN” project using a unique project ID, with detailed response codes for various statuses. |
|
|
| getCategories_2 | This tool retrieves all categories in a collection, including ACTIVE, INACTIVE, and deleted ones (except default project), with sorting, filtering, and pagination options. |
|
|
| createCategory | This tool creates a new category using a project identifier, supports STATIC and DYNAMIC types, and provides detailed error responses for various status codes. |
|
|
| cacheClear | This tool clears cached data by cache name(s), supports string-type keys, and clears the entire cache if no key or pattern is provided, with detailed response codes for various outcomes. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and provides detailed response codes and messages for various HTTP statuses. |
|
|
| getCollections | This tool retrieves merchandise collections with pagination, sorting, filtering, and locale support, returning success or various error responses. |
|
|
| createCollection | This tool creates a collection with default properties, requiring a business ID and optional locale, and provides detailed response codes for various outcomes. |
|
|
| getCategoryAttributes | This tool retrieves all category attributes from a collection based on ACTIVE or INACTIVE status, with sorting, filtering, pagination, and locale options. |
|
|
| createCategoryAttribute | This tool creates a new category attribute and provides detailed response codes for various outcomes. |
|
|
| getVersions | This tool retrieves all versions in a collection with sorting, filtering, pagination, and locale options, returning success or detailed error responses. |
|
|
| refreshApi_1 | This tool updates secret keys without restart, cleans instance data, and uses `keyName` and `resetRequired` parameters for AWS calls. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, cleans instance data, and requires `keyName` and `resetRequired` parameters, with various response codes indicating success or errors. |
|
None |
| getLiveMilestoneSearchCategory BySearchKeyword |
This tool retrieves milestone data based on a valid search keyword and returns the search override category in schema.org format, with detailed response codes and parameters. |
|
|
| getLiveMilestoneByProductId | This tool retrieves a milestone using a valid product ID and returns the product category in schema.org format with detailed response handling. |
|
|
| getCurrentMilestoneByNavigationId | This tool retrieves milestone data based on navigation ID and returns the navigation category in schema.org format, supporting various response codes. |
|
|
| getLiveMilestoneByCategoryId | This tool retrieves a live milestone using a valid category ID and returns the category in schema.org format with detailed response codes and properties. |
|
|
| getAllStandrdRoles | This tool retrieves and filters standard roles and privileges from `roles_privileges.json`, but has been deprecated since Infosys Equinox Commerce Release 8.3.0. |
|
|
| getReleaseDefinition | This tool retrieves the release definition of a service and provides detailed response codes and messages for various outcomes. |
|
None |
| getCategoryHierarchy | This tool retrieves a search override hierarchy using a valid search override ID within a specified collection. |
|
|
| getProductCategoryMapping | This tool retrieves category-product mapping details using valid product and project IDs, with responses based on locale and error codes. |
|
|
| getCategoryHierarchy_1 | This tool retrieves a product group hierarchy based on a valid product group ID within a specified collection, using path and query parameters. |
|
|
| getNote | This tool retrieves a note using a project ID and note ID, with locale-specific responses and detailed error handling. |
|
|
| getCategoryHierarchy_2 | This tool, deprecated since Infosys Equinox Release 8.2.0, loads a category hierarchy based on a valid category ID in the collection. |
|
|
| getCurrentMilestoneByCategoryId | This tool, deprecated since Infosys Equinox Release 8.2.0, loads milestones based on a valid category ID and project ID. |
|
|
| getAllPrivileges | This tool retrieves service privileges from `roles_privileges.json` and provides detailed response codes for various outcomes. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and their privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter, with detailed response codes for various outcomes. |
|
|
| ping | This tool provides a timestamp in milliseconds to check service availability, with various response codes indicating success or errors. |
|
None |
| exportMerchandiseSheet | This tool exports customized merchandising details to `.xlsx` format, with locale-based responses and various error codes. |
|
|
| getCacheValue | This tool retrieves cached data for a service using string-based cache name and key, with detailed success and error responses. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| getCollectionProperty | This tool retrieves a collection property by name using specified identifiers and parameters, returning success or error responses. |
|
|
| getCollectionAttributes | This tool retrieves all attributes in a collection and provides detailed response codes for various outcomes. |
|
|
| cacheClear_2 | This tool clears cache data using a specified key and provides various response codes for success or errors. |
|
|
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): success |
| 204 | (Success): No Content |
| 208 | Already Reported |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict |
| 422 | Unprocessable Entity |
| 500 | Internal Server Error |
Useful Resources
- API Specifications: API Endpoints – Merchandising
- Services Details: Merchandising Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added