--- title: "API v2 reference" description: "STOQ API v2 (Beta): every resource and endpoint, with request and response examples." url: https://docs.stoqapp.com/v2-reference/ api: "API v2 reference" --- # API v2 reference STOQ's action-driven, AI-native external API. Every action is self-describing (`description`, `aliases`, `notes`, JSON request schema) and also reachable via the `/help` manifest, `skill.md`, `llms.txt`, and the MCP server. **Public beta**: actions and schemas may change before GA. All endpoints require the `X-Auth-Token` API key. Base URL: `https://app.stoqapp.com/api/v2/external`. Authenticate with the `X-Auth-Token` header. ## Resources - [Account · Help Docs](https://docs.stoqapp.com/v2-reference/account-help-docs.md) (1 endpoints): Search STOQ's help centre and developer docs, or read one page in full. - [Account · Integrations](https://docs.stoqapp.com/v2-reference/account-integrations.md) (13 endpoints): Third-party integrations such as Klaviyo, Omnisend, Mailchimp, Shopify Flow, Judge.me and Gorgias: which are connected, their settings, and the Klaviyo flow setup steps. - [Account · Languages](https://docs.stoqapp.com/v2-reference/account-languages.md) (3 endpoints): The languages the shop's storefront text is translated into, and whether multi-language support is on. - [Account · Locations](https://docs.stoqapp.com/v2-reference/account-locations.md) (1 endpoints): The shop's Shopify locations, for naming the locations whose stock STOQ counts. - [Account · Markets](https://docs.stoqapp.com/v2-reference/account-markets.md) (2 endpoints): The shop's Shopify Markets and how STOQ routes stock by market, for back in stock and preorders. - [Account · Plan Usage](https://docs.stoqapp.com/v2-reference/account-plan-usage.md) (1 endpoints): The shop's current STOQ plan, its limits, and a month's usage against them. - [Account · Sending](https://docs.stoqapp.com/v2-reference/account-sending.md) (3 endpoints): Who sends customer notifications: email and SMS provider, sender name and the merchant's own sending address, including domain verification. - [Account · Settings](https://docs.stoqapp.com/v2-reference/account-settings.md) (1 endpoints): App settings read one section at a time, as the Settings pages group them. - [Account · Setup](https://docs.stoqapp.com/v2-reference/account-setup.md) (1 endpoints): Whether STOQ's app embed is on in the published theme. - [Account · Setup Guide](https://docs.stoqapp.com/v2-reference/account-setup-guide.md) (2 endpoints): The setup guide on the dashboard's Home page, for back in stock and preorders, with progress and a skip action. - [Account · Templates](https://docs.stoqapp.com/v2-reference/account-templates.md) (5 endpoints): Email styling, the logo, and per-language translations of notification templates. - [Account · Theme Integrations](https://docs.stoqapp.com/v2-reference/account-theme-integrations.md) (4 endpoints): Theme integrations (Quick Buy, Featured products) the merchant requested from the page editors, and their setup status. - [Account · Translations](https://docs.stoqapp.com/v2-reference/account-translations.md) (1 endpoints): Translation overrides for the notify-me button, signup form and preorder button and modal text. - [Account · Web Pixel](https://docs.stoqapp.com/v2-reference/account-web-pixel.md) (1 endpoints): The Shopify web pixel that records storefront views, add-to-carts and purchases for STOQ reports. - [Back In Stock · App Proxy](https://docs.stoqapp.com/v2-reference/back-in-stock-app-proxy.md) (2 endpoints): Checks that the storefront app proxy (the route the signup form talks to) is reachable and correctly signed. - [Back In Stock · Customers](https://docs.stoqapp.com/v2-reference/back-in-stock-customers.md) (6 endpoints): Everyone who signed up for an alert or placed a preorder, with subscribe, unsubscribe and delete. - [Back In Stock · Notification Settings](https://docs.stoqapp.com/v2-reference/back-in-stock-notification-settings.md) (3 endpoints): Per-notification-type settings, such as whether it sends and on which channels. - [Back In Stock · Notifications](https://docs.stoqapp.com/v2-reference/back-in-stock-notifications.md) (2 endpoints): The back-in-stock send log: one entry per notification sent. - [Back In Stock · Orders](https://docs.stoqapp.com/v2-reference/back-in-stock-orders.md) (1 endpoints): Orders placed after a back-in-stock alert. - [Back In Stock · Products](https://docs.stoqapp.com/v2-reference/back-in-stock-products.md) (2 endpoints): Per-product back-in-stock configuration, such as when the notify-me button shows. - [Back In Stock · Reports](https://docs.stoqapp.com/v2-reference/back-in-stock-reports.md) (9 endpoints): Back-in-stock analytics: signups, notifications, engagement, conversions and revenue. - [Back In Stock · Sending History](https://docs.stoqapp.com/v2-reference/back-in-stock-sending-history.md) (2 endpoints): Back-in-stock sends, newest first: each restock or manual send working through a variant's waitlist, with progress. - [Back In Stock · Settings](https://docs.stoqapp.com/v2-reference/back-in-stock-settings.md) (14 endpoints): Back-in-stock behavior: the signup form the app provides, channels, delivery, compliance and tagging. - [Back In Stock · Signups](https://docs.stoqapp.com/v2-reference/back-in-stock-signups.md) (12 endpoints): Individual back-in-stock signups (a customer waiting on a variant), with history and manual notify. - [Back In Stock · Templates](https://docs.stoqapp.com/v2-reference/back-in-stock-templates.md) (6 endpoints): The back-in-stock email and SMS templates, with test sends and translations. - [Back In Stock · Widget Templates](https://docs.stoqapp.com/v2-reference/back-in-stock-widget-templates.md) (4 endpoints): Saved designs for the storefront signup widget. - [Customers · Status](https://docs.stoqapp.com/v2-reference/customers-status.md) (1 endpoints): One customer's preorder and back-in-stock status, looked up by exact email. - [Preorders · Notification Settings](https://docs.stoqapp.com/v2-reference/preorders-notification-settings.md) (3 endpoints): Settings for preorder notifications, such as confirmation emails and SMS. - [Preorders · Offer Lookup](https://docs.stoqapp.com/v2-reference/preorders-offer-lookup.md) (1 endpoints): Find one preorder offer by exact id or fuzzy name match. - [Preorders · Offers](https://docs.stoqapp.com/v2-reference/preorders-offers.md) (52 endpoints): Preorder offers: what is sold as a preorder, how it is paid for and shipped, and how it looks on the storefront. Create, schedule and enable offers, and edit each capability group. - [Preorders · Orders](https://docs.stoqapp.com/v2-reference/preorders-orders.md) (26 endpoints): Orders containing preorder items, with payment collection, fulfillment holds and customer notifications. - [Preorders · Product Variants](https://docs.stoqapp.com/v2-reference/preorders-product-variants.md) (11 endpoints): Per-variant preorder state: the offers a variant is in, its preorder count and metafields, and detaching it from all offers. - [Preorders · Products](https://docs.stoqapp.com/v2-reference/preorders-products.md) (8 endpoints): The store-wide Preorders > Products tab: link variants to offers, and bulk add, remove or change inventory policy. - [Preorders · Reports](https://docs.stoqapp.com/v2-reference/preorders-reports.md) (6 endpoints): Preorder analytics: sales, revenue, engagement and fulfillments by date and product. - [Preorders · Settings](https://docs.stoqapp.com/v2-reference/preorders-settings.md) (8 endpoints): Store-wide preorder settings: storefront text, pages, reports and developer options. - [Preorders · Templates](https://docs.stoqapp.com/v2-reference/preorders-templates.md) (8 endpoints): The preorder email templates (confirmation, payment failed, shipping update), with test sends.