Documentation
Service VIN developer & AI platformGetting startedAuthenticationPaginationIdempotencyRate limitsErrorsWebhooks & signature verificationConnecting ClaudeRecipesMCP servers & the Claude connectorREST resource referenceCapability indexCustomers capabilitiesVehicles capabilitiesLeads capabilitiesWarranties capabilitiesQuotes capabilitiesInvoices capabilitiesPayments capabilitiesServices capabilitiesJobs capabilitiesCalendar capabilitiesScheduling capabilitiesStaff capabilitiesInventory capabilitiesComms capabilitiesTasks capabilitiesShop capabilitiesDocuments capabilitiesKnowledge capabilitiesReports capabilitiesBooking capabilitiesForms capabilitiesMarketing capabilitiesReviews capabilitiesAutomations capabilitiesIntegrations capabilitiesChangelogSearch
Domain
Shop capabilities
11 capabilities, all acting on a shop. A reference to one from another domain is spelled
shop_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.| Capability | What it does | Effect |
|---|---|---|
| shop.profilePOST /api/v1/shop/profile | Read the shop's name, timezone, currency, address and booking link | read-only |
| shop.playbookPOST /api/v1/shop/playbook | Read the shop's own playbook for one of its AI agents | read-only |
| shop.business_hoursPOST /api/v1/shop/business_hours | Read the days and hours this shop is open for work | read-only |
| shop.booking_configPOST /api/v1/shop/booking_config | Read how this shop takes bookings, deposits and approvals | read-only |
| shop.brandingPOST /api/v1/shop/branding | Read the shop's logo and accent colour as customers see them | read-only |
| shop.locationsPOST /api/v1/shop/locations | List the other locations in this shop's organization | read-only |
| shop.agentsPOST /api/v1/shop/agents | List this shop's AI agents, which are on and how they send | read-only |
| shop.messaging_configPOST /api/v1/shop/messaging_config | Read whether the shop may text, and inside which hours | read-only |
| shop.planPOST /api/v1/shop/plan | Read the shop's plan, trial state and what it includes | read-only |
| shop.ai_creditsPOST /api/v1/shop/ai_credits | Check how many AI credits this shop has left to spend | read-only |
| shop.setup_progressPOST /api/v1/shop/setup_progress | Check how far this shop is through setting itself up | read-only |