Class ReturnExchangeManager

Inheritance
System.Object
ReturnExchangeManager
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: Mediachase.Commerce.Orders.Managers
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
Syntax
public static class ReturnExchangeManager

Fields

ReturnFormCompleteWorkflowName

Declaration
public const string ReturnFormCompleteWorkflowName = "ReturnFormCompleteWorkflow"
Field Value
Type Description
System.String

ReturnFormRecalculateWorkflowName

Declaration
public const string ReturnFormRecalculateWorkflowName = "ReturnFormRecalculateWorkflow"
Field Value
Type Description
System.String

Methods

AddNewReturnFormToPurchaseOrder(PurchaseOrder)

Adds the new return form to purchase order.

Declaration
public static OrderForm AddNewReturnFormToPurchaseOrder(PurchaseOrder purchaseOrder)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.

Returns
Type Description
OrderForm

AddNewReturnLineItemToReturnForm(OrderForm, LineItem, Decimal, String)

Adds the new return line item to return form.

Declaration
public static LineItem AddNewReturnLineItemToReturnForm(OrderForm returnForm, LineItem origLineItem, decimal returnQuantity, string returnReason)
Parameters
Type Name Description
OrderForm returnForm

The return form.

LineItem origLineItem

The orig line item.

System.Decimal returnQuantity

The return quantity.

System.String returnReason

The return reason.

Returns
Type Description
LineItem

AddNewShipmentToReturnForm(OrderForm, Shipment)

Adds the new shipment to return form.

Declaration
public static Shipment AddNewShipmentToReturnForm(OrderForm returnForm, Shipment orginalShipment)
Parameters
Type Name Description
OrderForm returnForm

The return form.

Shipment orginalShipment

The orginal shipment.

Returns
Type Description
Shipment

AddNewShipmetToReturnForm(OrderForm, Shipment)

Declaration
[Obsolete("This method is no longer used, use AddNewShipmentToReturnForm instead. This property will be removed in version 10.")]
public static Shipment AddNewShipmetToReturnForm(OrderForm returnForm, Shipment orginalShipment)
Parameters
Type Name Description
OrderForm returnForm
Shipment orginalShipment
Returns
Type Description
Shipment

CreateExchangeOrderForReturnForm(OrderForm, Shipment)

Creates the exchange order for return form.

Declaration
public static PurchaseOrder CreateExchangeOrderForReturnForm(OrderForm returnForm, Shipment shipment)
Parameters
Type Name Description
OrderForm returnForm

The return form.

Shipment shipment

The shipment.

Returns
Type Description
PurchaseOrder

ExecuteReturnFormWorkflow(String, OrderForm)

Declaration
public static void ExecuteReturnFormWorkflow(string workflowName, OrderForm returnForm)
Parameters
Type Name Description
System.String workflowName
OrderForm returnForm

GetAvailableForReturnLineItems(Shipment)

Gets the available for return line items.

Declaration
public static IEnumerable<LineItem> GetAvailableForReturnLineItems(Shipment shipment)
Parameters
Type Name Description
Shipment shipment

The shipment.

Returns
Type Description
System.Collections.Generic.IEnumerable<LineItem>

GetAvailableForReturnQuantity(Shipment, Int32)

Gets the available for return line item quantity.

Declaration
public static decimal GetAvailableForReturnQuantity(Shipment shipment, int lineItemId)
Parameters
Type Name Description
Shipment shipment

The shipment.

System.Int32 lineItemId

The line item.

Returns
Type Description
System.Decimal

GetExchangeOrderForReturnForm(OrderForm)

Gets the exchange order for return form.

Declaration
public static PurchaseOrder GetExchangeOrderForReturnForm(OrderForm returnForm)
Parameters
Type Name Description
OrderForm returnForm

The return form.

Returns
Type Description
PurchaseOrder

GetOrigLineItemForReturnItem(LineItem)

Declaration
public static LineItem GetOrigLineItemForReturnItem(LineItem returnLineItem)
Parameters
Type Name Description
LineItem returnLineItem
Returns
Type Description
LineItem

GetReturnFormById(PurchaseOrder, Int32)

Gets the return form by id.

Declaration
public static OrderForm GetReturnFormById(PurchaseOrder purchaseOrder, int returnId)
Parameters
Type Name Description
PurchaseOrder purchaseOrder

The purchase order.

System.Int32 returnId

The return id.

Returns
Type Description
OrderForm

GetReturnFormOriginalShipment(OrderForm)

Gets the return form original shipment.

Declaration
public static Shipment GetReturnFormOriginalShipment(OrderForm returnForm)
Parameters
Type Name Description
OrderForm returnForm

The return form.

Returns
Type Description
Shipment

RecalculateReturnOrderForm(OrderForm)

Declaration
public static void RecalculateReturnOrderForm(OrderForm returnFrom)
Parameters
Type Name Description
OrderForm returnFrom