Updated 2026-06-01

Store API overview

The v1 Store API envelope, auth levels, versioning, and base URL.

The Store API is a RESTful developer API for reading and writing shop data — products, orders, customers, coupons, and taxonomy. It's secured by shop API keys with two auth levels.

Base URL & versioning

The Store API is mounted under /v1/store/. It's rate-limited to 120 requests per minute per shop. All responses are JSON.

Response envelope

Every Store API response wraps data in a consistent envelope:

json

{
  "data": { ... },
  "meta": {
    "shopSlug": "your-shop",
    "authLevel": "publishable"
  }
}

Auth levels

Field	Type	Description
read	level	Granted by the publishable key. All GET requests.
secret	level	Granted by the secret key. Required for POST, PATCH, DELETE. Enforced by requireSecretAuth.

Available resources

/me — shop metadata
/products — full CRUD
/orders — read, create, status, cancel
/customers — read, create, update
/coupons — read, validate, full CRUD
/categories — full CRUD
/collections — full CRUD
/brands — full CRUD

The /me endpoint

GET/v1/store/me

Shop metadata: id, name, slug, currency, domain, publishableClientKey, and permissions.

Publishable key

PreviousAPI keys NextStore API: Products