Use the Inventory API to retrieve the inventory levels of requested products, refresh and adjust current stock levels at fulfillment locations, and tag segmented inventory for different channels. For more information about how inventory works in Kibo, see the Inventory guides.
As of July 2024, applications must have the appropriate behaviors to access inventory-related APIs in some environments. These are Inventory Read (to retrieve inventory data), Inventory Modify (to create or update inventory data), and Inventory Delete (to explicitly remove inventory data). These are required for all sandbox environments. Existing applications developed before July 2024 do not require these behaviors for production environments, but newer applications do require them.
Some tips for using different resources of the Inventory APIs:
- Use the Inventory, Inventory Allocation, and Modify Inventory resources to retrieve and update inventory levels.
- Use the Inventory Job resource to retrieve information about your pending inventory update processing jobs.
- Use the Inventory Tag and Tag Category resources to segment your inventory records into categories to identify which portions of its total quantity are intended for different channels, customer groups, fulfillment methods, or other needs. This allows for setting a percentage of the quantity that would be available for each category and setting discrete units at the location level as available for each category.
TROUBLESHOOTING NOTE: Inventory API calls may not work with Site IDs in the URL at this time. Use the drop-down Base URL selector on the right side of the screen to use a different format (such as ttenantId instead of ttenantId-ssiteId).