Interface OmsReturnFacade

All Known Implementing Classes:
DefaultOmsReturnFacade

public interface OmsReturnFacade
API for return facade
  • Method Details

    • getReturns

      SearchPageData<ReturnRequestData> getReturns(PageableData pageableData)
      API to get all returns in the system
      Parameters:
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      Returns:
      SearchPageData that contains a list of returns
    • getPagedReturnRequestsByCurrentUser

      SearchPageData<ReturnRequestData> getPagedReturnRequestsByCurrentUser(PageableData pageableData, ReturnStatus... returnStatuses)
      Returns the paged ReturnRequestData for the current user.
      Parameters:
      pageableData - paging information
      returnStatuses - the list of ReturnStatus. If null or empty, all statuses are included.
      Returns:
      The ReturnRequestData for the current user.
    • getReturnsByStatuses

      SearchPageData<ReturnRequestData> getReturnsByStatuses(PageableData pageableData, Set<ReturnStatus> returnStatusSet)
      API to get all returns in the system that have certain status(s)
      Parameters:
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      returnStatusSet - set of return status(s) in which we want to get list of returns for.
      Returns:
      SearchPageData that contains a list of returns that complies with passed return status(es)
    • getReturnStatuses

      List<ReturnStatus> getReturnStatuses()
      API to get all return statuses
      Returns:
      a list of ReturnStatus
    • getReturnEntriesForReturnCode

      SearchPageData<ReturnEntryData> getReturnEntriesForReturnCode(String code, PageableData pageableData)
      API to get returnEntries for the given ReturnRequestModel.CODE
      Parameters:
      code - the return's code
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      Returns:
      SearchPageData that contains a list of the returnEntries for the given order
    • createReturnRequest

      ReturnRequestData createReturnRequest(ReturnRequestData returnRequestData)
      API to create a ReturnRequestModel
      Parameters:
      returnRequestData - the ReturnRequestData to create ReturnRequestModel
      Returns:
      the ReturnRequestData converted from the newly created ReturnRequestModel
    • getReturnForReturnCode

      ReturnRequestData getReturnForReturnCode(String code)
      API to get a ReturnRequestData by its code
      Parameters:
      code - the returnRequest's code
      Returns:
      the returnRequest
    • getCancelReasons

      List<CancelReason> getCancelReasons()
      API to get all return cancel reasons
      Returns:
      a list of CancelReason
    • getRefundReasons

      List<RefundReason> getRefundReasons()
      API to get all return refund reasons
      Returns:
      a list of RefundReason
    • getReturnActions

      List<ReturnAction> getReturnActions()
      API to get all return actions
      Returns:
      a list of ReturnAction
    • isCompleteReturn

      Boolean isCompleteReturn(OrderModel orderModel, ReturnRequestData returnRequestData)
      API to check if the ReturnRequestData contains a complete order return.
      Parameters:
      orderModel - the OrderModel related to the return request
      returnRequestData - the return form result ReturnRequestData
      Returns:
      true if it's a complete return.
    • approveReturnRequest

      void approveReturnRequest(String code)
      API to approve the ReturnRequestModel by its code
      Parameters:
      code - the code for the ReturnRequestModel to be approved
    • updateReturnRequest

      ReturnRequestData updateReturnRequest(String code, ReturnRequestModificationData returnRequestModificationData)
      API to update the ReturnRequestModel
      Parameters:
      code - the return request's code
      returnRequestModificationData - ReturnRequestModificationData
      Returns:
      ReturnRequestData
    • cancelReturnRequest

      void cancelReturnRequest(CancelReturnRequestData cancelReturnRequestData)
      API to cancel a ReturnRequestModel
      Parameters:
      cancelReturnRequestData - contains information about the cancellation of the return request.
    • requestManualPaymentReversalForReturnRequest

      void requestManualPaymentReversalForReturnRequest(String code)
      API to reverse payment manually for the returnRequest by its code
      Parameters:
      code - the code for the returnRequest
    • requestManualTaxReversalForReturnRequest

      void requestManualTaxReversalForReturnRequest(String code)
      API to reverse tax manually for the returnRequest by its code
      Parameters:
      code - the code for the returnRequest
    • isDeliveryCostRefundable

      boolean isDeliveryCostRefundable(String orderCode, String returnRequestRMA)
      Verifies if the delivery cost is refundable for the given order and return request.
      Parameters:
      orderCode - order code
      returnRequestRMA - the return request RMA
      Returns:
      true if the delivery cost can be refunded