Documentation Home

Advanced Inventory REST Endpoints

To enable the REST api endpoints, add the following component scan in an applicationContext.xml:

<context:component-scan base-package="com.broadleafcommerce.inventory.advanced.api" />

Below are the provided endpoints out of the box.

Fulfillment Location

URI Method Query Parameters Description
/fulfillment-location/default GET None Gets the default fulfillment location
/fulfillment-location/{locationId} GET None Gets the fulfillment location via the specified ID
/fulfillment-location/{locationId}/inventory GET None Gets all of the Inventory records for this particular fulfillment location
/fulfillment-location/pickup GET None Gets all of the Fulfillment locations with a FulfillmentType of PHYSICAL_PICKUP or PHYSICAL_PICKUP_OR_SHIP
/fulfillment-location/ship GET None Gets all of the Fulfillment locations with a FulfillmentType of PHYSICAL_SHIP or PHYSICAL_PICKUP_OR_SHIP
/fulfillment-location/physical GET None Gets all of the Fulfillment locations with a FulfillmentType of PHYSICAL_SHIP, PHYSICAL_PICKUP or PHYSICAL_PICKUP_OR_SHIP

Inventory

URI Method Query Parameters Description
/inventory/{skuId} GET locationId - a valid Fulfillment Location primary key to filter the Inventory records on Returns all of the Inventory records for the given Sku, optionally at a given Fulfillment Location
/inventory/{skuId}/pickup GET None Returns all of the Inventory records for the given Sku at Fulfillment Locations with a type of PHYSICAL_PICKUP or PHYSICAL_PICKUP_OR_SHIP
/inventory/{skuId}/shippable GET None Returns all of the Inventory records for the given Sku at Fulfillment Locations with a type of PHYSICAL_SHIP or PHYSICAL_PICKUP_OR_SHIP
/inventory/{skuId}/physical GET None Returns all of the inventory records for the given Sku at Fulfillment Locations with a type of PHYSICAL_SHIP, PHYSICAL_PICKUP or PHYSICAL_PICKUP_OR_SHIP
/inventory/{skuId}/available GET locationId - a valid Fulfillment Location primary key to filter the available quantity on Returns the available inventory for a particular Sku across all fulfillment locations

Inventory Notification

URI Method Query Parameters Description
/inventory/notification GET
  • limit - how many records to return (default is 20)
  • offset - 0-based offset from the set of total records (default is 0)
 Gets all of the unprocessed inventory notifications in the system
/inventory/notification PUT
  • skuId - the Sku to listen for inventory notifications to
  • locationId (optional) - the Fulfillment Location that this notification should be associated with
  • email (optional, default is CustomerState.getCustomer()) - email address that the notification should be sent to
 Gets all of the inventory notifications in the system
/inventory/notification/process/{notificationId} POST None Processes the given notification by sending an email to the customer or anonymous user
/inventory/notification/customer GET None Gets all of the unprocessed notifications for the current customer via CustomerState.getCustomer()
/inventory/notification/email/{email} GET None Gets all of the unprocessed notifications for the given email address