Interface OmsReturnFacade
- All Known Implementing Classes:
DefaultOmsReturnFacade
public interface OmsReturnFacade
API for return facade
-
Method Summary
Modifier and TypeMethodDescriptionvoidapproveReturnRequest(String code) API to approve theReturnRequestModelby its codevoidcancelReturnRequest(CancelReturnRequestData cancelReturnRequestData) API to cancel aReturnRequestModelcreateReturnRequest(ReturnRequestData returnRequestData) API to create aReturnRequestModelAPI to get all return cancel reasonsgetPagedReturnRequestsByCurrentUser(PageableData pageableData, ReturnStatus... returnStatuses) Returns the pagedReturnRequestDatafor the current user.API to get all return refund reasonsAPI to get all return actionsgetReturnEntriesForReturnCode(String code, PageableData pageableData) API to get returnEntries for the givenReturnRequestModel.CODEgetReturnForReturnCode(String code) API to get aReturnRequestDataby its codegetReturns(PageableData pageableData) API to get all returns in the systemgetReturnsByStatuses(PageableData pageableData, Set<ReturnStatus> returnStatusSet) API to get all returns in the system that have certain status(s)API to get all return statusesisCompleteReturn(OrderModel orderModel, ReturnRequestData returnRequestData) API to check if theReturnRequestDatacontains a complete order return.booleanisDeliveryCostRefundable(String orderCode, String returnRequestRMA) Verifies if the delivery cost is refundable for the given order and return request.voidAPI to reverse payment manually for the returnRequest by its codevoidAPI to reverse tax manually for the returnRequest by its codeupdateReturnRequest(String code, ReturnRequestModificationData returnRequestModificationData) API to update theReturnRequestModel
-
Method Details
-
getReturns
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 pagedReturnRequestDatafor the current user.- Parameters:
pageableData- paging informationreturnStatuses- the list ofReturnStatus. If null or empty, all statuses are included.- Returns:
- The
ReturnRequestDatafor 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 inforeturnStatusSet- 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 givenReturnRequestModel.CODE- Parameters:
code- the return's codepageableData- 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
API to create aReturnRequestModel- Parameters:
returnRequestData- theReturnRequestDatato createReturnRequestModel- Returns:
- the
ReturnRequestDataconverted from the newly createdReturnRequestModel
-
getReturnForReturnCode
API to get aReturnRequestDataby 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
API to check if theReturnRequestDatacontains a complete order return.- Parameters:
orderModel- theOrderModelrelated to the return requestreturnRequestData- the return form resultReturnRequestData- Returns:
- true if it's a complete return.
-
approveReturnRequest
API to approve theReturnRequestModelby its code- Parameters:
code- the code for theReturnRequestModelto be approved
-
updateReturnRequest
ReturnRequestData updateReturnRequest(String code, ReturnRequestModificationData returnRequestModificationData) API to update theReturnRequestModel- Parameters:
code- the return request's codereturnRequestModificationData-ReturnRequestModificationData- Returns:
ReturnRequestData
-
cancelReturnRequest
API to cancel aReturnRequestModel- Parameters:
cancelReturnRequestData- contains information about the cancellation of the return request.
-
requestManualPaymentReversalForReturnRequest
API to reverse payment manually for the returnRequest by its code- Parameters:
code- the code for the returnRequest
-
requestManualTaxReversalForReturnRequest
API to reverse tax manually for the returnRequest by its code- Parameters:
code- the code for the returnRequest
-
isDeliveryCostRefundable
Verifies if the delivery cost is refundable for the given order and return request.- Parameters:
orderCode- order codereturnRequestRMA- the return request RMA- Returns:
- true if the delivery cost can be refunded
-