Get Storefront

Full public storefront payload for a subdomain — catalog bootstrap for Vite themes and storefront refresh. Click Try it to call the live API from this page.

string

required

Vendor storefront subdomain (e.g. acme).

Response `200`

{
  "store": {
    "id": "…",
    "name": "Acme",
    "subdomain": "acme",
    "currency": "USD",
    "hasActiveCoupons": false
  },
  "stats": {
    "averageRating": 4.8,
    "feedbackCount": 12,
    "productsSold": 400,
    "totalCustomers": 210
  },
  "products": [],
  "groups": [],
  "feedback": [],
  "categories": []
}

Product object

Field	Type	Notes
`id`	string	Product CUID
`slug`	string	URL slug
`name`	string
`price`	number
`stock`	number	`-1` = unlimited
`variants`	array?	`{ id, label, price, stock }`

Errors

404 when subdomain missing or store banned:

{ "error": "Store not found" }

Caching

Server revalidate 60s. Response Cache-Control: private, no-cache, no-store, must-revalidate.

⌘I

API Documentation

Reference

Analytics

Catalog

Checkout

Orders

Webhooks

Dashboard APIs

Response `200`

Product object

Errors

Caching

​Response 200

​Product object

​Errors

​Caching

Response `200`

Product object

Errors

Caching