OrderSchedule command

This command submits a recurring order, which will be processed by the scheduler.  

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, OrderSchedule  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 which needs to be processed as a recurring order.
pay_payment_name
The payment_name is the name of the payment parameter used by DoPaymentCmd task command to process payment information. Note that the payment_name must be prefixed with the 'pay_' prefix.  The value for pay_payment_name is the value of the payment parameter to be used by DoPaymentCmd task command to process payment information for this customer. This parameter can be repeated.
start
(Required) The time at which the first execution of this order should occur in the format YYYY:MM:DD:hh:mm:ss. Only hh:mm:ss is mandatory.
host
Host name responsible for processing an order. This option is used when the scheduler is configured to run on multiple hosts and processing this order needs to be restricted to a particular host.
interval
The number of seconds between successive executions of this order. If omitted, this order will be processed only once.
attempts
The number of times the scheduler will retry processing this order should order processing failure occur
delay
The amount of time, in seconds before order processing is retried, in case of order processing failure. This parameter must be paired with the attempts parameter. If neither is specified, the failed order will not be recovered.

Example 1

The following example submits a pending order number 303 to the commerce scheduler. An instance of this order will be processed once per day at 5:25 PM, starting today.  If the order processing fails, the scheduler will retry once after 10 minutes.

     http://myhostname/webapp/wcs/stores/servlet/OrderSchedule?orderId=303
     &URL=OrderItemDisplay&start=17:25:00&interval=86400&attempts=1&delay=600

Example 2

The following example starts processing order number 123321 at one minute past midnight, passing in the payment parameters to the DoPaymentCmd task: cardNumber=2222222222, cardExpiryYear=2003, cardExpiryMonth=02, and cardBrand=ABC.

     http://myhostname/webapp/wcs/stores/servlet/OrderSchedule?URL=continue.html
     &orderId=123321&start=00:00:01&pay_cardNumber=2222222222
     &pay_cardExpiryYear=20013&pay_cardExpiryMonth=02&pay_cardBrand=ABC

Behavior

Exception conditions

None.