API Reference

Complete reference for the ZeroShop Admin API. All endpoints require authentication via Personal Access Token or JWT session.

Base URL

https://yourshop.zeroshop.io/admin/api

Products

Create, update, and manage products, variants, images, and digital files

Categories

Organize products into categories with facets and ordering

Product Series

Curate ordered collections of products with translations and hero media

Orders

View and manage orders, update status, tracking, and shipments

Internal Order Statuses

Define a private fulfilment-status pipeline and assign it to orders

Order Checklists

Define fulfilment checklist items and tick them off per order

Checkout Agreements

Configure required checkout consent checkboxes and checkout settings

Inquiries

Triage buyer inquiries from inquiry-type products and track status

Product Reviews

Moderate buyer star ratings, publish or reject reviews, and post replies

Customers

View customer profiles and order history

Shipping

Configure shipping zones, rates, methods, providers, and per-zip overrides

Pickup Locations

Manage in-store pickup addresses offered at checkout

Tax

Set up tax classes, zones, and rates

Vouchers

Create and manage discount vouchers

Discount Groups

Group B2B customers and apply automatic percentage discounts

Templates

Customize storefront templates and preview changes

Themes

Manage themes, theme templates, and email templates

Translations

Manage storefront and content translations

Media

Upload and manage media library files

Pages

Create and manage custom storefront pages

Options

Manage product options like Size and Color

Custom Fields

Define custom data fields for products

Invoices

Configure PDF invoice branding and regenerate invoices

Commission

Track platform commission owed and settle it via Stripe checkout

Tenant Tier

Preview vs Live tier, resource caps, and Stripe-triggered promotion

AI Assistant

Manage OpenRouter keys, conversations, and MCP tool execution

AI Tasks

AI-authored, sandboxed JS scripts that automate admin work

Redirect Rules

Intercept storefront 404s with priority-ordered glob redirects

404 Log

Capture storefront 404s, triage them, and map them to redirect rules

Access Groups

Gate digital files and pages behind product purchases, subscriptions, or manual grants

Settings

Shop settings, integrations, domain, SMTP

Team & Roles

Manage team members, roles, and permissions

Notifications

Notifications, logs, dashboard metrics, and per-user email prefs

We value your privacy

We use cookies for essential site functionality and, with your consent, analytics to understand how our platform is used. No personal data is shared with third parties. See our Privacy Policy for details.