Interface B2BOrderFacade

All Superinterfaces:
OrderFacade
All Known Implementing Classes:
DefaultB2BOrderFacade

public interface B2BOrderFacade extends OrderFacade
Interface responsible for B2B order services.
  • Method Details

    • getReplenishmentOrderDetailsForCode

      ScheduledCartData getReplenishmentOrderDetailsForCode(String code, String user)
      Gets the schedule Cart Data for replenishment given a code.
      Parameters:
      code - unique job identifier
      user - a customer assigned to the cart
      Returns:
      for given code and user
    • getReplenishmentHistory

      List<ScheduledCartData> getReplenishmentHistory()
      Retrieves replenishment cron jobs associated to the session user.
      Returns:
      the replenishment order history.
    • getPagedReplenishmentHistory

      SearchPageData<ScheduledCartData> getPagedReplenishmentHistory(PageableData pageableData)
      Retrieves replenishment cron jobs associated to the session user with paging support
      Parameters:
      pageableData - the pagination information (PageableData)
      Returns:
      the replenishment order history.
    • cancelReplenishment

      void cancelReplenishment(String jobCode, String user)
      Stops the order replenishment process.
      Parameters:
      jobCode - unique code for the replenishment cron job.
      user - customer assigned to the cart
    • getReplenishmentOrderHistory

      List<? extends OrderHistoryData> getReplenishmentOrderHistory(String jobCode, String user)
      Retrieves all the scheduled order for a given jobCode.
      Parameters:
      jobCode - a cron job code
      user - a customer assigned to the cart
      Returns:
      orders associated to a schedule job.
    • getOrdersForApproval

      List<B2BOrderApprovalData> getOrdersForApproval()
      Retrieves the order list for approval dashboard
      Returns:
      all orders pending approval
    • getPagedOrdersForApproval

      SearchPageData<B2BOrderApprovalData> getPagedOrdersForApproval(WorkflowActionType[] actionTypes, PageableData pageableData)
      Retrieves the order list for approval with configurable parameters.
      Parameters:
      actionTypes - the action types
      pageableData - the pagination information
      Returns:
      all orders pending approval
    • getOrderApprovalDetailsForCode

      B2BOrderApprovalData getOrderApprovalDetailsForCode(String code)
      Retrieves the approval details of a specific order code
      Parameters:
      code - the order code.
      Returns:
      the B2B order approval data
    • setOrderApprovalDecision

      B2BOrderApprovalData setOrderApprovalDecision(B2BOrderApprovalData b2bOrderApprovalData)
      Sets the order approval decision to the workflow.
      Parameters:
      b2bOrderApprovalData - the approval comments and decision action.
      Returns:
      the B2B order approval data
    • getPagedReplenishmentOrderHistory

      SearchPageData<? extends OrderHistoryData> getPagedReplenishmentOrderHistory(String jobCode, PageableData pageableData)
      Retrieves all the scheduled order for a given jobCode with configurable parameters.
      Parameters:
      jobCode - unique code for the replenishment cron job.
      pageableData - the pagination information
      Returns:
      a list of scheduled orders
    • getOrderHistoryEntryData

      List<B2BOrderHistoryEntryData> getOrderHistoryEntryData(String orderCode)
      Retrieves the history entry data of an order.
      Parameters:
      orderCode - the unique code of an order.
      Returns:
      a list of history entries.
    • createAndSetNewOrderFromRejectedQuote

      @Deprecated(since="6.3", forRemoval=true) void createAndSetNewOrderFromRejectedQuote(String orderCode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 6.3. Use quote functionality from commerce instead. (QuoteFacade).
      Creates an order from a rejected quote.
      Parameters:
      orderCode - the unique code of an order.
    • createAndSetNewOrderFromNegotiateQuote

      @Deprecated(since="6.3", forRemoval=true) void createAndSetNewOrderFromNegotiateQuote(String orderCode, String comment)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 6.3. Use quote functionality from commerce instead. (QuoteFacade).
      Creates an order from a negotiate quote.
      Parameters:
      orderCode - the unique code of an order.
      comment - comment string.
    • createAndSetNewOrderFromApprovedQuote

      @Deprecated(since="6.3", forRemoval=true) void createAndSetNewOrderFromApprovedQuote(String orderCode, String comment)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since 6.3. Use quote functionality from commerce instead. (QuoteFacade).
      Creates an order from an approved quote.
      Parameters:
      orderCode - the unique code of an order.
      comment - comment string.
    • cancelOrder

      void cancelOrder(String orderCode, String comment)
      Cancels an order.
      Parameters:
      orderCode - the unique code of an order.
      comment - comment string.
    • addAdditionalComment

      void addAdditionalComment(String orderCode, String comment)
      Add a comment to an order.
      Parameters:
      orderCode - the unique code of an order.
      comment - comment string.