Reference > Shop flow URLs > Order Management subsystem URLs > Scheduled orders URLs
ScheduledOrderCancel URL
Cancels execution of a recurring order submitted by the OrderSchedule URL.
URL structure
- http:// host/ path/
- The fully qualified name of the WebSphere Commerce Server and the configuration path.
name-value pair with the &
character. For a detailed description of the parameters and their values, see 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.
- URL
- Required: The URL to be called when the command completes successfully.
- orderId
- Required: The reference number of the scheduled order to be canceled.
Example
The following example stops instances of the recurring order number 1001 from processing. Order 1001 should be currently scheduled, that is, it must appear in the SCHORDERS table.
http://myhostname/webapp/wcs/stores/servlet/ScheduledOrderCancel?orderId=1001&URL=/
Behavior
- Cancels execution of a scheduled order by deactivating the scheduler job
that is responsible for processing this order.
- Removes an entry from the SCHORDERS table that associates the reference number of the scheduled order with the scheduler job reference number.
Exception conditions
None.
Related concepts
Related reference
Order Management subsystem URLs