v1

latestOpenAPI 3.0.32026-07-13149852.3 MB

warehouse

Warehouse - Stats

Retrieve warehouse statistics including item counts and inventory totals.

get/warehouse/stats

warehouse_idstring

Warehouse ID to filter stats for a single warehouse

Example:507f1f77bcf86cd799439011

with_locationsboolean

Group stats by location instead of warehouse

Array of warehouse (or location) statistics from aggregation

_idstring required

Warehouse ID (or location ID when with_locations is true)

on_handnumber required

Total on-hand quantity across all SKUs

sku_countnumber required

Total number of distinct SKUs

skus_availablenumber required

Number of SKUs with on_hand greater than zero

pct_availablenumber required

Percentage of SKUs in stock (0-100)

summarystring required

Human-readable summary, e.g. "1.2k skus, 85% in stock"

[
  {
    "_id": "507f1f77bcf86cd799439011"
  }
]