Skip to main content
Documentation

Warranties

warranties.certificate

Read what one warranty certificate actually promises
Read-onlyRead budget

REST

Shipping
POST /api/v1/warranties/certificate

MCP tool

Live
warranties.certificate

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

Operating contract

WHAT THE PAPER SAYS. This is the view the printed certificate itself renders from, so a machine reading cover out loud and the document in the customer's glovebox cannot disagree — which is the whole reason to use this rather than assembling an answer from warranties.list.

coverage is the shop's own words about what is covered. Read them as written. Do not paraphrase a warranty's scope, do not add exclusions that are not there, and do not soften ones that are.

term_months: null prints as 'Lifetime' and means exactly that: no expiry.

validation is whether cover has actually STARTED. Some shops issue a warranty PROVISIONALLY, with cover beginning at a check-over appointment — validatesOn is when that falls due. A provisional warranty is not the same as an active one, and telling a customer they are covered when their certificate says otherwise is the failure this field exists to prevent. not_applicable is the common case and means the shop does not run check-overs at all.

display_number is formatted with the shop's own numbering, so it matches what is printed. Quote that, not the raw id.

This reads the certificate; it does not send it. Putting the document in front of the customer is a person's decision at /warranties/[id].

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.

Input

FieldTypeDescription
warranty_idrequiredstringuuid

The warranty's id, as returned by warranties.list or warranties.issue.

Output

FieldTypeDescription
warranty_idstring

display_numberstring

typestring

statusstring

validationstring

validates_onstring | null

coveragestring | null

term_monthsnumber | null

starts_onstring | null

expires_onstring | null

materialstring | null

job_numberstring | null

invoice_numberstring | 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/warranties/certificate \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"warranty_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/warranties/certificate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "warranty_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
  }),
});

// 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/warranties/certificate",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "warranty_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
    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": "warranties.certificate",
    "arguments": {
      "warranty_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
    }
  }
}

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 customers.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.