Package 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 Details

    • 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 Details

    • FulfillmentEndpoint

      public FulfillmentEndpoint()

  • Method Details

    • findFulfillmentGroupsForOrder

      @FrameworkMapping(value="{cartId}/groups", method=GET) public List<FulfillmentGroupWrapper> findFulfillmentGroupsForOrder(jakarta.servlet.http.HttpServletRequest request, @PathVariable("cartId") Long cartId)
      Returns a list of all of the fulfillment groups for the order with id cartId
      Parameters:
      request -
      cartId -
      Returns:

    • removeAllFulfillmentGroupsFromOrder

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

    • addFulfillmentGroupToOrder

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

    • updateFulfillmentGroup

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

    • addItemToFulfillmentGroup

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

    • addFulfillmentOptionToFulfillmentGroup

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

    • findFulfillmentOptions

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

    • updateFulfillmentGroupAddress

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

    • removeOrderItemFromFulfillmentGroup

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

    • removeFulfillmentGroupFromOrder

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

    • getFulfillmentEstimations

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

    • validateFulfillmentGroupWithOrder

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