OrderItemDisplay command

This command lists all order items that are in pending status.

Command structure

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

Diagram of the command structure: the command starts with the fully qualified name of your WebSphere Commerce Server and the configuration path, followed by the command name, OrderItemDisplay  and the ? character. End the command with a list of parameters in the form of name value pairs. Separate each name value pair with the & character. For a detailed description of the parameters and their values, refer to the list entitled Parameter values.

Parameter values

forUser
The logon ID of another user on whose behalf the command will be run. Only a person with the authority to to perform the "becomeUser" action on this command can specify this parameter and run the OrderItemDisplay command on behalf of another user.
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 for the orders to list. If you omit this parameter, the session storeId is used. It is an error if you omit this parameter and there is no storeId in the session.
orderId
Specifies zero or more orders, using order reference numbers or one of the following special abbreviations: ".", "*", ".t", or "*t". See Order abbreviations for a description of these abbreviations. If this parameter is omitted, the default is "*". The specified orders must belong to the specified store. (Otherwise, the ResolveOrdersCmd task command will throw an ECApplicationException specifying the _ERR_INVALID_ORDER_REFNUM error message.) This parameter can be repeated.
outOrderName
Specifies the names of name-value pairs to be added to the response properties passed to the view command. The value of each added name-value pair is an array of the reference numbers of the specified orders. If this parameter is omitted, its value defaults to "orderId". This parameter can be repeated.
addressId
The reference number of the address for the items to display. If this parameter is omitted, all order items for the specified orders are displayed.
remerge
A list of the order items that should be merged with other order items in the same order and with the same correlationGroup attribute if possible. This parameter can be repeated.
merge
A list of order items that should be merged with other order items in the same order if possible, regardless of their correlationGroup attributes. This parameter can be repeated.
check
A list of order items that should be checked by the CheckInventoryAvailabilityCmd task command. This parameter can be repeated.
allocate
A list of order items that should be allocated from existing inventory. This parameter can be repeated.
backorder
A list of order items that should be allocated from expected inventory. This parameter can be repeated.
reverse
A list of order items whose allocations should be released (that is, de-allocated from existing or expected inventory as appropriate). This parameter can be repeated.

Note: The remerge, merge, check, allocate, backorder and reverse parameters are applicable only if ATP inventory is enabled. (See the ALLOCATIONGOODFOR column in the STORE table.) They represent lists of order items that will be passed to the AllocateInventoryCmd task command, which calls the CheckInventoryAvailabilityCmd, AllocateExistingInventoryCmd, AllocateExpectedInventoryCmd, DeallocateExistingInventoryCmd, and DeallocateExpectedInventoryCmd task commands as specified below. Also, these parameters accept OrderItem abbreviations, which are detailed in the help for Order Management subsystem commands.

The default ATP parameter values are as follows:

Example 1

The following example displays all the products and items that correspond to address reference number 2 and all the customer's pending orders. The reference numbers of these orders are passed to the OrderItemDisplay command using the orderId parameter.

     http://myhostname/webapp/wcs/stores/servlet/OrderItemDisplay?addressId=2

Example 2

The following example first creates a new order with a single item using the OrderItemAdd command then displays the shipping details for the items.

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

Behavior

Exception conditions