OrderItemDisplay URL


+

Search Tips   |   Advanced Search

 

Lists all order items that are in pending state.

 

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

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.

doPrice

Specifies whether the command should perform the price calculation subtasks. Set to either do the price tasks (Y), or not (N). Turning off these tasks might result in better performance, but customers might not get the most current price, or product entitlement, when changes occur.

doInventory

Specifies whether the command should perform the inventory calculation subtasks. Set to either do the price tasks (Y), or not (N). Turning off these tasks might result in better performance, but customers might not get the most current inventory level, when changes occur.

The remerge, merge, check, allocate, backorder and reverse parameters are applicable only if ATP inventory is enabled. (See the INVENTORYSYSTEM column in the STORE table.) They represent lists of order items that will be passed to the DoInventoryAction task command which calls AllocateInventoryCmd task command, which invokes 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 URLs.

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

 

Example 3

The following example shows how to use doPrice and doInventory parameters. In this example, order item prices are not refreshed if the item is not expired, and inventory actions are not performed. 

http://
myhostname/webapp/wcs/stores/servlet/OrderItemDisplay?orderId=1234

&storeId=10001&catalogId=10001&doPrice=N&doInventory=N

 

Behavior

If that task command throws an ECApplicationException exception with error message key _API_BAD_INV, indicating insufficient inventory for some order items, then the ResolveFulfillmentCenterCmd task command is called to re-assign fulfillment centers to the order items. If that task command throws an ECApplicationException exception with error message key _ERR_CANT_RESOLVE_FULFILLMENTCENTER, indicating that it is unable to assign fulfillment centers with sufficient inventory to certain order items, name-value pairs named "errorOrderItemId" whose values are the order item reference numbers of those order items are added to the response properties.

Exception conditions

Related concepts

Order Management subsystem

Related reference

Order Management subsystem URLs