Package de.hybris.platform.ordermanagementfacades.returns

Interface OmsReturnFacade

  • All Known Implementing Classes:
    DefaultOmsReturnFacade
    public interface OmsReturnFacade
    API for return facade

    • Method Detail

      • 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

      • getReturnsByStatuses

        SearchPageData<ReturnRequestData> getReturnsByStatuses​(PageableData pageableData,
                                                       java.util.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

        java.util.List<ReturnStatus> getReturnStatuses()
        API to get all return statuses
        Returns:
        a list of ReturnStatus

      • getReturnEntriesForReturnCode

        SearchPageData<ReturnEntryData> getReturnEntriesForReturnCode​(java.lang.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

      • getReturnForReturnCode

        ReturnRequestData getReturnForReturnCode​(java.lang.String code)
        API to get a ReturnRequestData by its code
        Parameters:
        code - the returnRequest's code
        Returns:
        the returnRequest

      • getCancelReasons

        java.util.List<CancelReason> getCancelReasons()
        API to get all return cancel reasons
        Returns:
        a list of CancelReason

      • getRefundReasons

        java.util.List<RefundReason> getRefundReasons()
        API to get all return refund reasons
        Returns:
        a list of RefundReason

      • getReturnActions

        java.util.List<ReturnAction> getReturnActions()
        API to get all return actions
        Returns:
        a list of ReturnAction

      • isCompleteReturn

        java.lang.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​(java.lang.String code)
        API to approve the ReturnRequestModel by its code
        Parameters:
        code - the code for the ReturnRequestModel to be approved

      • cancelReturnRequest

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

      • requestManualPaymentReversalForReturnRequest

        void requestManualPaymentReversalForReturnRequest​(java.lang.String code)
        API to reverse payment manually for the returnRequest by its code
        Parameters:
        code - the code for the returnRequest

      • requestManualTaxReversalForReturnRequest

        void requestManualTaxReversalForReturnRequest​(java.lang.String code)
        API to reverse tax manually for the returnRequest by its code
        Parameters:
        code - the code for the returnRequest

      • isDeliveryCostRefundable

        boolean isDeliveryCostRefundable​(java.lang.String orderCode,
                                 java.lang.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