Documentation Home

OMS Returns

Domain Overview

The Returns/RMA process can be broken down into the following domain:

  • com.broadleafcommerce.oms.returns.domain.ReturnAuthorization
  • com.broadleafcommerce.oms.returns.domain.ReturnAuthorizationGroup
  • com.broadleafcommerce.oms.returns.domain.ReturnAuthorizationItem
  • com.broadleafcommerce.oms.returns.domain.ReturnAuthorizationNote
  • com.broadleafcommerce.oms.returns.domain.ReturnConfirmation

Return Authorization Group and Return Authorization

A ReturnAuthorization is an object that is used to initiate a return for a single order. The ReturnAuthorizationGroup defines a list of return ruthorizations across different orders and can contain a single packing slip/tracking number. In most cases you'll be dealing and constructing return groups that contain return authorizations and items within it.

Return Confirmations

A ReturnConfirmation is tied to a ReturnAuthorizationItem. The intent of this object is to track what items and quantites are actually returned for a given return authorization item.

Controller and Services Overview

The following services are available for the return flow:

  • com.broadleafcommerce.oms.returns.service.ReturnAuthorizationGroupService
  • com.broadleafcommerce.oms.returns.service.ReturnAuthorizationItemService
  • com.broadleafcommerce.oms.returns.service.ReturnAuthorizationService
  • com.broadleafcommerce.oms.returns.service.ReturnConfirmationService
  • com.broadleafcommerce.oms.returns.service.ReturnsService

The ReturnsService is the main entry point for the returns flow and can be used to create and build a ReturnAuthorizationGroup, build an estimate for a ReturnAuthorizationGroup, confirm ReturnAuthorizationItem's and create estimates for item confirmations.