MCP Server and Resource Metrics

  • Server URL: https://<domain>/shipping/mcp
  • Total Tools: 51
  • Total Error Codes: 9

Server Overview

The MCP server offers robust shipping, caching, and collection management functionalities, enabling businesses to efficiently handle shipping options, tiers, labels, tracking, and costs, alongside advanced cache management and privilege control for seamless operations.

Tools

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

Tool Name Tool Description Required Parameters Optional Parameters
GetShipmentOption This tool retrieves shipping option details using a unique shippingOptionId and supports locale-based responses.
  • x-auth-token
  • x-collection-id
  • shippingOptionId
  • x-api-key
  • x-version-id
  • locale
updateShipmentOption This tool updates a shipping option using its unique shippingOptionId and supports locale-specific responses.
  • x-auth-token
  • shippingOptionId
  • x-collection-id
  • x-api-key
  • marketplaceappinstallid
  • appid
  • appversion
  • appimage
  • appname
  • appStatus
  • status
  • cashondelivery
  • taxrate
  • taxclassid
  • tierDefinitionStrict
  • basepriceExvat
  • addeachproductorder
  • addpercentageordertotal
  • addperkgordered
  • weightorvolume
  • transporttype
  • shippingformulaId
  • shipmentDeliveryTime
  • startdate
  • enddate
  • visibilityState
  • locale
  • x-version-id
  • carriernetworkname
  • source
  • properties
  • rule
  • tiers
  • customShippingCostRequest
deleteShipmentOption This tool deletes a shipping option using its unique ID and provides localized responses with detailed status codes.
  • shippingOptionId
  • x-collection-id
  • x-auth-token
  • x-api-key
  • locale
  • x-version-id
patchupdateShipmentOption This tool patch updates the details of a shipping option using its unique shippingOptionId, with locale-specific responses and various status codes.
  • x-auth-token
  • shippingOptionId
  • x-collection-id
  • x-api-key
  • marketplaceappinstallid
  • appid
  • appversion
  • appimage
  • appname
  • appStatus
  • status
  • cashondelivery
  • taxrate
  • taxclassid
  • tierDefinitionStrict
  • basepriceExvat
  • addeachproductorder
  • addpercentageordertotal
  • addperkgordered
  • weightorvolume
  • transporttype
  • shippingformulaId
  • shipmentDeliveryTime
  • startdate
  • enddate
  • visibilityState
  • locale
  • x-version-id
  • carriernetworkname
  • source
  • properties
  • rule
  • tiers
  • customShippingCostRequest
GetShipmentTier This tool retrieves shipping tier details using a shipping option ID and tier ID, with responses in various formats based on locale and status codes.
  • x-auth-token
  • shippingOptionId
  • x-collection-id
  • shippingTierId
  • x-api-key
  • x-version-id
  • locale
updateShipmentOptionTier This tool updates a shipping option’s tier using its shipping option ID and shipping tier ID, with locale-based responses and detailed status codes.
  • x-auth-token
  • shippingOptionId
  • shippingTierId
  • x-collection-id
  • x-api-key
  • fromUnits
  • toUnits
  • priceForRange
  • locale
  • x-version-id
patchUpdateShipmentOptionRule This tool patch modifies a shipping option tier using its shipping option ID and tier ID, with responses for success, errors, or server issues.
  • x-auth-token
  • shippingOptionId
  • shippingTierId
  • x-collection-id
  • x-api-key
  • fromUnits
  • toUnits
  • priceForRange
  • locale
  • x-version-id
updateShipmentOptionRule This tool updates a shipping option’s rule using its shipping option ID and shipping rule ID.
  • x-auth-token
  • shippingOptionId
  • shippingRuleId
  • x-collection-id
  • x-api-key
  • ruleJSON
  • locale
  • x-version-id
  • ruleString
updateShipmentOptionRule_1 This tool patch modifies a shipping option rule using the shipping option ID and rule ID, with locale-based responses and detailed status codes.
  • x-auth-token
  • shippingOptionId
  • shippingRuleId
  • x-collection-id
  • x-api-key
  • ruleJSON
  • locale
  • x-version-id
  • ruleString
GetAllShippingOptionProperties This tool retrieves all property details of a shipping option using its unique shippingOptionId, with responses in the specified locale.
  • x-auth-token
  • x-collection-id
  • shippingOptionId
  • x-api-key
  • x-version-id
  • locale
updateShipmentProperty This tool updates a shipping property for a specified shipping option ID, with responses based on locale and error handling.
  • x-auth-token
  • x-collection-id
  • shippingOptionId
  • x-api-key
  • x-version-id
  • locale
updateShipmentOptionProperty This tool patch updates a shipping property for a specified shipping option ID, with responses for success, errors, and validation details.
  • x-auth-token
  • x-collection-id
  • shippingOptionId
  • x-api-key
  • x-version-id
  • locale
Update_Ranking This tool updates the ranking order for shipping options based on specified parameters and returns detailed responses for various status codes.
  • x-collection-id
  • shippingRankingId
  • x-auth-token
  • x-api-key
  • sortingOrder
  • sortingMethod
  • x-version-id
  • locale
getCollectionById This tool retrieves collection details and properties based on business and collection IDs, throwing errors if required parameters are missing.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • locale
replaceCollectionById This tool updates collection properties based on business and collection IDs, requiring a mandatory field name in the request, and returns various responses depending on the operation’s success or errors.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • name
  • x-version-id
  • locale
  • description
  • status
  • properties
replacePropertiesByCollectionId This tool updates collection properties, requiring a mandatory field name and valid identifiers, with responses ranging from success to various error codes.
  • x-auth-token
  • collectionId
  • businessId
  • x-api-key
  • x-version-id
  • locale
updatePropertiesByCollectionId This tool patch updates collection properties, requiring a mandatory field name and valid identifiers for successful operation, with detailed responses for various status codes.
  • x-auth-token
  • businessId
  • collectionId
  • x-api-key
  • x-version-id
  • locale
GetAllShipmentOption This tool loads all shipping options based on query parameters and returns paginated responses with various status codes.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version-id
  • locale
  • sort
  • filters
  • page
  • size
createShipmentOptions This tool creates a shipping option with detailed parameters, responses, and error handling.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • marketplaceappinstallid
  • appid
  • appversion
  • appimage
  • appname
  • appStatus
  • status
  • cashondelivery
  • taxrate
  • taxclassid
  • tierDefinitionStrict
  • basepriceExvat
  • addeachproductorder
  • addpercentageordertotal
  • addperkgordered
  • weightorvolume
  • transporttype
  • shippingformulaId
  • shipmentDeliveryTime
  • startdate
  • enddate
  • visibilityState
  • locale
  • x-version-id
  • carriernetworkname
  • source
  • properties
  • rule
  • tiers
  • customShippingCostRequest
select This tool retrieves all rules for a shipping option using its unique shippingOptionId, with optional query parameters for locale, sorting, filtering, pagination, and size.
  • x-auth-token
  • shippingOptionId
  • x-collection-id
  • x-api-key
  • x-version-id
  • locale
  • sort
  • filters
  • page
  • size
createShipmentOptionRule This tool creates a shipping option rule based on a given shipping option ID and provides detailed responses for success or errors.
  • x-auth-token
  • shippingOptionId
  • x-collection-id
  • x-api-key
  • ruleJSON
  • locale
  • x-version-id
  • ruleString
get_ranking This tool retrieves ranking details for all shipping options, with responses based on query parameters and various status codes.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version-id
  • locale
Create_Ranking This tool generates a ranking order for shipping options based on specified parameters and provides detailed responses for various status codes.
  • x-collection-id
  • x-auth-token
  • x-api-key
  • sortingOrder
  • sortingMethod
  • x-version-id
  • locale
Eligible_Shipping_Options This tool calculates shipping costs and retrieves eligible shipping methods based on query parameters and provides detailed responses for various HTTP status codes.
  • x-collection-id
  • x-auth-token
  • previewMode
  • x-api-key
  • shippingId
  • itemDetails
  • totalPriceIncVat
  • totalPriceExVat
  • x-version-id
  • locale__query
  • deliveryType
  • cartValue
  • deliveryAddress
  • properties
  • orderAmount
  • customerPriceCategory
  • customerCategory
  • accountId
  • locale
GETAllShippingLabel This tool retrieves detailed information about a shipping label based on specified query parameters and provides structured responses for various status codes.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • x-version-id
  • locale
  • sort
  • filters
  • page
  • size
CreateShippingLabel This tool generates a shipment label with detailed response properties and error handling.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • shippingOptionId
  • locale
  • x-version-id
  • shippingDate
  • storeId
  • deliveryAddress
  • itemDetails
  • customerPriceCategory
  • extShippingLabelId
  • orderId
  • return
