Oracle Commerce Platform - Return Manager

Return Manager

ReturnManager is the main API for returns, and uses the following methods to manage each step in the return process:

ReturnManager creates the return, instantiating the ReturnRequest using the createReturnRequest method.
The applySelectedItems method selects the items to be returned and calculates the initial refund.
The optional applyRefundMethodAllocations method manually allocates the refund across the RefundMethod. An automatic allocation is performed when the RefundMethods are initially created.
The confirmRequest method validates and saves the return to the repository.
The settleReturnRequest method issues the refund credits and submits replacement orders to fulfillment.

ReturnManager uses pipelines to perform a number of the return tasks. All of the pipeline chain IDs are configurable in the ReturnManager. For detailed information on pipelines, refer to Appendix E: Pipeline Chains.

The following properties can be configured in the ReturnManager:

Property	Description
`pendingCustomerReturnOrderState`	This property sets the state used for exchange orders while waiting for return items to be received by the merchant. The default is configured to `PENDING_CUSTOMER_RETURN`.
`storeCreditType`	This property identifies the `PaymentGroupType` used to create store credits. The default is set to `storeCredit`.
`defaultReturnFee`	Sets the default return fee that is associated with a return. By default, the value is set to `0.0`.
`processImmediately`	Identifies if the returns process will credit and submit the replacement order immediately. By default, this property is set to `false`.
`doShippingRefunds`	Determines if the shipping refunds are calculated. When this property is set to `false`, suggested refund amounts will always be 0. By default, this property is set to `true`.
`initializeActualShippingRefund`	Determines if the actual shipping refunds are calculated from the suggested value. The default is set to `true`.
`createReturnAdjustedOrderPipeline`	The pipeline that creates the Return Adjusted Order.
`createReturnCalculationOrderPipeline`	The pipeline that creates the Return Calculation Order.
`createPromotionEvaluationOrderPipeline`	The pipeline that creates the Promotion Evaluation Order.
`createReturnRequestPipelineChainId`	The pipeline that creates the new return request.
`confirmReturnRequestPipelineChainId`	The pipeline that confirms a new return request.
`settleReturnRequestPipelineChainId`	The pipeline that settles a return request.
`receiveItemPipelineChainId`	The pipeline used to receive returned merchandise for a return request.
`applyRefundAllocationsPipelineChainId`	The pipeline used to allocate the refund of a return request.
`calculateRefundAmountsPipelineChainId`	The pipeline that calculates refund amounts.
`generateReplacementOrderPipelineChainId`	The pipeline that creates the replacement order for an exchange.
`submitReplacementOrderPipelineChainId`	The pipeline that submits the replacement order for an exchange.

For additional information on ReturnManager properties, refer to the ATG Platform API Reference.

Return Manager

Core Commerce Programming Guide