Skip to main content
Documentation

Inventory

inventory.skus

List the products the shop buys rolls and materials in
Read-onlyRead budget

REST

Shipping
POST /api/v1/inventory/skus

MCP tool

Live
inventory.skus

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

Operating contract

The catalogue of what this shop stocks — brand, product line, finish, width and unit — with the cost it expects to pay and, where it has one, the price it sells at.

sku_code is the shop's own code for a product and it is what inventory.rolls and inventory.stock_levels filter by. unit_of_measure decides what a quantity MEANS: linear_ft and sqft are film, each is a countable item, ml and oz are liquids. A number without its unit is not an answer.

reorder_threshold is the level at which this shop wants to be warned, in that unit. It is the shop's own judgement about lead times, not a computed figure, and a SKU with none set will never raise a low-stock warning however empty the shelf gets.

default_cost_per_unit is what the shop pays and is STAFF-ONLY. Never quote it to a customer — it is the input to every margin figure in the product.

Archived products are left off by default. They are things the shop stopped buying, and rolls of them may still be on the shelf.

TRUNCATION: total is the exact number of matching products and omitted is how many are not here. When omitted is not 0, call again with offset set to next_offset.

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 products in the catalogue. Call again with `offset` set to `next_offset`, or narrow `q`.

Input

FieldTypeDescription
qstringmax 120 chars

Part of a product name, brand or code.

include_archivedboolean

True also returns products the shop stopped buying. Defaults to false.

limitinteger1–200

How many products 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[].sku_codestring

items[].namestring

items[].brandstring | null

items[].product_linestring | null

items[].finishstring | null

items[].width_innumber | null

items[].unit_of_measurestring

items[].unit_labelstring

items[].default_cost_per_unitnumber

items[].default_sell_per_unitnumber | null

items[].reorder_thresholdnumber | null

items[].activeboolean

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/skus \
  -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/skus", {
  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/skus",
    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.skus",
    "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.