This command deletes an order item or product from a pending order.
Command 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 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 store reference number.
- URL
- (Required) The URL to be called when the command completes successfully.
- orderItemId
- (Required) The reference numbers of the items to be deleted from the orders. This parameter is required only if catEntryId is not specified. This parameter can be repeated.
- catEntryId
- The catalog entry ID of the item to be deleted from the order.
- orderId
- Specifies zero or more orders, using order reference numbers or one of the special abbreviations ".", "*", ".t", "*t". See the Order abbreviations for a description of these abbreviations. If this parameter is omitted, it defaults to ".".
- outOrderName
- Specifies the names of name-value pairs to add to the redirection URL. The values of the added name-value pairs are the reference numbers of the input orders.
Example 1
The following example deletes the items that are associated with shipping address number 2 from the customer's order, and then calls the OrderItemDisplay command to re-display the items in the customer's order:
http://myhostname/webapp/wcs/stores/servlet/OrderItemDelete? orderItemId=2&URL=/webapp/wcs/stores/servlet/OrderItemDisplay
Example 2
The following example deletes the items with catalog entry ID of 2 from the customer's current pending orders. The reference numbers of the current pending orders are passed to the OrderItemDisplay command using the orderId parameter.
http://myhostname/webapp/wcs/stores/servlet/OrderItemDelete? &catEntryId=2&orderId=.&outOrderName=orderId&URL=/webapp/wcs/stores/servlet/OrderItemList
Behavior
- De-allocates existing and expected inventory from deleted or canceled OrderItems by calling the AllocateInventory command and specifying that all the OrderItems in the order in the reverseOrderItems parameter.
- For each of the order items to be deleted, the command does the following
if orderItemId is specified:
- Obtains the order that the order item is associated with.
- If the order is in either pending or editing state, unlocks it and updates the timestamp.
- Deletes the order items.
- The command does the following if catEntryId is specified:
- Compiles the list of orders for processing.
The ResolveOrdersCmd task command is invoked to obtain the current pending orders, if needed.- Does the following for each order in the list:
- If the order is in pending state and the order items for the order contain the specified product, unlocks the order and updates the timestamp.
- Deletes all the order items that contain the specified product.
- Does the following for each order in the list:
- Compiles the list of orders for processing.
- On successful completion, call the specified URL.
Exception conditions
If there are no products or orders match the specified parameters, the command execution fails.