warehouse

Warehouse - Stats

Changed on

Retrieve warehouse statistics including item counts and inventory totals.

get/warehouse/stats

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/warehouse/stats
  • Auth
    HTTP bearer

Query parameters

warehouse_idstring

Warehouse ID to filter stats for a single warehouse

Example:507f1f77bcf86cd799439011
with_locationsboolean

Group stats by location instead of warehouse

Response

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"

Example response

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

Changes

  • fa53dd949b8eRevision changes
    • breaking

      for the query request parameter with_locations, the type changed from string to boolean

    • info

      api operation id get_warehouse_stats was added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 08cd9cfa14ddRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status