Package com.broadleafcommerce.orderoperation.service

Interface ReturnOperationService

All Known Implementing Classes:
DefaultReturnOperationService
public interface ReturnOperationService
Responsible for managing operations on returns.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.broadleafcommerce.order.client.domain.ReturnAuthorization>
    cancelReturn(String orderId, CancelReturnRequest cancelReturnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Cancel a ReturnAuthorization for the Order with the given orderId.
    com.broadleafcommerce.order.client.domain.ReturnAuthorization
    confirmReturn(String orderId, ConfirmReturnRequest confirmReturnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Create ReturnConfirmations for ReturnAuthorizationItems within the Order with the given orderId.
    com.broadleafcommerce.order.client.domain.ReturnAuthorization
    createReturn(String orderId, ReturnRequest returnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Create a ReturnAuthorization for the Order with the given orderId containing the items requested by returnRequest.
    com.broadleafcommerce.order.client.domain.ReturnAuthorization
    estimateReturn(String orderId, ReturnRequest returnRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Estimate a ReturnAuthorization for the Order with the given orderId containing the items requested by returnRequest.

  • Method Details

    • createReturn

      com.broadleafcommerce.order.client.domain.ReturnAuthorization createReturn(String orderId, ReturnRequest returnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Create a ReturnAuthorization for the Order with the given orderId containing the items requested by returnRequest.
      Parameters:
      orderId - the ID of the order with the items to return
      returnRequest - the request containing items to return
      contextInfo - context information around sandbox and multitenant state
      Returns:
      the created ReturnAuthorization

    • confirmReturn

      com.broadleafcommerce.order.client.domain.ReturnAuthorization confirmReturn(String orderId, ConfirmReturnRequest confirmReturnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Create ReturnConfirmations for ReturnAuthorizationItems within the Order with the given orderId.
      Parameters:
      orderId - the ID of the order with the return having items confirmed
      confirmReturnRequest - the request containing items to confirm as returned
      contextInfo - context information around sandbox and multitenant state
      Returns:
      the ReturnAuthorization updated with the new ReturnConfirmations

    • cancelReturn

      List<com.broadleafcommerce.order.client.domain.ReturnAuthorization> cancelReturn(String orderId, CancelReturnRequest cancelReturnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Cancel a ReturnAuthorization for the Order with the given orderId. Any already confirmed ReturnAuthorizationItems are extracted into a new separate confirmed ReturnAuthorization, since they cannot be cancelled.
      Parameters:
      orderId - the ID of the order with the return to cancel
      cancelReturnRequest - the request indicating which return to cancel
      contextInfo - context information around sandbox and multitenant state
      Returns:
      the cancelled ReturnAuthorization and possibly a newly separated confirmed ReturnAuthorization, if there were any confirmations

    • estimateReturn

      com.broadleafcommerce.order.client.domain.ReturnAuthorization estimateReturn(String orderId, ReturnRequest returnRequest, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Estimate a ReturnAuthorization for the Order with the given orderId containing the items requested by returnRequest.
      Parameters:
      orderId - the ID of the order with the items to return
      returnRequest - the request containing items to return
      contextInfo - context information around sandbox and multitenant state
      Returns:
      the created ReturnAuthorization