Try our conversational search powered by Generative AI!

AI OnAI Off

Class DefaultReturnOrderService

NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version.

Handles operations on IReturnOrderForm such as complete, cancel a return or acknowledge receipt items of a return.

Inheritance
System.Object
DefaultReturnOrderService
Implements
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Commerce.Order
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2
Syntax
public class DefaultReturnOrderService : IReturnOrderService

Constructors

DefaultReturnOrderService(IOrderRepository, IOrderGroupCalculator, IReturnOrderFormCalculator, IInventoryProcessor, IPurchaseOrderFactory, IReturnOrderNumberGenerator, IPromotionEngine, IMarketService)

Initializes a new instance of the DefaultReturnOrderService class.

Declaration
public DefaultReturnOrderService(IOrderRepository orderRepository, IOrderGroupCalculator orderGroupCalculator, IReturnOrderFormCalculator returnOrderFormCalculator, IInventoryProcessor inventoryProcessor, IPurchaseOrderFactory purchaseOrderFactory, IReturnOrderNumberGenerator returnOrderNumberGenerator, IPromotionEngine promotionEngine, IMarketService marketService)
Parameters
Type Name Description
IOrderRepository orderRepository

The order repository.
IOrderGroupCalculator orderGroupCalculator

The order group calculator.
IReturnOrderFormCalculator returnOrderFormCalculator

The return order form calculator.
IInventoryProcessor inventoryProcessor

The inventory processor.
IPurchaseOrderFactory purchaseOrderFactory

The purchase order factory.
IReturnOrderNumberGenerator returnOrderNumberGenerator

The return order number generator.
IPromotionEngine promotionEngine

The promotion engine.
IMarketService marketService

The market service.

Methods

AcknowledgeReceiptOfItems(IReturnOrderForm)

Acknowledges receipt of items of an IReturnOrderForm.

Declaration
public virtual void AcknowledgeReceiptOfItems(IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.

CalculateExchangePaymentTotal(IPurchaseOrder, IPurchaseOrder, IReturnOrderForm)

Calculates the exchange payment total.

Declaration
protected virtual decimal CalculateExchangePaymentTotal(IPurchaseOrder purchaseOrder, IPurchaseOrder exchangeOrder, IReturnOrderForm returnForm)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The origin purchase order.
IPurchaseOrder exchangeOrder

The exchange order.
IReturnOrderForm returnForm

The return order form.
Returns
Type Description
System.Decimal

The exchange payment total.

CancelReturn(IReturnOrderForm)

Cancels a IReturnOrderForm.

Declaration
public virtual void CancelReturn(IReturnOrderForm returnForm)
Parameters
Type Name Description
IReturnOrderForm returnForm

The return order form.

CompleteReturn(IPurchaseOrder, IReturnOrderForm)

Completes an IReturnOrderForm.

Declaration
public virtual void CompleteReturn(IPurchaseOrder purchaseOrder, IReturnOrderForm returnForm)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The purchase order that the return form was created for.
IReturnOrderForm returnForm

The return order form.

CreateExchangeOrder(IPurchaseOrder, IShipment)

Creates an exchange order for an IShipment.

Declaration
public virtual IPurchaseOrder CreateExchangeOrder(IPurchaseOrder purchaseOrder, IShipment originalShipment)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The purchase order that the exchange order is created for.
IShipment originalShipment

The original shipment that contains items that need to be returned.
Returns
Type Description
IPurchaseOrder

The exchange order of type IPurchaseOrder.

InvalidatePromotions(IPurchaseOrder, IReturnOrderForm)

Invalidates promotions which are no longer applicable after returning items.

Declaration
public void InvalidatePromotions(IPurchaseOrder purchaseOrder, IReturnOrderForm returnOrderForm)
Parameters
Type Name Description
IPurchaseOrder purchaseOrder

The original IPurchaseOrder.
IReturnOrderForm returnOrderForm

The current IReturnOrderForm in the purchaseOrder.
Remarks

It will update the Promotions of the IReturnOrderForm Also it will update the discount amount of IReturnLineItems of the IReturnOrderForm.

Implements