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.
Reference
Topics in the Reference section contain all of the HCL Commerce reference documentation.
HCL Commerce API reference
HCL Commerce exposes two main programming APIs. The first and newest API is a REST interface, and most new classes are exposed here. The legacy Java API also contains new classes not suitable for REST, and can be browsed in Javadoc format.
HCL Commerce REST API
The HCL Commerce REST API documentation contains a list of resources that are provided by the HCL Commerce REST API. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
Mapping of REST services to BOD services
The following sections detail how the REST resource method names relate to specific BOD services.

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.1, 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.
- 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.
  - HCL Commerce API reference
    HCL Commerce exposes two main programming APIs. The first and newest API is a REST interface, and most new classes are exposed here. The legacy Java API also contains new classes not suitable for REST, and can be browsed in Javadoc format.
    - HCL Commerce REST API
      The HCL Commerce REST API documentation contains a list of resources that are provided by the HCL Commerce REST API. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
      - Swagger UI
        A live version of the HCL Commerce REST API is available in a web browser on your HCL Commerce test server using the Swagger UI. It is composed of a set of static HTML, CSS, and JavaScript that dynamically documents the available REST API on the HCL Commerce test server.
      - Viewing the REST API using Swagger in pre-9.1.6 versions
        While more recent versions have updated their API documentation tools, HCL Commerce 9.1.5 and earlier continue to support the Swagger UI. This tool provides a live sandbox to view and execute RESTful API calls that carry supported annotations.
      - Setting up a local Swagger instance
        A local Swagger instance provides an environment to review, test, and document REST APIs using the Swagger Editor and Swagger User Interface.
      - Testing REST APIs
        HCL Commerce supports the OpenAPI 3.0 specification from Version 9.1.6.0 onwards. You can use the Swagger specification to test any RESTful APIs that are documented in OAS files.
      - Administrative REST API
        You can use the HCL Commerce administrative API to complete administrative tasks for managing your site. The Administrative API contains a list of resources that are provided for creating, retrieving, changing, and deleting data to administer your site globalization capabilities, organizations, and more.
      - Approval service APIs
        API definitions for Seller organization requests approval service
      - Storefront REST API
        HCL Commerce Storefront REST API documentation contains a list of resources that are provided by the HCL Commerce REST API for retrieving, changing, and deleting data related to a store. Each REST resource contains information such as URLs, descriptions, and sample input and output data.
      - REST API for Elasticsearch-based Search
        These API's can be used to create and administer the Ingest, Query, and NiFi services of the Version 9.1 Elasticsearch-based Search solution.
      - xC extension points
        You can use the REST API to help you create your custom business logic for extending existing HCL Commerce processes or to call your own custom processes.
      - Mapping of REST services to BOD services
        The following sections detail how the REST resource method names relate to specific BOD services.
      - Mapping of REST services to storefront checkout actions
        REST services map to specific storefront checkout actions in the Aurora starter store. Each page action corresponds to a specific REST service for cart management and order processing.
      - REST service annotations
        HCL Commerce REST services and Search REST services are annotated so you view and test the APIs with Swagger, an interactive REST service interface. The REST Discovery API generates a list of REST resources and APIs by parsing annotations on a resource handler. By documenting your custom REST resource handlers with the same annotation standards as HCL Commerce REST services, your custom REST services can be viewed and tested with Swagger.
    - HCL Commerce GraphQL API
      GraphQL makes it easy to construct APIs. The GraphQL markup language is available for any API. It is a server-side interpreter for processing queries using a data type system you design. With GraphQL, your data and code are independent of any database or storage system.
    - Java API classes
      You can browse the HCL Commerce Java APIs in Javadoc format.
  - Cross-reference of data beans and tables
    Data beans are grouped into several component groups.
  - Cross-reference of commands, tasks, and tables
    URL commands, controller commands, task commands, view commands and tables are related to each other.
  - Cross reference: Commands to beans to database tables
    Use this information when you are customizing a command and you want to know which tables are affected. You should also use this topic if you are modifying a table and want to know which commands and beans are affected.
  - Run Engine commands
    The following Run Engine commands are available by default for you to configure the applications that are running inside the containers.
  - Entering Docker containers
    To enter a Docker container you can complete the following steps.
  - Docker container start up logic for HCL Commerce Version 9.1
    When you deploy a container from an HCL provided image, an Entrypoint.sh helper script determines the configurations to use while starting up the container. Review the following information to learn about what the helper script does, and how you can customize the configurations.
  - HCL Commerce database schema
    Learn how to extend and maintain the HCL Commerce database schema to ensure data integrity and performance.
  - Payments subsystem
    In HCL Commerce, payment processing uses the Payments subsystem.
  - Dynamic caching
    In general, caching improves response time and reduces system load. Caching techniques are used to improve the performance of World Wide Web Internet applications. Most techniques cache static content (content that rarely changes) such as graphic and text files. However, many websites serve dynamic content, containing personalized information or data that changes more frequently. Caching dynamic content requires more sophisticated caching techniques, such as those provided by the WebSphere Application Server dynamic cache, a built-in service for caching and serving dynamic content.
  - HCL Commerce store pages properties
  - Cache-entry elements
    The root element of the cachespec.xml file, <cache>, contains <cache-entry> elements. The WebSphere dynamic cache service parses the cachespec.xml file during start-up, and extracts a set of configuration parameters from each <cache-entry> element.
  - Data Load utility configuration file schema
    The Data Load utility contains several configuration files. You can use the configuration file schema to understand and customize the data load configuration files.
  - HCL Commerce web services
    HCL Commerce provides many web services.
  - Utilities
    In HCL Commerce utilities are scripts that perform operations such as loading access control policies, loading store data, and cleaning the database of obsolete objects. In runtime environments, run utilities from the Utility server Docker container. In the development environment, run utilities from the bin directory.
  - Shopping flow URLs
    HCL Commerce shopping flow URLs are organized by subsystem.
  - Messaging system URLs
    The following URLs relate to the Messaging system.
  - Scheduler URLs
    The server subsystem consists of functions that are associated with URLs that are run by the scheduler.
  - jQuery Enhancements API
    The Aurora starter store in HCL Commerce is completely written in jQuery, which is one of the most commonly used JavaScript libraries used in dynamic websites. The jQuery AJAX and events API provides an easy to use framework that meets most AJAX requirements for storefront development.
  - HCL Commerce foundation tag library
    The HCL Commerce foundation JSTL tag library is a collection of custom tags that are provided to you to support the authoring of HCL Commerce JSP files. HCL Commerce stores use the JavaServer Pages Standard Tag Library (JSTL) to perform logic, instead of Java code. At the same time, business logic is moved into data beans. The combination of these steps allows for less Java code in a JSP page.

