Class CartEndpoint
java.lang.Object
com.broadleafcommerce.rest.api.endpoint.BaseEndpoint
com.broadleafcommerce.rest.api.endpoint.order.CartEndpoint
- All Implemented Interfaces:
org.springframework.beans.factory.Aware,org.springframework.context.ApplicationContextAware,org.springframework.context.MessageSourceAware
@FrameworkRestController
@FrameworkMapping(value="/cart",
produces={"application/json","application/xml"})
public class CartEndpoint
extends BaseEndpoint
This endpoint depends on JAX-RS to provide cart services. It should be extended by components that actually wish
to provide an endpoint. The annotations such as @Path, @Scope, @Context, @PathParam, @QueryParam,
- Author:
- Jay Aisenbrey (cja769)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.broadleafcommerce.core.catalog.service.CatalogServiceprotected org.broadleafcommerce.profile.core.service.CustomerServiceprotected org.broadleafcommerce.core.offer.service.OfferServiceprotected org.broadleafcommerce.core.order.service.OrderItemServiceprotected OrderRequestServiceprotected org.broadleafcommerce.core.order.service.OrderServiceFields inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint
context, messageSource -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddItemToOrder(jakarta.servlet.http.HttpServletRequest request, Long cartId, OrderItemWrapper orderItemWrapper, Boolean priceOrder, Boolean isUpdateRequest) addOfferCode(jakarta.servlet.http.HttpServletRequest request, String promoCode, Long cartId, Boolean priceOrder) configureItem(jakarta.servlet.http.HttpServletRequest request, Long productId) configureProductItem(jakarta.servlet.http.HttpServletRequest request, Long productId) createNewCartForCustomer(jakarta.servlet.http.HttpServletRequest request) Create a newOrderforCustomerdeleteOrderAttributes(jakarta.servlet.http.HttpServletRequest request, List<OrderAttributeWrapper> requestParams, Long cartId, Boolean priceOrder) deleteProductOptions(jakarta.servlet.http.HttpServletRequest request, List<OrderItemAttributeWrapper> requestParams, Long cartId, Long itemId, Boolean priceOrder) findCartById(jakarta.servlet.http.HttpServletRequest request, Long cartId) findCartForCustomer(jakarta.servlet.http.HttpServletRequest request) Search forOrderbyCustomergetOrderAttributeMap(Map<String, String> options, org.broadleafcommerce.core.order.domain.Order order) getRemainingOrderAttributes(Map<String, String> attrsToRemove, Map<String, org.broadleafcommerce.core.order.domain.OrderAttribute> attrs) reconfigureItemFromOrder(jakarta.servlet.http.HttpServletRequest request, Long orderItemId) reconfigureOrderItemFromOrder(jakarta.servlet.http.HttpServletRequest request, Long orderItemId) removeAllOfferCodes(jakarta.servlet.http.HttpServletRequest request, Long cartId, boolean priceOrder) removeItemFromOrder(jakarta.servlet.http.HttpServletRequest request, Long itemId, Long cartId, Boolean priceOrder) removeOfferCode(jakarta.servlet.http.HttpServletRequest request, String promoCode, Long cartId, Boolean priceOrder) protected voidupdateAddRequestQuantities(org.broadleafcommerce.core.order.service.call.OrderItemRequestDTO itemRequest, Long originalOrderItemId) updateItemQuantity(jakarta.servlet.http.HttpServletRequest request, Long itemId, Long cartId, Integer quantity, Boolean priceOrder) updateOrderAttributes(jakarta.servlet.http.HttpServletRequest request, List<OrderAttributeWrapper> requestParams, Long cartId, Boolean priceOrder) updateProductOptions(jakarta.servlet.http.HttpServletRequest request, List<OrderItemAttributeWrapper> requestParams, Long cartId, Long itemId, Boolean priceOrder) protected OrderWrapperwrapCart(jakarta.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.order.domain.Order cart) Methods inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint
getApplicationContext, getMessageSource, setApplicationContext, setMessageSource
-
Field Details
-
orderService
protected org.broadleafcommerce.core.order.service.OrderService orderService -
offerService
protected org.broadleafcommerce.core.offer.service.OfferService offerService -
orderItemService
protected org.broadleafcommerce.core.order.service.OrderItemService orderItemService -
catalogService
protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService -
customerService
protected org.broadleafcommerce.profile.core.service.CustomerService customerService -
orderRequestService
-
-
Constructor Details
-
CartEndpoint
public CartEndpoint()
-
-
Method Details
-
findCartForCustomer
@FrameworkMapping(value="", method=GET) public OrderWrapper findCartForCustomer(jakarta.servlet.http.HttpServletRequest request) Search forOrderbyCustomer- Returns:
- the cart for the customer
-
createNewCartForCustomer
@FrameworkMapping(value="", method=POST) public OrderWrapper createNewCartForCustomer(jakarta.servlet.http.HttpServletRequest request) Create a newOrderforCustomer- Returns:
- the cart for the customer
-
findCartById
@FrameworkMapping(value="/{cartId}", method=GET) public OrderWrapper findCartById(jakarta.servlet.http.HttpServletRequest request, @PathVariable("cartId") Long cartId) -
removeItemFromOrder
@FrameworkMapping(value="/{cartId}/items/{itemId}", method=DELETE) public OrderWrapper removeItemFromOrder(jakarta.servlet.http.HttpServletRequest request, @PathVariable("itemId") Long itemId, @PathVariable("cartId") Long cartId, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
updateItemQuantity
@FrameworkMapping(value="/{cartId}/items/{itemId}", method=PUT) public OrderWrapper updateItemQuantity(jakarta.servlet.http.HttpServletRequest request, @PathVariable("itemId") Long itemId, @PathVariable("cartId") Long cartId, @RequestParam("quantity") Integer quantity, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
addOfferCode
@FrameworkMapping(value="/{cartId}/offer/{promoCode}", method=POST) public OrderWrapper addOfferCode(jakarta.servlet.http.HttpServletRequest request, @PathVariable("promoCode") String promoCode, @PathVariable("cartId") Long cartId, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
removeOfferCode
@FrameworkMapping(value="/{cartId}/offer/{promoCode}", method=DELETE) public OrderWrapper removeOfferCode(jakarta.servlet.http.HttpServletRequest request, @PathVariable("promoCode") String promoCode, @PathVariable("cartId") Long cartId, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
removeAllOfferCodes
@FrameworkMapping(value="/{cartId}/offers", method=DELETE) public OrderWrapper removeAllOfferCodes(jakarta.servlet.http.HttpServletRequest request, @PathVariable("cartId") Long cartId, @RequestParam(value="priceOrder",required=false,defaultValue="true") boolean priceOrder) -
updateProductOptions
@FrameworkMapping(value="/{cartId}/item/{itemId}/attributes", method=PUT, consumes={"application/json","application/xml"}) public OrderWrapper updateProductOptions(jakarta.servlet.http.HttpServletRequest request, @RequestBody List<OrderItemAttributeWrapper> requestParams, @PathVariable("cartId") Long cartId, @PathVariable("itemId") Long itemId, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
deleteProductOptions
@FrameworkMapping(value="/{cartId}/item/{itemId}/attributes", method=DELETE, consumes={"application/json","application/xml"}) public OrderWrapper deleteProductOptions(jakarta.servlet.http.HttpServletRequest request, @RequestBody(required=false) List<OrderItemAttributeWrapper> requestParams, @PathVariable("cartId") Long cartId, @PathVariable("itemId") Long itemId, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
updateOrderAttributes
@FrameworkMapping(value="/{cartId}/attributes", method=PUT, consumes={"application/json","application/xml"}) public OrderWrapper updateOrderAttributes(jakarta.servlet.http.HttpServletRequest request, @RequestBody List<OrderAttributeWrapper> requestParams, @PathVariable("cartId") Long cartId, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
deleteOrderAttributes
@FrameworkMapping(value="/{cartId}/attributes", method=DELETE, consumes={"application/json","application/xml"}) public OrderWrapper deleteOrderAttributes(jakarta.servlet.http.HttpServletRequest request, @RequestBody List<OrderAttributeWrapper> requestParams, @PathVariable("cartId") Long cartId, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder) -
getOrderAttributeMap
-
getRemainingOrderAttributes
-
addItemToOrder
@FrameworkMapping(value="/{cartId}/item", method=POST, consumes={"application/json","application/xml"}) public OrderWrapper addItemToOrder(jakarta.servlet.http.HttpServletRequest request, @PathVariable("cartId") Long cartId, @RequestBody OrderItemWrapper orderItemWrapper, @RequestParam(value="priceOrder",required=false,defaultValue="true") Boolean priceOrder, @RequestParam(value="isUpdateRequest",required=false,defaultValue="false") Boolean isUpdateRequest) -
configureProductItem
@FrameworkMapping(value="/configure/{productId}", method=GET) public ConfigurableOrderItemWrapper configureProductItem(jakarta.servlet.http.HttpServletRequest request, @PathVariable Long productId) -
reconfigureOrderItemFromOrder
@FrameworkMapping(value="/reconfigure/{orderItemId}", method=GET) public ConfigurableOrderItemWrapper reconfigureOrderItemFromOrder(jakarta.servlet.http.HttpServletRequest request, @PathVariable Long orderItemId) -
configureItem
public ConfigurableOrderItemWrapper configureItem(jakarta.servlet.http.HttpServletRequest request, Long productId) -
reconfigureItemFromOrder
public ConfigurableOrderItemWrapper reconfigureItemFromOrder(jakarta.servlet.http.HttpServletRequest request, Long orderItemId) -
wrapCart
protected OrderWrapper wrapCart(jakarta.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.order.domain.Order cart) -
updateAddRequestQuantities
protected void updateAddRequestQuantities(org.broadleafcommerce.core.order.service.call.OrderItemRequestDTO itemRequest, Long originalOrderItemId)
-