Skip to content

Returns lifecycle


RMA request (return) is modeled as RmaReturn entity in VCF data model.В RmaReturn isВ integral part of an Order. RmaReturn may be created for an Order of state Completed.В A returnВ life cycle is divided into separate distinct states (enumeration):

publicВ enumВ RmaRequestStatus
  CompleteВ =В 1,
  CanceledВ =В 2,
  AwaitingStockReturnВ =В 4,
  AwaitingCompletionВ =В 8

RmaReturn isВ alwaysВ in one ofВ enumeration'sВ RmaRequestStatusВ states.В If exact enumeration mach wouldn't be found then it's considered to be in a state ofВ AwaitingStockReturn.В State changing is controlled byВ StateMachineBase implementation (RmaRequestStateMachineImplВ class). This actuallyВ implements theВ state diagram depicted below and controls state transitions.

Create return

Return is created as a part of an order. It's initial state can beВ AwaitingStockReturn orВ AwaitingCompletion. Return amount is calculated in external workflow, which isВ accessibleВ trough service.

public Order CreateRmaReturn(Order order)
  CurrentOrder = order;
  var rmaRequest = CreateEntity<RmaRequest>();

  // fill the RmaRequest properties, add/remove returning items using AddReturnItem / RemoveReturnItem respectively

  // setting correct status is essential
  if (rmaRequest.IsPhysicalReturnRequired)
    rmaRequest.Status = RmaRequestStatus.AwaitingStockReturn.ToString();
    rmaRequest.Status = RmaRequestStatus.AwaitingCompletion.ToString();

public void AddReturnItem(LineItem lineItem, decimal returnQuantity, string returnReason)
  var returnItem = RmaReturnItems.FirstOrDefault(x => x.RmaLineItems[0].LineItemId == lineItem.LineItemId && x.ReturnReason == returnReason);

  if (returnItem == null)
    var rmaLineItem = CreateEntity<RmaLineItem>();
    rmaLineItem.LineItemId = lineItem.LineItemId;
    rmaLineItem.LineItem = lineItem;

    returnItem = CreateEntity<RmaReturnItem>();
    returnItem.ItemState = RmaLineItemState.AwaitingReturn.ToString();
    returnItem.ReturnReason = returnReason;


  returnItem.RmaLineItems[0].ReturnQuantity += returnQuantity;
  lineItem.Quantity -= returnQuantity;

  if (lineItem.Quantity == 0)


public void RemoveReturnItem(RmaReturnItem returnItem, decimal returnQuantity)
  returnItem.RmaLineItems[0].ReturnQuantity -= returnQuantity;
  if (returnItem.RmaLineItems[0].ReturnQuantity <= 0)

  var availableLineItem = AvailableForReturnLineItems.FirstOrDefault(x => x.LineItemId == returnItem.RmaLineItems[0].LineItemId);
  if (availableLineItem == null)
    availableLineItem = _deletedLineItemList.FirstOrDefault(x => x.LineItemId == returnItem.RmaLineItems[0].LineItemId);
    // undelete

  availableLineItem.Quantity += returnQuantity;

// Recalculates current Return's amounts: fees, subtotals, totals, etc.
private void Recalculate()
  var orderService = ServiceLocator.Current.GetInstance<IOrderService>();
  var result = orderService.ExecuteWorkflow(RecalculateWorkflowName, CurrentOrder);
  CurrentOrder = result.OrderGroup;

Transition toВ AwaitingCompletion state

State transitionВ AwaitingStockReturn --> AwaitingCompletionВ is initiated upon RmaReturnВ RmaLineItems quantity change:

private void RecalculateRmaRequestStatuses()
  //if all lineItems physically returned to stock need change status 
  //to AwaitingCompletion
  var retVal = InnerItem.RmaReturnItems.All(x0 => x0.RmaLineItems.All(x => x.ReturnQuantity == x.Quantity));
  InnerItem.Status = retVal ? RmaRequestStatus.AwaitingCompletion.ToString() : RmaRequestStatus.AwaitingStockReturn.ToString();

whereВ InnerItem is instance of RmaReturn.


RMA request can gain status of Complete when there exists a state transition toВ RmaRequestStatus.Complete. Steps to complete:

  1. IfВ RmaReturn.ReturnTotal > 0, then "Create Refund" process with ReturnTotal amountВ should be initialized.В 
  2. If previous step completed successfully, then set the status:В RmaReturn.Status =В В RmaRequestStatus.Complete.ToString();

Last update: June 18, 2020