Documentation
Quotes
quotes.options
REST
ShippingPOST /api/v1/quotes/optionsMCP tool
Livequotes.optionsExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Quotes domain.
Operating contract
How this quote is BUILT AS A CHOICE rather than a number: which lines are grouped into a decision, whether the customer picks one or ticks any, and which combinations earn a bundle saving.
A QUOTE WITH OPTION GROUPS HAS NO SINGLE TOTAL, and reading its headline figure as the price is the mistake this capability exists to prevent. single means pick exactly one of these lines; multi means tick any of them. The total moves with what they pick.
bundles IS THE SHOP'S OWN UPSELL and it is worth saying out loud. 'Add the ceramic and 10% comes off the PPF' is a reason to say yes; a total that quietly includes the discount is not.
default_total is what the quote comes to on the selection the shop set as its default — the figure the customer sees before they touch anything. Quote it as the starting point, never as the price.
option_groups: [] means this is an ordinary quote with a fixed set of lines, and its total is simply its total.
One quote's structure, entirely returned, so nothing is truncated. The line detail itself is quotes.list_lines.
Who may call it
- Permission
quotes.accessThe caller must hold Quotes 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
| Field | Type | Description |
|---|---|---|
| quote_idrequired | stringuuid | The quote to read, as returned by quotes.list. |
Output
| Field | Type | Description |
|---|---|---|
| quote_id | string | — |
| has_options | boolean | — |
| option_groups | object[] | — |
| option_groups[].id | string | — |
| option_groups[].title | string | — |
| option_groups[].kind | string | — |
| option_groups[].line_ids | string[] | — |
| bundles | object[] | — |
| bundles[].id | string | — |
| bundles[].label | string | — |
| bundles[].percent | number | — |
| bundles[].trigger_line_ids | string[] | — |
| bundles[].target_line_ids | string[] | — |
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/quotes/options \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"quote_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'const res = await fetch("https://www.servicevin.com/api/v1/quotes/options", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"quote_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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/quotes/options",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"quote_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
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": "quotes.options",
"arguments": {
"quote_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.
| 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 quotes.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. |