Interface IReturnOrderService
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.
Namespace: EPiServer.Commerce.Order
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2Syntax
public interface IReturnOrderServiceMethods
AcknowledgeReceiptOfItems(IReturnOrderForm)
Acknowledges receipt of items of a IReturnOrderForm.
Declaration
void AcknowledgeReceiptOfItems(IReturnOrderForm returnForm)Parameters
| Type | Name | Description |
|---|---|---|
| IReturnOrderForm | returnForm | The return order form. |
CancelReturn(IReturnOrderForm)
Cancels a IReturnOrderForm.
Declaration
void CancelReturn(IReturnOrderForm returnForm)Parameters
| Type | Name | Description |
|---|---|---|
| IReturnOrderForm | returnForm | The return order form. |
CompleteReturn(IPurchaseOrder, IReturnOrderForm)
Completes an IReturnOrderForm.
Declaration
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
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 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
void InvalidatePromotions(IPurchaseOrder purchaseOrder, IReturnOrderForm returnOrderForm)Parameters
| Type | Name | Description |
|---|---|---|
| IPurchaseOrder | purchaseOrder | The original IPurchaseOrder. |
| IReturnOrderForm | returnOrderForm | The current IReturnOrderForm in the |
Remarks
It will update the Promotions of the IReturnOrderForm Also it will update the discount amount of IReturnLineItems of the IReturnOrderForm.