Mapping of REST services to BOD services

The following sections detail how the REST resource method names relate to specific BOD services.

AssignedCouponHandler

REST API: assigned_coupon
BOD noun: Order


Resource Method Name	BOD Service Mapping
getAssignedCouponInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
applyCoupon	BOD: ProcessOrderAction Code: ApplyCouponAction Expression: /Order BOD:ProcessOrderAction Code: CalculateInternallyAction Expression: /Order
removeCoupon	BOD: ProcessOrderAction Code: RemoveCouponAction Expression: /Order BOD: ProcessOrderAction Code: CalculateInternallyAction Expression: /Order

AssignedPromotionCodeHandler

REST API: assigned_promotion_code
BOD noun: Order


Resource Method Name	BOD Service Mapping
getAssignedPromotioncodeInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
applyPromotioncode	BOD: ProcessOrderAction Code: ApplyPromotionCodeAction Expression: /Order BOD: ProcessOrderAction Code: CalculateInternallyAction Expression: /Order
removePromotionCode	BOD: ProcessOrderAction Code: RemovePromotionCodeAction Expression: /Order BOD: ProcessOrderAction Code: CalculateInternallyAction Expression: /Order

AssociatedPromotionHandler

REST API: associated_promotion
Data bean: CalculationCodeListDataBean


