Build with ZeroShop
The official guide to themes, the API, and the MCP server.
Guides
Getting Started
Create a PAT and make your first API call
Read guideAuthentication
PATs, JWT sessions, and OAuth for MCP
Read guidePagination & Filtering
Navigate paginated responses and filter results
Read guideRate Limiting & Idempotency
Understand rate limits and safely retry requests
Read guideError Handling
Handle errors and HTTP status codes
Read guideWebhooks
Receive real-time notifications via Stripe webhooks
Read guideCommon Workflows
Step-by-step guides for common API tasks
Read guideMCP Integration
Connect your shop to AI assistants via MCP
Read guideAPI Reference
Products
Create, update, and manage products, variants, images, and digital files
View endpointsCategories
Organize products into categories with facets and ordering
View endpointsProduct Series
Curate ordered collections of products with translations and hero media
View endpointsOrders
View and manage orders, update status, tracking, and shipments
View endpointsInternal Order Statuses
Define a private fulfilment-status pipeline and assign it to orders
View endpointsOrder Checklists
Define fulfilment checklist items and tick them off per order
View endpointsCheckout Agreements
Configure required checkout consent checkboxes and checkout settings
View endpointsInquiries
Triage buyer inquiries from inquiry-type products and track status
View endpointsProduct Reviews
Moderate buyer star ratings, publish or reject reviews, and post replies
View endpointsCustomers
View customer profiles and order history
View endpointsShipping
Configure shipping zones, rates, methods, providers, and per-zip overrides
View endpointsPickup Locations
Manage in-store pickup addresses offered at checkout
View endpointsTax
Set up tax classes, zones, and rates
View endpointsVouchers
Create and manage discount vouchers
View endpointsDiscount Groups
Group B2B customers and apply automatic percentage discounts
View endpointsTemplates
Customize storefront templates and preview changes
View endpointsThemes
Manage themes, theme templates, and email templates
View endpointsTranslations
Manage storefront and content translations
View endpointsMedia
Upload and manage media library files
View endpointsPages
Create and manage custom storefront pages
View endpointsOptions
Manage product options like Size and Color
View endpointsCustom Fields
Define custom data fields for products
View endpointsInvoices
Configure PDF invoice branding and regenerate invoices
View endpointsCommission
Track platform commission owed and settle it via Stripe checkout
View endpointsTenant Tier
Preview vs Live tier, resource caps, and Stripe-triggered promotion
View endpointsAI Assistant
Manage OpenRouter keys, conversations, and MCP tool execution
View endpointsAI Tasks
AI-authored, sandboxed JS scripts that automate admin work
View endpointsRedirect Rules
Intercept storefront 404s with priority-ordered glob redirects
View endpoints404 Log
Capture storefront 404s, triage them, and map them to redirect rules
View endpointsAccess Groups
Gate digital files and pages behind product purchases, subscriptions, or manual grants
View endpointsSettings
Shop settings, integrations, domain, SMTP
View endpointsTeam & Roles
Manage team members, roles, and permissions
View endpointsNotifications
Notifications, logs, dashboard metrics, and per-user email prefs
View endpointsCan't find what you're looking for?
Email our support team — we read every message and usually reply within a business day.
support@zeroshop.io