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 Summary
Modifier and TypeMethodDescriptionretrieveHistoricalCartByOrderNumber
(String customerId, String orderNumber, boolean hydratePayments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Find the cart and payments (if it exists) for the provided customer id and order number.retrieveHistoricalCartForAnonymousCustomer
(String emailAddress, String orderNumber, boolean hydratePayments, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Finds a single, historical cart for an anonymous customer.
-
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 cartorderNumber
- the order number for the carthydratePayments
- if true, the payments for the cart will be added to the responsecontextInfo
- 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
-
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
- Theemail address associated with the cart
orderNumber
- Thehistorical cart's order number
hydratePayments
- if true, the payments for the cart will be added to the responsecontextInfo
- Context information around sandbox and multitenant state.- Returns:
- The single, historical cart for an anonymous customer
-