ReturnProcess command

This command determines the approval status of a return merchandise authorization (RMA) by rolling up the status of the return items. If the RMA is approved, then the command redirects to the URL specified by the URL value. If the RMA is not approved, then the command redirects to the URL2 value. If the RMA has expired, and an expiry URL was specified, then the command redirects to the RMAExpiryURL value.

ReturnProcess is run by customers and by Customer Service Representatives (CSRs) for the store. It is the final step in creating or editing an RMA. The basic flow of a return is as follows:

  1. Run the ReturnItemAdd, ReturnItemUpdate and ReturnItemDelete commands, as applicable, to set up the RMA. 
  2. Run the ReturnPrepare command to calculate taxes and credits.
  3. Run the ReturnProcess command to finish the RMA. This command can be thought of as "finalizing" the RMA.

A customer can run any combination of adding, updating, and deleting, and then preparing an RMA, but can run the  ReturnProcess command only once. A CSR can edit an RMA even after the ReturnProcess command has been run. The ReturnProcess command determines whether or not an RMA was automatically approved. If not, a CSR can either edit the RMA until it is automatically approved, or if the CSR has the right level of authority, the CSR can use the ReturnApprove command to approve an RMA as-is.

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, ReturnProcess  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
(Required) The store reference number.
RMAId
(Required) The RMA identifier to be processed.
URL
(Required) The URL to redirect to if the RMA is approved.
URL2
The URL to redirect to if the RMA is not approved. If not specified, the value specified in the URL parameter will be used.
refundPolicyId
The ID of the policy to use for the refund payment method. This parameter is optional as long as there is only one refund payment policy in the contract; otherwise, a value must be specified the first time the command is called.
RMAExpiryURL
The URL to redirect to if the RMA has expired. If this URL is specified and RMGOODFOR is exceeded, then the ReturnPrepareCmd command is called and a redirection will occur to this URL. If this URL is not specified, then the ReturnProcessCmd command completes, even if the ReturnPrepareCmd is called because the RMGOODFOR time frame has expired for the RMA.

Example

The following command processes an order using two re-directional URLs.

http://myhostname/webapp/wcs/stores/servlet/
ReturnProcess?RMAId=1&storeId=1&URL=ReturnDisplay&URL2=ReturnListDisplay

Behavior

Exception conditions

The following conditions will cause command execution to fail: