com.broadleafcommerce.inventory.advanced.api.endpoint

Class InventoryEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.inventory.advanced.api.endpoint.InventoryEndpoint

All Implemented Interfaces:

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

@ConditionalOnBroadleafModule(value=REST_API)
 @RestController(value="blAdvancedInventoryEndpoint")
 @RequestMapping(value="/inventory/",
                produces={"application/json","application/xml"})
public class InventoryEndpoint
extends com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

REST endpoint for operations dealing with AdvancedInventoryService functionality

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected AdvancedInventoryService	inventoryService
protected FulfillmentLocationService	locationService

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

context, messageSource

Constructor Summary

Constructors

Constructor and Description
InventoryEndpoint()

Method Summary

Modifier and Type	Method and Description
List<InventoryWrapper>	findInventoryForSku(javax.servlet.http.HttpServletRequest request, Long skuId, Long locationId)
protected FulfillmentLocation	findLocation(Long locationId)
List<InventoryWrapper>	findPhysicalInventoryForSku(javax.servlet.http.HttpServletRequest request, Long skuId)
List<InventoryWrapper>	findPickupInventoryForSku(javax.servlet.http.HttpServletRequest request, Long skuId)
List<InventoryWrapper>	findShippableInventoryForSku(javax.servlet.http.HttpServletRequest request, Long skuId)
protected org.broadleafcommerce.core.catalog.domain.Sku	findSku(Long skuId) Checks to see if the given Sku ID is valid
Integer	getQuantityAvailable(javax.servlet.http.HttpServletRequest request, Long skuId, Long locationId)

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

catalogService

protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService

inventoryService

protected AdvancedInventoryService inventoryService

locationService

protected FulfillmentLocationService locationService

Constructor Detail

InventoryEndpoint

public InventoryEndpoint()

Method Detail

findInventoryForSku

@RequestMapping(value="{skuId}",
                method=GET)
public List<InventoryWrapper> findInventoryForSku(javax.servlet.http.HttpServletRequest request,
                                                                                                               @PathVariable(value="skuId")
                                                                                                               Long skuId,
                                                                                                               @RequestParam(value="locationId")
                                                                                                               Long locationId)

findPickupInventoryForSku

@RequestMapping(value="{skuId}/pickup",
                method=GET)
public List<InventoryWrapper> findPickupInventoryForSku(javax.servlet.http.HttpServletRequest request,
                                                                                                                            @PathVariable(value="skuId")
                                                                                                                            Long skuId)

findShippableInventoryForSku

@RequestMapping(value="{skuId}/shippable",
                method=GET)
public List<InventoryWrapper> findShippableInventoryForSku(javax.servlet.http.HttpServletRequest request,
                                                                                                                                  @PathVariable(value="skuId")
                                                                                                                                  Long skuId)

findPhysicalInventoryForSku

@RequestMapping(value="{skuId}/physical",
                method=GET)
public List<InventoryWrapper> findPhysicalInventoryForSku(javax.servlet.http.HttpServletRequest request,
                                                                                                                                @PathVariable(value="skuId")
                                                                                                                                Long skuId)

getQuantityAvailable

@RequestMapping(value="{skuId}/available",
                method=GET)
public Integer getQuantityAvailable(javax.servlet.http.HttpServletRequest request,
                                                                                                           @PathVariable(value="skuId")
                                                                                                           Long skuId,
                                                                                                           @RequestParam(value="locationId")
                                                                                                           Long locationId)

findSku

protected org.broadleafcommerce.core.catalog.domain.Sku findSku(Long skuId)

Checks to see if the given Sku ID is valid

Parameters:

skuId - the Sku primary key to check

Returns:

the Sku looked up from the database

Throws:

{@link - BroadleafWebServicesException} if the Sku referenced by skuId is not found

findLocation

protected FulfillmentLocation findLocation(Long locationId)