Skip to main content
Documentation

Quotes

quotes.list_lines

List the priced lines on a quote
Read-onlyRead budget

REST

Shipping
POST /api/v1/quotes/list_lines

MCP tool

Live
quotes.list_lines

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

Operating contract

Each line's description, quantity, unit, unit price, discount and line total — the itemisation the customer sees.

COST AND MARGIN ARE NOT PUBLISHED HERE. What the shop paid is not part of what it offered, and a line's cost reaching a surface that quotes a customer is the one mistake in this domain that cannot be taken back.

TRUNCATION: total_count is the exact number of lines and omitted is how many are not in this response. A packaged job runs to dozens of lines, so never summarise 'what is on this quote' from a response whose omitted is not 0.

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.

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

When `omitted` is not 0 there are more lines on this quote. Call again with `offset` set to `next_offset`.

Input

FieldTypeDescription
quote_idrequiredstringuuid

The quote to itemise, as returned by quotes.list or quotes.get.

limitinteger1–100

How many lines to return, 1-100. Defaults to 50.

Default: 50
offsetintegermin 0

How many to skip. Pass the previous response's next_offset to continue.

Default: 0

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].descriptionstring

items[].quantitynumber

items[].unitstring

items[].unit_pricenumber

items[].discountnumber

items[].line_totalnumber | null

items[].taxableboolean

total_countnumber

omittednumber

next_offsetnumber | 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/quotes/list_lines \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quote_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20","limit":50,"offset":0}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/quotes/list_lines", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "quote_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "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;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/quotes/list_lines",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "quote_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
    "limit": 50,
    "offset": 0
},
    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": "quotes.list_lines",
    "arguments": {
      "quote_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20",
      "limit": 50,
      "offset": 0
    }
  }
}

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