> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > 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 on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > 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 except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — 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. # Build a member site > Learn what a member site is, how the storefront runs it, who can open it, and how you build one from the member site template and publish it with the Fluid CLI. A member site is a static web app, such as a Vite and React app, that runs on your company's storefront. Members open it at an address under `/accounts/`, inside the storefront's own cart, sign-in and account menu. You build it like any static app, and you publish its build output with the Fluid CLI. > [!NOTE] > > This is the new way to build member sites. The Liquid-based pages in the **Member sites v2** group describe the earlier approach, and they will be retired. Build new sites as described here. > [!NOTE] > > Fluid turns member sites on for your company. Until they are on, publishing answers `404`. To ask for them, [contact support](https://docs.fluid.app/help/getting-help.md). ## How a member site runs A visitor opens a site at its storefront address: ```text theme={null} https://yoli.com/accounts/diamond-leaders https://yoli.com/accounts/diamond-leaders/events ``` `diamond-leaders` is the site's handle: lowercase letters, digits and single hyphens, at most 40 characters, unique in your company. Everything after the handle is the site's own path. The storefront draws the page around your site: * **The storefront's own parts.** The cart drawer, checkout, sign-in and the account menu belong to the storefront. Your site uses them through the SDK, so member pricing and the visit's credit are the storefront's own. * **One frame for your site.** Your site runs in one full-page frame, served from its own host under `sites.fluid.app`. The frame is sandboxed, so your code can't move the storefront's window by script. Link to storefront pages with plain `` links, and the SDK opens them in the storefront's window when the visitor clicks. See [Link to the storefront](https://docs.fluid.app/member-sites-v1/sdk.md#link-to-the-storefront). * **One address bar.** The storefront keeps the address bar and the history. Back and Forward move through your site's pages, one entry per page. * **Page titles and previews.** The storefront writes each page's title and link preview from your site's `config/meta.json`. See [Page titles and previews](https://docs.fluid.app/member-sites-v1/declarations.md#page-titles-and-previews). If someone opens your site's own host directly, they land on its storefront address, so your site always opens inside the storefront. ## Who can open a site A site belongs to a member or to the company. A new site is private until its owner makes it public. | Visibility | Who can open it | | - | - | | `public` | Anyone, signed in or not | | `private` | The owner, company admins, and members a share admits | Sites are shared within one company. A visitor who isn't a member of your company is a guest, and a guest opens public sites only. A signed-in member a private site doesn't admit sees a refusal page. A guest is asked to sign in. ## Start from the template Start from the member site template. Mist creates a new member site from it, and it builds and publishes as it is. It's a Vite and React app with three pages: a home page, a shop that adds products to the storefront's cart, and a guestbook kept in the site's own database. ```text theme={null} diamond-leaders/ index.html package.json vite.config.ts src/ main.tsx imports the SDK once App.tsx the pages router.ts a small router that follows Back and Forward products.ts the variant ids the shop recommends styles.css the design tokens db/schema.json the site's database config/access.json the Fluid API scopes the site asks for config/meta.json each page's title, description and image ``` `db/schema.json` and the files in `config/` are your site's declarations. They're published with the build and never served as files. Each is optional: leave one out and the site gets its default. | File | What it declares | Page | | - | - | - | | `db/schema.json` | The site's tables, their columns and who may read and write them | [Database](https://docs.fluid.app/member-sites-v1/database.md) | | `config/access.json` | The Fluid API scopes and member fields the site uses | [Declarations](https://docs.fluid.app/member-sites-v1/declarations.md#fluid-data-the-site-uses) | | `config/meta.json` | Each page's title, description and preview image | [Declarations](https://docs.fluid.app/member-sites-v1/declarations.md#page-titles-and-previews) | | `config/routes.json` | Which file answers each path | [Declarations](https://docs.fluid.app/member-sites-v1/declarations.md#routes) | ## Build and publish Install the dependencies, build, check and publish: ```bash theme={null} npm install npm run build # typechecks, then writes dist/ fluid sites lint # checks dist/, db/ and config/ fluid sites publish # uploads what changed, and makes it live ``` `npm run dev` serves the app on its own, outside the storefront. The cart and the database answer only once the site is published and opened at its storefront address. [Publish a member site](https://docs.fluid.app/member-sites-v1/publishing.md) covers the login, the checks, and what each answer means. ## Use the SDK Your site talks to Fluid through `@fluid-app/sites`. Import it once, at the top of your app: ```ts src/main.tsx theme={null} import "@fluid-app/sites"; ``` Then use `fluid` anywhere: ```ts theme={null} import { fluid } from "@fluid-app/sites"; const me = await fluid.auth.me(); await fluid.cart.add([{ variant_id: 48213, quantity: 1 }]); const { data, error } = await fluid.db.from("guestbook").select("name,message"); ``` [The member sites SDK](https://docs.fluid.app/member-sites-v1/sdk.md) covers each part. ## What member sites don't do yet * **No server functions.** A site is static files and the SDK. `fluid.fn.fetch` answers `404`, and `fluid sites publish` refuses a site with a `functions/` folder or `config/functions.json`. * **No service workers.** The site's host refuses a service worker's script. * **No files under `/_fluid/`.** The site's host answers that path itself, and publishing refuses a build with a file under it. * **No SQL from the browser.** Your code reads and writes its tables through `fluid.db`, and the site's table rules decide each request. * **No secrets in the site.** Everything in your build is public to whoever can open the site. Don't put an API key or a token in it. * **No visitors from other companies.** A person who isn't a member of your company opens your sites as a guest. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.