Home
Documentation
This Help Center provides documentation on all aspects of the HCL Commerce+ product, from installation and deployment to operating and customization.
Reference
Topics in the Reference section contain all of the Commerce+ reference documentation.
REST API
The REST API reference describes the available endpoints for customizing the system. Essential information such as the resource path, descriptions of each operation, and samples of the request and response payloads is provided.
Transaction Server REST API
You can use the Commerce+ Transaction Server API to managing the overall system. The API includes resources for creating, retrieving, changing, and deleting data to administer the Commerce+ infrastructure.
Storefront REST API
Commerce+ Storefront REST API documentation contains a list of resources that are provided by the 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.

Documentation
This Help Center provides documentation on all aspects of the HCL Commerce+ product, from installation and deployment to operating and customization.
- Overview
  Welcome to the HCL Commerce+ overview. Explore these feature overviews to learn how Commerce+ operates. Refer to the related links listed at the end of each topic to access expanded product documentation.
- Deploying
  This section provides details on deploying HCL Commerce+. It explains how to download the Docker images and Git bundles that comprise the product, how to create a minimal environment, and how to plan for a full deployment. It details supported software versions, patches, and configurations to ensure the platform performs well.
- Migrating
  The following topics show how to migrate an existing HCL Commerce Version 9.1 environment to Commerce+. The process consists of an initial migration of your database contents. This is followed by a code migration. Both are fully described.
- Operating
  The topics in this section focus on tasks that are performed by business users, marketers, and customer support representatives to connect with partners and attract and satisfy customers.
- Administering
  The site administrator performs the tasks needed to support day to day operations of the Commerce+ site.
- Extending
  Using Commerce+'s xC programming model, you can use HCL-provided extension points to extend existing Commerce logic. You can implement these extensions with the xC Customization toolkit provided by HCL. Commerce+ also provides Packaged Business Capability integrations that extend the product's reach and functionality.
- Securing
  These topics describe the security features of 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 Commerce+ site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with Commerce+, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the Commerce+ reference documentation.
  - REST API
    The REST API reference describes the available endpoints for customizing the system. Essential information such as the resource path, descriptions of each operation, and samples of the request and response payloads is provided.
    - Transaction Server REST API
      You can use the Commerce+ Transaction Server API to managing the overall system. The API includes resources for creating, retrieving, changing, and deleting data to administer the Commerce+ infrastructure.
      - Administrative REST API
        You can use the 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.
      - Search administrative REST API
        These API's can be used to create and administer search capabilities and features, such as to create facets, define search fields, field properties, and more.
      - Storefront REST API
        Commerce+ Storefront REST API documentation contains a list of resources that are provided by the 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.
        Authentication, Authorization and Session Management
        These services provide APIs related to authentication and session management in a B2B or B2C store.
        Cart
        Operations for the support of Payment Instructions, Cart and Shipping Info
        Catalog
        Operations for retrieving category, catalog entry and category
        Commerce Composer
        Operations for Layout, Page Design, Widget Definition and Page
        Coupons and promotions
        Operations for Coupon, Promotion and Associated Promotion
        Data extract
        Operations for Catalog, Catalog Export, Catalog Download, Order Download, Order Export
        Extended Logging
        Operations for configuration of extended logger
        Google Analytics
        Operations for managing Google Analytics access information
        Marketing
        Operations for Spot, Event, Segment, User Behavior
        HCL Commerce Marketplace Sellers
        Operations to fetch active marketplace sellers for a store. Please note that these APIs are introduced in HCL Commerce V9.1.10 as preview version. HCL Commerce reserves the right to make modification to these APIs when they are GA in the future release.
        Miscellaneous Transaction
        These services provide APIs related to locational data, including the store locator feature.
        Order Capture
        Operations for creating and managing order, order notification, inventory availability and wishlist
        Price
        Operations for Currency Format, Price, Display Price
        Store Configurations
        Operations for retrieval of store configuration values
        Store Locator
        Operations for retrieval of store locator, country and geonode values
        Subscription
        Operations for creating and administering subscriptions
        User and Organization Management
        These services provide APIs related to user and organization management in a B2C and B2B store
        Workspace
        Operations for the creation and management of workspaces, task_group and task
      - Commerce+ REST API
        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 storefront checkout actions
      The Aurora starter store uses REST services throughout the checkout process. The actions for each page map to a REST service.
    - REST service annotations
      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 Commerce+ REST services, your custom REST services can be viewed and tested with Swagger.
  - Run Engine commands
    The following Run Engine commands are available by default for you to configure the applications that are running inside the containers.
  - Commerce+ database schema
    The Commerce+ database model was designed for data integrity and optimal performance. Commerce+ provides several hundred tables that store Commerce+ instance data. To maintain data integrity, and to ease maintenance referential integrity, constraints are widely used in the database model. Indexes are used carefully on tables to avoid over-indexing and to provide a good balance between data retrieval and data manipulation activities (insert and update). The business rules are implemented at the application level rather than by using database trigger. Triggers, however, are used to facilitate data staging and optimistic locking. A limited number of SQL-based database stored procedures are used for data intensive activities.
  - Payments subsystem
    In 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 Open Liberty Server dynamic cache, a built-in service for caching and serving dynamic content.
  - 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.
  - Commerce+ web services
    Commerce+ provides many web services.
  - Utilities
    In 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.
  - 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.

Storefront REST API

Commerce+ Storefront REST API documentation contains a list of resources that are provided by the 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.

Most REST APIs require the storeId. To find your store ID, open the Store Management tool within the Commerce Lab and select your store. Then, view Store Properties > Store Profile and note your store ID value that is displayed as the store's Unique ID.