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.
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.
Order management administrative REST API
These API's can be used for order management, such as to define and administer fulfillment centers, shipping options, calculation codes and rules, installment rules, and more.
Shipping REST API
You can use the Shipping REST APIs to personalize your customers' experience, manage localization and shipping prices, and more.

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.
        Catalog administrative REST API
        These API's can be used to create and administer the attribute dictionary and attribute dictionary attributes for your stores.
        Content administrative REST API
        These API's can be used to create and administer content for your site. This content, such as images and documents, is used in catalogs and marketing.
        Contract administrative REST API
        These API's can be used to create and administer contracts and contract-related objects and functions, such as to administer contract trading agreements and the relationships between accounts and contracts.
        REST API for Elastic-based Search
        These API's can be used to create and administer the Ingest, Query, and NiFi services of the Elastic-based Search solution.
        Globalization administrative REST API
        These API's can be used to create and administer globalization support, such as for defining languages and currencies that can then be used in a store.
        Inventory management administrative REST API
        These API's can be used for DOM, Non-ATP, and ATP inventory management, such as to define the inventory model for a store, manage store inventories, and more.
        Managed Directories Administrative REST APIs
        Create and administer managed directories.
        Managed Files Administrative REST APIs
        Create and administer managed files.
        Marketing administrative REST API
        These API's can be used to create and administer marketing campaigns and marketing content for your stores.
        OIDC Authentication
        OIDC Authentication.
        Pricing administrative REST API
        These API's can be used to create and administer pricing functions for a store, such as for creating and administering offers, price lists, price rules, and more.
        Order management administrative REST API
        These API's can be used for order management, such as to define and administer fulfillment centers, shipping options, calculation codes and rules, installment rules, and more.
        Appeasement Configurations
        Provides order appeasement configuration data.
        Appeasements
        Create and administer a collection of appeasements.
        Approval status
        Operations related to administering contract approval statuses.
        Approval Type
        Operations to create and manage approval types
        Calculation code descriptions
        Operations related to creating and administering calculation code descriptions.
        Calculation codes
        Operations related to creating and administering calculation codes.
        Calculation range details
        Operations related to creating and administering calculation range details.
        Calculation ranges
        Operations related to creating and administering calculation ranges.
        Calculation rule scales
        Operations related to creating and administering calculation rule scales.
        Calculation rules
        Operations related to creating and administering calculation rules.
        Calculation rule scale descriptions
        Operations related to creating and administering calculation rule scale descriptions.
        Calculation scales
        Operations related to creating and administering calculation scales.
        Fulfillment centers
        Operations related to creating and administering fulfillment centers.
        Fulfillment center descriptions
        Operations related to creating and administering fulfillment descriptions.
        Installment rules
        Operations related to creating and administering installment rules.
        Jurisdiction group relationships
        Operations related to creating and administering jurisdiction group relationships.
        Jurisdiction groups
        Operations related to creating and administering jurisdiction groups.
        Jurisdictions
        Operations related to creating and administering jurisdictions.
        Order Justifications
        Create and administer a collection of justifications for order management.
        Orders
        Operations related to creating and administering orders.
        Order payments
        Operations related to order payments.
        Order blocks
        Operations related to administering order blocks.
        Order block reason codes
        Operations related to order block reason codes.
        Order Change Reasons
        Fetch order change reason codes and descriptions.
        Order Comments
        Fetches a collection of order comments.
        Order Item Returns
        Create and administer a collection of order item returns.
        Resource Metrics
        Retrieve Resource Value Unit (RVU) metrics count.
        RMA
        Create and administer a collection of RMA.
        Shipping REST API
        You can use the Shipping REST APIs to personalize your customers' experience, manage localization and shipping prices, and more.
        Shipping Charges
        Operations for retrieval of shipping charges
        Shipping Methods
        Operations for retrieval of shipping methods
        Shipping Mode Carriers
        Operations for retrieval of shipping mode carriers
        Shipping arrangements
        Operations related to creating and administering shipping arrangements.
        Shipping jurisdiction calculation rules
        Operations related to creating and administering shipping jurisdiction calculation rules.
        Shipping modes
        Operations related to creating and administering shipping modes.
        Shipping mode codes
        Operations related to creating and administering shipping mode codes.
        Shipping mode descriptions
        Operations related to creating and administering shipping mode descriptions.
        Store administrative REST API
        These API's can be used to create and administer stores, including defining supported store languages and currencies, defining store configurations, enabling store functions, and more.
        Tax REST API
        The Tax REST APIs allow you to manage selling and merchandizing within a diverse range of national and international environments.
        System administrative REST API
        These API's can be used to create and administer systems functions, such as to administer scheduled jobs, transports, message types, registries, device formats, business audits, and more.
        User and organization administrative REST API
        These API's can be used to create and administer users and organizations for your site, member groups, roles, role assignments, password policies, access control policies, 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.
      - 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.

Shipping REST API

You can use the Shipping REST APIs to personalize your customers' experience, manage localization and shipping prices, and more.