org.broadleafcommerce.core.web.api.endpoint.order

Class CartEndpoint

java.lang.Object

org.broadleafcommerce.core.web.api.endpoint.BaseEndpoint

org.broadleafcommerce.core.web.api.endpoint.order.CartEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.MessageSourceAware

public abstract 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,

Field Summary

Fields

Modifier and Type	Field and Description
protected CustomerService	customerService
protected OfferService	offerService
protected OrderService	orderService

Fields inherited from class org.broadleafcommerce.core.web.api.endpoint.BaseEndpoint

context, messageSource

Constructor Summary

Constructors

Constructor and Description
CartEndpoint()

Method Summary

Modifier and Type	Method and Description
OrderWrapper	addOfferCode(javax.servlet.http.HttpServletRequest request, String promoCode, boolean priceOrder)
OrderWrapper	addProductToOrder(javax.servlet.http.HttpServletRequest request, org.springframework.util.MultiValueMap<String,String> requestParams, Long productId, Long categoryId, int quantity, boolean priceOrder) This method takes in a categoryId and productId as path parameters.
OrderWrapper	createNewCartForCustomer(javax.servlet.http.HttpServletRequest request) Create a new Order for Customer
OrderWrapper	findCartForCustomer(javax.servlet.http.HttpServletRequest request) Search for Order by Customer
protected HashMap<String,String>	getOptions(org.springframework.util.MultiValueMap<String,String> requestParams)
OrderWrapper	removeAllOfferCodes(javax.servlet.http.HttpServletRequest request, boolean priceOrder)
OrderWrapper	removeItemFromOrder(javax.servlet.http.HttpServletRequest request, Long itemId, boolean priceOrder)
OrderWrapper	removeOfferCode(javax.servlet.http.HttpServletRequest request, String promoCode, boolean priceOrder)
OrderWrapper	updateItemQuantity(javax.servlet.http.HttpServletRequest request, Long itemId, Integer quantity, boolean priceOrder)
OrderWrapper	updateProductOptions(javax.servlet.http.HttpServletRequest request, org.springframework.util.MultiValueMap<String,String> requestParams, Long itemId, boolean priceOrder)
protected OrderWrapper	wrapCart(javax.servlet.http.HttpServletRequest request, Order cart)

Methods inherited from class org.broadleafcommerce.core.web.api.endpoint.BaseEndpoint

getApplicationContext, getMessageSource, setApplicationContext, setMessageSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

orderService

protected OrderService orderService

offerService

protected OfferService offerService

customerService

protected CustomerService customerService

Constructor Detail

CartEndpoint

public CartEndpoint()

Method Detail

findCartForCustomer

public OrderWrapper findCartForCustomer(javax.servlet.http.HttpServletRequest request)

Search for Order by Customer

Returns:

the cart for the customer

createNewCartForCustomer

public OrderWrapper createNewCartForCustomer(javax.servlet.http.HttpServletRequest request)

Create a new Order for Customer

Returns:

the cart for the customer

addProductToOrder

public OrderWrapper addProductToOrder(javax.servlet.http.HttpServletRequest request,
                                      org.springframework.util.MultiValueMap<String,String> requestParams,
                                      Long productId,
                                      Long categoryId,
                                      int quantity,
                                      boolean priceOrder)

This method takes in a categoryId and productId as path parameters. In addition, query parameters can be supplied including:

skuId quantity priceOrder You must provide a ProductId OR ProductId with product options. Product options can be posted as form or querystring parameters. You must pass in the ProductOption attributeName as the key and the ProductOptionValue attributeValue as the value. See CatalogEndpoint.

Parameters:

request -

uriInfo -

categoryId -

productId -

quantity -

priceOrder -

Returns:

OrderWrapper

getOptions

protected HashMap<String,String> getOptions(org.springframework.util.MultiValueMap<String,String> requestParams)

removeItemFromOrder

public OrderWrapper removeItemFromOrder(javax.servlet.http.HttpServletRequest request,
                                        Long itemId,
                                        boolean priceOrder)

updateItemQuantity

public OrderWrapper updateItemQuantity(javax.servlet.http.HttpServletRequest request,
                                       Long itemId,
                                       Integer quantity,
                                       boolean priceOrder)

addOfferCode

public OrderWrapper addOfferCode(javax.servlet.http.HttpServletRequest request,
                                 String promoCode,
                                 boolean priceOrder)

removeOfferCode

public OrderWrapper removeOfferCode(javax.servlet.http.HttpServletRequest request,
                                    String promoCode,
                                    boolean priceOrder)

removeAllOfferCodes

public OrderWrapper removeAllOfferCodes(javax.servlet.http.HttpServletRequest request,
                                        boolean priceOrder)

updateProductOptions

public OrderWrapper updateProductOptions(javax.servlet.http.HttpServletRequest request,
                                         org.springframework.util.MultiValueMap<String,String> requestParams,
                                         Long itemId,
                                         boolean priceOrder)

wrapCart

protected OrderWrapper wrapCart(javax.servlet.http.HttpServletRequest request,
                                Order cart)