com.broadleafcommerce.rest.api.endpoint.order

Class FulfillmentEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.order.FulfillmentEndpoint

All Implemented Interfaces:

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

@FrameworkRestController
 @FrameworkMapping(value="/shipping/",
                  produces={"application/json","application/xml"})
public class FulfillmentEndpoint
extends BaseEndpoint

This endpoint depends on JAX-RS. 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 org.broadleafcommerce.core.checkout.service.CheckoutService	checkoutService
protected org.broadleafcommerce.core.order.service.FulfillmentGroupService	fulfillmentGroupService
protected org.broadleafcommerce.core.order.service.FulfillmentOptionService	fulfillmentOptionService
protected org.broadleafcommerce.core.pricing.service.FulfillmentPricingService	fulfillmentPricingService
protected org.broadleafcommerce.core.order.service.OrderService	orderService

Fields inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

context, messageSource

Constructor Summary

Constructors

Constructor and Description
FulfillmentEndpoint()

Method Summary

Modifier and Type	Method and Description
FulfillmentGroupWrapper	addFulfillmentGroupToOrder(javax.servlet.http.HttpServletRequest request, FulfillmentGroupWrapper wrapper, boolean priceOrder, Long cartId)
FulfillmentGroupWrapper	addFulfillmentOptionToFulfillmentGroup(javax.servlet.http.HttpServletRequest request, Long fulfillmentGroupId, Long fulfillmentOptionId, boolean priceOrder, Long cartId)
FulfillmentGroupWrapper	addItemToFulfillmentGroup(javax.servlet.http.HttpServletRequest request, Long fulfillmentGroupId, FulfillmentGroupItemWrapper wrapper, boolean priceOrder, Long cartId)
List<FulfillmentGroupWrapper>	findFulfillmentGroupsForOrder(javax.servlet.http.HttpServletRequest request, Long cartId) Returns a list of all of the fulfillment groups for the order with id cartId
List<FulfillmentOptionWrapper>	findFulfillmentOptions(javax.servlet.http.HttpServletRequest request, String fulfillmentType)
List<FulfillmentEstimationWrapper>	getFulfillmentEstimations(javax.servlet.http.HttpServletRequest request, Long cartId)
OrderWrapper	removeAllFulfillmentGroupsFromOrder(javax.servlet.http.HttpServletRequest request, boolean priceOrder, Long cartId)
List<FulfillmentGroupWrapper>	removeFulfillmentGroupFromOrder(javax.servlet.http.HttpServletRequest request, Long fulfillmentGroupId, Long cartId)
FulfillmentGroupWrapper	removeOrderItemFromFulfillmentGroup(javax.servlet.http.HttpServletRequest request, Long fulfillmentGroupId, Long itemId, Long cartId)
FulfillmentGroupWrapper	updateFulfillmentGroup(javax.servlet.http.HttpServletRequest request, FulfillmentGroupWrapper wrapper, boolean priceOrder, Long cartId, Long fulfillmentGroupId)
FulfillmentGroupWrapper	updateFulfillmentGroupAddress(javax.servlet.http.HttpServletRequest request, Long fulfillmentGroupId, Long cartId, AddressWrapper address)
protected void	validateFulfillmentGroupWithOrder(org.broadleafcommerce.core.order.domain.Order order, org.broadleafcommerce.core.order.domain.FulfillmentGroup group)

Methods inherited from class com.broadleafcommerce.rest.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

checkoutService

protected org.broadleafcommerce.core.checkout.service.CheckoutService checkoutService

orderService

protected org.broadleafcommerce.core.order.service.OrderService orderService

fulfillmentGroupService

protected org.broadleafcommerce.core.order.service.FulfillmentGroupService fulfillmentGroupService

fulfillmentOptionService

protected org.broadleafcommerce.core.order.service.FulfillmentOptionService fulfillmentOptionService

fulfillmentPricingService

protected org.broadleafcommerce.core.pricing.service.FulfillmentPricingService fulfillmentPricingService

Constructor Detail

FulfillmentEndpoint

public FulfillmentEndpoint()

Method Detail

findFulfillmentGroupsForOrder

@FrameworkMapping(value="{cartId}/groups",
                  method=GET)
public List<FulfillmentGroupWrapper> findFulfillmentGroupsForOrder(javax.servlet.http.HttpServletRequest request,
                                                                                                                                            @PathVariable(value="cartId")
                                                                                                                                            Long cartId)

Returns a list of all of the fulfillment groups for the order with id cartId

Parameters:

request -

cartId -

Returns:

Throws:

404 - Not Found if no order exists with id cartId

removeAllFulfillmentGroupsFromOrder

@FrameworkMapping(value="{cartId}/groups",
                  method=DELETE)
public OrderWrapper removeAllFulfillmentGroupsFromOrder(javax.servlet.http.HttpServletRequest request,
                                                                                                                                    @RequestParam(value="priceOrder",defaultValue="true")
                                                                                                                                    boolean priceOrder,
                                                                                                                                    @PathVariable(value="cartId")
                                                                                                                                    Long cartId)

addFulfillmentGroupToOrder

@FrameworkMapping(value="{cartId}/group",
                  method=POST,
                  consumes={"application/json","application/xml"})
