Package com.broadleafcommerce.cartoperation.service

Interface CartHistoryService

All Known Implementing Classes:
DefaultCartHistoryService
public interface CartHistoryService
The service for retrieving the submitted Carts and any related data if requested.
Author:
Dima Myroniuk (dmyroniuk)

  • Method Details

    • retrieveHistoricalCartByOrderNumber

      CartHistoryResponse retrieveHistoricalCartByOrderNumber(String customerId, String orderNumber, boolean hydratePayments, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Find the cart and payments (if it exists) for the provided customer id and order number.
      Parameters:
      customerId - the id of the customer who owns the cart
      orderNumber - the order number for the cart
      hydratePayments - if true, the payments for the cart will be added to the response
      contextInfo - Context information around sandbox and multitenant state.
      Returns:
      a cart and payments (if it exists) with the given order number that belongs to the provided customer

    • retrieveHistoricalCartByCartId

      CartHistoryResponse retrieveHistoricalCartByCartId(com.broadleafcommerce.order.common.domain.CustomerRef customer, String cartId, boolean hydratePayments, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Find the cart and payments (if it exists) for the provided customer id and cart id.
      Parameters:
      customer - the resolved CustomerRef for the customer requesting the cart
      cartId - the ID for the cart
      hydratePayments - if true, the payments for the cart will be added to the response
      contextInfo - Context information around sandbox and multitenant state.
      Returns:
      a cart and payments (if it exists) with the given order number that belongs to the provided customer
      Since:
      Cart Operations 2.1.6, Release Train 2.1.7, Cart Operations 2.2.3, Release Train 2.2.3, Cart Operations 2.3.1, Release Train 2.3.1

    • retrieveHistoricalCartForAnonymousCustomer

      CartHistoryResponse retrieveHistoricalCartForAnonymousCustomer(String emailAddress, String orderNumber, boolean hydratePayments, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Finds a single, historical cart for an anonymous customer.
      Parameters:
      emailAddress - The email address associated with the cart
      orderNumber - The historical cart's order number
      hydratePayments - if true, the payments for the cart will be added to the response
      contextInfo - Context information around sandbox and multitenant state.
      Returns:
      The single, historical cart for an anonymous customer

    • retrieveHistoricalCartByIdForAnonymousCustomer

      CartHistoryResponse retrieveHistoricalCartByIdForAnonymousCustomer(String emailAddress, String cartId, boolean hydratePayments, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Finds a single, historical cart for an anonymous customer.
      Parameters:
      emailAddress - The email address associated with the cart
      cartId - The Cart.getId() historical cart's ID}
      hydratePayments - if true, the payments for the cart will be added to the response
      contextInfo - Context information around sandbox and multitenant state.
      Returns:
      The single, historical cart for an anonymous customer
      Since:
      Cart Operations 2.1.6, Release Train 2.1.7, Cart Operations 2.2.3, Release Train 2.2.3, Cart Operations 2.3.1, Release Train 2.3.1

    • retrieveHistoricalCartsForCustomer

      SimplePage<com.broadleafcommerce.cart.client.domain.Cart> retrieveHistoricalCartsForCustomer(com.broadleafcommerce.order.common.domain.CustomerRef customer, @Nullable Date startDate, @Nullable Date endDate, @Nullable org.springframework.data.domain.Pageable page, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves all historical carts for a customer.
      Parameters:
      customer - the resolved CustomerRef for the customer requesting the carts
      startDate - first day of the range
      endDate - last day of the range
      page - Pagination information
      contextInfo - Context information around sandbox and multitenant state.
      Returns:
      a SimplePage of Carts