> ## 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. # Essential elements for successful app design > The elements a successful company app needs, from a clear purpose and easy onboarding to the right content, communication, growth tools and analytics. The most successful apps help people reach their goals with little effort. This guide covers the elements that turn a good company app into one your team opens every day. ## A clear purpose From the moment someone opens your app, they should understand what it does and why it matters to them. The first screens should answer three questions: * What can I do here? * How do I get started? * Why should I come back? When people see the value right away, engagement follows. ## Easy onboarding Each first step should lead naturally to the next. ### Make getting started effortless People expect: * Quick sign-in * As few required fields as possible * A profile they can complete later * Immediate access to the main features The best onboarding feels like a conversation. Guide people through their first actions with help that appears right when they need it. ## Content that converts Great content needs great presentation. Your app's visual content should be: * Sharp and professional * Consistently branded * Easy to share * Designed for phones Organization matters as much as quality. Put content in clear categories, so people find what they need without searching. ## Communication: the heart of engagement In direct selling, communication is how the business runs. Use each channel for what it does best: 1. **Push notifications** for timely updates 2. **In-app messaging** for team collaboration 3. **SMS** for critical alerts 4. **Email** for detailed communications Push notifications should feel like a tap on the shoulder, not a bullhorn. See [Push notifications vs SMS](/help/playbook/push-notifications-vs-sms-mastering-multi-channel-communication). ## Growth tools that work Your app should help your team grow the business, not just run it. **For sales:** * One-tap product sharing * Up-to-date product availability * An easy shopping experience * A fast checkout **For team building:** * Training your team can take on the go * Recognition that celebrates success * Results that show reps where to focus * Tools for managing a growing team ## Design without code A successful app feels both capable and easy to use. With Fluid, your team builds the app without writing code: * Build the app's Home, Share and Shop screens from widgets in the admin. See [Mobile App](/help/admin/mobile). * Capture leads with forms. See [Forms](/help/admin/forms). * Make every part of the app reflect your brand. Design with intention. Every element should serve your users and reflect your brand. ### Built for direct sales Direct selling needs its own tools. Fluid gives you: * Branded storefronts and a personal MySite for every rep * A streamlined checkout * Messaging for your team and their customers * Sharing and selling from the phone ## Analytics that drive action Data matters only when it leads to action. Your analytics should answer: * Which features drive the most engagement? * Where do people spend their time? * What content leads to action? * Which paths lead to a sale? Track: * How people use the app * How well your content performs * Sales and conversion * Team activity And watch the trends: * How quickly people adopt the app * Which features they use * How many keep coming back * How revenue changes ## Best practices ### Keep it fresh Your app should feel alive, with: * Regular content updates * New features * Performance improvements * Changes your users ask for ### Support that scales Build trust with: * Clear help documentation * More than one way to get help * Quick answers to issues * Proactive communication Reliable, responsive support turns frustrated users into loyal advocates. ## Looking ahead The best apps evolve with their users. Create feedback loops: * Gather user feedback continuously. * Test new features carefully. * Monitor your results. * Improve based on real data. Your app is never finished. It grows with your business. Success isn't about having every feature. It's about having the right features, done well. Focus on what matters most to your users. ## Related pages * [Mobile App](/help/admin/mobile) * [App engagement](/help/playbook/maximizing-app-engagement-your-strategy-guide) * [Your app as a brand ambassador](/help/playbook/turning-your-mobile-app-into-a-brand-ambassador) ## Get help Email Fluid support at [help@fluid.app](mailto:help@fluid.app). The [Getting help](/help/getting-help) page lists what to include in your request. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.