public FulfillmentGroupWrapper addFulfillmentGroupToOrder(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                      @RequestBody
                                                                                                                                                                                                      FulfillmentGroupWrapper wrapper,
                                                                                                                                                                                                      @RequestParam(value="priceOrder",defaultValue="true")
                                                                                                                                                                                                      boolean priceOrder,
                                                                                                                                                                                                      @PathVariable(value="cartId")
                                                                                                                                                                                                      Long cartId)

updateFulfillmentGroup

@FrameworkMapping(value="{cartId}/group/{fulfillmentGroupId}",
                  method=PATCH,
                  consumes={"application/json","application/xml"})
public FulfillmentGroupWrapper updateFulfillmentGroup(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                                                        FulfillmentGroupWrapper wrapper,
                                                                                                                                                                                                                        @RequestParam(value="priceOrder",defaultValue="true")
                                                                                                                                                                                                                        boolean priceOrder,
                                                                                                                                                                                                                        @PathVariable(value="cartId")
                                                                                                                                                                                                                        Long cartId,
                                                                                                                                                                                                                        @PathVariable(value="fulfillmentGroupId")
                                                                                                                                                                                                                        Long fulfillmentGroupId)

addItemToFulfillmentGroup

@FrameworkMapping(value="{cartId}/group/{fulfillmentGroupId}/item",
                  method=POST,
                  consumes={"application/json","application/xml"})
public FulfillmentGroupWrapper addItemToFulfillmentGroup(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                               @PathVariable(value="fulfillmentGroupId")
                                                                                                                                                                                                                               Long fulfillmentGroupId,
                                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                                               FulfillmentGroupItemWrapper wrapper,
                                                                                                                                                                                                                               @RequestParam(value="priceOrder",defaultValue="true")
                                                                                                                                                                                                                               boolean priceOrder,
                                                                                                                                                                                                                               @PathVariable(value="cartId")
                                                                                                                                                                                                                               Long cartId)

addFulfillmentOptionToFulfillmentGroup

@FrameworkMapping(value="{cartId}/group/{fulfillmentGroupId}/option/{fulfillmentOptionId}",
                  method=PUT)
public FulfillmentGroupWrapper addFulfillmentOptionToFulfillmentGroup(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                @PathVariable(value="fulfillmentGroupId")
                                                                                                                                                                                                Long fulfillmentGroupId,
                                                                                                                                                                                                @PathVariable(value="fulfillmentOptionId")
                                                                                                                                                                                                Long fulfillmentOptionId,
                                                                                                                                                                                                @RequestParam(value="priceOrder",defaultValue="true")
                                                                                                                                                                                                boolean priceOrder,
                                                                                                                                                                                                @PathVariable(value="cartId")
                                                                                                                                                                                                Long cartId)

findFulfillmentOptions

@FrameworkMapping(value="options",
                  method=GET)
public List<FulfillmentOptionWrapper> findFulfillmentOptions(javax.servlet.http.HttpServletRequest request,
                                                                                                                              @RequestParam(value="fulfillmentType")
                                                                                                                              String fulfillmentType)

updateFulfillmentGroupAddress

@FrameworkMapping(value="{cartId}/{fulfillmentGroupId}/address",
                  method=PUT,
                  consumes={"application/json","application/xml"})
public FulfillmentGroupWrapper updateFulfillmentGroupAddress(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                               @PathVariable(value="fulfillmentGroupId")
                                                                                                                                                                                                                               Long fulfillmentGroupId,
                                                                                                                                                                                                                               @PathVariable(value="cartId")
                                                                                                                                                                                                                               Long cartId,
                                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                                               AddressWrapper address)

removeOrderItemFromFulfillmentGroup

@FrameworkMapping(value="{cartId}/group/{fulfillmentGroupId}/item/{itemId}",
                  method=DELETE)
public FulfillmentGroupWrapper removeOrderItemFromFulfillmentGroup(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                 @PathVariable(value="fulfillmentGroupId")
                                                                                                                                                                                 Long fulfillmentGroupId,
                                                                                                                                                                                 @PathVariable(value="itemId")
                                                                                                                                                                                 Long itemId,
                                                                                                                                                                                 @PathVariable(value="cartId")
                                                                                                                                                                                 Long cartId)

removeFulfillmentGroupFromOrder

@FrameworkMapping(value="{cartId}/group/{fulfillmentGroupId}",
                  method=DELETE)
public List<FulfillmentGroupWrapper> removeFulfillmentGroupFromOrder(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                     @PathVariable(value="fulfillmentGroupId")
                                                                                                                                                                     Long fulfillmentGroupId,
                                                                                                                                                                     @PathVariable(value="cartId")
                                                                                                                                                                     Long cartId)

getFulfillmentEstimations

@FrameworkMapping(value="{cartId}/estimate")
public List<FulfillmentEstimationWrapper> getFulfillmentEstimations(javax.servlet.http.HttpServletRequest request,
                                                                                                                 @PathVariable(value="cartId")
                                                                                                                 Long cartId)

validateFulfillmentGroupWithOrder

protected void validateFulfillmentGroupWithOrder(org.broadleafcommerce.core.order.domain.Order order,
                                                 org.broadleafcommerce.core.order.domain.FulfillmentGroup group)