Interface OmsOrderFacade

All Known Implementing Classes:
DefaultOmsB2bOrderFacade, DefaultOmsOrderFacade

public interface OmsOrderFacade
OrderManagement facade exposing operations on OrderModel
  • Method Details

    • getOrders

      SearchPageData<OrderData> getOrders(PageableData pageableData)
      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

      OrderData getOrderForCode(String orderCode)
      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 info
      orderStatusSet - 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 given AbstractOrderModel.CODE
      Parameters:
      orderCode - the order'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 orderEntries for the given order
    • getOrderEntryForOrderCodeAndEntryNumber

      OrderEntryData getOrderEntryForOrderCodeAndEntryNumber(String orderCode, Integer entryNumber)
      API to get an orderEntry by it's entryNumber and its order's code
      Parameters:
      orderCode - the order's code
      entryNumber - the order entry's number
      Returns:
      the order entry
    • getOrderFraudReports

      List<FraudReportData> getOrderFraudReports(String orderCode)
      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

      void approvePotentiallyFraudulentOrder(String orderCode)
      API to approve a potentially fraudulent order
      Parameters:
      orderCode - code of the order for which to approve the fraud check
    • rejectPotentiallyFraudulentOrder

      void rejectPotentiallyFraudulentOrder(String orderCode)
      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

      OrderData submitOrder(OrderRequestData orderRequestData)
      API to submit an OrderModel in the system
      Parameters:
      orderRequestData - the OrderRequestData to submit an OrderModel
      Returns:
      the submitted OrderData
    • createRequestOrderCancel

      OrderCancelRecordEntryData createRequestOrderCancel(OrderCancelRequestData orderCancelRequestData)
      API to request a order cancelOrderCancelRequest
      Parameters:
      orderCancelRequestData - the OrderCancelRequestData to create OrderCancelRequestData
      Returns:
      OrderCancelRecordEntryData representing the cancel request that was created
    • manuallyReleasePaymentVoid

      void manuallyReleasePaymentVoid(String orderCode)
      API to manually release void payment in waiting step.
      Parameters:
      orderCode - the AbstractOrderModel.CODE
    • manuallyReleaseTaxVoid

      void manuallyReleaseTaxVoid(String orderCode)
      API to manually release void tax in waiting step.
      Parameters:
      orderCode - the AbstractOrderModel.CODE
    • manuallyReleaseTaxCommit

      void manuallyReleaseTaxCommit(String orderCode)
      API to manually commit tax and release OrderModel from waiting step.
      Parameters:
      orderCode - the AbstractOrderModel.CODE
    • manuallyReleaseTaxRequote

      void manuallyReleaseTaxRequote(String orderCode)
      API to manually requote tax and release OrderModel from waiting step.
      Parameters:
      orderCode - the AbstractOrderModel.CODE
    • manuallyReleasePaymentReauth

      void manuallyReleasePaymentReauth(String orderCode)
      API to manually reauth payment and release OrderModel from waiting step.
      Parameters:
      orderCode - the AbstractOrderModel.CODE
    • manuallyReleaseDeliveryCostCommit

      void manuallyReleaseDeliveryCostCommit(String orderCode)
      API to manually commit delivery cost taxes and release OrderModel from waiting step.
      Parameters:
      orderCode - the AbstractOrderModel.CODE