MCP Server and Resource Metrics
- Server URL:
https://<domain>/cart/mcp - Total Tools: 83
- Total Error Codes: 10
Server Overview
The MCP server provides a robust suite of 83 tools designed to manage collections, carts, items, shipping, promotions, payments, loyalty rewards, and cache operations, enabling seamless e-commerce functionalities with error handling, validation, and dynamic updates for efficient business operations.
Tools
The following table lists the available MCP tools for Cart service along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| subscribeEvent | This tool sends a cache clear message to the queue via the default exchange for cache clearing operations. |
|
None |
| listenEvent | This tool merges guest and registered user lists via the default exchange, with locale-specific responses in JSON format. |
|
|
| getCollectionById | This tool retrieves collection details based on business ID and collection ID, throwing an error if required parameters are missing. |
|
|
| replaceCollectionById | This tool updates collection properties based on business and collection IDs, requiring a mandatory field name in the request, with various response codes for success or errors. |
|
|
| replacePropertiesByCollectionId | This tool updates collection properties, requiring a mandatory field name and valid identifiers, with responses ranging from success to various error codes. |
|
|
| updatePropertiesByCollectionId | This tool patch updates collection properties, requiring a mandatory field name, and supports various responses based on operation outcomes. |
|
|
| getPropertiesByCartId | This tool retrieves cart properties based on cart ID and collection ID, with errors for missing or invalid inputs. |
|
|
| replacePropertiesByCartId | This tool updates or creates cart properties based on input, requiring valid cart and collection IDs, and provides various response codes for success or errors. |
|
|
| createPropertiesByCartId | This tool adds extra properties to a cart using cart and collection IDs, returning a list of properties or errors for invalid inputs. |
|
|
| getPropertiesByItemIdAndCartId | This tool retrieves item properties using item ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| replacePropertiesByItemIdAndCartId | This tool updates or creates item properties by item ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| createPropertiesByItemIdAndCartId | This tool adds extra properties to an item based on item ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| getCommunicationPreferenceByCartId | This tool retrieves communication preference details for a guest user based on cart ID and collection ID, throwing errors for missing or invalid inputs. |
|
|
| replaceCommunication PreferenceByCartId |
This tool updates cart communication preferences, requiring valid cart and collection IDs, and provides responses for success or various errors. |
|
|
| deleteCommunication PreferenceByCartId |
This tool deletes communication preferences for a cart, requiring valid cart and collection IDs, with various response codes for success or errors. |
|
|
| refreshApi | This tool updates secret keys without restart, clears instance data, and uses `keyName` and `resetRequired` parameters. |
|
None |
| cacheClear | This tool clears cached data for specified cache names, supports string-type keys, and clears entire cache if no key or pattern is provided. |
|
|
| cacheClear_1 | This tool clears cached data using dynamic cache keys and returns a JSON response with code, message, and timestamp. |
|
|
| getCollections | This tool retrieves collections based on a mandatory business ID, with optional sorting, filtering, pagination, and locale parameters, returning JSON responses for success or various errors. |
|
|
| createCollection | This tool initializes a collection with defined properties as the foundation for microservices, requiring mandatory fields and supporting various response codes for validation and errors. |
|
|
| getCarts | This tool retrieves all carts and associated entities using collection and cart IDs, throwing errors for missing or invalid inputs. |
|
|
| createCart | This tool creates a cart linked to a user and collection using authToken, throwing errors for missing or invalid inputs. |
|
|
| getShippingByCartId | This tool retrieves shipping details of a cart using shipping ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| createShippingByCartId | This tool generates shipping details for a cart using cart ID and collection ID, throwing errors for missing or invalid inputs. |
|
|
| getPromotionsByCartId | This tool retrieves cart promotions using collection and cart IDs, with errors for missing or invalid inputs. |
|
|
| createPromotionsByCartId | This tool adds promotions to a cart using cart ID and collection ID, validates inputs including mandatory promocode, and returns appropriate responses based on success or errors. |
|
|
| deleteAllPromotionByCartId | This tool removes all promotions from a cart linked to a collection ID, throwing errors for missing or invalid cart ID and collection ID inputs. |
|
|
| getPaymentsByCartId | This tool retrieves payments linked to a cart using cart ID and collection ID, with errors for missing or invalid inputs. |
|
|
| createPaymentsByCartId | This tool manages cart payment records linked to cart and collection IDs, fetching data from the Payment service with various response codes. |
|
|
| deletePaymentsByCartId | This tool deletes all payments linked to a cart using cart ID and collection ID, throwing errors for missing or invalid inputs. |
|
|
| createOtherCharges | This tool generates and stores a list of additional charges based on cart and collection IDs, with support for locale and user filtering. |
|
|
| getLoyaltyRewardsByCartId | This tool retrieves loyalty rewards for a cart using cart ID and collection ID, with errors for missing or invalid inputs. |
|
|
| createLoyaltyRewardsByCartId | This tool manages cart loyalty rewards linked to cart and collection IDs, with responses for various status codes. |
|
|
| deleteLoyaltyRewardsByCartId | This tool removes all loyalty rewards linked to a cart using cart ID and collection ID, throwing errors for missing or invalid inputs. |
|
|
| createItemsByCartId | This tool adds items to a cart using cart ID and collection ID, requiring mandatory fields like quantity and SKUs, with error responses for missing or invalid inputs. |
|
|
| deleteAllByCartId | This tool deletes all cart items using cart ID and collection ID, throwing errors for missing or invalid inputs. |
|
|
| getShippingByCartIdAndItemId | This tool retrieves shipping details for a cart item using cart ID, item ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| createShippingByCartIdAndItemId | This tool generates shipping details for a cart item using cart ID, item ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| getAddressByCartIdAndItemId | This tool retrieves a shipping address based on cart ID, item ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| createAddressByCartIdAndItemId | This tool generates a shipping address using cart ID, item ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| validateCart | This tool validates cart details including shipping, item availability, preferences, delivery address, payment, and age using request data. |
|
|
| calculateCart | This tool calculates cart costs, applies discounts, and prepares the cart for order submission based on provided parameters. |
|
|
| getAddressByCartId | This tool retrieves a cart’s shipping address using cart and collection IDs, throwing errors for missing or invalid inputs. |
|
|
| createAddressByCartId | This tool generates a shipping address for a cart using cart ID and collection ID, throwing errors for missing or invalid inputs. |
|
|
| getCartById | This tool retrieves cart details and associated entities based on collection and cart IDs, throwing errors for missing or invalid inputs. |
|
|
| deleteCartById | This tool deletes carts and their child entities based on valid collection and cart IDs, throwing errors for missing or invalid inputs. |
|
|
| updateCartById | This tool patch updates a cart by collection and cart IDs, excluding child entities, and throws errors for missing or invalid inputs. |
|
|
| deleteShippingByCartId | This tool deletes cart shipping details using collection and cart IDs, throwing errors for missing or invalid inputs. |
|
|
| updateShippingByCartId | This tool patch updates cart shipping details based on collection and cart IDs, with errors for missing or invalid inputs. |
|
|
| deletePropertyByCartId AndPropertyName |
This tool deletes cart properties by name, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| updatePropertyByCartId AndPropertyName |
This tool updates an existing cart property by name, requires valid cart and collection IDs, and returns various status codes based on the response or errors. |
|
|
| deletePaymentByIdAndCartId | This tool deletes a cart’s payment using payment ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| updatePaymentByIdAndCartId | This tool patch updates cart payment details using payment ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| deleteOtherCharges | This tool removes other charges from a cart using specified IDs, throwing errors for missing or invalid inputs. |
|
|
| patchOtherCharges | This tool updates `chargeValue` and `description` for cart charges using IDs, throwing errors for missing or invalid inputs. |
|
|
| deleteLoyaltyRewardsByIdAndCartId | This tool deletes loyalty rewards from a cart using specified IDs, throwing errors for missing or invalid inputs. |
|
|
| updateLoyaltyRewardsByIdAndCartId | This tool patch updates loyalty rewards for a cart using loyalty rewards ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| deleteItemByIdAndCartId | This tool deletes an item using item ID, cart ID, and collection ID, throwing errors for missing or invalid inputs, and provides responses in JSON format for various status codes. |
|
|
| updateItemByIdAndCartId | This tool patch updates an item using item ID, cart ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| createShippingByCartIdAndItemId_1 | This tool deletes shipping details for a cart item using item ID, collection ID, and cart ID, throwing errors for missing or invalid inputs. |
|
|
| createShippingByCartIdAndItemId_2 | This tool patch updates cart item shipping details using item ID, collection ID, and cart ID, throwing errors for missing or invalid inputs. |
|
|
| deletePropertyByNameAndItemId AndCartId |
This tool deletes an item property using cart ID, item ID, property name, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| updatePropertyByNameAndItemId AndCartId |
This tool patch updates item properties based on provided IDs and property name, throwing errors for missing or invalid inputs, with various response codes indicating success or failure. |
|
|
| deleteCartItemAddress | This tool deletes an item’s shipping address using cart ID, item ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| updateAddressByCartIdAndItemId | This tool patch updates the shipping address using cart ID, item ID, and collection ID, throwing errors for missing or invalid inputs. |
|
|
| deleteAddressByCartId | This tool deletes a cart’s shipping address using cart and collection IDs, throwing errors for missing or invalid inputs. |
|
|
| updateAddressByCartId | This tool patch updates a cart’s shipping address using cart ID and collection ID, throwing errors for missing or invalid inputs. |
|
|
| refreshApi_1 | This tool updates secret keys without a restart, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters. |
|
None |
| rabbitMQUpdateCredentials | This tool updates RabbitMQ credentials, clears instance data for AWS updates, and requires `keyName` and `resetRequired` parameters. |
|
None |
| refreshApi_2 | This tool updates secret keys without restarting, clears instance data for AWS calls, and uses `keyName` and `resetRequired` parameters. |
|
None |
| 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 with structured responses for success, errors, and validation details. |
|
None |
| getAllPrivileges | This tool fetches all service privileges listed in `roles_privileges.json` within the microservice’s classpath, returning a JSON response upon success. |
|
None |
| getAllPrivilegeGroups | This tool retrieves and filters privilege groups and their privileges from `roles_privileges.json` based on the `privilegeGroupName` parameter. |
|
|
| ping | This tool returns a timestamp in milliseconds to confirm service availability. |
|
None |
| getCacheValue | This tool retrieves cached data for a specified service using a string-based cache name and cache key. |
|
None |
| getCacheKeys | This tool retrieves cache keys for a service using a specified Redis regex pattern, defaulting to ‘*’. |
|
None |
| getPropertyByCollectionId AndPropertyName |
This tool retrieves a collection property by name, requiring mandatory field inputs and valid identifiers, with detailed response codes for success or errors. |
|
|
| getCollectionAttributes | This tool retrieves collection attributes for a microservice, with query parameters like businessId and locale, and provides structured JSON responses for various status codes. |
|
|
| getItemsByCartId | This tool retrieves cart items using cart ID and collection ID, with errors for missing or invalid inputs. |
|
|
| deletePromotionByCartIdAndPromoCode | This tool deletes a cart’s promotion by promocode, requiring valid cart ID, collection ID, and promocode, with detailed error responses for invalid inputs. |
|
|
| deleteCartSubscriptionByCartId | This tool deletes cart subscriptions using cartId and collectionId, with various response codes for success or errors. |
|
|
| cacheClear_2 | This tool clears all cache or specific cache by name and ID, with optional locale and ID parameters. |
|
|
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 |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | The resource you are trying to reach is not found |
| 409 | Conflict Request |
| 422 | Unprocessable Entity |
| 500 | Internal Server Error occurred |
Useful Resources
- API Specifications: API Endpoints – Cart
- Services Details: Cart Service
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added