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.
Shopping flow URLs
HCL Commerce shopping flow URLs are organized by subsystem.
Order Management subsystem URLs
The Order Management subsystem includes all logic and data relevant to placing, processing, and managing orders. The Order Management subsystem also deals with returns.
Orders URLs
The following URLS are related to orders:
AdvancedOrderEditEnd
Closes an order for editing and removes the editor ID from the order, that is this URL removes the EDITOR_ID values from the order in the ORDERS table.

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.
- 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.
  - 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 9.0.0.0 and 9.0.0.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.
  - Docker container start up logic for HCL Commerce Version 9.0.0.2 or later
    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
    The HCL Commerce database model was designed for data integrity and optimal performance. HCL Commerce provides several hundred tables that store HCL 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 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.
    - Catalog subsystem URLs
      Catalog subsystem URLs include all logic and data relevant to a catalog, including categories, products and their attributes, items, and groupings of each, and any associations or relationships among them.
    - Member subsystem URLs
      The Member subsystem includes all logic and data relevant to registration, authentication, and grouping of all members. A member can be a user, an organization or organizational entity, or a member group.
    - Order Management subsystem URLs
      The Order Management subsystem includes all logic and data relevant to placing, processing, and managing orders. The Order Management subsystem also deals with returns.
      - Order abbreviations
        Several order URLs accept order abbreviations such as "*" and "." to indicate one or more values for some of their parameters that specify order identifiers. URLs that accept order abbreviations generally accept any of the following abbreviations, although "**" and ".**." (which involve creating a new order) may not be applicable for some URLs. Refer to each URL's documentation to understand which abbreviations are accepted by each URL. Many URLs accept the following order abbreviations for parameters that specify order reference numbers.
      - Error codes for error views
      - Overall shopping flow diagram
        A diagram showing various scenarios including the service calls, optional commands, controller commands and views.
      - Order status transition flow diagrams
        The four diagrams are comprised of one overall view and three simplified diagrams each showing a particular flow process. The status transition in each shopping flow diagram applies to all business models.
      - Order task commands
        The Order Management subsystem uses many task commands. Each task command performs one function.
      - Orders URLs
        The following URLS are related to orders:
        AdvancedOrderEditBegin
        Sets up an order for editing or changes and begins an edit session. It attaches an editor ID to the order. This URL checks whether the order and order items are editable; if they are editable, this URL changes the status to E unless the state is NEW, P, or E. Meanwhile, if the order and order items are in a shopping cart, no status change is made. Orders that have already been submitted can be changed before they are released to fulfillment.
        AdvancedOrderEditEnd
        Closes an order for editing and removes the editor ID from the order, that is this URL removes the EDITOR_ID values from the order in the ORDERS table.
        InventoryAllocationCheckCmd
        Display a list of order items based on the status of the order items in specified orders.
        OrderCalculate
        Determines a list of catalog items to be included in an order, adds them to the order by calling OrderItemAdd if they are not already in it, and recalculates specified CalculationUsages.
        OrderCancel
        Cancel the specified order by changing its order state, reversing any inventory allocations, and canceling any backordered items. This URL does not remove the order from the database. OrderCancel can cancel orders with an order status of A, B, C, I, L, M, N.
        OrderCopy
        Create, merge, or modify pending orders that have a status attribute of P or I.
        OrderCreate
        This URL creates an order without any order items.
        OrderDisplay
        Displays the contents of specified orders. If order reference numbers are not specified, this URL displays the list of orders that match the input parameters.
        OrderList
        Displays a list of the customer's orders, whether they have been prepared or not. This URL provides a summary of the orders. It does not show tax, shipping, or discounts.
        OrderPrepare
        Prepares an order by determining its prices, discounts, shipping charges, and taxes. If an order reference number is not specified, all current pending orders will be prepared for the current customer at the given store.
        OrderProcess
        Submits an order for processing. The order must be locked by the OrderPrepare command.
        OrderProfileUpdate
        Creates or updates a customer's default billing and shipping addresses, payment information, and shipping mode. Order profiles can be stored at store level, to provide defaults for use within a store, or at store group level, to provide defaults for use within all stores in the group.
        OrderUnlock
        Unlocks an order that was previously locked by OrderPrepare command, then calls the specified URL. If the order is not locked, or if the order reference number is not correct, the command only calls the URL.
        ScheduledOrderCancel
        Cancels execution of a recurring order submitted by the OrderSchedule URL.
        SetOrderTemplate
        Sets or resets a "template" order or a "current template" order.
        SetPendingOrder
        Set a pending order as the current pending order.
        ShipInfoAdd
        Add shipping instructions or a shipping-carrier account number to an order and creates records in the SHIPINFO database table.
        ShipInfoUpdate
        Updates an order with shipping instructions or a shipping-carrier account number. For B2B orders where shipping is charged by the carrier, the shipping carrier account number to be used with the order.
        ShipInfoDelete
        Deletes either shipping instructions or, for B2B orders, shipping charge type information from an order.
        ShipInfoPrepare
        Reconciles the SHIPINFO table and ORDERITEMS table to look for orphaned SHIPINFO records, and deletes any orphaned records from the SHIPINFO table. An orphaned SHIPINFO record is one that does not have a matching record in the ORDERITEMS table. This situation can occur if a shipping address is deleted after a SHIPINFO record is created.
      - Order item URLs
        The following URLs are related to order items:
      - Order fulfillment URLs
        The following URLs are related to order fulfillment:
      - Order quotation URLs
        The following URLs are related to order quotations:
      - Returns and refunds
        The following URLs are related to Returns and refunds.
      - Scheduled orders URLs
        The following URLs are related to scheduled orders:
      - Currency
        The following URL is related to currency.
      - Requisition lists
        A requisition list is a list of items that is used to create orders at a later date. Users can create requisition lists of items that they order frequently and use it to periodically re-order the items. Each item on a requisition list is associated with a catalog entry and has the following attributes: SKU, Quantity, Last update time, Owner, Store, Type: private or shared. Private requisition lists can be viewed and modified only by a certain user, typically the creator. A shared requisition list can be read and used by the users in the same organization.
    - Request for Quote (RFQ)
      A Request for Quote (RFQ) is a type of trading mechanism available in HCL Commerce. You can maintain and administer RFQs using the HCL Commerce Accelerator. When you publish the advanced B2B starter store provided with HCL Commerce, you get the RFQ request tool.
  - 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.

