Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

The Kibo Composable Commerce Platform (KCCP) allows you to track different inventory quantities for your products. This guide defines the quantity types, explains how they’re calculated, and provides more details about the Future Available to Promise inventory type.
TypeDescription
AvailableThe total quantity that’s available to sell, or the amount on hand minus any allocated quantity.
AllocatedThe quantity that shoppers have purchased and has not been fulfilled.
On HandThe quantity that you have in stock in your warehouse.
PendingThe quantity that was overallocated and is waiting for inventory. This occurs anytime there is an allocation greater than the Available amount of inventory. Pending items will be “released” and automatically converted to Allocated when stock is available, which the system checks for every thirty minutes.
LTDThe inventory age, or lifetime to date, of the product.
FloorThe desired minimum to have in stock before ordering more inventory. This represents when inventory is getting low and should be replenished.
Safety StockHow much inventory to set aside and not factor into the available quantity that can be fulfilled. You can configure Safety Stock values to be automatically set across UPC-Location records with the Safety Stock Rules feature.
ExcessThe inventory quantity available above the defined Excess Inventory Threshold. This is a calculated value based on the formula: Available minus Excess Inventory Threshold. Excess is never negative and only considers current available inventory, not incoming or future inventory.
Excess Inventory ThresholdThe absolute maximum desired Available inventory for a given UPC at a specific Location. Any Available quantity above this threshold is considered Excess.
FutureThe projected inventory you will receive within a certain time frame. This must be enabled via site settings, but is not currently displayed in the inventory table. See Future Inventory for more details about how it is used.

Inventory Calculations

It’s important to understand how inventory quantities are calculated while you are refreshing and adjusting inventory levels. The inclusion or exclusion of Safety Stock affects the total On Hand and Available inventory calculations. If Safety Stock is not included, then those values are calculated as follows:
  • On Hand = Allocated + Available + Pending
  • Available = On Hand – Allocated – Pending
If Safety Stock is included, then the calculations are:
  • On Hand = (Allocated + Available + Pending) – Safety Stock
  • Available = (On Hand – Allocated – Pending) – Safety Stock
When an Excess Inventory Threshold is defined, below calculations are applied on Excess field:
  • Excess = max(0, Available – Excess Inventory Threshold)
Excess is always calculated using current Available inventory only (future or incoming inventory is not included). You can update inventory levels via the Inventory UI, the Refresh and Adjust APIs, or the file import process. By default, the quantity provided in the APIs or file import will be used as the On Hand value and the system will calculate the appropriate Available amount. If you want to change this behavior so that quantity is applied directly as the Available inventory value, contact Kibo Support to update your tenant configurations. This behavior also applies to updating segmented and granular inventory levels.

Updating Available Inventory Directly

When the Update Available Inventory Directly tenant attribute is enabled, the same inventory calculations described above still apply, but they run in reverse: the system treats your quantity as the Available value and derives On Hand from it (using the existing Allocated and Pending quantities), instead of treating quantity as On Hand and deriving Available. On Hand is never reduced below zero—any deficit is tracked as a shortage and reconciled automatically as stock becomes available. Negative quantity values are also permitted in this mode, allowing you to explicitly reduce Available stock. The same quantity field is reused for both modes; no new fields are introduced. This is a tenant-level setting that applies to all Refresh and Adjust API calls and file imports for the tenant—it cannot be set on a per-request basis.

Enabling or reverting the setting

  • When it takes effect: Once Kibo Support updates the setting, it applies to all subsequent writes and may take a few minutes to take effect across the tenant. No deployment, restart, or downtime is required.
  • Enabling before go-live: Enabling the setting does not modify existing inventory records on its own. If you enable it before any order placement or allocation activity, no inventory data reset or normalization is required—the first full Refresh after the setting is enabled produces correct values. With no allocations, On Hand and Available will be equal on that first write.