Home
Reference
Shopping flow URLs
WebSphere 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.
Order task commands
The Order Management subsystem uses many task commands. Each task command performs one function.
CalculateOrderCmd
The CalculateOrderCmd task command handles free gifts and implements the core logic of calculation.

Reference
- WebSphere Commerce API reference
  WebSphere 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, EJB 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.
- API changes between WebSphere Commerce Version 7.0.0.9 and WebSphere Commerce Version 8.0.0.0
  If you are migrating version 7.0 of WebSphere Commerce, review the API changes between releases.
- WebSphere Commerce database schema
  The WebSphere Commerce database model was designed for data integrity and optimal performance. WebSphere Commerce provides several hundred tables that store WebSphere 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 WebSphere 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.
- 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.
- WebSphere Commerce web services
  WebSphere Commerce provides many web services.
- Utilities
  Utilities help you to accomplish administrative or configuration tasks, for example, loading data, publishing a store.
- Shopping flow URLs
  WebSphere 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.
  - Messaging system URLs
    The following URLs relate to the Messaging system.
  - 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.
      - PrepareOrderCmd
        The PrepareOrderCmd task command prepares an order by determining prices, discounts, shipping charges, and taxes for an order.
      - ProcessOrderCmd
        The ProcessOrderCmd task command makes the ProcessOrder server request.
      - PreProcessOrderCmd
        The PreProcessOrderCmd task command preprocesses the order.
      - ReprepareOrderCmd
        The ReprepareOrderCmd task command recalculates shipping charges and taxes, and locks the order.
      - DoInventoryActionCmd
        The DoInventoryActionCmd task command interfaces with all inventory operations.
      - AddOrderItemComponentsCmd
        The AddOrderItemComponents task command creates the components that are associated with a composite order item.
      - UpdateShippingAddressCmd
        The UpdateShippingAddressCmd task command updates the shipping address for the passed order items.
      - UpdateShipInfoCmd
        The UpdateShipInfoCmd task command updates shipping information.
      - RaiseOrderEventCmd
        The RaiseOrderEventCmd task command is used to raise an order related event. Default implementation of this command is RaiseOrderEventCmdImpl.
      - PrepareShipInfoCmd
        The PrepareShipInfoCmd performs a verification between the SHIPINFO table and the ORDERITEMS table and checks for orphaned SHIPINFO records.
      - CheckAndResetOrderItemPriceFlagCmd
        The CheckAndResetOrderItemPriceFlagCmd task command is used to check and reset the bit price flag "PRICE_REFRESHED" for the order items if price is expired. The flag PRICE_REFRESHED indicates whether the price should be recalculated. If the price is expired, the flag should be reset to 0 and price should be recalculated.
      - ValidateShippingAdjustmentCmd
        The ValidateShippingAdjustmentCmd task command is used to find any inconsistencies in the order's shipping adjustments. If new items have been added then the value returned from hasShoppingCartChanged() will be true else it will be false.
      - OrderCommentRecordContrlCmd
        The OrderCommentRecordContrlCmd task command creates the order comments and notifies the shopper if needed.
      - ValidatePaymentMethodCmd
        The ValidatePaymentMethodCmd task command checks whether the payment method to be added comply with the Buy Online Pick In Store rules.
      - UpdateSpendingLimitCmd
        The UpdateSpendingLimitCmd task command checks account, spending limit and purchase order number, and updates some items if needed.
      - RaiseOrderSubmitEventCmd
        The RaiseOrderSubmitEventCmd task command raises an event for order submit or process payment authorization complete.
      - TransferOrderCmd
        The TransferOrderCmd task command confirms successful transfer of an order to an external system.
      - OrderMessagingCmd
        The OrderMessagingCmd task command generates an outbound order create message.
      - CheckOrderAcceptanceCmd
        Checks that an Order can be accepted for processing.
      - ValidateOrderAddressCmd
        The ValidateOrderAddressCmd task command validates the shipping or billing address for the order or order items using given criteria.
      - CheckPaymentTCsCmd
        The CheckPaymentTCsCmd task command checks account, spending limit and purchase order number.
      - SetOrderOrganizationCmd
        The SetOrderOrganizationCmd task command sets the organization information of an order when called by other order commands.
      - ResolveOrderItemPriceCmd
        The ResolveOrderItemPriceCmd task command resolves the price for a group of order items from one order.
      - CalculateOrderCmd
        The CalculateOrderCmd task command handles free gifts and implements the core logic of calculation.
    - Orders URLs
      The following URLS are related to orders:
    - 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.
    - 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.
  - Scheduler URLs
    The server subsystem consists of functions that are associated with URLs that are run by the scheduler.
  - WebSphere Commerce Search URLs
    The starter stores consist of pages that are associated with URLs that are run by WebSphere Commerce Search. You can use the following URLs to invoke various WebSphere Commerce search tasks.
- Ant targets
  A WebSphere Commerce instance can be created from the command line. The command-line utility uses Apache Ant to create the objects required. The targets are divided into several high-level groups that correspond to the environment that is to be configured.
- Glossary

CalculateOrderCmd task command

The CalculateOrderCmd task command handles free gifts and implements the core logic of calculation.

Task command

com.ibm.commerce.order.commands.CalculateOrderCmd

Implementation class

com.ibm.commerce.order.commands.CalculateOrderCmdImpl

Commands called

DoInventoryActionCmd

OrderItemUpdateCmd

OrderItemAddCmd

OrderItemDeleteCmd

Possible callers

OrderCalculateCmdImpl

PrepareOrderCmdImpl

OrderProcessingHelper

Behavior

If doFreeGift is true:

If the PromotionsEngine component is enabled and freegift is to be refreshed:

Call the PromotionEngine to obtain a list of CatalogEntries to add to the Order

For each CatalogEntry to be added to the Order, if ATP is disabled and there is insufficient inventory:

Remove that CatalogEntry from the list
Add the CatalogEntry identifier to the outOfInventoryCatalogEntryId list

For each order item to be added or updated, compare it with the free gift list obtained by PromotionEngine:
- If the CatentryId is the same but Quantity is different:
  - Add it to the updating list
- If the CatentryId is not found within an existing CatalogEntry:
  - Add it to the adding list
- If the free gifts which are cached before are not contained in the new returned list:
  - Add it to the deleting list

Remove free gifts listed in the deleting list

Update the quantities of free gifts listed in the updating list

Add the new free gifts listed in the adding list

Calculate the product total of the order

Initialize the specified CalculationUsages that are enabled

Apply the specified CalculationUsages that are enabled

Update the SubOrders for the Order unless that feature is disabled

Summarize the specified CalculationUsages that are enabled