Resource Method Name	BOD Service Mapping
findPromotionList	Not applicable. Calls the CalculationCodeListDataBean data bean.

CartHandler

REST API: cart
BOD noun: Order


Resource Method Name	BOD Service Mapping
getCart	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
getUsableShippingInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD: GetOrderAccess Profile: IBM_UsableShippingInfo /Order[OrderIdentifier[(UniqueID='$OrderID$')]]
getUsablePaymentInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD: GetOrderAccess Profile: IBM_UsablePaymentInfoAction Expression: /Order[OrderIdentifier[(UniqueID='$OrderID$')]]
applyCheckoutProfile	BOD: GetOrderAccess Profile: IBM_SummaryAction Expression: /Order[OrderStatus[(Status='Q')]] BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem BOD: ProcessOrderAction Code: CheckoutAction Expression: {_ord.usingProfile='true'}/Order
addOrderItem	BOD: ChangeOrder Action Code: CreateAction Expression: /Order/OrderItem
udpateOrderItem	BOD: ChangeOrder Action Code: UpdateAction Expression: /Order/OrderItem
cancelOrderInCart	BOD: ProcessOrder Action Code: CancelAction Expression: /Order
preCheckout	BOD: ProcessOrder Action Code: PrepareAction Expression: /Order
checkOut	BOD: ProcessOrder Action Code: SubmitAction Expression: /Order
lockCart	BOD: ProcessOrder Action Code: LockAction Expression: /Order
unlockCart	BOD: ProcessOrder Action Code: UnlockAction Expression: /Order
getAllowableShippingModes	Not applicable. Calls an AccessBean to get the allowable shipping modes.

CouponHandler

REST API: coupon
BOD noun: WalletItem


Resource Method Name	BOD Service Mapping
getCoupon	BOD: GetWalletItemAccess Profile: IBM_Store_DetailsAction Expression: /WalletItem[Data[Status='0'] and Type='Coupon' and WalletItemIdentifier/ExternalIdentifier/WalletIdentifier[UniqueID='$uniqueId$']]
deleteCouponById	BOD: ProcessWalletItemAction Code: DeleteAction Expression:/WalletItem

ESpotDataHandler

REST API: espot
BOD noun: MarketingSpotData


Resource Method Name	BOD Service Mapping
findByName	BOD: GetMarketingSpotDataAccess Profile: IBM_Store_AllAction Expression: `{_wcf.ap=$accessProfile$`
findByNameWithCategory	BOD: GetMarketingSpotDataAccess Profile: IBM_Store_AllAction Expression: `{_wcf.ap=$accessProfile$`
findByNameWithProduct	BOD: GetMarketingSpotDataAccess Profile: IBM_Store_AllAction Expression: `{_wcf.ap=$accessProfile$`

EventHandler

REST API: Event
BOD noun: MarketingTrigger


Resource Method Name	BOD Service Mapping
triggerMarketing	BOD: ProcessMarketingTriggerAction Code: EvaluateAction Expression: {_mkt.triggerParameters='DM_ReqCmd=$commandName$&nvp1=value1&nvp1=value2_mkt.endTriggerParameters'}/MarketingTrigger

GeoNodeHandler

REST API: geonode
BOD noun: GeoNode


Resource Method Name	BOD Service Mapping
findTopGeoNodes (site level search)	BOD: GetGeoNodeAccess Profile: IBM_Store_AllAction Expression: /GeoNode[@topGeoNode='true']
findTopGeoNodes (store level search)	BOD: GetGeoNode Access Profile: IBM_Store_AllAction Expression: /GeoNode[@topGeoNode='true' and StoreIdentifier[UniqueID=$storeId$]]
findGeoByParentGeoId	BOD: GetGeoNode Access Profile: IBM_Store_AllAction Expression: /GeoNode[ParentGeoNodeIdentifier[UniqueID=$parentUniqueId$]]

InventoryHandler

REST API: inventoryavailability
BOD noun: InventoryAvailability


