In most cases, you will want to develop rules concerning which orders or items can be returned. The following describes the API framework for defining and customizing those rules.
In addition to customized rules you may want to create, there are the following built-in rules available by default:
Order rules:
Orders must be in a fulfilled state. Returns cannot be performed on partially fulfilled orders. Fulfilled Order states are configured using the
/atg/commerce/custsvc/property. By default, the
returns/ReturnTools fulfilledOrderStatesfulfilledOrderStatesproperty is set toNO_PENDING_ACTION, which is the Commerce state indicating that an order has been fulfilled:#states that indicate an order is fulfilled
fulfilledOrderStates=NO_PENDING_ACTIONBefore you can add additional states to the
fulfilledOrderStatesproperty, ensure that the state has been configured for orders. Once the state is part of theOrderStateclass, add the state to thefulfilledOrderStatesproperty.At least one item in the order must be returnable. This applies to cases where the order has been fulfilled, but the items are not returnable.
Item rules:
An item is not returnable if it has already been fully returned.
An item is not returnable if the SKU it references has been flagged as “not returnable” in the catalog.
ReturnTools provides the API for determining the returnable state of an order or an item:
public String getOrderReturnableState(RepositoryItem pOrderItem)
public String getItemReturnableState(RepositoryItem pOrderItem)
