Documentation
Inventory
inventory.remnants
REST
ShippingPOST /api/v1/inventory/remnantsMCP tool
Liveinventory.remnantsExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Inventory domain.
Operating contract
The pieces of film left over from previous jobs that are big enough to use again. A shop that forgets these buys film it already has, and a shop that plans around one that was scrapped runs short mid-job.
status says whether a piece is actually available: available is on the shelf and free, reserved is spoken for by a job, used is gone, and scrapped is thrown away. Only available is stock, and it is the default filter.
length_ft and width_in TOGETHER decide whether a remnant can do a job. A 40-foot piece 24 inches wide will not cover a hood, and a length alone is not an answer.
parent_film_roll_id is the roll it was cut from, which is how a remnant's product and cost are traced.
READ ONLY. Reserving, using or scrapping a remnant is a claim about a physical piece of film somebody is holding.
TRUNCATION: total is the exact number of matching remnants and omitted is how many are not here. When omitted is not 0, page on before concluding the shop has nothing that fits.
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
Input
| Field | Type | Description |
|---|---|---|
| available_only | boolean | True returns only remnants that are free to use. Defaults to true. Default:true |
| min_length_ft | number0–10000 | Only remnants at least this long, in feet. |
| limit | integer1–200 | How many remnants to return, 1-200. Defaults to 50. Default:50 |
| offset | integermin 0 | How many to skip. Pass the previous response's next_offset to continue. Default:0 |
Output
| Field | Type | Description |
|---|---|---|
| items | object[] | — |
| items[].id | string | — |
| items[].material_sku_id | string | — |
| items[].parent_film_roll_id | string | null | — |
| items[].length_ft | number | — |
| items[].width_in | number | null | — |
| items[].cost_per_ft | number | — |
| items[].status | string | — |
| items[].location_note | string | null | — |
| total | number | — |
| omitted | number | — |
| next_offset | number | 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.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/inventory/remnants \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"available_only":true,"limit":50,"offset":0}'const res = await fetch("https://www.servicevin.com/api/v1/inventory/remnants", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"available_only": true,
"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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/inventory/remnants",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"available_only": True,
"limit": 50,
"offset": 0
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["code"])
data = payload["data"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "inventory.remnants",
"arguments": {
"available_only": true,
"limit": 50,
"offset": 0
}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold inventory.access. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many read calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |