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.
Orders URLs
The following URLS are related to orders:
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.

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.
    - 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.
    - 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

OrderUnlock URL

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.

URL structure

http:// host_name/ path/: The fully qualified name of your WebSphere Commerce Server and the configuration path.

This diagram displays the structure for the OrderUnlock URL.

Parameter values

forUser: The logon ID of the user on whose behalf the command will be run; only a person with the authority to process orders can specify this parameter.
forUserId: Same as forUser, but identifying the user by the internal user ID, as found in the USERS table.
langId: Sets or resets the preferred language for the duration of the session; the supported languages for a store are found in the STORELANG table.
storeId: The reference number of the store associated with this command.
URL: Required: The URL to be called when the command completes successfully.
orderId: Required: The reference number of the order to be unlocked.

Example 1

The following example unlocks the order whose reference number is 2 and displays the contents of the order:


   
http://myhostname/webapp/wcs/stores/servlet/OrderUnlock?orderId=2
    &URL=/webapp/commerce/OrderDisplay?status=P&orderId=2

Example 2

The following example first adds an order, using OrderItemAdd. The orderId is obtained (assume it is 112) from the ORDERS table. It then prepares the order, during which time the order is locked. Finally, the order is unlocked.


http://myhostname/webapp/wcs/stores/servlet/OrderItemAdd?catEntryId=322200305&quantity=1
    &URL=OrderItemDisplay&orderId=**
http://myhostname/webapp/wcs/stores/servlet/OrderPrepare?orderId=112&URL=OrderDisplay
http://myhostname/webapp/wcs/stores/servlet/OrderUnlock?orderId=112&URL=OrderItemDisplay

Behavior

Unlocks an order that was previously locked by the OrderPrepare command.
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.

Exception conditions

None.