> ## 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. > 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 — 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. # Glossary > Short definitions of the Fluid terms you meet in the admin, the mobile app and Mist, with a link to the guide for each. Each term has a short definition and a link to the guide that covers it in full. ## Terms ### Admin portal The admin portal at [admin.fluid.app](https://admin.fluid.app) is where your team runs your Fluid company: products and orders, your storefront and website, reps and customers, payments and settings. See [Admin portal](/help/admin). ### Agreements The legal agreements your checkout shows customers. For each one, you choose whether customers must accept it, can choose to accept it, or only see it as a link in the checkout footer. See [Agreements](/help/admin/settings/agreements). ### Catchups Follow-up suggestions for your affiliates. In the mobile app, catch-ups are cards that suggest what to follow up on, such as a contact's recent activity, new media, a new product or an overdue task. Admins choose which types are on for the whole company. See [Catchups](/help/admin/settings/catch-ups) and [Getting around the app](/help/mobile/getting-around#catch-ups). ### Categories Groups of products for your storefront. Categories form a tree, so a category can sit under a parent category. Each category has its own title, description, image, product list and storefront settings. See [Categories](/help/admin/categories) and [Storefront resources](/storefront/resources#categories). ### Collections Flat, hand-picked groups of products for display on your storefront. Unlike categories, collections have no hierarchy. Each collection has its own title, description, image, product list and storefront page. See [Collections](/help/admin/collections) and [Storefront resources](/storefront/resources#collections). ### Commission engine The system many direct-sales companies use as their back office. You connect it from **Getting Started**, and Fluid Connect then syncs products, customers, reps, ranks and genealogy between it and Fluid. If you don't have one, you add the items under **Set up We-Commerce** on **Getting Started** yourself. See [Getting Started](/help/admin/getting-started#connect-your-commission-engine) and [Agent launch guide](/api/agent-launch). ### Contacts The people your reps follow up with. The admin keeps each contact's name, contact details and status, and the rep they're assigned to. See [Contacts](/help/admin/contacts) and [Contacts in the mobile app](/help/mobile/contacts). ### Customers and reps Your company's members. In the admin, customers and reps share one list on the **Customers** screen, and each member opens on a member card with their orders, subscriptions and profile. A member's member type decides whether they can act as a rep. See [Customers](/help/admin/customers) and [Member Types](/help/admin/settings/member-types). ### Default MySite Your company's starting MySite. While **Auto Populate Status** is **Active**, each new member's MySite starts with a copy of it. See [Default MySite](/help/admin/settings/default-mysite). ### Droplets Fluid's integration layer: self-contained apps that connect Fluid to external services, add functionality to your checkout and add custom screens to the admin. Merchants install them from the Droplet Marketplace. In the admin, droplets can add sections to the Page Editor and create promo codes. See [Droplets](/concepts/droplets) and [Promo Codes](/help/admin/promo-codes#droplet-codes). ### Enrollment packs A pack bundles a one-time product, a subscription product, legal agreements and an optional fee. When a shopper adds a pack to their cart, the cart becomes an enrollment. See [Enrollments](/help/admin/enrollments). ### Entities An entity is a legal company you do business through. Each entity has its registration details, the countries it operates in and its bank accounts. See [Entities](/help/admin/settings/entities). ### FairShare Fluid's JavaScript SDK for direct sales. It works out which rep should get credit for a visit, and carries that credit into the cart and the order. In the admin, the **Fluid Fair Share** screen decides how commission is attributed for orders that come through shared links. See [FairShare: sales rep attribution](/concepts/fair-share) and [Fluid Fair Share](/help/admin/settings/fair-share). ### Media Your company's media library: images, videos and PDF documents that you can tag with products and embed. See [Media](/help/admin/media). ### Member types Each member type sets the pricing tier its members price at and whether they can act as a rep. See [Member Types](/help/admin/settings/member-types). ### Mist Fluid's AI assistant, a desktop app for macOS and Windows. You describe what you want in a chat, and Mist plans it, writes it and connects it to your Fluid company. See [Mist](/help/mist). ### Mist apps Web apps that Fluid hosts for you. You describe what you want in Mist, and Mist writes the code, runs it on your computer and publishes it. The **Mist Apps** screen in the admin lists the hosted apps your company has deployed. See [Mist Apps and other projects](/help/mist/mist-apps) and [Mist Apps](/help/admin/settings/mist-apps). ### Mobile app Your company's mobile app, where reps do their day-to-day selling: sharing content, following up with contacts, messaging customers and running their MySite. Each company publishes the app under its own name. See [Mobile app](/help/mobile) and [Mobile App](/help/admin/mobile). ### MySite A rep's personal website, where customers and prospects can see the products, media and links the rep picks. See [MySite](/help/mobile/my-site). ### MySite themes The themes your reps' MySites can use. See [Mysite Themes](/help/admin/mysite-themes). ### Page editor The **Page Editor**, also called the Visual Editor, changes how your storefront pages look. You work on one theme template at a time by arranging its sections and changing their settings. See [Page Editor](/help/admin/page-editor). ### Payment gateways The gateways that process your company's credit card payments. Non-card payment accounts are managed on a separate screen. See [Payment Gateways](/help/admin/settings/gateways) and [Alternative Payment Accounts](/help/admin/settings/apm). ### Payment routing Rules that decide which of your card gateways handles each card payment, and the default order of gateways for payments that no rule matches. See [Payment Routing](/help/admin/settings/payment-routing). ### Playlists A playlist groups items, such as media, products and pages, so they can be shared together with one link. In the admin, a playlist becomes one storefront page you can share or embed. See [Playlists](/help/admin/playlists) and [Playlists and content](/help/mobile/playlists). ### Portal The signed-in experience for your reps. You can build a portal and its widgets in Mist. Developers author portal definitions and widget packages. See [Mist Apps and other projects](/help/mist/mist-apps) and [Portal and widget development](/portal-widgets/overview). ### Promo codes The discounts shoppers get at checkout. A promo code can take a percentage or a fixed amount off, give free products, free shipping or free enrollment packs, and apply either when a shopper enters it or automatically. See [Promo Codes](/help/admin/promo-codes). ### Ranks Your company's list of rep ranks. Each rank has a name and an external ID. See [Ranks](/help/admin/settings/ranks). ### Rewards points Your company's points rewards system, including how many points equal one unit of each of your currencies. See [Rewards Points](/help/admin/settings/rewards-points). ### Roles A role is a set of permissions. Every user you add to a role gets those permissions, and roles control what people can see and do in the admin. See [Roles](/help/admin/settings/roles). ### Safe Mode A Mist mode for exploring without any risk of changing production. Mist can read your data and edit files on your computer, but it can't change anything live. See [Safe Mode](/help/mist/safe-mode). ### Skills A skill is a set of written instructions that Mist follows to do one job. Run a skill, and Mist does the job the same way every time. See [Skills](/help/mist/skills). ### Smart links A smart link is made for one contact. You create one when you tap **Send** next to a contact in the share drawer, or with **Create Smart Link**. A general share link is the same no matter who you share it with and isn't tied to a contact, so use it for posts many people see. See [Sharing content](/help/mobile/sharing#contact-smart-link-vs-general-share-link). ### Subscription plans A plan holds a subscription's schedule and pricing, such as how often it's billed and shipped and how the discount is calculated. You offer a plan on a product from the product's page. See [Subscription Plans](/help/admin/settings/subscription-plans). ### Themes Your storefront's look. One theme is live at a time. The others wait in your library until you publish one. See [Themes](/help/admin/themes). ### Time Machine Time Machine records every change made to your Fluid company from Mist Desktop, by Mist or by you. It shows what changed, and lets you undo it. See [Time Machine](/help/mist/time-machine). ### URL redirects Redirects send visitors from one path on your storefront to another address. Each redirect is permanent (HTTP 301), so search engines move their listing to the new address. See [URL Redirects](/help/admin/url_redirects). ### Warehouses Your company's warehouse locations and their addresses. Products and bundles track their stock by warehouse. See [Warehouses](/help/admin/settings/warehouses). ### We-Commerce Fluid's approach to combining direct sales and e-commerce. Merchants and reps work together on one platform, with every sale, attribution and commission visible to all parties. In the admin, the **Set up We-Commerce** cards on **Getting Started** cover the items that sync through Fluid Connect when you connect a commission engine. See [What is We-Commerce?](/concepts/we-commerce) and [Getting Started](/help/admin/getting-started#quickstart-console). ### Workflows A workflow is a chain of steps that Mist runs for you. Each step runs a skill or a written instruction, and a separate reviewer checks each result against the step's acceptance criteria. See [Workflows](/help/mist/workflows). This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.