> ## 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. # Themes > See your current storefront theme, keep other themes in your library, add or import new ones, and publish the one your store uses. Use the **Themes** screen to manage your storefront's look. One theme is live at a time. The others wait in your library until you publish one. ## Where to find it In the admin sidebar, under **Website**, select **Theme**. To open this screen, your role needs **View only** or **Full access** for **Theme**. To import, add, customize, publish, rename, upgrade or delete themes, it needs **Full access**. To add or edit global themes, it also needs **Full access** for **Global Themes**. On the [Roles](/help/admin/settings/roles) screen, **Theme** and **Global Themes** are in the **Content & Website** card. Open the card and set access from each area's menu, not the card's. ## What's on the screen At the top of the page: * **View your site** opens your storefront in a new tab. It's grayed out until your company's signup email is confirmed. * The three-dot button next to it holds **Clear Cache** and **Connect from GitHub**. It appears only if your role has the **Theme** switch **Customize and edit theme settings**. ### Current theme The first card shows a desktop-sized and a phone-sized preview of your storefront, with your current theme's row below them. Until your signup email is confirmed, the previews say **Your store preview appears once you confirm your email.** ### Theme Library **Theme Library** lists your company's themes, including the current one. Other themes in the library aren't live until you publish one. * Use the search box to filter the list. * **Import** uploads a theme from a ZIP file. It appears only if your role has the **Theme** switch **Install new themes**. * The list loads 10 themes at a time. Click **Load More** for the next 10. ### Theme rows The current theme card and the library show each theme as a row with its thumbnail, name, **Version** and **Last save** date and time. Two badges can appear: * **Current theme**: the theme your storefront uses. * **Outdated**: you can upgrade the theme with **Upgrade**. A row can also show: * **Customize**: opens the theme's home page in the [Page Editor](/help/admin/page-editor). If the theme has no default home page template, it opens the theme's code editor instead. * **Publish**: on draft themes in the library. See [Publish a theme](#publish-a-theme). * **Importing**: the theme is still importing. * **Error Importing Theme**: the theme's import failed. The row's three-dot button, hidden while the theme imports, has: * **Preview**: opens your storefront with this theme in a new tab. It isn't offered for the current theme. * **Open in Editor**: opens the theme's code editor in a new tab. * **Upgrade**: on outdated themes. In the **Upgrade Theme** dialog, click **Upgrade**. The dialog warns that you may lose your changes to the theme. * **Rename**: turns the name into a text box. Press Enter or click away to save, or press Esc to cancel. * **Download**: saves the theme as a ZIP file named after the theme. * **Delete**: on draft themes in the library and on themes whose import failed. In the **Delete Theme** dialog, click **Delete**. * **Copy Preview URL**: copies a link that opens the theme's preview. **Customize**, **Publish**, **Open in Editor**, **Upgrade** and **Rename** appear only with the **Customize and edit theme settings** switch, and **Delete** only with **Remove installed themes**. **Preview** and **Copy Preview URL** don't appear until your signup email is confirmed. ### Fluid Studios This banner offers Fluid's design and marketing services. **Let's get started** opens a scheduling page in a new tab. ### Trending Themes **Trending Themes** lists ready-made themes you can add to your library. Each card shows the theme's name and version, with an **Add** button. Click **Load More** to see more. This section appears only if your role has the **Install new themes** switch. ### Global Themes The last card's title is your company's name followed by **Global Themes**. It lists the global themes your company has created, each with its name, version and a status such as **Draft** or **Published**. **View Demo** opens a theme's demo, when it has one. **Add Global Theme** creates a global theme, and a card's **Edit** opens it. Both open the global theme's own screen. **Add Global Theme** appears only with the **Install new themes** switch. ## Tasks ### Publish a theme In **Theme Library**, find the draft theme you want. Use the search box or **Load More** if you need to. Optional: open the row's three-dot button and choose **Preview** to see the theme on your storefront. Click **Publish**. A **Published successfully!** message appears. Publishing takes effect right away, with no confirmation. The theme becomes your current theme, and the theme that was current becomes a draft in your library. ### Import a theme from a ZIP file In **Theme Library**, click **Import**. Click **Choose Files**, pick the theme's `.zip` file and confirm it. You can import one file at a time. In the **Import Theme** dialog, **Theme Name** starts as the file's name. Change it if you like. It can't be empty. Click **Import Theme**. A message confirms that the import has started. The import runs in the background. When it finishes, the theme is a draft in your library. If it fails, its row shows **Error Importing Theme**, and you can delete the theme. ### Add a theme from Trending Themes In **Trending Themes**, find the theme you want. Click **Load More** to see more. Click **Add**. A **Theme import started!** message appears. The theme imports into your library in the background and goes through the same statuses as a ZIP import. ### Connect a theme from GitHub **Connect from GitHub** imports a theme from a branch of a GitHub repository. Click the three-dot button at the top of the screen and choose **Connect from GitHub**. Under **GitHub Account**, select an account. To add one, click **Connect to GitHub**, or **Add Another Account** if one is already connected. In the GitHub window that opens, choose which repositories to grant access to. If your browser blocks the window, allow pop-ups for the admin and try again. Under **Select Repository**, search for the repository and select it. Each one is marked **Private** or **Public**. Under **Choose Branch**, select a branch. The repository's default branch, marked **default**, is selected for you. Click **Connect**. A message confirms that the theme is connected. The theme imports into your library in the background, named after the repository. **Connect from GitHub** appears only if your role also has the **GitHub** switch **View GitHub integration status**. Adding a GitHub account also needs **Configure GitHub integration**. On the [Roles](/help/admin/settings/roles) screen, **GitHub** is in the **Settings** card; set it from the **GitHub** area's menu, not the card's. If a **Failed to connect GitHub account** message appears, check your role's access to **GitHub**. ### Clear the cache Click the three-dot button at the top of the screen and choose **Clear Cache**. It clears the cache for every page of your storefront. The item reads **Clearing Cache** while it works, and a message confirms when it's done. To clear the cache, your role also needs the **Developer** switch **Manage webhooks and API configuration (Callbacks, Developer, Webhooks)**. On the [Roles](/help/admin/settings/roles) screen, **Developer** is in the **Settings** card; set it from the **Developer** area's menu, not the card's. If a **Failed to clear cache** message appears, check your role's access to **Developer**. ## Tips Before you upgrade a theme, use **Download** to save a copy of it. ## Frequently asked questions You can add a theme to your library in three ways: * Upload a ZIP file with **Import**. See [Import a theme from a ZIP file](#import-a-theme-from-a-zip-file). * Add a ready-made theme from **Trending Themes**. See [Add a theme from Trending Themes](#add-a-theme-from-trending-themes). * Import a branch of a GitHub repository. See [Connect a theme from GitHub](#connect-a-theme-from-github). Imported themes start as drafts. Customize and preview the theme, then publish it when it's ready. **Delete** appears only on draft themes in **Theme Library** and on themes whose import failed. You can't delete your current theme. To remove it, publish another theme first. The old theme becomes a draft that you can then delete. Your company's signup email isn't confirmed yet. Until it is, **View your site** is grayed out, the previews show a message instead of your storefront, and **Preview** and **Copy Preview URL** don't appear in the theme menus. Confirm the email to turn them on. Your role can view themes but doesn't have **Full access** for **Theme**. Without the **Install new themes** switch, **Import**, **Trending Themes** and **Add Global Theme** don't appear. Without **Customize and edit theme settings**, **Customize**, **Publish** and the three-dot button at the top of the screen don't appear. Ask an admin who manages roles to give your role **Full access** for **Theme**. See [Roles](/help/admin/settings/roles). ## Related pages * [Website](/help/admin/website) * [Page Editor](/help/admin/page-editor) * [Mysite Theme](/help/admin/mysite-themes) * [Roles](/help/admin/settings/roles) * [Themes overview](/themes/overview) * [Connect a theme to GitHub](/themes/github-integration) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.