API

Stock export

A convenience endpoint that returns your available stock per SKU, summed across all warehouses marked as your own stock. Use it to feed an external order management system, a pricing tool, or any script that needs a single number per SKU without dealing with per-warehouse breakdown or pagination.

For authentication, see Authentication. This endpoint is a convenient shortcut: for the full per-warehouse breakdown, use /api/v1/stock instead.

Endpoint

GET https://vintrhall.com/api/v1/stock-export
curl -H "Authorization: Bearer vh_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  https://vintrhall.com/api/v1/stock-export

This endpoint has no query parameters and is not paginated: it always returns the full list in one response.

Response

{
  "items": [
    { "sku": "TSH-BLK-M", "qty": 14, "location": "A-03-2" },
    { "sku": "TSH-BLK-L", "qty": 3, "location": null }
  ],
  "generatedAt": "2026-07-11T12:00:00.000Z"
}

What the fields mean:

  • qty is the available quantity: physical stock minus active reservations.
  • Quantities are summed per SKU across all warehouses marked as your own stock. Supplier warehouses are excluded, so the export reflects what you can actually sell and ship yourself.
  • location is the primary rack code for the SKU: the location holding the largest quantity, excluding staging locations. null when the product has no rack assignment yet. Use it to print pick locations on order lines in an external OMS.
  • SKUs with no stock rows and no rack assignment are not included in the list. A product with a rack assignment but zero stock is included (qty: 0), so pick locations stay available for orders even when the item is temporarily sold out.

Rate limit

This endpoint has its own limit of 30 requests per minute per organization, separate from the shared 60/min limit on other endpoints.

The export is a snapshot, not a change feed. Polling every minute or two is more than enough for typical integrations, there is no benefit in requesting it more often than stock actually changes.