Skip to main content
Documentation

Inventory

inventory.rolls

List the film rolls on the shelf and how much is left on each
Read-onlyRead budget

REST

Shipping
POST /api/v1/inventory/rolls

MCP tool

Live
inventory.rolls

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

Operating contract

Every roll the shop is holding, with the feet remaining on it, what it cost per foot, where it is stored and what condition it is in.

status is DERIVED from what is left, not typed in: depleted at zero, low under a fifth of the roll's original length, otherwise in_stock. quarantined is the exception — it is set by hand, never cleared automatically, and it means somebody found a problem with that roll. Do not plan work onto a quarantined roll.

length_remaining_ft is the number that matters for 'can we do this job'. length_total_ft is what the roll was when it arrived, and the ratio of the two is what status reads.

sku is the product — brand, line, finish and width. Two rolls of the same SKU are interchangeable; two rolls of different widths usually are not, because a 60-inch panel cannot be cut from a 48-inch roll.

Depleted rolls are left off by default, because they are not stock. Ask for them when the question is about history.

TRUNCATION: total is the exact number of matching rolls and omitted is how many are not in this response. When omitted is not 0, call again with offset set to next_offset — never tell a shop what it has in stock from a truncated list.

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.

Partial answers

omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. Continue with next_offset.

Do not summarise from a truncated response

When `omitted` is not 0 there are more rolls on the shelf than came back. Call again with `offset` set to `next_offset` before reporting what the shop has.

Input

FieldTypeDescription
statusstring

One roll status — in_stock, low, depleted or quarantined.

One of: in_stock, low, depleted, quarantined
sku_codestringmax 80 chars

One product code, as returned by inventory.skus.

include_depletedboolean

True also returns finished rolls. Defaults to false.

limitinteger1–200

How many rolls to return, 1-200. Defaults to 50.

Default: 50
offsetintegermin 0

How many to skip. Pass the previous response's next_offset to continue.

Default: 0

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].roll_codestring | null

items[].sku_codestring | null

items[].sku_namestring | null

items[].width_innumber | null

items[].length_total_ftnumber

items[].length_remaining_ftnumber

items[].cost_per_ftnumber

items[].statusstring

items[].location_notestring | null

items[].received_atstring | null

totalnumber

omittednumber

next_offsetnumber | null

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/rolls \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":50,"offset":0}'

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

// 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/rolls",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 50,
    "offset": 0
},
    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.rolls",
    "arguments": {
      "limit": 50,
      "offset": 0
    }
  }
}

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.