Documentation
Inventory
inventory.valuation
REST
ShippingPOST /api/v1/inventory/valuationMCP tool
Liveinventory.valuationExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Inventory domain.
Operating contract
What the shop's stock is worth, at what it paid — the figure an accountant asks for at year end and the one an owner is surprised by.
AT COST, NEVER AT SELL. Each roll's remaining feet are valued at that roll's own recorded cost per foot, so a price rise between two purchases is reflected rather than averaged away. This is not what the film would fetch and it is not what it would be billed at.
by_product breaks the total down, biggest first, which is usually where the answer is: a shop is rarely surprised by its total and often surprised by how much of it is one line.
Quarantined film is counted separately in quarantined_value rather than in the total, because it is stock the shop cannot currently sell. Depleted rolls are worth nothing and are excluded.
This is a rollup over every live roll and reports the whole shelf, 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
This capability takes no arguments.
Output
| Field | Type | Description |
|---|---|---|
| currency | string | — |
| total_value | number | — |
| quarantined_value | number | — |
| roll_count | number | — |
| by_product | object[] | — |
| by_product[].sku_code | string | — |
| by_product[].name | string | — |
| by_product[].quantity_remaining | number | — |
| by_product[].value | 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/valuation \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://www.servicevin.com/api/v1/inventory/valuation", {
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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/inventory/valuation",
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"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "inventory.valuation",
"arguments": {}
}
}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. |