Skip to content
v0.3

read.availability_by_skus

Available units for a batch of skus in one warehouse (comma-separated sku_ids, at most 100 per call), one row per requested sku id in the order asked. Public sees available only and is scoped to the store’s published assortment — a sku whose product this store does not publish answers 0, in its place, never as a missing row; internal also sees on_hand/reserved, tenant-wide. Over the ceiling is an error, never a truncated answer — page in batches.

  • Surface: GET /v1/read/availability_by_skus · CLI forge read availability_by_skus · MCP tool read.availability_by_skus
  • Auth: public (no actor; store resolves the tenant)
{
"properties": {
"sku_ids": {
"type": "string"
},
"store": {
"minLength": 1,
"type": "string"
},
"warehouse_id": {
"type": "string"
}
},
"type": "object"
}

Open (unknown) — this capability does not declare an output schema.

validation_failed (400) · not_found (404)