Home
Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
Integrating
Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
Sterling Order Management integration
The integration between HCL Commerce and Sterling Order Management combines the industry-leading front-end capabilities of HCL Commerce with the proven, back-end order and inventory management features of Sterling Order Management.
Reference
To understand how Sterling Order Management integrates with HCL Commerce, review mappings between the two systems and integration flows.
Mappings and integration flows
You should review the mappings between HCL Commerce and Sterling Order Management.
Integration flows
Integration flows provide mappings between HCL Commerce and Sterling Order Management.
validateCouponUE
The validateCouponUE mappings allow for validation of coupons between Sterling Order Management and HCL Commerce. When a shopper adds a manual coupon from Sterling Call Center, validateCouponUE is implemented to call HCL Commerce for validation of entered coupons against their definitions in HCL Commerce.

Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
- Getting started
  HCL Commerce has different advantages for business users, administrators and developers. HCL Commerce targets each of these roles with a tailored set of offerings so that each of your users can get maximum benefit.
- Installing and deploying
  Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
- Migrating
  Before you migrate to HCL Commerce Version 9, review this information to help plan and execute your migration.
- Operating
  Topics in the Operating category highlight tasks that are typically performed by business users, customer support representatives, to complete their day-to-day tasks in the operation of the HCL Commerce site.
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
  - Order management system integration
    Integrate a distributed order management (DOM) system with your store to provide comprehensive coverage of the order lifecycle across channels, from capture to fulfillment.
  - Sterling Order Management integration
    The integration between HCL Commerce and Sterling Order Management combines the industry-leading front-end capabilities of HCL Commerce with the proven, back-end order and inventory management features of Sterling Order Management.
    - Solution Overview
      The integration of HCL Commerce and IBM Sterling Order Management delivers the strengths of both products.
    - Prerequisites
      For the Sterling Order Management integration with HCL Commerce, some prerequisites, system requirements, assumptions, and limitations apply.
    - Sample configuration for integrating with Aurora starter store
      The sample configuration for integrating with the Aurora starter store provides a preconfigured order management-to-storefront environment that you can test to understand the significant features of the HCL Commerce integration with Sterling Order Management.
    - Integrating Sterling Order Management with HCL Commerce
      Configuring and deploying HCL Commerce and Sterling Order Management for integration includes running provided activation scripts, defining properties for your implementation, granting permissions, and triggering agent and integration servers.
    - Customizing
      Many elements of the side-by-side integration can be customized.
    - Troubleshooting and status codes
      To troubleshoot integration issues, review status codes.
    - Reference
      To understand how Sterling Order Management integrates with HCL Commerce, review mappings between the two systems and integration flows.
      - Creating static kits and prebuilt kits in the integration
        You can create a kit to attract customers. Kits are groupings of catalog entries that can be used when creating promotions.
      - Mappings and integration flows
        You should review the mappings between HCL Commerce and Sterling Order Management.
        General mapping rules
        Each installation of HCL Commerce and Sterling Order Management is different. Some assumptions are made about the mapping between the two systems, and these assumptions are reflected in the ValueMaps.xml file, which you can change to suit your particular environment.
        Integration flows
        Integration flows provide mappings between HCL Commerce and Sterling Order Management.
        GetCartListToGetOrder request mappings
        The GetCartListToGetCartOrder communication uses the Customer ID (or member ID) from Sterling Call Center to retrieve a list of the customer's active carts in HCL Commerce. The SCWC_SDF_GetCartList service fetches the list of active carts, and if there are multiple active carts, the SCWC_SDF_GetCartList_Internal service calls the WCGetCartListToSterlingOrderList xsl component to transform the HCL Commerce response to the Sterling Order Management getOrderList output format.
        GetCartDetailsToGetOrder request mappings
        The GetCartDetailsToGetOrder communication uses the cart ID in HCL Commerce to fetch details about the cart. The SCWC_SDF_GetCartDetails service fetches the cart details and calls the SCWC_SDF_GetCartList_Internal service, which transforms the HCL Commerce response to Sterling Order Management getCompleteOrderDetails API output format.
        LockCartToProcessOrder request mappings
        The LockCartToProcessOrder communication checks the cart ID in the order details in HCL Commerce to verify that a draft order is created. Draft orders are created and the CREATE_DRAFT_ORDER.ON_SUCCESS event is triggered when the CSR pulls the cart. The event invokes the SCWC_SDF_LockWCShoppingCart service. The service locks the cart in HCL Commerce and calls the SCWC_SDF_LockWCShoppingCart_Internal service, which transforms the HCL Commerce message into Sterling Order Management format. When a CSR locks a cart, the CSR can work on the cart for the shopper and create an order for the shopper. The shopper cannot work on the cart.
        UnlockCartToProcessOrder request mappings
        The UnlockCartToProcessOrder communication checks the cart ID in the order details in HCL Commerce to verify that draft order is canceled or deleted by the CSR. The ORDER_CHANGE.DELETE_ORDER event is invoked when a CSR cancels or deletes a draft order. The event triggers the SCWC_SDF_UnlockWCShoppingCart service, which unlocks the shopper's cart and calls the SCWC_SDF_UnlockWCShoppingCart_Internal service. After the cart is unlocked, the shopper can update the cart. The internal services transforms the HCL Commerce message into Sterling Order Management format.
        ChangeOrderOnCancel request mappings
        The changeOrderOnCancel communication maps the cancellation of an order in Sterling Order Management to HCL Commerce . When an order is canceled from Sterling Order Management or Sterling Call Center, ChangeOrderOnCancel also updates promotion usage statistics in the HCL Commerce Promotion Engine through a call to the CancelPromotionCalUsage service.
        CreateOrderOnSuccess request mappings
        The CreateOrderOnSuccess communication maps the successful creation of an order in Sterling Order Management with HCL Commerce. When a shopper submits an order, the order is created in Sterling Order Management through a call to the CreateOrder API. Upon successful creation, the SCWC_SDF_createOrderOnSuccess service creates a message that is then transferred back to HCL Commerce. HCL Commerce receives the acknowledgment and updates the order status to "Successfully Transferred". This also updates the HCL Commerce promotion usage statistics through the FinalizePromotionCalUsage service.
        ChangeOrderOnSuccess request mappings
        When an order is changed from Sterling Order Management or Sterling Call Center, order price and promotion information is retrieved from HCL Commerce. The changeOrderOnSuccess event is used to update promotion usage statistics in the HCL Commerce Promotion Engine by calling CancelPromotionCalUsage or UpdatePromotionCalUsage.
        ConfirmDraftOrderOnSuccess request mappings
        The ConfirmDraftOrderOnSuccess communication maps a successful draft order creation in Sterling Order Management or Sterling Call Center to HCL Commerce. This service is also used to update promotion usage statistics in the HCL Commerce Promotion Engine through a call to the FinalizePromotionCalUsage service.
        getCompleteOrderDetails
        The getCompleteOrderDetails communication maps historical order information between Sterling Order Management and HCL Commerce. When a shopper wants to view the details of an order that exists in Sterling Order Management, the getCompleteOrderDetails API is called. If the shopper wants to reorder and create a cart that is based on these order details, HCL Commerce calls the same API.
        Get inventory availability
        The get inventory availability communication maps the HCL Commerce GetInventoryAvailability request to the Sterling Order Management monitorItemAvailability (for an online store call) or findInventory (for a physical store call). It is possible to cache the result, which eliminates a real time call to Sterling Order Management for each inventory check and drastically increases performance.
        getItemPriceUE
        The GetItemPriceUE mappings allow for a Customer Service Representative (CSR) using the Sterling Call Center, the Sterling Store, or other Order Management channel to interface with HCL Commerce for pricing requests, coupon validation, or order creation.
        getOrderList
        The GetOrderList mappings allow HCL Commerce to return historical order information from Sterling Order Management. When a shopper wants to view a history of orders in the My Account section, HCL Commerce returns a consolidated order history list to the shopper. The list includes both orders that were successfully created in Sterling Order Management, and orders that were not successfully created, but whose records are available locally in HCL Commerce. HCL Commerce uses the Sterling Order Management GetOrderList API to retrieve an order history.
        getOrderPriceUE
        The GetOrderPriceUE mappings allow for orders created in Sterling Order Management or Sterling Call Center to retrieve unit prices, promotion discounts, free gifts, and shipping promotion discount information from HCL Commerce.
        getPricingRuleDetailsUE
        The GetPricingRuleDetailsUE mappings are used for Sterling Order Management to retrieve specific promotion details from HCL Commerce .
        REAL_TIME_AVAILABILITY_CHANGE event
        The Sterling Order Management Real-Time Availability Monitor (RTAM) uses a time-triggered transaction to detect inventory changes beyond specified levels and triggers a REALTIME_AVAILABILITY_CHANGE event (in and later, the REALTIME_AVAILABILITY_CHANGE_LIST event). This event starts a service that publishes inventory information to the HCL Commerce Inventory Cache.
        REAL_TIME_AVAILABILITY_CHANGE_LIST event
        The Sterling Order Management Real-Time Availability Monitor (RTAM) uses a time-triggered transaction to detect inventory changes beyond specified levels and triggers a REALTIME_AVAILABILITY_CHANGE_LIST event. This event starts a service that publishes inventory information to the HCL Commerce Inventory Cache.
        Reserve inventory
        The Reserve Inventory communication maps the HCL Commerce ProcessInventoryRequirement request to the Sterling Order Management reserveAvailableInventory API call. As both HCL Commerce and Sterling Order Management are customizable, assumptions are made with the mapping from one system to the other.
        syncInventory
        If RTAM triggers a REALTIME_AVAILABILITY_CHANGE_LIST event and the inventory push is triggered in Monitor Option 1 or Monitor Option 3 mode, the availability change message from Sterling Order Management is routed to the SyncInventoryAvailability Service and sent to the HCL Commerce Inventory service.
        Transfer order
        The transfer order communication maps the HCL Commerce ProcessOrder request to the Sterling Order Management createOrder API call. As both HCL Commerce and Sterling Order Management are customizable, assumptions are made with the mapping from one system to the other.
        validateCouponUE
        The validateCouponUE mappings allow for validation of coupons between Sterling Order Management and HCL Commerce. When a shopper adds a manual coupon from Sterling Call Center, validateCouponUE is implemented to call HCL Commerce for validation of entered coupons against their definitions in HCL Commerce.
  - Inventory Management system integration
    Integrate an inventory management system with your store to ensure that inventory availability is constantly updated to reflect your store's current inventory levels.
  - Payments system integration
    Integrate a payments system with your store to process shopper payments for your site. You can also integrate with pricing and tax service providers to manage the pricing and tax calculations for your store.
  - Tax system integration
    You can integrate HCL Commerce with a third-party tax calculation system to provide tax calculations for your store. Integrating with a third-party tax service provider can help you to build and maintain a highly secure e-commerce site with a worldwide tax calculation process. Use the available HCL Commerce tax integration extension points to create any extensions that you need for integrating with your third-party tax calculation system. The tax integration xC extensions are a set of task commands that are called by the order component to communicate with the third-party tax calculation system when the tax integration feature is enabled.
  - Integrating with back-end systems and external applications
    External systems integration is a key feature of the HCL Commerce solution. In HCL Commerce business logic is enabled for integration and built-in adapters and interfaces are provided for common integration points. Additionally, the HCL Commerce integration solution leverages integration standards by using various IBM connectivity solutions.
  - IBM Watson Campaign Automation integration
    You can integrate IBM Watson Campaign Automation with HCL Commerce so that transactional emails are sent by IBM Watson Campaign Automation.
  - IBM MQ
    HCL Commerce provides a listener for IBM MQ for inbound requests, and an adapter for IBM MQ for outbound requests, to integrate back-end, and external systems with HCL Commerce.
  - Content management integration
    You can integrate HCL Commerce with an external content management system through a punch-out window from Management Center and through the web feed utility. You can integrate HCL Commerce with IBM Web Content Manager to provide Management Center users the ability to associate IBM Web Content Manager content with HCL Commerce objects.
  - Analytics for HCL Commerce
    HCL Commerce provides a framework that you can configure to integrate your store with an external Web analytics solution. This framework includes a tag library that you can use in store page JSP files to provide appropriate analytics information to the external analytics system.
  - IBM Product Recommendations and HCL Commerce
    IBM Product Recommendations is an IBM Digital Analytics solution that you can subscribe to that automatically generates personalized product recommendations on the storefront. The recommendations are based on the browsing, shopping, and purchasing behavior of individual customers. If your site is integrated with IBM Digital Analytics, you can display recommendations from IBM Product Recommendations on your store pages.
  - IBM Enterprise Marketing Management integration
    You can integrate HCL Commerce with IBM Enterprise Marketing Management.
  - IBM Dynamic Pricing
    Dynamic Pricing is a cloud-based pricing system that analyzes real-time market data to provide suggestions on how merchandisers can react to competitor pricing and shifts in market conditions. Data can be fed to Dynamic Pricing from multiple sources, including HCL Commerce. You can configure HCL Commerce to export pricing data to Dynamic Pricing for pricing analysis and adjustment. The adjusted pricing data can then be imported from Dynamic Pricing to HCL Commerce, so the prices can be propagated to your live store front.
  - IBM WebSphere eXtreme Scale
    You can integrate HCL Commerce version 9.0.0.7 or later with IBM WebSphere eXtreme Scale version 8.6.1.2 or later. The WebSphere eXtreme Scale licensed program is an elastic, scalable, in-memory data grid that you can use as an advanced cache for HCL Commerce. Integrating with WebSphere eXtreme Scale can provide significant performance benefits for high volume HCL Commerce customers.
  - Apple Pay on the Web integration
    Apple Pay on the Web integration with HCL Commerce provides you with an easy and secure way to accept and process payments. Apple Pay on the Web enables customers to purchase products in the Aurora starter store with a single touch in Safari on Mac, iPhone, and iPad.
  - Configuring directory services (LDAP) with HCL Commerce
    HCL Commerce can be configured to use one or more LDAP servers as the master user repository instead of the HCL Commerce database. This is typically done when multiple applications need to share a common user repository.
  - Sterling Omni-Configurator integration
    The Sterling Omni-Configurator integration for HCL Commerce enables your storefront to sell complex, configurable products, otherwise know as dynamic kits.
  - OAuth 2.0 framework for social login
    When you integrate with the OAuth 2.0 framework, your shoppers can authenticate to your storefront with their social networking accounts, like Google, Facebook, and Twitter.
