Documentation
Warranties
warranties.list
REST
ShippingPOST /api/v1/warranties/listMCP tool
Livewarranties.listExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Warranties domain.
Operating contract
The shop's register of cover it has sold, soonest expiry first — because the ones about to lapse are the ones anybody needs to act on.
status IS DERIVED AGAINST THE SHOP'S CALENDAR DAY, not read off a column. A warranty whose expiry passed last night is expired here whether or not the nightly sweep has caught up, which is the answer a customer standing at the counter needs.
The filter shortcuts are the questions people actually ask: active is still covered, expiring lapses within the next 60 days, expired has run out, closed was voided or claimed out.
days_to_expiry is negative once a warranty has lapsed and NULL for a lifetime warranty, which has no expiry at all. Null is not zero — do not report a lifetime warranty as expiring today.
q matches a warranty number ('W-42', '42'), a customer name, or a full 17-character VIN, and works out which you meant from the shape of what you typed.
Every id here is what warranties.certificate takes. customer_id is customers.get's, and job_id is jobs.get's.
TRUNCATION: total is the exact number of warranties matching the filter and omitted is how many are not in this response. When omitted is not 0, call again with page incremented — never tell a shop what is expiring from a truncated list, because the ones it has not seen are the ones it would have acted on.
Who may call it
- Permission
customers.accessThe caller must hold Customers 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 page.
Do not summarise from a truncated response
Input
| Field | Type | Description |
|---|---|---|
| filter | string | all, active, expiring (within 60 days), expired, or closed. Default:"all"One of: all, active, expiring, expired, closed |
| q | stringmax 120 chars | A warranty number, a customer name, or a full VIN. |
| customer_id | stringuuid | One customer's id, as returned by customers.list or customers.get. |
| job_id | stringuuid | One job's id, as returned by jobs.list — the cover issued off that work. |
| page | integer1–1000 | 1-based page number. Defaults to 1. Default:1 |
| limit | integer1–100 | How many warranties per page, 1-100. Defaults to 50. Default:50 |
Output
| Field | Type | Description |
|---|---|---|
| items | object[] | — |
| items[].id | string | — |
| items[].number | string | — |
| items[].type | string | — |
| items[].status | string | — |
| items[].coverage | string | null | — |
| items[].term_months | number | null | — |
| items[].starts_on | string | null | — |
| items[].expires_on | string | null | — |
| items[].days_to_expiry | number | null | — |
| items[].customer_id | string | — |
| items[].customer_name | string | — |
| items[].vehicle_id | string | null | — |
| items[].job_id | string | null | — |
| items[].invoice_id | string | null | — |
| items[].material | string | null | — |
| total | number | — |
| page | number | — |
| page_count | number | — |
| omitted | number | — |
| expiring_soon_days | 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/warranties/list \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"filter":"all","page":1,"limit":50}'const res = await fetch("https://www.servicevin.com/api/v1/warranties/list", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"filter": "all",
"page": 1,
"limit": 50
}),
});
// 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/warranties/list",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"filter": "all",
"page": 1,
"limit": 50
},
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": "warranties.list",
"arguments": {
"filter": "all",
"page": 1,
"limit": 50
}
}
}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 customers.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. |