shop.setup_progress

Check how far this shop is through setting itself up

Read-onlyRead budget

REST

Shipping

POST /api/v1/shop/setup_progress

MCP tool

Live

shop.setup_progress

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

Operating contract

WHAT IS STILL MISSING BEFORE THE PRODUCT WORKS PROPERLY FOR THIS SHOP, phase by phase, with the exact next steps.

MAKE THIS READ WHEN SOMETHING 'DOES NOT WORK'. A shop with no bays gets an empty availability grid, one with no price tiers gets quotes that will not price, and one that never connected texting gets automations that appear to run and send nothing. Every one of those reads as a broken product and is a setup step.

next_steps IS THE ANSWER TO GIVE — the next three unresolved steps in walkthrough order, each with why in the product's own words. Reading out the whole list instead is how an owner closes the page.

ai_coverable MARKS THE ONES THE SETUP ASSISTANT COULD DO IN ONE RUN, which is usually the fastest thing to offer. Running it is a person pressing a button on /setup — it writes real settings.

status: skipped IS A DECISION, NOT A GAP. The owner said no to that step. Do not put it back in front of them as though it were outstanding.

manually_done: true means somebody TICKED it rather than the product detecting it. Treat those more carefully than detected steps — a ticked box is a claim, and a detected one is a fact.

pct counts done AND skipped as resolved, which is why a shop can reach 100% with steps it deliberately declined.

The whole guide is returned, so nothing is truncated.

Who may call it

Permission: shop.manageThe caller must hold shop.manage 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
todo_only	boolean	True returns only the unresolved steps — no done, no skipped.

Output

Field	Type	Description
pct	number	—
total	number	—
resolved	number	—
done_count	number	—
skipped_count	number	—
complete	boolean	—
next_steps	object[]	—
next_steps[].key	string	—
next_steps[].title	string	—
next_steps[].why	string	—
next_steps[].ai_setup	boolean	—
ai_coverable	string[]	—
phases	object[]	—
phases[].key	string	—
phases[].title	string	—
phases[].done_count	number	—
phases[].steps	object[]	—
phases[].steps[].key	string	—
phases[].steps[].title	string	—
phases[].steps[].why	string	—
phases[].steps[].status	string	—
phases[].steps[].optional	boolean	—
phases[].steps[].ai_setup	boolean	—
phases[].steps[].manually_done	boolean	—
phases[].steps[].detail	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.

curl

export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/shop/setup_progress \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)

const res = await fetch("https://www.servicevin.com/api/v1/shop/setup_progress", {
  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;

Python (requests)

import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/shop/setup_progress",
    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"]

MCP tools/call — https://www.servicevin.com/api/mcp

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "shop.setup_progress",
    "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 shop.manage.
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.

Operating contract#

Who may call it#

Input#

Output#

Examples#