Skip to main content
Documentation

Shop

shop.profile

Read the shop's name, timezone, currency, address and booking link
Read-onlyRead budget

REST

Shipping
POST /api/v1/shop/profile

MCP tool

Live
shop.profile

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

Operating contract

The business's own facts: display name, postal address, phone, email, the CURRENCY every price in this shop is denominated in, and the TIMEZONE every date and time is expressed in.

READ THIS BEFORE ANSWERING ANYTHING WITH A DATE OR A PRICE IN IT. scheduling.calendar takes civil dates in this timezone; jobs.get returns instants that only mean something once converted to it; quotes.catalog returns numbers with no currency symbol on them. Guessing any of the three produces an answer that looks right and is wrong.

booking_slug is the shop's storefront handle and online_booking says whether that storefront is switched on. When it is off, no booking link exists to hand a customer.

No arguments, no cost — the shop row is already loaded for every call.

Who may call it

Permission
NoneThe shop's own name, hours, address and currency. Every one of these is already on the public storefront, and every other capability's answer is uninterpretable without the timezone and the currency — gating it behind a section would make a receptionist's job read return times they could not convert.
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

FieldTypeDescription
idstring

namestring

timezonestring

currencystring

phonestring | null

emailstring | null

addressstring | null

citystring | null

regionstring | null

postal_codestring | null

booking_slugstring | null

online_bookingboolean

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/profile \
  -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/profile", {
  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/profile",
    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.profile",
    "arguments": {}
  }
}

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