API

Stock

Returns stock levels per SKU per warehouse. Use it when you need per-warehouse detail; for a single summed number per SKU across your own warehouses, see stock export instead.

Endpoint

GET https://vintrhall.com/api/v1/stock
curl -H "Authorization: Bearer vh_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  "https://vintrhall.com/api/v1/stock?warehouse=WH1&limit=100"

Query parameters

ParameterDescription
skuReturn only stock for this SKU.
warehouseWarehouse code, as returned by the warehouses endpoint.
cursorPagination cursor from a previous response.
limitPage size, default 100, maximum 200.

Response

{
  "items": [
    {
      "sku": "TSH-BLK-M",
      "warehouse": "WH1",
      "qty": 14,
      "physicalQty": 18,
      "updatedAt": "2026-07-11T08:02:00.000Z"
    }
  ],
  "nextCursor": null
}
  • qty is the available quantity: physical stock minus active reservations.
  • physicalQty is the raw physical count. It is null when the underlying source does not distinguish physical from available stock.