Endpoint catalog
The REST resources exposed under /api/v1, grouped by domain.
Every resource lives under /api/v1 on the store’s domain, returns the
standard envelope, and requires an authorized
API key or session scoped to the matching permission.
This is the resource map; field-level detail is per resource Paths and grouping below are authoritative, and every response follows the conventions (envelope, pagination, errors). For field-by-field detail on the most-integrated resources, see the reference pages: Products, Orders, and Customers. Access to each resource is gated by the permission that matches it.
Catalog & content
| Resource | Base path |
|---|---|
| Products | /api/v1/products |
| Categories | /api/v1/categories |
| Metafields (custom data) | /api/v1/metafields |
| Blog | /api/v1/blog |
| CMS pages | /api/v1/pages |
| Media / images | /api/v1/images |
| Product feeds | /api/v1/feeds |
| Redirects | /api/v1/redirects |
Orders, fulfillment & money
| Resource | Base path |
|---|---|
| Orders | /api/v1/orders |
| Refunds | /api/v1/refunds |
| Invoices | /api/v1/invoices |
| Inventory | /api/v1/inventory |
| Locations | /api/v1/locations |
| Shipping & zones | /api/v1/shipping, /api/v1/shipping/zones |
| Payment gateways | /api/v1/payments/gateways |
| Tax rates | /api/v1/tax-rates |
| COD settlements | /api/v1/cod-settlements |
| POS | /api/v1/pos |
Customers & storefront
| Resource | Base path |
|---|---|
| Customers | /api/v1/customer |
| Cart | /api/v1/cart |
| Wishlist | /api/v1/wishlist |
| Reviews | /api/v1/reviews |
| Store credit | /api/v1/store-credit |
| Storefront read APIs | /api/v1/store/* (bundles, loyalty, gift-cards, downloads, recommendations, back-in-stock, …) |
Marketing
| Resource | Base path |
|---|---|
| Coupons | /api/v1/coupons |
| Campaigns | /api/v1/marketing/campaigns |
| Bundles & offers | /api/v1/marketing/bundles |
| Loyalty | /api/v1/marketing/loyalty |
| Gift cards | /api/v1/marketing/gift-cards |
| Affiliates | /api/v1/marketing/affiliates |
| Newsletter | /api/v1/marketing/newsletter |
| Messaging (WhatsApp/SMS) | /api/v1/marketing/messaging |
| Recommendations | /api/v1/marketing/recommendations |
| Pixels | /api/v1/pixels |
Store administration
| Resource | Base path |
|---|---|
| Auth | /api/v1/auth |
| API keys | /api/v1/api-keys |
| Managers & roles | /api/v1/managers, /api/v1/roles |
| Themes (marketplace) | /api/v1/themes |
| Tenant themes (installs, files, publish) | /api/v1/tenant-themes |
| Store settings | /api/v1/tenants, /api/v1/branding |
| Domains | /api/v1/domain |
| Reports & analytics | /api/v1/reports, /api/v1/analytics |
| Audit log | /api/v1/audit |
| Webhooks | /api/v1/webhooks |
| Import / migration | /api/v1/import |
| Integrations | /api/v1/integrations |
AI
| Resource | Base path |
|---|---|
| AI store manager | /api/v1/ai |
Theme code over the API
The CLI drives /api/v1/tenant-themes — listing files,
reading/writing a file (with optimistic locking), and publishing. A Theme
Access key can use those, but owner-only actions on the same resource
(activate, purchase, delete) return 403.