> ## 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. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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. # Add a language and translate your storefront > Turn on a new language, translate your storefront resources, navigation, theme strings, agreements, and product labels, and confirm nothing is left untranslated. A new language shows shoppers your storefront in the language they choose. First you turn the language on for your company. Then you translate what shoppers see: your storefront resources (products, categories, collections, pages, and so on), your navigation menus, your theme's own strings, such as button labels, your agreements, and your product labels. The CLI reports what isn't translated yet, machine-translates it, and writes it back. You review the result and finish when the report comes back empty. ## Before you start * A Fluid API token for the company, from **Settings > API Tokens**, or your own sign-in with `fluid login`. The token needs these permissions: * **Languages** update, to turn a language on. * **Storefront** update, to translate storefront resources. * **Menus** update, to translate navigation. * **Themes** update, to save theme strings and to use machine translation. * **Agreements** update, to translate agreements. * **Categories** update, to translate product labels. * Know the language's code, such as `fr` for French or `zh-TW` for Traditional Chinese. `fluid translations languages` lists every language Fluid supports and its code. * Install and sign in to the CLI: ```bash theme={null} npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-localization fluid login ``` Every `fluid translations` command prints JSON. Failures print a JSON `error` on stderr and exit with a non-zero code. Prefer to answer questions? Run `fluid translations walk` in a terminal. It asks for the language, offers to turn it on, shows what's missing, and machine-translates each type in batches. You accept, edit, or skip each translation, and each one is saved as you accept it. Type `<` to go back, `>` to skip, and `?` for the menu. ## Steps ```bash theme={null} fluid translations enable fr --yes ``` This changes your company's live configuration: shoppers can now choose French, and translations can be saved to it. The CLI asks for confirmation unless you pass `--yes`. If the language is already on, the output lists it under `alreadyActive` and nothing changes. You can turn on several at once, such as `fluid translations enable fr de --yes`. ```bash theme={null} fluid translations missing fr ``` The report has one entry per type. Each entry gives `total`, `missingCount`, and a `missing` list. Every item in the list has an `id` and its `source` text in your default language. `done` is `true` only when every type is fully translated. Narrow the report with `--type`, for example `--type products --type theme`. Add `--published-only` to skip drafts, scheduled items, and archived items, which shoppers don't see. Preview first. Without `--write`, nothing is saved: ```bash theme={null} fluid translations auto fr --limit 10 ``` Then save the translations: ```bash theme={null} fluid translations auto fr --limit 25 --write --yes ``` `--write` changes live content. Theme strings publish to your storefront as soon as they're saved. Machine translation uses Fluid AI and counts toward your company's AI usage. `--limit` caps how many items of each type one run translates. Each type reports `remaining`, the number of items still left. Run the command again until `remaining` is `0` for every type. Machine translation fills text fields only. Set a per-language image or file in the next step. Each item is saved on its own. If the API refuses one, it's listed under `failed` with the reason and the rest are saved; it counts toward `remaining`. Compare an item's default text with its translation: ```bash theme={null} fluid translations show products 60311 --lang fr ``` Then correct a translation or fill a field by hand: ```bash theme={null} fluid translations set products 60311 --lang fr --yes \ --set title="Mélange de betteraves" \ --set description="

Un concentré de betteraves pressé à froid.

" fluid translations set menu-items 12/340 --lang fr --yes --set title="Boutique" fluid translations set theme --lang fr --yes --set products.add_to_cart="Ajouter au panier" fluid translations set labels 6 --lang fr --yes --set title="Végétalien" fluid translations set agreements 4 --lang fr --yes --file terms-fr.json ``` Each `set` changes live content. A menu item's id is `/`, a theme string's id is its dotted key, and a theme page string's id is `