# StoreOS documentation

Markdown versions of every docs page.

- [StoreOS changelog](https://storeos.dev/docs/changelog.md): Product updates in StoreOS for merchants and storefront developers, including what changed and which release it landed in.
- [StoreOS CLI](https://storeos.dev/docs/cli.md): StoreOS CLI is a command-line tool for building and packaging StoreOS themes from your computer.
- [theme](https://storeos.dev/docs/cli/theme.md): Commands for creating, previewing, checking and packaging StoreOS themes.
- [theme check](https://storeos.dev/docs/cli/theme/check.md): Check a StoreOS theme the same way upload does.
- [theme dev](https://storeos.dev/docs/cli/theme/dev.md): Preview a StoreOS theme from your folder with live reload, and connect it to the console customizer.
- [theme init](https://storeos.dev/docs/cli/theme/init.md): Create a new StoreOS theme from the starter theme.
- [theme new](https://storeos.dev/docs/cli/theme/new.md): Add a widget or snippet to a StoreOS theme.
- [theme package](https://storeos.dev/docs/cli/theme/package.md): Check a StoreOS theme and zip it for upload.
- [Core GraphQL API](https://storeos.dev/docs/core-graphql-api.md): The admin and merchant GraphQL API for managing products, orders, stores, themes and billing, with the gateway URL, headers, scopes and a first query.
- [Core REST API](https://storeos.dev/docs/core-rest-api.md): The few REST routes on the Core API, for uploading files and themes, with the gateway URL, headers and scopes.
- [Files](https://storeos.dev/docs/core-rest-api/reference/files.md)
- [Themes](https://storeos.dev/docs/core-rest-api/reference/themes.md)
- [Getting started with StoreOS](https://storeos.dev/docs/getting-started.md): Create your storefront app, install the package, connect through the API gateway, and launch.
- [StoreOS environment variables](https://storeos.dev/docs/getting-started/environment-variables.md): The environment variables that connect a storefront app to the StoreOS API gateway: tenant UID, API key, and site URL.
- [Your first StoreOS API request](https://storeos.dev/docs/getting-started/first-request.md): Make the first StoreOS API call through the public gateway and confirm your API key reaches the catalog for your store.
- [StoreOS GraphQL API](https://storeos.dev/docs/graphql-api.md): What the StoreOS GraphQL API covers on the public gateway, how it differs from REST, and when a storefront should use queries instead of HTTP routes.
- [StoreOS API authentication](https://storeos.dev/docs/graphql-api/authentication.md): How customer authentication works on the StoreOS API: login, registration, phone OTP, and how a session is kept.
- [StoreOS GraphQL mutations](https://storeos.dev/docs/graphql-api/mutations.md): The StoreOS GraphQL mutations that change checkout, coupons, and the customer account, and when to call each one.
- [StoreOS GraphQL queries](https://storeos.dev/docs/graphql-api/queries.md): The StoreOS GraphQL queries for catalog, cart, and account data, what each one reads, and when a storefront should use it.
- [StoreOS guides](https://storeos.dev/docs/guides.md): End-to-end guides for storefront commerce flows and custom admin applications built on StoreOS APIs.
- [Build a custom admin dashboard](https://storeos.dev/docs/guides/admin-dashboard.md): High-level guidelines for building a merchant admin app like the StoreOS console — overview, orders, inventory, stock, staff, customers, and more on the public API gateway.
- [AI-driven development](https://storeos.dev/docs/guides/ai-development.md): Prompt recipes for building a Fluid theme, a custom storefront on the Storefront API, and a custom admin dashboard on the Core API — with the StoreOS docs MCP.
- [Public API keys and the API gateway](https://storeos.dev/docs/guides/api-keys.md): Create StoreOS API keys in the console, call the public gateway at api.storeos.dev with x-storeos-key, and review recent API call logs for your store.
- [StoreOS checkout guide](https://storeos.dev/docs/guides/checkout.md): How checkout works — cart, discounts, delivery, and placing an order with StoreOS.
- [Docs MCP server](https://storeos.dev/docs/guides/mcp.md): Connect Cursor, Claude, ChatGPT, Codex, and other AI agents to StoreOS documentation over the Model Context Protocol.
- [StoreOS phone OTP authentication](https://storeos.dev/docs/guides/phone-otp.md): Passwordless customer login with an SMS code on StoreOS: how phone OTP is requested, checked, and turned into a session.
- [What StoreOS is](https://storeos.dev/docs/introduction.md): StoreOS is an ecommerce builder for Bangladesh sellers: catalog, checkout, cash on delivery, and a public API gateway when you want your own frontend.
- [StoreOS plugins](https://storeos.dev/docs/plugins.md): How StoreOS plugins work — couriers, payments, notifications, analytics, support, and SEO integrations attached to a tenant.
- [StoreOS plugin API](https://storeos.dev/docs/plugins/api.md): Console-side GraphQL for installing, configuring, validating, and uninstalling StoreOS plugins.
- [StoreOS plugin catalog](https://storeos.dev/docs/plugins/catalog.md): Every StoreOS plugin — ID, provider key, credential fields, and validation rules.
- [Reading StoreOS plugins on a storefront](https://storeos.dev/docs/plugins/storefront.md): Load GA4, GTM, pixels, chat widgets, and verification tags that a merchant configured in the StoreOS console.
- [StoreOS webhooks and callbacks](https://storeos.dev/docs/plugins/webhooks.md): The four public endpoints StoreOS exposes per tenant for courier and payment providers, and how each one is authenticated.
- [StoreOS REST API](https://storeos.dev/docs/rest-api.md): How the StoreOS REST API is organized on the public gateway, which routes read the catalog and checkout, and when a storefront should call them.
- [Auth](https://storeos.dev/docs/rest-api/reference/auth.md)
- [Blogs](https://storeos.dev/docs/rest-api/reference/blogs.md)
- [Carts](https://storeos.dev/docs/rest-api/reference/carts.md)
- [Collections](https://storeos.dev/docs/rest-api/reference/collections.md)
- [Discounts](https://storeos.dev/docs/rest-api/reference/discounts.md)
- [Orders](https://storeos.dev/docs/rest-api/reference/orders.md)
- [Pages](https://storeos.dev/docs/rest-api/reference/pages.md)
- [Products](https://storeos.dev/docs/rest-api/reference/products.md)
- [Reviews](https://storeos.dev/docs/rest-api/reference/reviews.md)
- [Tenant](https://storeos.dev/docs/rest-api/reference/tenant.md)
- [Vendors](https://storeos.dev/docs/rest-api/reference/vendors.md)
- [StoreOS roadmap](https://storeos.dev/docs/roadmap.md): What StoreOS ships today for storefront developers, and which commerce and storefront features are still on the roadmap.
- [StoreOS TypeScript SDK](https://storeos.dev/docs/storefront-client.md): What @storeos/storefront-client is — REST client and React SDK for StoreOS storefronts.
- [StoreOS SDK configuration](https://storeos.dev/docs/storefront-client/configuration.md): How to point @storeos/storefront-client at the public API gateway: tenant UID, API key, and the options the client accepts.
- [StoreOS SDK methods](https://storeos.dev/docs/storefront-client/methods.md): What each @storeos/storefront-client method does — catalog, auth, cart, checkout, and orders.
- [StoreOS React SDK](https://storeos.dev/docs/storefront-client/react.md): Providers, hooks, GraphQL helpers, and Next.js server utilities from @storeos/storefront-client/react.
- [Fluid themes](https://storeos.dev/docs/themes.md): Build a StoreOS storefront theme with Fluid templates and widgets that merchants customize in the console.
- [Assets](https://storeos.dev/docs/themes/assets.md): CSS, JavaScript, images and fonts in a StoreOS theme, how to link to them, and the file and size limits.
- [Theme CLI reference](https://storeos.dev/docs/themes/cli.md): Reference for the storeos theme commands — init, dev, check and package — their options, store data and connecting to the console.
- [Contexts](https://storeos.dev/docs/themes/contexts.md): How StoreOS decides which widgets and data a page gets, and the data every page shares.
- [Blog post](https://storeos.dev/docs/themes/contexts/blog-post.md): The blog post context in a StoreOS Fluid theme, with its route, widgets, the article object and an example widget.
- [Blog](https://storeos.dev/docs/themes/contexts/blog.md): The blog context in a StoreOS Fluid theme, with its route, widgets, the blog object and an example widget.
- [Collection](https://storeos.dev/docs/themes/contexts/collection.md): The collection context in a StoreOS Fluid theme, with its route, sorting, pagination, the collection object and an example widget.
- [Home](https://storeos.dev/docs/themes/contexts/home.md): The home context in a StoreOS Fluid theme, with its route, widgets, the products object and an example widget.
- [Page](https://storeos.dev/docs/themes/contexts/page.md): The page context in a StoreOS Fluid theme, with its route, widgets, the page object and an example widget.
- [Product](https://storeos.dev/docs/themes/contexts/product.md): The product context in a StoreOS Fluid theme, with its route, widgets, the product object, related products and an example widget.
- [Search](https://storeos.dev/docs/themes/contexts/search.md): The search context in a StoreOS Fluid theme, with its route, widgets, the search object and an example widget.
- [Editor extension](https://storeos.dev/docs/themes/editor-extension.md): Install the StoreOS Fluid extension in VS Code, Cursor and other VS Code-based editors for .fluid syntax highlighting, schema and drop completions, snippets and error checking.
- [Filters and tags](https://storeos.dev/docs/themes/filters.md): Reference for every filter and tag in StoreOS Fluid themes, with examples, translations and the escaping rules.
- [Layout and theme document](https://storeos.dev/docs/themes/layout-and-document.md): The page shell in layout/theme.fluid, the starting widgets in config/document.json, pages, regions and theme settings.
- [Objects](https://storeos.dev/docs/themes/objects-and-filters.md): Reference for every object a StoreOS Fluid theme can read, and the fields on each.
- [Theme quickstart](https://storeos.dev/docs/themes/quickstart.md): Install the storeos theme CLI, create a theme, preview it with live reload, customize it in the console, and upload it.
- [Structure](https://storeos.dev/docs/themes/structure.md): The files in a StoreOS Fluid theme, which ones are required, and what each template does.
- [Styling](https://storeos.dev/docs/themes/styling.md): Theme color and font variables, and built-in Tailwind CSS, for StoreOS Fluid themes.
- [Validation](https://storeos.dev/docs/themes/validation.md): What storeos theme check and theme upload verify, which problems are errors and which are warnings, and the limits on a theme zip.
- [Widgets and settings](https://storeos.dev/docs/themes/widgets.md): Widget files, settings merchants can change, collection data, nesting, and the built-in widgets every theme gets.