STOQ Docs

Preorders & back-in-stock for Shopify. Pick your path below, or browse a section from the top nav.

How do I integrate?

Headless or Hydrogen storefront (SDK · Beta)

Build on the JavaScript SDK — a typed client plus React hooks for Hydrogen. Install once and ship notify-me and preorder widgets.

Themed store with the STOQ app

Already running the app's theme embed? Customize with the on-page JavaScript API, custom events, and theme metafields — no SDK required.

Server / backend integration

Manage signups, selling plans, and variants over REST with API v1 — or the action-driven, AI-native API v2 (Beta).

AI agent (MCP · Beta)

Drive STOQ from an agent — every v2 action is exposed as an MCP tool.

Quickstart

1. Get your API key

In the STOQ app, go to Settings → Integrations → API Key and copy the key. Send it in the X-Auth-Token header on every request — keep it secret.

Warning

Never expose your API key in browser/client code. For storefronts, the JavaScript SDK authenticates with your shop's public Storefront API token instead.

2. Make your first call

Create a back-in-stock signup — the one public endpoint (no key; identified by the shop domain):

curl -X POST https://app.stoqapp.com/api/v1/intents.json \
  -H "Content-Type: application/json" \
  -H "X-Shopify-Shop-Domain: my-store.myshopify.com" \
  -d '{ "intent": { "email": "shopper@example.com", "variant_id": 43900910010503 } }'

List your preorder offers with the action-driven v2 API (uses your key):

curl https://app.stoqapp.com/api/v2/external/preorders/offers \
  -H "X-Auth-Token: $STOQ_API_KEY"

That's it. From here, follow your path above — or see API Key and Rate Limits for the details.