Skip to content

Inventory Management ​

The Inventory system tracks stock levels for your products across one or more warehouses. It is the single source of truth for stock availability in Product V2.

How It Fits In ​

Product V2
  └── ProductSku (for VARIABLE products)
        └── Inventory record (per warehouse)
              └── Warehouse
  • SIMPLE / DIGITAL products → one inventory record per warehouse (linked at the product level).
  • VARIABLE products → one inventory record per SKU per warehouse.
  • BUNDLE products → no inventory records (a bundle is composed of other products; stock is tracked at the component level).

Stock Quantities ​

FieldDescription
onHandQtyTotal units physically in stock.
reservedQtyUnits held for pending orders (not yet shipped).
availableQtyUnits available for purchase. Computed as onHandQty − reservedQty.

Endpoints ​

EndpointMethodPathDescription
List & Query InventoryGET/v1/inventoryList store inventory records
Get Inventory RecordGET/v1/inventory/{id}Record details, logs, and batches
Storefront StockGET/v1/inventory/product/{id}/storefrontPublic real-time available stock
Adjust StockPATCH/v1/inventory/{id}/adjustIncrease or decrease stock quantity
Physical Stock CountPATCH/v1/inventory/{id}/countAudit and record physical stock count
Reserve & Release StockPATCH/v1/inventory/{id}/reserveHold or release stock for orders
Low Stock AlertsGET/v1/inventory/low-stockList items below reorder threshold
Inventory LogsGET/v1/inventory/logsAudit trail of all stock movements
Create Inventory RecordPOST/v1/inventoryManual inventory creation

Build with joy