Deprecated feature

AdvancedOrderEditEnd URL

Closes an order for editing and removes the editor ID from the order, that is this URL removes the EDITOR_ID values from the order in the ORDERS table.

An order can be placed into the major status state of E by using the AdvancedOrderEditBegin URL unless the state is P, NEW, or E; the value of the HCL Commerce user (member ID) is attached to the order in the ORDERS table and is recorded as the editor ID. The AdvancedOrderEditEnd URL can be used to remove the associated member ID from the order.

The AdvancedOrderEditEnd URL can be used to close the editing of an order only if the order is in the NEW, P, or E state. The major status will not change after the invocation.

For the order to be processed, it does not have to be released from the control of a user (such as a CSR). When the order is processed by using the OrderProcess command, the system automatically invokes the AdvancedOrderEditEndCmd controller command to remove the member ID that was attached to the order.

URL structure

http://host_name/path/: The fully qualified name of your Transaction server and the configuration path.

This diagram displays the structure for the AdvancedOrderEditEnd URL.

Parameter values

orderId: Required: The identifier of the order undergoing the edit or change.

Example

The following example causes the EDITOR_ID value in the ORDERS table for order 112233 to be removed:


http://host_name/webapp/wcs/stores/servlet/AdvancedOrderEditEnd?orderId=112233

Exception conditions

User is not authorized to invoke the command.
Authorized user has not logged in.
Invalid major status: Order is in a state other than PRC, EDT, or NEW.