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.
Returns and refunds
The following URLs are related to Returns and refunds.
ReturnCancel
This URL cancels a return merchandise authorization (RMA).

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:
    - 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.
      - ReturnCancel
        This URL cancels a return merchandise authorization (RMA).
      - ReturnCreate
        This URL creates an empty return merchandise authorization (RMA) container.
      - ReturnDisplay
        This URL displays the contents of the specified return merchandise authorization (RMA).
      - ReturnItemAdd
        This URL adds products to a return merchandise authorization (RMA).
      - ReturnItemDelete
        This URL deletes an order item from a return merchandise authorization (RMA).
      - ReturnItemUpdate
        This URL updates information about a returned item and can be called for multiple return merchandise authorization (RMA) items.
      - ReturnListDisplay
        This URL lists all return merchandise authorizations (RMAs) for a customer.
      - ReturnPrepare
        This URL prepares a return merchandise authorization (RMA).
      - ReturnProcess
        This URL determines the approval status of a return merchandise authorization (RMA).
      - ReturnCreditAndCloseScan command
        Refunds for a return merchandise authorization (RMA).
    - 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

ReturnCancel URL

This URL cancels a return merchandise authorization (RMA).

This URL does not remove the RMA from the database. To remove canceled RMAs, use the Database Cleanup utility.

URL structure

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

Parameter values

forUser: The logon ID of the user on whose behalf the command will be run; only a person with a security role of Customer Service Representative 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: Required: The store reference number.
RMAId: Required: The identifier of the RMA to cancel.
URL: Required: The URL to be called when the command completes successfully.

Example

The following example cancels the RMA whose reference number is 1 and displays the shopping cart.


    http://myhostname/webapp/wcs/stores/servlet/
    ReturnCancel?&RMAId=1&URL=ReturnDisplay&storeId=1

Behavior

Checks that the returned items have not already been received or credited to the customer. If this check fails then an exception is raised.
Cancels the specified RMA by setting the status of the RMA to 'CAN'.
On successful completion, set up to redirect to the specified URL.
Call the task command ExtendReturnCancelCmd.

Exception condition

If the returned items of the RMA have already been received or credited, then no processing occurs and the command execution fails with an ECApplicationException with message _ERR_CANNOT_CANCEL_RETURN.
If the RMA does not have a status of 'PRC', 'EDT', 'PND', 'APP', then an ECApplicationException is generated with message _ERR_RMA_IN_INVALID_STATE_FOR_COMMAND