Package com.broadleafcommerce.catalogbrowse.web.endpoint

Class InventoryAvailabilityIndexEndpoint

java.lang.Object

com.broadleafcommerce.catalogbrowse.web.endpoint.InventoryAvailabilityIndexEndpoint

@FrameworkRestController
@FrameworkMapping("/inventory-availability-index")
@DataRouteByKey("catalogbrowse")
public class InventoryAvailabilityIndexEndpoint
extends Object

Since:

Catalog Browse Service 2.2.0, Release Train 2.3.0

Author:

Susana Cruz (susanacruz)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
InventoryAvailabilityIndexEndpoint(InventoryAvailabilityIndexService inventoryAvailabilityIndexService)

Method Summary

Modifier and Type	Method	Description
protected InventoryAvailabilityIndexService	getInventoryAvailabilityIndexService()
ProductAvailabilityIndex	readProductAvailabilityIndex(jakarta.servlet.http.HttpServletRequest request, String productId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Fetches all LiteVariants related to a given productId and finds their inventory availability.

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

InventoryAvailabilityIndexEndpoint

public InventoryAvailabilityIndexEndpoint(InventoryAvailabilityIndexService inventoryAvailabilityIndexService)

Method Details

readProductAvailabilityIndex

@FrameworkGetMapping("/{productId}")
public ProductAvailabilityIndex readProductAvailabilityIndex(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable("productId")
 String productId,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Fetches all LiteVariants related to a given productId and finds their inventory availability.

Parameters:

request - HttpServletRequest for the request

productId - the productId to find inventory availability for

contextInfo - ContextInfo for multitenant and sandbox conditions

getInventoryAvailabilityIndexService

protected InventoryAvailabilityIndexService getInventoryAvailabilityIndexService()