Warehouse - Stats

Retrieve warehouse statistics including item counts and inventory totals.

GET /warehouse/stats

Warehouse - Stats

cURL

curl --request GET \
  --url https://api.skulabs.com/warehouse/stats \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "on_hand": 123,
    "sku_count": 123,
    "skus_available": 123,
    "pct_available": 123,
    "summary": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

warehouse_id · string

Warehouse ID to filter stats for a single warehouse

Example:

"507f1f77bcf86cd799439011"

with_locations · boolean

Group stats by location instead of warehouse

Response

200

application/json

Array of warehouse (or location) statistics from aggregation

_id · string · required

Warehouse ID (or location ID when with_locations is true)

Example:

"507f1f77bcf86cd799439011"

on_hand · number · required

Total on-hand quantity across all SKUs

sku_count · number · required

Total number of distinct SKUs

skus_available · number · required

Number of SKUs with on_hand greater than zero

pct_available · number · required

Percentage of SKUs in stock (0-100)

summary · string · required

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