OrderUnlock command

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

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

Exception conditions

None.