read.availability

Available units for a (warehouse, sku). Public sees available only, scoped to the store’s published assortment — a sku whose product this store does not publish answers 0; internal also sees on_hand/reserved, tenant-wide.

• Surface: GET /v1/read/availability · CLI forge read availability · MCP tool read.availability
• Auth: public (no actor; store resolves the tenant)

Params (JSON Schema)

{
  "properties": {
    "sku_id": {
      "minLength": 1,
      "type": "string"
    },
    "store": {
      "minLength": 1,
      "type": "string"
    },
    "warehouse_id": {
      "type": "string"
    }
  },
  "required": [
    "sku_id"
  ],
  "type": "object"
}

Result (200)

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

Errors

validation_failed (400) · not_found (404)