shop.booking_config

Read how this shop takes bookings, deposits and approvals

Read-onlyRead budget

REST

Shipping

POST /api/v1/shop/booking_config

MCP tool

Live

shop.booking_config

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

Operating contract

The commercial settings behind the shop's public booking page: whether it is open at all, what deposit it asks for, whether it reviews bookings before confirming them, and whether a customer may choose their installer.

enabled: false MEANS NOTHING CAN BE BOOKED ONLINE, whatever the availability grid would otherwise say. Check it before telling anybody to book.

approval_mode is the difference between a booking and a request. Under approval, a customer's slot is held and the shop says yes or no — so telling them they are 'booked' is wrong, and they will find out when the shop declines.

require_deposit with deposit_percent and deposit_flat is what a customer owes to hold the slot; the actual figure for a given service is booking.deposit_due, which applies the greater of the two against a real price.

deposit_hold_minutes is how long an unpaid booking is held before it releases automatically. It is why a booking taken and not paid for can vanish, and it is worth telling a customer.

custom_domain is the shop's own booking address when it has one. Quote that rather than the default when it is set — it is what their marketing points at.

One shop's settings, entirely 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

This capability takes no arguments.

Output

Field	Type	Description
enabled	boolean	—
approval_mode	string	—
require_deposit	boolean	—
deposit_percent	number	—
deposit_flat	number	—
deposit_hold_minutes	number	—
deposit_nudge_minutes	number	—
allow_installer_choice	boolean	—
custom_domain	string \| 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/shop/booking_config \
  -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/booking_config", {
  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/booking_config",
    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.booking_config",
    "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#