> ## 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. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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. # Create a page > Create a storefront page with its own page template, check the link between them, edit the template, and publish the page. A page on your storefront, such as `/home/pages/spring-wellness-guide`, is two records: the **page**, which holds its title, slug, description, and status, and a **page template**, a Liquid file in your theme that decides what the page looks like. `fluid pages create` creates both and links them, so the new page renders through a template of its own instead of the theme's default page template. ## How a page and its template fit together * The page is the content record. Its slug sets the URL, and its status decides whether shoppers can see it. * The page template belongs to a theme. It is a Liquid file like any other template in the theme, so you edit it the way you edit the rest of the theme. * One template can serve many pages, but each page created here gets its own, named after the page's title. * A page with no template of its own renders through the theme's default page template. The template is versioned separately from the page. Editing the page's title or description doesn't change its template, and saving the template doesn't change the page. ## Before you start * Your token needs update permission for **Pages** to create and change pages, and for **Themes** to create and edit page templates. * Decide which theme the template goes in. The CLI uses the active theme unless you pass `--theme` with another theme's name or ID. * Install and sign in to the CLI: ```bash theme={null} npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-pages fluid login ``` Every `fluid pages` command prints JSON. Failures print a JSON `error` on stderr and exit with a non-zero code. Prefer to answer questions? Run `fluid pages walk` in a terminal. It asks for the title, slug, template, and theme one at a time, shows a summary before it creates anything, then offers to publish the page and replace its template's Liquid. Type `<` to go back, `>` to skip, and `?` for a menu. ## Steps ```bash theme={null} fluid pages create --title "Spring Wellness Guide" --yes ``` This changes your storefront, so the CLI asks for confirmation unless you pass `--yes`. In order, it: 1. creates a page template in the theme, named `spring-wellness-guide` after the title; 2. creates the page as a draft, with the slug `spring-wellness-guide`; 3. assigns the template to the page; 4. reads both back to confirm they are linked. The template starts as a minimal layout that shows the page's title and description. To start from your own Liquid instead, pass `--content-file page.liquid`, or copy an existing page template in the same theme with `--template-from `. Pass `--slug` or `--template-name` to choose those names yourself. By default the page also loads the theme's stylesheets, so it matches the rest of your storefront. Pass `--blank` to leave them out. The page stays a draft. Add `--publish` to publish it in the same run, or publish it in the last step once the template is ready. ```bash theme={null} fluid pages template spring-wellness-guide ``` The output shows the template's ID, its theme, the pages it is assigned to, and its Liquid. `fluid pages show spring-wellness-guide` shows the page itself. ```bash theme={null} fluid pages template spring-wellness-guide --content-file page.liquid --publish --yes ``` This replaces the template's Liquid and publishes the new version, so it changes your storefront and needs `--yes`. Leave out `--publish` to save the change as a draft version of the template without making it live, then run the command again with `--publish` when it is ready. Repeat until the page shows what you want. For sections, blocks, and settings, work in the theme itself: see the [Theme developer guide](/themes/developer-guide), the [Fluid CLI for themes](/themes/cli), and the [Page Editor](/themes/page-editor). ```bash theme={null} fluid pages publish spring-wellness-guide --yes ``` This makes the page visible on your storefront. To take it down again, run `fluid pages unpublish spring-wellness-guide --yes`, which turns it back into a draft. ## What the status means The result of `create` reports how the template is linked in `assignment`, and the page's state in `status`: | Field | Value | What it means | | - | - | - | | `assignment` | `direct-page` | The template is in the active theme, and the page renders through it. | | `assignment` | `theme-scoped` | The template is in a theme that isn't active. The page renders through it once that theme is active; until then, preview it with the `previewPath`, which includes `?theme_template_id=`. | | `status` | `draft` | Only you can see the page. | | `status` | `published` | The page is live on your storefront. | ## Troubleshooting * **A step fails after the template was created.** The CLI removes the draft page and the template it just created, and the error says so. If removing them also fails, the error names what is left so you can delete it. * **The error says the link couldn't be read back.** The CLI keeps the draft page and the template and prints their IDs. Check them with `fluid pages show` and `fluid pages template` before you retry, so you don't create a second pair. * **Your session expires partway through.** The CLI keeps whatever it created and prints the IDs. Sign in again, then check or delete them. * **`fluid pages template` says the page has no template of its own.** The page renders through the theme's default page template, or its template is in a theme that isn't active. Pass `--template-id` with the template's ID. * **The page looks unstyled.** It was created with `--blank`, which leaves out the theme's stylesheets. Delete it and create it again without `--blank`. ## Delete a page ```bash theme={null} fluid pages delete spring-wellness-guide --yes ``` The page comes off your storefront immediately. Its template stays in the theme, because another page may use it, and the output gives its ID as `templateId` when the template is in the active theme. Once no other page uses the template, delete it with `fluid themes templates delete