ReturnItemDelete URL

This URL deletes an order item from a return merchandise authorization (RMA).

URL structure

http:// host_name/path/
The fully qualified name of your HCL Commerce Server and the configuration path.

osrtnitdl.gif (4895 bytes)

Parameter values

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.
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
The logon ID of the user on whose behalf the command will be run; only a person with a security role of Customer Service Representative can specify this parameter. The user is identified by an internal user ID, as found in the USERS table.
RMAItemId
Required: The RMAItem identifier to be deleted.
outRMAName
The name to use for the name-value pair which will be passed to the redirected URL. This parameter is useful for chaining commands. If this parameter is not specified then "RMAId" is used.
URL
Required: The URL to be called when the command completes successfully.

Example

The following example deletes RMA item 25 and 26 from an RMA and then displays the RMA


http://myhostname/webapp/wcs/stores/servlet/
ReturnItemDelete?&RMAId=25&RMAItemID=26&URL=ReturnDisplay&storeId=1

Behavior

  • Each RMA item deleted can be from a different existing RMA.
  • If this command is being run with a value specified for either the forUser or the forUserId parameter, then the RMA must be in status "EDT", "APP", or "PND" otherwise the status of the RMA must be "PRC".
  • If no part of the item has been received and if the item has not been credited yet then the RMA item and its components are deleted. The status of each RMA is set to "EDT", if either the forUser or the forUserId parameter is specified, or "PRC" otherwise.
  • On successful completion, set up to redirect to the specified URL.
  • Call the task command ExtendReturnItemDeleteCmd.

Exception condition

Command execution fails for the following conditions:

  • If the RMA is not in the correct status, the command generates an ECApplicationException with message _ERR_RMA_IN_INVALID_STATE_FOR_COMMAND
  • If the RMA item has already been at least partially received or credited, the command generates an ECApplicationException with message _ERR_CANNOT_DELETE_RETURN_ITEM