> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Why build on a Fluid theme instead of going headless > For developers and AI agents choosing how to build a Fluid storefront: a Fluid theme gives you editor support, FairShare rep credit, slug routes, SEO, droplet integration, menus, and per-market routing for free, while you still control every pixel. **Build your storefront as a Fluid theme unless you have a specific reason not to.** A Fluid theme is Liquid templates, section schemas, CSS, and JavaScript that Fluid renders for you. You keep full control of the design. In return, Fluid handles the parts that are hard to rebuild correctly: merchant editing, rep credit, routing, SEO, droplets, menus, translations, and per-market views. A headless storefront, where you build your own front end against the API, is supported. But everything in the table below becomes yours to build and maintain. ## At a glance | You need | With a Fluid theme | Headless, you build it | | - | - | - | | Merchants editing pages | The Page Editor edits your sections and settings | Your own CMS or editor | | Rep credit (FairShare) | Credit routes and the SDK are already in place | Load the SDK and reproduce the credit routes | | Product, collection, and page URLs | Each resource is served at its slug route | Your own routing and data fetching | | SEO and page head | Admins manage it per resource | Read the `seo` data and render it yourself | | Droplet features | Droplets add sections, blocks, and embeds | Integrate each droplet by hand | | Navigation | Managed menus that admins edit | Your own menu data and rendering | | Different views per market | Sitemap and country routes | Your own geo routing | | Translations | Translate from the admin, Mist, or the CLI | Your own translation storage and language switching | | Design control | Every pixel, in Liquid, CSS, and JS | Every pixel | ## Why a Fluid theme ### Merchants can keep editing after you ship Your templates, sections, and schemas become the panels in the [Page Editor](/themes/page-editor). Merchants rearrange sections and change settings without a developer, and without breaking your code. A headless front end loses that, unless you build an editor too. ### Routes carry FairShare credit Fluid's routes are built for [FairShare](/concepts/fair-share). When a member shares a credit path such as `//products/`, the FairShare SDK logs the credit. FairShare then keeps that member's credit as the shopper moves around the store. Every Fluid storefront already loads the SDK, so you don't add it to a theme. See [Supported paths](/themes/supported-paths) and [FairShare SDK and the storefront](/storefront/fairshare-sdk). A headless site has to load the SDK itself and follow the same credit routes. If it doesn't, member shares can't credit the member. ### Resources arrive on the right routes Products, collections, categories, pages, posts, and media each have a slug route, such as `/products/`. Fluid matches the route to the resource and passes it into the right template. You write the template, and Fluid fetches the data. See [Supported paths](/themes/supported-paths) and [Slugs and URLs](/storefront/slugs-and-urls). ### Admins manage SEO and the page head Each resource carries its own SEO title, description, preview image, and indexing setting, which admins can change. Admins add scripts and tags to the page head or body with [global embeds](/api/guides/global-embeds), such as analytics or verification tags. See [SEO](/storefront/seo). With a Fluid theme, you don't build any of this. ### Droplets plug into your theme Droplets that add storefront features have a structure to build on. A droplet can add sections that merchants place on pages, blocks inside your sections, and app embeds that load across the storefront. Your theme doesn't change when a merchant installs one. See [Droplet theme extensions](/themes/droplet-theme-extensions). ### Menus survive theme changes [Navigation menus](/themes/navigation-menus) live in Fluid, not in your theme's code. Admins edit the links in the admin, and your theme renders whatever menu it's given. You can redesign or replace a theme later without rebuilding the menu structure. ### Every market can get its own view The storefront [sitemap](/api-reference/sitemap/get-sitemap-urls) gives every route a structure you can control. Country routes, called theme region rules in the API, can serve a different template, resource, or redirect for each country at the same URL. Use them when one market needs a different layout. Combine them with [translations](/storefront/translations) for language. See [country routes in the API reference](/api-reference/theme-region-rules/list-sitemap-country-routes-theme-region-rules). ### Translations are easy to add and keep up Your theme renders translated content from the same structure in every language. Products, collections, pages, menus, and your theme's own text each carry a translation for every language the store sells in. Admins translate from the admin, or ask Mist, Fluid's AI assistant, to do it. Agents and developers can use the [Add a language](/setup/add-a-language) guided setup. It finds what isn't translated, machine-translates it, and confirms nothing is left. Shoppers pick their language on the storefront, and the theme doesn't change. See [Translations](/storefront/translations). ### You still control every pixel None of this limits the design. Your theme is your own Liquid, CSS, and JavaScript, built from [sections and blocks](/themes/blocks-and-components) that you define. You work locally with the [Fluid CLI](/themes/cli) or in the editor's code mode. Developers and agents have full control, as long as they follow the structure these docs describe. ## When headless makes sense Go headless when the front end isn't a website Fluid can render: for example, a native mobile app, a kiosk, or a checkout embedded in another product. For those, build against the API: * [Build a headless checkout](/api/guides/headless-commerce) for the purchase flow. * [Choosing a cart surface](/api/choosing-a-cart-surface) to pick between the Checkout API and the FairShare SDK's cart. * [FairShare SDK](/sdk/overview) to keep rep credit working. ## For AI agents building a storefront 1. Start from a Fluid theme, not a blank front end. To match a merchant's current site, copy it into a theme. See [Agent launch guide](/api/agent-launch). 2. Read the [developer guide](/themes/developer-guide) and [common pitfalls](/themes/common-pitfalls) before you edit. 3. Install Fluid's theme skills with `fluid theme skills install`. See [Fluid CLI](/themes/cli). 4. Push to an unpublished theme, preview it, and publish only when the merchant approves. ## Frequently asked questions ### Can I build a headless storefront on Fluid? Yes. The Checkout API and the FairShare SDK support it. You then build the editing, routing, SEO, menus, translations, and per-market views a Fluid theme already gives you. ### Will a Fluid theme limit my design? No. You write the templates, CSS, and JavaScript, so you control every pixel. Fluid supplies the data, routes, and editor around them. ### How does rep credit work with a Fluid theme? When a member shares a credit path, the FairShare SDK logs the credit, and FairShare keeps it as the shopper browses. The SDK is already on every Fluid storefront. See [FairShare](/concepts/fair-share). ### Do I lose my menus if I change themes? No. Menus are stored in Fluid, not in the theme. A new theme renders the same menus. ### How do I translate a Fluid storefront? Turn the language on, then translate from the admin, ask Mist, or follow the [Add a language](/setup/add-a-language) guided setup with the Fluid CLI. The theme renders each language without code changes. ### Can I show a different storefront design in each country? Yes. Use country routes to serve a different template or resource for each country at the same URL, and translations for each language. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.