Interface OmsOrderFacade
- All Known Implementing Classes:
DefaultOmsB2bOrderFacade,DefaultOmsOrderFacade
public interface OmsOrderFacade
OrderManagement facade exposing operations on
OrderModel-
Method Summary
Modifier and TypeMethodDescriptionvoidapprovePotentiallyFraudulentOrder(String orderCode) API to approve a potentially fraudulent ordercreateRequestOrderCancel(OrderCancelRequestData orderCancelRequestData) API to request a order cancelOrderCancelRequestAPI to get all order cancel reasonsgetOrderEntriesForOrderCode(String orderCode, PageableData pageableData) API to get orderEntries for the givenAbstractOrderModel.CODEgetOrderEntryForOrderCodeAndEntryNumber(String orderCode, Integer entryNumber) API to get an orderEntry by it's entryNumber and its order's codegetOrderForCode(String orderCode) API to get an order by it's codegetOrderFraudReports(String orderCode) API to get an order's fraud reportsgetOrders(PageableData pageableData) API to get all orders in the systemgetOrdersByStatuses(PageableData pageableData, Set<OrderStatus> orderStatusSet) API to get all orders in the system that have certain status(es)API to get all order statusesvoidmanuallyReleaseDeliveryCostCommit(String orderCode) API to manually commit delivery cost taxes and releaseOrderModelfrom waiting step.voidmanuallyReleasePaymentReauth(String orderCode) API to manually reauth payment and releaseOrderModelfrom waiting step.voidmanuallyReleasePaymentVoid(String orderCode) API to manually release void payment in waiting step.voidmanuallyReleaseTaxCommit(String orderCode) API to manually commit tax and releaseOrderModelfrom waiting step.voidmanuallyReleaseTaxRequote(String orderCode) API to manually requote tax and releaseOrderModelfrom waiting step.voidmanuallyReleaseTaxVoid(String orderCode) API to manually release void tax in waiting step.voidrejectPotentiallyFraudulentOrder(String orderCode) API to reject a potentially fraudulent ordersubmitOrder(OrderRequestData orderRequestData) API to submit anOrderModelin the system
-
Method Details
-
getOrders
API to get all orders 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 orders
-
getOrderForCode
API to get an order by it's code- Parameters:
orderCode- the order's code- Returns:
- the order
-
getOrdersByStatuses
SearchPageData<OrderData> getOrdersByStatuses(PageableData pageableData, Set<OrderStatus> orderStatusSet) API to get all orders in the system that have certain status(es)- Parameters:
pageableData- pageable object that contains info on the number or pages and how many items in each page in addition the sorting infoorderStatusSet- set of order status(s) in which we want to get list of orders for- Returns:
- SearchPageData that contains a list of orders that complies with passed order status(es)
-
getOrderStatuses
List<OrderStatus> getOrderStatuses()API to get all order statuses- Returns:
- a list of
OrderStatus
-
getOrderEntriesForOrderCode
SearchPageData<OrderEntryData> getOrderEntriesForOrderCode(String orderCode, PageableData pageableData) API to get orderEntries for the givenAbstractOrderModel.CODE- Parameters:
orderCode- the order'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 orderEntries for the given order
-
getOrderEntryForOrderCodeAndEntryNumber
API to get an orderEntry by it's entryNumber and its order's code- Parameters:
orderCode- the order's codeentryNumber- the order entry's number- Returns:
- the order entry
-
getOrderFraudReports
API to get an order's fraud reports- Parameters:
orderCode- code of the order for which to get the fraud reports- Returns:
- a list of fraud reports
-
approvePotentiallyFraudulentOrder
API to approve a potentially fraudulent order- Parameters:
orderCode- code of the order for which to approve the fraud check
-
rejectPotentiallyFraudulentOrder
API to reject a potentially fraudulent order- Parameters:
orderCode- code of the order for which to reject the fraud check
-
getCancelReasons
List<CancelReason> getCancelReasons()API to get all order cancel reasons- Returns:
- a list of
CancelReason
-
submitOrder
API to submit anOrderModelin the system- Parameters:
orderRequestData- theOrderRequestDatato submit anOrderModel- Returns:
- the submitted
OrderData
-
createRequestOrderCancel
API to request a order cancelOrderCancelRequest- Parameters:
orderCancelRequestData- theOrderCancelRequestDatato createOrderCancelRequestData- Returns:
OrderCancelRecordEntryDatarepresenting the cancel request that was created
-
manuallyReleasePaymentVoid
API to manually release void payment in waiting step.- Parameters:
orderCode- theAbstractOrderModel.CODE
-
manuallyReleaseTaxVoid
API to manually release void tax in waiting step.- Parameters:
orderCode- theAbstractOrderModel.CODE
-
manuallyReleaseTaxCommit
API to manually commit tax and releaseOrderModelfrom waiting step.- Parameters:
orderCode- theAbstractOrderModel.CODE
-
manuallyReleaseTaxRequote
API to manually requote tax and releaseOrderModelfrom waiting step.- Parameters:
orderCode- theAbstractOrderModel.CODE
-
manuallyReleasePaymentReauth
API to manually reauth payment and releaseOrderModelfrom waiting step.- Parameters:
orderCode- theAbstractOrderModel.CODE
-
manuallyReleaseDeliveryCostCommit
API to manually commit delivery cost taxes and releaseOrderModelfrom waiting step.- Parameters:
orderCode- theAbstractOrderModel.CODE
-