Resource Method Name	BOD Service Mapping
getInventoryAvailabilityByProductId	BOD: GetInventoryAvailabilityAccess Profile: IBM_Store_DetailsAction expression: 1. /InventoryAvailability[InventoryAvailabilityIdentifier/ExternalIdentifier[CatalogEntryIdentifier[(UniqueID=$uniqueId$)] and OnlineStoreIdentifier[(UniqueID=$uniqueId$)]]]

OrderHandler

REST API: order
BOD noun: Order


Resource Method Name	BOD Service Mapping
findOrderHistory	BOD: GetOrderAccess Profile: IBM_SummaryAction Expression: /Order[OrderStatus[(status='$OrderStatus$')]]
findByOrderId	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: /Order[OrderIdentifier[(UniqueID='$orderID$')]]
findByStatus	BOD: GetOrderAccess Profile: IBM_SummaryAction Expression: /Order[OrderStatus[(status='$OrderStatus$')]]

PaymentInstructionHandler

REST API: payment_instruction
BOD noun: Order


Resource Method Name	BOD Service Mapping
getPaymentInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression: {ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
addPaymentInstruction	BOD: ChangeOrderAction Code: CreateActionExpression: /Order/OrderPaymentInfo/PaymentInstruction
updatePaymentInstruction	BOD: ChangeOrderAction Code: UpdateActionExpression: /Order/OrderPaymentInfo/PaymentInstruction
deletePaymentInstruction	BOD: ChangeOrderAction Code: DeleteActionExpression: /Order/OrderPaymentInfo/PaymentInstruction
deleteAllPaymentInstructions	BOD: ChangeOrderAction Code: DeleteActionExpression: /Order/OrderPaymentInfo/PaymentInstruction

PersonHandler

REST API: person
BOD noun: Person


Resource Method Name	BOD Service Mapping
findPersonBySelf	BOD: GetPersonAccess Profile: IBM_AllActionExpression: {self=true}/Person
registerPerson	BOD: ProcessPersonAction Code: RegisterActionExpression: /Person BOD: ProcessPersonAction Code: AuthenticatePassword
updatePerson	BOD: ChangePersonAction Code: UpdateActionExpression: /Person
deleteContextAttributeForPerson	BOD: ChangePersonAction Code: DeleteActionExpression: /Person/ContextAttribute

PromotionHandler

REST API: promotion
BOD noun: Promotion


Resource Method Name	BOD Service Mapping
getPromotionsByQuery	BOD: GetPromotionAccess Profile: IBM_Admin_DetailsAction Expression: /Promotion
getPromotionsByQuery?q=byName	BOD: GetPromotionAccess Profile: IBM_Admin_DetailsAction Expression: /Promotion[search(contains(AdministrativeName, $qName$))]
getPromotionByID	BOD: GetPromotionAccess Profile: IBM_Admin_DetailsAction Expression: /Promotion[PromotionIdentifier[(UniqueID='$promotionId$')]]

SegmentHandler

REST API: segment
BOD noun: MemberGroup


Resource Method Name	BOD Service Mapping
checkIsInSegmentByUserId	BOD: GetMemberGroupAccess Profile: IBM_Admin_DetailsAction Expression: /MemberGroup[MemberGroupIdentifier[UniqueID='$memberGroupID$'] and IncludedPerson[UniqueID='$personID$']]
getCustomerSegment	BOD: GetMemberGroupAccess Profile: IBM_Admin_DetailsAction Expression:ByName: /MemberGroup[search(contains(MemberGroupIdentifier[ExternalIdentifier[Name="$name$" and Usage="GeneralPurpose"]]ByUserId: /MemberGroup[IncludedPerson[UniqueID="$UserID$"] and Usage="-1"]ByPersonalizationId: /MemberGroup[IncludedPerson[UniqueID="$personID$"] and Usage="-1"]ByStore: /MemberGroup[Usage='GeneralPurpose']
getCustomerSegmentById	BOD: GetMemberGroupAccess Profile: IBM_Admin_DetailsAction Expression: /MemberGroup[MemberGroupIdentifier[(UniqueID='$memberGroupID$')]]

ShippingInfoHandler

REST API: shipping_info
BOD noun: Order


Resource Method Name	BOD Service Mapping
getShippingInfo	BOD: GetOrderAccess Profile: IBM_DetailsAction Expression:{ibmord.isCurrentShoppingCart='true'}/Order/OrderItem
updateOrderShippingInfo	BOD: ChangeOrderAction Code: UpdateAction Expression: /Order/OrderItem/OrderItemShippingInfo

SpotHandler

REST API: spot
BOD noun: MarketingSpot


Resource Method Name	BOD Service Mapping
findSpotsByQuery?q=byType	BOD: GetMarketingSpotAccess Profile: IBM_Admin_DetailsAction Expression: /MarketingSpot[Usage='$qType$']
findSpotsByQuery?q=byTypeAndName	BOD: GetMarketingSpotAccess Profile: IBM_Admin_DetailsAction Expression: /MarketingSpot[Usage='$qType$' and search(contains(MarketingSpotIdentifier/ExternalIdentifier/Name, '$qName$') or contains(Description, '$qName$'))]
findSpotByID	BOD: GetMarketingSpotAccess Profile: IBM_Admin_DetailsAction Expression: /MarketingSpot[MarketingSpotIdentifier[(UniqueID='$spotId$')]]

StoreLocatorHandler

REST API: storelocator
BOD nouns: GeoNode, PhysicalStore


Resource Method Name	BOD Service Mapping
findGeoNodeByGeoLocation (site level search)	BOD: GetGeoNodeAccess Profile: IBM_Store_AllAction Expression: /GeoNode[@type=$type$ and search(contains(Description/Name,$Name$))] BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]]
findGeoNodeByGeoLocation (store level search)	BOD: GetGeoNodeAccess Profile: IBM_Store_AllAction Expression: /GeoNode[@type=$type$ and StoreIdentifier[UniqueID=$storeId$] and search(contains(Description/Name,$Name$))] BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]]
findGeoNodeByGeoId	BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[LocationInfo[GeoNodeIdentifier[UniqueID=$uniqueId$]]]
findByStoreUniqueId	BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: /PhysicalStore[PhysicalStoreIdentifier[(UniqueID=$uniqueId$)]]
findStores	BOD: GetPhysicalStoreAccess Profile: IBM_Store_DetailsAction Expression: {_sto.radiusValue=$value$;_sto.radiusUom=$uom$;_sto.maxStores=$maxStores$}/PhysicalStore[LocationInfo[GeoCode[Latitude=$latitude$ and Longitude=$longitude$]] and StoreIdentifier[UniqueID=$storeId$]]

