Documentation
Inventory
inventory.consumption
REST
ShippingPOST /api/v1/inventory/consumptionMCP tool
Liveinventory.consumptionExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Inventory domain.
Operating contract
The consumption ledger: every time film left a roll, how much, what it cost at that moment, and why.
reason is the important column and it is not all the same thing. job is film that went onto a car and was billed for. waste is film that was cut wrong — it is the number a shop wants trended, because it is pure loss. remnant_cut is an offcut that went back on the shelf as a usable piece. adjustment, return and transfer are bookkeeping.
cost_at_consumption is what that film cost at the time it was used, not today's cost. That is what makes a job's material cost accurate months later, and it is why re-deriving cost from the current SKU price gives a different and wrong answer.
Filter by job_id to answer 'what did this job cost us in film'. Filter by reason: waste over a period to answer 'how much are we throwing away'.
APPEND-ONLY. A consumption row is a record of something that happened and nothing in this registry edits or removes one. A mistake is corrected by a further row with an adjustment reason, entered by somebody at the rack.
TRUNCATION: total is the exact number of matching rows and omitted is how many are not here. When omitted is not 0, narrow the window or page on — a waste figure from a truncated ledger is an understatement, which is the wrong direction to be wrong in.
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 |
|---|---|---|
| job_id | stringuuid | One job's id, as returned by jobs.list — what that job took off the shelf. |
| reason | string | One reason — job, waste, return, adjustment, remnant_cut or transfer. One of:job, waste, return, adjustment, remnant_cut, transfer |
| since | string | Only rows from this date onward, YYYY-MM-DD. |
| until | string | Only rows up to this date, YYYY-MM-DD, inclusive. |
| limit | integer1–200 | How many rows 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[].film_roll_id | string | — |
| items[].job_id | string | null | — |
| items[].consumed_ft | number | — |
| items[].cost_at_consumption | number | — |
| items[].reason | string | — |
| items[].created_at | string | — |
| total | number | — |
| omitted | number | — |
| next_offset | number | null | — |
| consumed_ft_on_page | number | — |
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/consumption \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"limit":50,"offset":0}'const res = await fetch("https://www.servicevin.com/api/v1/inventory/consumption", {
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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/inventory/consumption",
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"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "inventory.consumption",
"arguments": {
"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. |