getShipmentTrack Executes POST /shipmentTracking to fetch shipment tracking details with locale-specific responses and JSON output.
  • x-auth-token
  • x-collection-id
  • x-api-key
  • shippingOptionId
  • locale
  • x-version-id
  • trackingNumber
  • storeId
refreshApi This tool updates secret keys without restarting, clears instance data for AWS calls, and requires `keyName` and `resetRequired` parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
 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.
  • x-auth-token
  • cacheName
  • x-api-key
  • cacheKey
  • pattern
cacheClear_1 This tool clears cached data using dynamic cache keys and returns a JSON response with code, message, and timestamp.
  • x-api-key
  • cacheNames
  • cacheKey
  • simpleKey
  • pattern
getCollections This tool retrieves collections based on a mandatory business ID, with optional sorting, filtering, locale, and pagination parameters, returning JSON responses for various status codes.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version-id
  • sort
  • filters
  • locale
  • page
  • size
createCollection This tool initializes a collection with defined properties as the foundation for microservices, requiring mandatory fields like `CollectionRequest` and `businessId` for proper functionality.
  • x-auth-token
  • businessId
  • x-api-key
  • name
  • x-version-id
  • locale
  • description
  • status
  • properties
calculateShipping This tool identifies shipping methods and calculates associated delivery charges based on query parameters and provides detailed responses for various status codes.
  • x-collection-id
  • x-auth-token
  • x-version
  • x-api-key
  • shippingId
  • validationType
  • locale
  • deliveryType
  • cartValue
  • deliveryAddress
  • properties
  • itemDetails
  • shippingDetails
GetShipmentTier_1 This tool retrieves tier details using shipping option ID and tier ID, supporting various response codes and locale-based outputs.
  • x-auth-token
  • shippingOptionId
  • x-collection-id
  • x-api-key
  • x-version-id
  • locale
GetOneShippingOptionProperties This tool retrieves shipping option property details using a name and shipping option ID, with responses based on locale and status codes.
  • x-auth-token
  • x-collection-id
  • name
  • shippingOptionId
  • x-api-key
  • x-version-id
  • locale
GETAShippingLabel This tool retrieves shipping label details using a unique shipping label ID and supports locale-specific responses.
  • x-auth-token
  • x-collection-id
  • shippingLabelId
  • x-api-key
  • x-version-id
  • locale
DeleteShippingLabel This tool deletes a shipping label using its unique shipping label ID and provides responses based on the operation’s outcome.
  • shippingLabelId
  • x-collection-id
  • x-auth-token
  • x-api-key
  • locale
  • x-version-id
refreshApi_1 This tool updates secret keys without restarting, clears instance data for AWS calls, 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
refreshApi_2 This tool sets secret keys without restart, updates AWS call values, and uses keyName and resetRequired parameters.
  • x-auth-token
  • keyName
  • resetRequired
  • x-api-key
 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.
  • x-auth-token
  • x-api-key
  • roleName
getReleaseDefinition This tool provides release definitions of a service with detailed response codes and validation errors.
  • x-auth-token
  • x-api-key
 None
getAllPrivileges This tool retrieves service privileges listed in `roles_privileges.json` within the microservice’s classpath, returning them as JSON upon success.
  • x-auth-token
  • x-api-key
 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
ping This tool returns a timestamp in milliseconds to confirm service availability.
  • 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
getPropertyByCollectionId
AndPropertyName		 This tool retrieves a mandatory collection property by name for a specified collection, with detailed response codes for success or errors.
  • x-auth-token
  • businessId
  • collectionId
  • propertyName
  • x-api-key
  • x-version-id
  • locale
getCollectionAttributes This tool retrieves all collection attributes for a microservice, detailing properties like name, type, and possible values, with responses based on query parameters and status codes.
  • x-auth-token
  • businessId
  • x-api-key
  • x-version-id
  • locale
clearCacheByKey This tool clears cached shipping details by shippingId and supports validation, locale settings, and various response codes.
  • x-collection-id
  • x-auth-token
  • x-version
  • shippingId
  • x-api-key
  • validationType
  • locale
clearAllCache This tool clears cached shipping details and provides responses in various statuses with shipping data.
  • x-collection-id
  • x-auth-token
  • x-version
  • x-api-key
  • 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
204 DELETED
400 Bad Request
401 Unauthorized
403 Forbidden
404 the resource you are trying to reach is not found
409 Conflict Request
500 Internal Server Error occurred

Useful Resources

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