WishlistHandler

REST API: wishlist
BOD nouns: Person, GiftList


Resource Method Name	BOD Service Mapping
findWishlist	BOD: GetPerson Access Profile: IBM_AllAction Expression: {self=true}/Person BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: /GiftList[Registrant[PersonIdentifier[UniqueID=]] and Registry=]
findWishlistByUserId_default	BOD: GetPersonAccess Profile: IBM_AllAction Expression: {self=true}/Person BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: /GiftList[Registrant[PersonIdentifier[UniqueID=]] and Registry= and (State=)]
findWishlistByExternalId	BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: GiftList[GiftListIdentifier[GiftListExternalIdentifier[(ExternalIdentifier=)]]] BOD: GetGiftListAccess Profile: IBM_Store_GiftListSummaryAndItemsAction Expression: /GiftList[AccessSpecifier[GuestAccessKey= or RegistryAccessKey=] and GiftListIdentifier[GiftListExternalIdentifier[ExternalIdentifier=]]]
createWishlist	BOD: ProcessGiftListAction Code: CreateAction Expression: /GiftList[1]
updateWishlist (when addItem=true)	BOD: ChangeGiftListAction Code: AddAction Expression: /GiftList[] /GiftList[]/Item[]
updateWishlist	BOD: ChangeGiftListAction Code: ChangeAction Expression: /GiftList[] /GiftList[]/Item[] /GiftList[]/Description
deleteWishlist	BOD: ProcessGiftListAction Code: DeleteAction Expression: /GiftList[1]