> ## 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. # Pages, menus and settings of a member site > Define a member site's pages in config/pages.json, its menus in config/menus.json and its settings in config/settings.json, pick layouts and menus, and see which changes are live at once. A member site's structure lives in three files under `config/`. `config/pages.json` lists the pages, `config/menus.json` holds the menus, and `config/settings.json` holds the values your templates read as `settings`. This page covers what each file holds, how a page picks its layout and menu, and which changes are live at once and which wait for a publish. You edit these files in the folder the [CLI](https://docs.fluid.app/member-sites/cli.md) pulls, or you write them through the file API: see [Write a site file](https://docs.fluid.app/api-reference/site-files/write-a-site-file.md) for members and [Write a site file](https://docs.fluid.app/api-reference/member-site-files/write-a-site-file.md) for company sites. The pages API changes one page at a time: see [Add a page](https://docs.fluid.app/api-reference/site-pages/add-a-page.md) and [Change a page](https://docs.fluid.app/api-reference/site-pages/change-a-page.md). ## Know how a page works A page is two things: * **A row** in `config/pages.json`. It holds the page's slug, title, position, published flag, layout and menu. * **A file**, `pages/.liquid`. It holds the page's content. The home page's file is `pages/index.liquid`. Members are served a page only when both are ready. The row must say `published: true`, and the page's content must have been published with the site. A page whose row is published but whose content was never published is missing to members, and no list of pages shows it. ## Write the pages file ```json config/pages.json theme={null} { "layout": null, "pages": [ { "slug": "/", "title": "Home", "position": 1, "published": true, "layout": null, "menu": null }, { "slug": "about", "title": "About", "position": 2, "published": true, "layout": null, "menu": "main" }, { "slug": "spring-sale", "title": "Spring sale", "position": 3, "published": false, "layout": "none", "menu": null } ] } ``` `layout` at the top is the site's default layout name, or `null`. Each page row holds: | Key | What it holds | | - | - | | `slug` | The page's address segment. The home page is `/`. Any other slug is lowercase letters and digits separated by single hyphens, never `index`, and unique in the site without regard to letter case | | `title` | The page's title, 1 to 255 characters | | `position` | An integer. Pages are listed in position order | | `published` | Whether members are served the page once the site is published | | `layout` | The name of the layout this page uses, or `null` to use the site's default | | `menu` | The slug of one of the site's menus, or `null` for none | * **The CLI needs four keys.** A row must have `slug`, `title`, `position` and `published`. `layout` and `menu` default to `null`. Any other key is refused. * **The file API needs two.** Written through the file API, a row needs only `slug` and `title`. `position` defaults to the row's place in the list, `published` to `false`, and `layout` and `menu` to `null`. * **A site holds at most 50 pages.** A new page needs a row and a file. * **The home page is `/`.** Its file is `pages/index.liquid`, which is why no other page can take the slug `index`. If a site has no served home page, `/accounts/` answers not found for every member, and the `/accounts` landing skips the site. See [Sites home](https://docs.fluid.app/member-sites/sites-home.md#know-where-members-land). * **Rows are matched by slug.** Writing `config/pages.json` through the file API makes the site's pages match the file. It changes the rows it names, adds new ones with an empty file, and removes every page whose row is missing, with its content. A page you rename is a new page and a removal. * **An unpublished page is hidden everywhere.** It isn't in `site.pages`, `site.pages_menu` or any menu, and a visitor who opens its address gets not found. [A draft preview](https://docs.fluid.app/member-sites/publishing.md#preview-the-draft) shows it. ## Pick a layout A page uses the first of these that applies: 1. The page row's `layout`. 2. The site's default `layout`. 3. The layout named `site`, which is `layouts/site.liquid`. The name `none` renders the page with no layout. A layout name the site has no published layout for falls back to the layout named `site`, and then to no layout when the site has none. A page never goes blank because a layout is missing. The layout prints the page where it writes `content_for_layout`. See [Pick a layout](https://docs.fluid.app/member-sites/templates.md#pick-a-layout). ## Write the menus file A menu is a list of items. A site can hold any number of menus, each with its own slug. ```json config/menus.json theme={null} { "menus": [ { "slug": "main", "title": "Main menu", "items": [ { "title": "Home", "page": "/" }, { "title": "About", "page": "about" }, { "title": "Help", "items": [ { "title": "Contact", "url": "https://shop.example.com/contact" }, { "title": "Returns", "url": "https://shop.example.com/returns" } ] } ] }, { "slug": "footer", "title": "Footer", "items": [{ "title": "Contact", "url": "https://shop.example.com/contact" }] } ] } ``` * **A menu has a `slug`, a `title` and `items`.** The slug is lowercase words joined by single hyphens and unique in the file. The title can't be empty. `items` is optional. * **An item has a `title`.** It can carry a `page`, which is the slug of a page in `config/pages.json` (`/` is the home page), or a `url`, which is an `http` or `https` address. It never carries both. An item with neither is a heading. * **Items nest to any depth.** Put children under `items`. The order of the list is the order members see. * **Every other key is refused.** So is an item whose `page` names no page of the site. * **The file replaces every menu.** Menus are matched by slug and keep their identity. A menu you leave out is deleted, and the pages that used it lose their menu. To clear every menu, write a file whose `menus` list is empty. * **A link to a page the site doesn't serve is left out, with the items under it.** That includes a page that is unpublished. A heading keeps its place and has no link. ## Choose which menu a page uses A page's templates read its menu as `settings.menu`. Fluid picks it in this order: 1. The menu named in the page row's `menu`. 2. The menu with the slug `main`. 3. `site.pages_menu`, a menu Fluid builds from the site's served pages. A template can also read any menu by its slug as `site.menus.`, such as `site.menus.footer`. See [Read the Liquid objects](https://docs.fluid.app/member-sites/templates.md#read-the-liquid-objects) for the shape of a menu. A page row can name only a menu that `config/menus.json` defines. Push `config/menus.json` before the row that names a new menu. The CLI does this for you. ## Write the settings file `config/settings.json` is one JSON object. Templates read it as `settings`, and Fluid adds `settings.menu` to it for the page being rendered. Use it for values such as colors and fonts that every viewer sees the same. * **Writing the file replaces the whole object.** The site's `settings` field in [Change a site](https://docs.fluid.app/api-reference/sites/change-a-site.md) does the same. * **Never put a member's data in it.** The settings are the same for every viewer and are visible to every viewer. * **It always exists.** You can write it but not remove it. ## Know what is live at once Some of these files have a draft, and some don't. A publish makes the drafts live. See [Publish a site](https://docs.fluid.app/member-sites/publishing.md). | File or change | When it takes effect | | - | - | | A page row in `config/pages.json`: a new page, its title, position, `published` flag, layout or menu, or a removed page | At once | | The site's default layout | At once | | `config/menus.json` | At once | | A new, changed or removed asset | At once | | A removed layout, section or snippet | At once. The file and its published copy go together | | A page's content, `pages/.liquid` | Saved as a draft until you publish | | A layout, section or snippet you write | Saved as a draft until you publish | | `config/settings.json` | Saved as a draft until you publish | | `config/access.json` | Saved as a draft until you publish | Two things follow: * **A new page isn't served until you publish.** Its row is live at once, but its content is a draft. Members get not found for the page until the next publish. * **Unpublishing a page takes effect at once.** Setting `published` to `false` on a page members already see removes it from the site, from its menus and from `site.pages` without a publish. The [CLI page](https://docs.fluid.app/member-sites/cli.md#know-what-is-live-at-once) lists these changes before a push writes them. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.