> ## 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. # Preview theme changes on staging before they go live > Give a theme a private staging copy, publish your local changes to it, preview and share it on your real storefront, then push to live when it's right. Theme staging gives a theme its own private copy, called **staging**. You publish your local theme files to staging, open it on your real storefront through a preview link, share that link for review, and only then push the same files to your live theme. Publishing to staging never changes what shoppers see. > [!NOTE] > > Theme staging is in early access. It works only for companies where Fluid has turned on branch environments. For any other company, the staging commands answer `Theme staging is not enabled for this company.` ## How staging works * **One staging per theme.** A draft or live theme can have one staging copy. It belongs to that theme and lasts until the theme is deleted. * **It starts as a copy.** Requesting staging copies the theme: its templates, sections, settings, translations, files, and member sites. * **Only staging publishes change it.** The staging copy isn't listed with your other themes, can't be made live, and refuses edits from the theme editor or a `fluid theme push` aimed at it. Your local files reach it only through `fluid theme staging publish`. * **Publishes land all at once.** A staging publish applies every changed file in one step, so anyone previewing staging sees the whole previous version or the whole new one, never half of each. * **Every publish bumps a revision.** Staging starts at revision `0` and goes up by one with each publish. | | Staging | Development theme | Unpublished theme | | - | - | - | - | | Created by | `fluid theme staging request` | `fluid theme dev` | `fluid theme push --unpublished` | | How many | One per theme | One per project | As many as you push | | Preview | A signed link anyone can open | Your local dev server | The admin's theme preview | | Can go live | No | No | Yes, by publishing it | ## Create staging Run the staging commands from a theme directory you pulled with `fluid theme pull`. They use the theme this directory is bound to in `.fluid-theme.json`. Pass `--theme ` to name another theme, or `--root ` to read a different directory. **1. Request staging** ```bash theme={null} fluid theme staging request ``` Fluid starts copying the theme in the background. If staging already exists or is already being created, the command reports where it stands instead of failing. **2. Wait until it's ready** ```bash theme={null} fluid theme staging wait ``` The command checks every few seconds and returns when staging is ready or has failed. It gives up after 600 seconds; set another limit with `--timeout `. It exits with code 1 unless staging is ready. **3. Check it** ```bash theme={null} fluid theme staging status ``` It prints staging's state and, once it's ready, its preview link. If creating staging fails, run `fluid theme staging request` again. It picks up where the copy stopped. ## Publish to staging ```bash theme={null} fluid theme staging publish ``` The publish sends your local theme files to staging. Your live theme isn't touched. * **Only changed files travel.** The CLI sends a SHA-256 checksum for each file, Fluid compares them with what staging already has, and only new or changed content is uploaded and applied. Publishing again with nothing changed is quick. * **Someone else may have published first.** If another publish reached staging after yours started, yours is refused instead of overwriting it. Publish again. * **Deleting a file locally doesn't delete it from staging.** A publish changes only the files you have. * **Member sites come along.** `members_sites.json` is published with the rest of the theme, without references to retired account and member pages. Fluid stores the member configuration it imports, and may rewrite keys in it, for example a site key becoming the site's name. Some files are never published to staging, and the command lists them as skipped: | File | Why | | - | - | | Account and member page folders, such as `account_page/` | They're no longer theme files | | Numbered duplicate templates, such as `page/home~2/index.liquid` | Rename them first | | Files attached to a template, such as `page/home/assets/hero.png` | Not supported on staging yet | One publish can hold up to 5,000 files, each up to 5 MB of text or 25 MB for images and other binary files. ## Preview and share staging `fluid theme staging status` prints staging's preview link. It opens staging on your real storefront domain, with a **Preview mode** banner at the top naming the staging theme. * **Anyone can open it.** The link doesn't need a Fluid login, so you can send it to a reviewer. * **It lasts 7 days.** Run `fluid theme staging status` again for a fresh link. * **The preview stays on while you browse.** Following links on the storefront keeps showing staging in that browser until you choose **Exit preview** in the banner. * **It stops working once staging is removed.** After that, the link shows the live theme. > [!WARNING] > > Cart and checkout in a staging preview act on your real store. Adding to the cart or checking out during a preview uses live data and can create real orders. Share staging links for review, not for test purchases. Products or pages pinned to a specific template keep using the live theme's template in a staging preview. ## Push to live Staging doesn't go live by itself, and there's no command that copies staging to your live theme. When staging looks right, push the same files to your live theme as usual: ```bash theme={null} fluid theme push ``` > [!WARNING] > > `fluid theme push` sends the files in your directory, not what's on staging. If you edited files after your last staging publish, or a teammate published to staging from their own copy, live won't match what you reviewed. Publish to staging and check it again before you push. ## Remove staging Staging is removed together with its theme: deleting a theme also deletes its staging copy, its preview link, and everything it stored. There's no command that removes staging on its own. ## Use staging in Mist Desktop For a theme project, Mist Desktop shows staging next to Local and Prod in the preview: * **Request staging** in the preview bar creates it and shows its progress. * The **Staging** tab opens staging inside Mist, and **Copy link** copies a fresh preview link for the page you're viewing. * **Publish to staging** sits beside **Publish** in the top bar. **Publish** still pushes your local files to the live theme. ## Scripts and coding agents Every staging command accepts `--json`. `status`, `request`, and `wait` print the staging state, the branch with its `revision` and `preview_url`, and any operation still running. `publish` prints the new branch, how many files it declared and uploaded, and any `skipped` files with the reason. On failure, the command prints one JSON error with the refusal's `type` and `message`, and exits with code 1. ```bash theme={null} fluid theme staging publish --json ``` ## Messages you might see | Message | What it means | | - | - | | `Theme staging is not enabled for this company.` | Theme staging isn't turned on for this company | | `This theme cannot have a staging branch (only draft and live production themes can).` | Use a draft or live theme | | ``No staging yet; request it with `fluid theme staging request`.`` | Staging hasn't been created | | `Copying the theme…` | Staging is being created | | `Staging failed (…); request it again to resume.` | Run `fluid theme staging request` again | | ``Staging is not ready. Run `fluid theme staging request` and wait for it first.`` | Publish once staging is ready | | `Staging is ready.` | You can publish and preview | This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.