> ## 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. # Getting Started > Preview your site and app, connect a commission engine, start payments and enrollment setup, and jump to each area you set up. **Getting Started** is the screen the admin opens on. Use it to check your website and mobile app at a glance, start the first setup tasks, and open each area you need to set up. ## Where to find it In the admin sidebar, select **Getting Started**. To open this screen, your role needs **View only** or **Full access** for **Getting Started**. To use **Connect Now**, the **Schedule a Call** button at the top, and the **Set Up Payments**, **Enrollments** and **Droplets** cards, it needs **Full access**. On the [Roles](/help/admin/settings/roles) screen, **Getting Started** is in the **Commerce** card. Open the card and set access from the **Getting Started** area's menu, not the card's. ## What's on the screen A card for another area, such as **Set Up Payments** or **Products**, appears only if your role can view that area. ### Header The screen opens with **Welcome to We-Commerce** and a greeting. Under it: * **Learn About We-Commerce** opens the We-Commerce website in a new tab. * **Schedule a Call** opens a booking page in a new tab, where you can book a call with Fluid Studios. ### Commission engine card The **Your Platform. Ready in Minutes.** card is for connecting your commission engine. **Connect Now** opens the **Connect Data Source** panel. See [Connect your commission engine](#connect-your-commission-engine). ### Site and app previews **Live Site** shows a preview of your website's home page, with the site's address above it. The preview is for viewing only. * Scan the QR code to open your site on a phone, or click it to open the site in a new tab. * **Customize** opens the [Theme](/help/admin/themes) screen. * **Connect domain** appears while your site uses a Fluid web address instead of your own domain. It opens the [Domains](/help/admin/settings/domains) screen. **Mobile App** shows a preview of your app's home page. If you have more than one home page, it shows the default one, or the first active one if none is the default. * Scan the QR code with a phone to download your app, or click it to open the download page in a new tab. * **Customize** opens the [Home Tabs](/help/admin/mobile/home) screen. ### Setup cards Three cards sit under the previews. Click a card to use it. * **Set Up Payments** opens the **Set Up Payments** panel. See [Set up payments](#set-up-payments). * **Enrollments** opens the **Enrollment Packages** panel. See [Set up enrollment](#set-up-enrollment). * **Droplets** opens the Droplets **Marketplace**. Its button reads **Explore** until your company has connected a droplet, and **Manage** after that. ### Quickstart Console The **Quickstart Console** has a card for each area you set up. Most cards show a count. Click a card to open its screen. **Set up We-Commerce** covers the items that sync through Fluid Connect when you connect a commission engine. If you don't have one, you add them yourself. * **Products**: how many products you have, counting active, draft and archived ones. Opens [Products](/help/admin/products). * **Customers**: how many members your company has, customers and reps alike. Opens [Customers](/help/admin/customers). * **Countries**: how many countries you've added. Opens [Countries](/help/admin/settings/countries). * **Warehouses**: how many warehouse locations you have. Opens [Warehouses](/help/admin/settings/warehouses). * **Inventory**: how many warehouses you have. Opens [Inventory](/help/admin/inventory-levels). * **Categories**: how many categories you have. Opens [Categories](/help/admin/categories). * **Collections**: how many collections you have. Opens [Collections](/help/admin/collections). The next section's title starts with **Configure Fluid for** and ends with your company's name. It covers areas Fluid has set up for you that you should double-check. * **APMs**: how many active payment methods you have. Opens [Alternative Payment Accounts](/help/admin/settings/apm). * **Shipping**: your company's shipping setting, or **Not Set**. Opens [Shipping](/help/admin/settings/shipping). * **Tax**: your company's tax setting, or **Not Set**. Opens [Tax](/help/admin/settings/taxes). * **Admins**: how many admins your company has. Opens [Admins](/help/admin/admins). * **Agreements**: how many **Active Agreements** you have. Opens [Agreements](/help/admin/settings/agreements). * **Languages**: how many **Active Languages** your company has. Opens [Languages](/help/admin/settings/languages). * **Subscription Plans**: how many subscription plans you have. Opens [Subscription Plans](/help/admin/settings/subscription-plans). * **Promotions**: how many **Active Codes** you have. Opens [Promo Codes](/help/admin/promo-codes). * **Developer**: opens [Developer](/help/admin/settings/developer). * **Brand Guidelines**: opens [Brand Guidelines](/help/admin/settings/brand-guidelines). In this section, a green dot on a card means the area is set up: its count is above zero or, for **Shipping** and **Tax**, a setting is chosen. **Developer** and **Brand Guidelines** don't show one. **Get even more out of We-Commerce** has two more cards: * **Advanced settings & configurations for power users** opens the [Brand Guidelines](/help/admin/settings/brand-guidelines) screen in Settings. * **Get personalized help from Fluid Studios experts** opens the same booking page as **Schedule a Call**, in a new tab. ## Tasks ### Connect your commission engine On the **Your Platform. Ready in Minutes.** card, click **Connect Now**. The **Connect Data Source** panel opens. Under **Connect Your Commission Engine**, click your engine's tile. The panel has a tile for each of these that's available as a droplet: Exigo, ByDesign, Pillars, Shopify and Infotrax. A **Connected** badge marks one your company has already connected. The droplet's page opens, and the panel closes. If your engine has no tile, click **Custom** to browse all integrations in the **Marketplace**. If you don't have a commission engine, click **I Need One** to open a booking page for a call with Fluid Studios. For guided setup of these connections, see [Connect Exigo](/setup/connect-exigo), [Connect ByDesign](/setup/connect-bydesign), [Connect Pillars](/setup/connect-pillars) and [Connect InfoTrax](/setup/connect-infotrax) in the developer docs. ### Set up payments Click the **Set Up Payments** card. The **Set Up Payments** panel opens. Under **Choose Your Payment Experience**, choose one: * **Activate Fluid Payments** opens the [Onboarding](/help/admin/settings/onboarding) screen. * **Connect to existing provider accounts** opens the [Alternative Payment Accounts](/help/admin/settings/apm) screen, for using your own provider accounts instead of Fluid Payments. * **Need Help?** opens a booking page in a new tab, where you can book a call with a payment specialist. ### Set up enrollment Click the **Enrollments** card. The **Enrollment Packages** panel opens. * On the **Enrollment Forms** card, click **Set Up Forms** to open the [Forms](/help/admin/forms) screen. * On the **Enrollment Packs** card, click **Create Packs** to open the [Enrollments](/help/admin/enrollments) screen. * **Need Help Getting Started?** opens a booking page in a new tab, where you can book a call with an enrollment specialist. ## Tips * The counts on the cards can take up to five minutes to catch up with changes you make elsewhere in the admin. * The **Mobile App** preview reloads each time you open this screen, so changes to your app's home page show when you come back. ## Frequently asked questions Your role has **View only** for **Getting Started**. **Connect Now**, the **Schedule a Call** button at the top, and the **Set Up Payments**, **Enrollments** and **Droplets** cards need **Full access**. The **Quickstart Console** cards still open their screens. Ask an admin who manages roles to update your role. See [Roles](/help/admin/settings/roles). A card for another area appears only if your role can view that area. Ask an admin who manages roles to give your role access to it. See [Roles](/help/admin/settings/roles). If the card says **Your store preview appears once you confirm your email.**, your company's signup email isn't confirmed yet. After you confirm it, the preview and the site's QR code appear. Your app doesn't have a home page yet. Click **Customize** on the **Mobile App** card to open the [Home Tabs](/help/admin/mobile/home) screen and set one up. The admin couldn't load your full profile. Click **Retry** on the banner to load it again. ## Related pages * [Admin portal](/help/admin) * [Playbook](/help/playbook) * [Roles](/help/admin/settings/roles) * [Payment Gateways](/help/admin/settings/gateways) * [Guided setup](/setup/overview) * [We-Commerce](/concepts/we-commerce) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.