> ## 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 > Publish a theme to its staging copy in Mist, share a preview link, promote staging to your live theme, undo a promotion, and work on the same theme as your teammates without overwriting each other. Staging is a private copy of a theme. You publish your changes to staging, check them on your real storefront through a preview link, and then **promote** staging to your live theme when it's right. Shoppers don't see anything on staging until you promote it. Each theme has one staging copy, and everyone on your team who works on that theme shares it. ## Before you start * **Mist 1.10.0 or later.** Mist updates itself; restart it to get the latest version. See [Download Mist](https://docs.fluid.app/help/mist/download.md). * **Theme branches turned on for your company.** Fluid turns them on per company. If you don't see staging in the preview header of a theme project, ask Fluid support. * **Permission to update themes**, to publish to staging, promote, and undo. * **A draft or live theme.** Other themes can't have staging. * **The theme downloaded to your computer.** See [Run and publish](https://docs.fluid.app/help/mist/run-and-publish.md#before-you-start). ## Create staging Open the theme project. In the preview header, click **Request staging**. Mist copies the theme, which usually takes under a minute, and the header shows **Staging** when it's ready. You only do this once per theme. Staging stays until the theme is deleted. ## Publish to staging **1. Make your changes** Change the theme in the chat or in your files, and check the **Local** preview. **2. Publish to staging** Click **Publish to staging**, next to **Publish**. Your live theme isn't touched. When it's done, the header shows **Published to staging · revision N**, and the revision goes up by one with each publish. **3. Check staging** Click the **Staging** tab to see staging on your real storefront. Next to the staging pill, Mist shows whether your files are **Up to date with local** or have **Local changes not on staging**. ## Share a preview link Click **Copy link** on the staging pill, and send the link to anyone who should review the change. They don't need a Fluid login. The link lasts 7 days; copy a new one when you need it. > [!WARNING] > > The cart and checkout in a staging preview use your real store. Adding to the cart or checking out can create real orders. Share staging links for review, not for test purchases. ## When a teammate published first Publishing to staging sends your theme files, apart from a few kinds it skips and lists. If a teammate published to staging after you last did, and your copies of their files are different, publishing would put your copies back over their work. Mist asks before that happens: > **Staging has changes you don't have** > > Someone published files to staging (revision 12) that this project has differently. Publishing replaces them with your copies. Get their changes first, or replace them if you mean to. The dialog lists their files under **Their changes**. * **Cancel** publishes nothing. Get your teammate's changes into your project first, then publish again. * **Replace anyway** publishes your copies over theirs. It replaces only what you were shown: if someone publishes again before yours lands, Mist asks you again. Files your teammate published that you don't have at all are never removed. ## Promote staging to your live theme **1. Click Promote to live** Mist lists every file that would change on your live theme. **2. Confirm** Click **Promote to live**. The dialog shows the promotion running, then **Promoted to live** with the files that changed. Shoppers see them straight away. Promoting copies exactly what staging shows, including what your teammates published to it, so read the list before you confirm. If someone publishes to staging while the dialog is open, nothing is promoted. The dialog says **Staging changed while you were reviewing**; click **Review again** to see the new changes. When **Promote to live** is greyed out, hover over it to see why: | Reason | What to do | | - | - | | The live theme already matches staging | Nothing; there's nothing to promote | | The live theme changed since staging was made | Someone changed the live theme another way, such as **Publish** or the theme editor. Promoting would overwrite that change, so use **Publish** instead | ## Undo a promotion Click **Undo promote**, then **Undo promotion**. Your live theme goes back to how it was before the promotion, and the dialog shows **Promotion undone**. Staging keeps its changes, so you can promote them again later. You can undo only the latest promotion, once. If someone edited a promoted file on the live theme since, undo is refused so their edit isn't lost; the dialog says why. ## Publish or promote? There are two ways to change your live theme: * **Promote to live** puts exactly what staging shows onto your live theme. Use it when the change was reviewed on staging, especially when several people work on the theme. * **Publish** sends the files on your computer straight to your live theme. Before it does, Mist warns you if your files differ from staging. > [!WARNING] > > Once the live theme is changed with **Publish** or the theme editor, promoting that staging is refused from then on, because it would overwrite that change. If your team reviews on staging, promote every change instead of mixing Publish and promote. ## Frequently asked questions > [accordion] Why don't I see staging in the preview header? > > Theme branches aren't turned on for your company, or the theme isn't a draft or live theme. Ask Fluid support to turn theme branches on. > [accordion] Can I delete staging? > > No. Staging goes away when its theme is deleted. > [accordion] Can I use the terminal instead? > > Yes. Mist runs the same Fluid CLI commands. See [Theme branches](https://docs.fluid.app/themes/branches.md). ## Related pages * [Run and publish](https://docs.fluid.app/help/mist/run-and-publish.md) * [Theme branches](https://docs.fluid.app/themes/branches.md) * [Time Machine](https://docs.fluid.app/help/mist/time-machine.md) > [!NOTE] > > Email Fluid support at [help@fluid.app](mailto:help@fluid.app). The [Getting help](https://docs.fluid.app/help/getting-help.md) page lists what to include in your request. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.