Skip to main content
Documentation

Inventory

inventory.stock_levels

Total the stock left per product across every roll on the shelf
Read-onlyRead budget

REST

Shipping
POST /api/v1/inventory/stock_levels

MCP tool

Live
inventory.stock_levels

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Inventory domain.

Operating contract

THE READ FOR 'ARE WE ABOUT TO RUN OUT'. One row per product, totalling what is left across all of its rolls, measured against the reorder level the shop set.

below_reorder: true is the finding. It means the shop's own threshold has been crossed, and the threshold is a judgement about lead times rather than a computed number — so this is the shop telling itself to order, not us guessing.

reorder_threshold: null means nobody set one, and then below_reorder is always false however empty the shelf is. Say that rather than reporting the product as healthy: it is unmonitored, which is a different and more useful thing to tell an owner.

quantity_remaining is in the product's own unit — read unit_label with it. roll_count is how many separate rolls that total is spread across, and it matters more than it looks: 40 feet across four short offcuts will not cover a job that needs 30 feet in one piece.

Quarantined rolls are counted in quarantined_quantity and excluded from quantity_remaining, because film somebody flagged is film you cannot plan on.

This walks every live roll in the shop and rolls it up per product, so nothing is truncated.

Who may call it

Permission
inventory.accessThe caller must hold Inventory at the ACT level. A read-only dashboard grant on the same section is refused.
Plan
Every planNo plan gate. Available on every Service VIN plan.
Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class
readCounted against the read budget — the widest of the four.

Input

FieldTypeDescription
below_reorder_onlyboolean

True returns only products that have crossed their reorder level.

Output

FieldTypeDescription
itemsobject[]

items[].sku_idstring

items[].sku_codestring

items[].namestring

items[].unit_labelstring

items[].quantity_remainingnumber

items[].quarantined_quantitynumber

items[].roll_countnumber

items[].reorder_thresholdnumber | null

items[].below_reorderboolean

below_reorder_countnumber

unmonitored_countnumber

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl
export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/inventory/stock_levels \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/inventory/stock_levels", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/inventory/stock_levels",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "inventory.stock_levels",
    "arguments": {}
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold inventory.access.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.