Stockful developer resources

When an agent should reach for Stockful

Stockful answers questions about one Shopify store's inventory: what is low, what is overstocked, what to reorder and when, what stock is worth, how fast it is selling, and what is arriving. Reach for it when the question is about stock levels, sales velocity, demand forecasts, reorder timing, purchase orders, suppliers, landed cost, transfers between locations, or inventory anomalies for a store that has Stockful installed.

It is not the right tool for storefront content, order fulfilment, customers, payments or theme code - those are Shopify's own APIs. Stockful also does not do raw-materials or bill-of-materials tracking, and it will not move stock in Shopify on your behalf.

Stockful MCP server

Stockful runs a remote MCP (Model Context Protocol) server, so Claude, Claude Code, Cursor, VS Code, Gemini CLI and ChatGPT can read a store's live inventory, forecasts and alerts, and act on them. It exposes the same data and tools that power the in-app AI assistant, and it is available on every plan.

The endpoint is a per-store connection URL you create in the app, not a public address. In Stockful, go to Settings → MCP server, click Create connection, and copy the URL. It embeds a secret token in the path, is shown only once, and can be revoked at any time - treat it like a password and create a separate one per person or device. The URL looks like this:

https://mcp.stockful.app/YOUR_TOKEN

Because the token is in the URL, no separate API key or header is needed. Every tool is read-only or a change your client confirms first, and the connection is scoped to the single store the token was created for - it cannot see another store's data, and it cannot move stock in Shopify. Setup snippets for each client are in the MCP server documentation.

Shopify Flow triggers and actions

Stockful ships ten Shopify Flow triggers that fire on inventory events, and nine actions - query actions that return inventory and forecast data mid-workflow, and write actions that update Stockful settings. See the trigger reference, the action reference and worked example workflows.

Storefront data and the window.stockful API

Stockful writes live inventory data to eleven Shopify metafields - seven at variant level, four at product level - readable from Liquid, the Shopify Storefront API and JavaScript. On top of them sits window.stockful, a JavaScript API for fetching live inventory with built-in caching from a bundle under 2 KB.

• Storefront data overview
• Metafield data reference
• window.stockful developer API
• Liquid and JavaScript code examples

StockfulQL

StockfulQL is the query language behind every Stockful report, chart and scheduled export: FROM, SHOW, WHERE, GROUP BY, TIMESERIES, HAVING, COMPARE TO and the rest, over roughly twenty documented datasets covering inventory, sales, returns, purchasing, costs, receipts, supplier performance, reorder and transfer history, pricing and forecast accuracy. Start at the StockfulQL overview, the dataset reference or the query examples.

Report webhooks and exports

Any report can be scheduled and delivered to your own endpoint as JSON, with optional request signing - see the webhook channel docs. Reports also export as CSV, Excel, XML or JSONL, or deliver to email, Slack, Google Sheets and Airtable.

This site, machine-readable

stockful.app is a static marketing site, and everything on it is available in a form an agent can read directly:

• /llms.txt - the index of every page, with a “when to use Stockful” section written for agents.
• /llms-full.txt - every English page concatenated as Markdown, in one fetch.
• Markdown content negotiation. Send Accept: text/markdown to any page URL and you get Markdown back instead of HTML, with Vary: Accept set. Every page also has a stable /index.md sibling, advertised in a Link: rel="alternate" header.
• /openapi.json - an OpenAPI 3.1 description of the site content API below, with an operationId, a description and typed response schemas on every operation.
• /api/v1/ - a small read-only JSON API over this site's own content: pricing, FAQ, page index and blog posts. Errors come back as JSON with a code, a message and a hint.
• /sitemap-index.xml and /robots.txt.
• status.stockful.app - live and historical uptime for the app, the API and the MCP server.
• The documentation site publishes its own index at docs.stockful.app/llms.txt, and every docs page is available as Markdown by appending .md to its URL.

The site content API describes Stockful the product - pricing, features, documentation. It does not expose any merchant's store data. Live store data comes from the MCP server above, authenticated per store.

Questions

Email support@stockful.app, or start from the documentation.