- Administering
  Topics in the Administering category highlight tasks that are typically performed by the Site Administrator, to support daily operations of the HCL Commerce site.
- Customizing
  The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
- Tutorials
  HCL Commerce provides many tutorials to help you customize and understand your HCL Commerce instance and stores.
- Samples
  Topics in the Samples category highlight the various samples that are provided with HCL Commerce.
- Compliance
  The following section describes how you can leverage HCL Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of HCL Commerce and how to configure these features.
- Performance
  Topics in the Performance section describe the means by which to plan, implement, test, and re-visit the optimization of HCL Commerce site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with HCL Commerce, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the HCL Commerce reference documentation.

validateCouponUE

The validateCouponUE mappings allow for validation of coupons between Sterling Order Management and HCL Commerce. When a shopper adds a manual coupon from Sterling Call Center, validateCouponUE is implemented to call HCL Commerce for validation of entered coupons against their definitions in HCL Commerce.

**validateCouponUE Request**
validateCouponUE request mapping to ValidatePromoCodeBOD
Sterling Order Management API Path	HCL Commerce Path
Coupon / @CouponID	PromoCode / Code
Coupon /@BuyerUserId	PromoCode / BuyerIdentifier / ExternalIdentifier/ Identifier
Coupon /@OrganizationCode	Use ValueMap.xml to convert it to storeId, then put the storeId in the service context data
Coupon / @PricingDate	PromoCode / PricingDate

**validateCouponUE Response**
ValidatePromoCodeBOD response mapping to validateCouponUE
HCL Commerce Path	Sterling Order Management API Path
PromoCode / Code	Coupon /@CouponID
PromoCode/ Reason / Valid (true/false)	Coupon /@Valid (Y/N)
PromoCode / Reason / ReasonCode	Use ValueMap.xml to convert it to Coupon / @CouponStatusMsgCode