> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > 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. > To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP server can't publish server functions or convert a Site to an App, so use the fluid sites CLI for those. A Site can serve light server code: each functions/.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/ on the Site's own host; publish it with fluid deploy (the MCP site_deploy tool does not carry functions). See /sites/functions and /sites/rest-api. > 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 on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > 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 except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — 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. # Read a record's metafield translations > Token-authenticated. Returns each translatable metafield the record holds a value for, with its original value, the digest of that original, and the stored translation in `lang`, or `null` when there is none. No fallback text stands in for a missing translation. A field is listed when its metafield definition is marked translatable and its type is `single_line_text_field`, `multi_line_text_field`, `rich_text_field`, `list.single_line_text_field` or `url`. Definitions are matched by namespace and key among those of the record's own owner type (`Product`, `Variant` or `EnrollmentPack`). Needs the permissions of the record's resource: `Product` and `Variant` the storefront (or legacy product) permissions, `EnrollmentPack` the storefront (or legacy enrollment pack) permissions. A caller without them gets 403 whether or not the record exists. Answers 404 while the `translatable-metafields` feature is off for the company, and for a record of another company (a variant counts as its product's). `lang` must be a language the store sells in and not its default language (422). ## OpenAPI ````yaml /api-reference/storefront-v2026-04.yaml get /api/v202604/company/metafield-translations openapi: 3.1.0 info: title: Fluid Storefront v2026-04 API version: v2026-04 description: > The modernized storefront surface, covering all eight storefront resources: **Categories**, **Collections**, **Products**, **Posts**, **Pages**, **Media**, **Enrollment Packs**, and **Playlists**. ## Two surfaces Every resource is exposed twice, and the pair is the thing to understand first: - **Public** — `/api/v202604/{resource}` and `/api/v202604/{resource}/{slug}`. Unauthenticated (`security: []`); the store is resolved from the request subdomain. Addressed by `slug`, the same identifier that appears in `canonical_url`. Lists return only live rows. Show-by-slug is looser so preview links work: draft, scheduled, and inactive rows resolve with `seo.indexable: false`, and country availability never restricts it. Show returns 404 only for archived or deleted products, categories, collections, and posts, and for deleted pages, media, playlists, and enrollment packs (which have no archived state). - **Company** — `/api/v202604/company/{resource}`. Bearer-token authenticated, addressed by `id`, and returns every row whatever its lifecycle state, so an admin can manage drafts and archives. Full CRUD plus the standardized `shares`, `lighthouse`, and `compliance` member actions on each resource. Path segments use the storefront's nouns, not the database's: `enrollment-packs` and `playlists` (the Library model). ## One response shape Every resource response opens with the same canonical "common top", in the same order, before any resource-specific fields: id, slug, title, description, image_url, canonical_url, images, active, status, publish_at, seo, metafields, languages That means a consumer can render any storefront resource from one code path. `seo` is always present and always fully populated — the server resolves it through a priority chain (SEO record → resource field → store default → built-in), so there is no client-side fallback logic and the API can never disagree with the rendered ``. `metafields`, `languages`, and (where applicable) `countries` are always arrays, never null. ## Lifecycle `status` is the canonical four-value contract — `draft`, `scheduled`, `published`, `archived` — and resolves at the API boundary: a stored `scheduled` row whose `publish_at` has passed reads as `published` with no write required. `active` is the separate merchant on/off toggle; a resource is live only when it is both active and resolved-published. Company create and update auto-queue Lighthouse and compliance scans, so the scores on the member actions always describe the current state of the resource. ## Listing and pagination Index endpoints share one query surface: `lang`, `q` (full-text search over title and description), `filter[…]`, `sort`, and cursor pagination via `page[cursor]` / `page[limit]` (default 25, max 100). Follow `meta.pagination.next_cursor`; do not construct cursors. Products additionally take `country`, which selects the country-relative price and currency AND gates availability. Categories and Collections expose their products from their own path — `GET /api/v202604/categories/{slug}/products` — which is the products catalog scoped to one owner, with the same card shape, filters, sorting, and pagination. ## Translating a resource Translations of a resource's own fields are written inline on its own create/update. There is no separate translations endpoint for them and no `translations` object in the payload — the `lang` query parameter selects the locale a request reads or writes. Metafield values are the exception. A metafield whose definition is marked translatable is translated through its own operations, `GET` and `PUT /api/v202604/company/metafield-translations`, which keep each translation apart from the original value. The `lang` parameter on a resource's own update never writes metafields. **Read** a locale with `lang` on any GET: GET /api/v202604/company/collections/4821?lang=fr Translated fields (`title`, `description`, `image_url`, and each resource's own translated fields) come back inline in that locale. Any field with no `fr` translation falls back to its `en` value, so a partially-translated resource never renders blank. On reads an unsupported or unknown `lang` is ignored and the response comes back in the default locale. The `languages` array on every response lists exactly the locales that carry a translation, always including the default. **Write** a locale with `lang` on POST/PATCH: PATCH /api/v202604/company/collections/4821?lang=fr { "collection": { "title": "Essentiels bien-être" } } Omitting `lang` writes the store's default locale — the store's own default language, not the platform's. A store selling in French treats `lang=fr` as its default write. On every resource except products, a translation PATCH is TEXT ONLY: against any other locale, everything but the translated fields is ignored, so translating a title can never change the slug, move `status`, or change `country_isos`, metafields, SEO, or associations. Send those in a request against the store's default locale instead. Products are the exception. A product PATCH with a non-default `lang` is NOT text-only: it writes the translated fields for that locale AND applies the other fields in the payload to the product itself. Only `images_attributes` and `metafields_attributes`, on the product and on each variant, are ignored. When translating a product, send only the translated fields. Creating is different: POST always writes the store's default locale whatever `lang` says, and keeps its full payload. A resource created under a translation would have no value in the store's own language and would take its slug from the translation. `lang` is still validated on POST, so an unsupported locale is a 422 rather than a surprise. On a write, a `lang` the store does not sell in returns 422 — translations are never written to a locale the store has not enabled. Add the language to the store first. The typical flow is: create in the default locale, then one PATCH per additional locale carrying only the translated text. **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: >- Company operations (`/api/v202604/company/...`). The Bearer token identifies the company. - url: https://{company}.fluid.app description: >- Public storefront reads (`/api/v202604/`). These carry no token, so the company is resolved from the request host: the company's Fluid subdomain or a custom domain connected to the company. Sent to api.fluid.app, they return 404. variables: company: default: acme description: Your company's Fluid subdomain security: [] tags: - name: storefront description: | Unauthenticated public surface that backs storefront pages and AEO crawlers. All operations are `security: []`. - name: company description: | Token-authenticated company surface that backs the admin UI and integrations. - name: options description: >- Product options used to define variant attributes and coordinate safe option-value updates. x-fluid-section: Commerce - name: member-sites description: >- The public sites a company's members made, listed by member without a token. x-fluid-section: Storefront - name: metafield-translations description: >- Per-language translations of the values of a record's metafields, kept apart from the original values. x-fluid-section: Storefront - name: sites description: | A company's own sites as storefront resources: the public catalog and show, and the company CRUD with shares, Lighthouse and compliance. x-fluid-section: Storefront paths: /api/v202604/company/metafield-translations: get: tags: - metafield-translations summary: Read a record's metafield translations description: | Token-authenticated. Returns each translatable metafield the record holds a value for, with its original value, the digest of that original, and the stored translation in `lang`, or `null` when there is none. No fallback text stands in for a missing translation. A field is listed when its metafield definition is marked translatable and its type is `single_line_text_field`, `multi_line_text_field`, `rich_text_field`, `list.single_line_text_field` or `url`. Definitions are matched by namespace and key among those of the record's own owner type (`Product`, `Variant` or `EnrollmentPack`). Needs the permissions of the record's resource: `Product` and `Variant` the storefront (or legacy product) permissions, `EnrollmentPack` the storefront (or legacy enrollment pack) permissions. A caller without them gets 403 whether or not the record exists. Answers 404 while the `translatable-metafields` feature is off for the company, and for a record of another company (a variant counts as its product's). `lang` must be a language the store sells in and not its default language (422). operationId: companyMetafieldTranslationsShow parameters: - name: owner_type in: query required: true description: | The kind of record: `Product`, `Variant` or `EnrollmentPack`. A variant is the company's when its product is. The metafield definitions that apply are those of this owner type. schema: type: string enum: - Product - Variant - EnrollmentPack - name: owner_id in: query required: true description: The record's id. schema: type: integer - name: lang in: query required: true description: > The language ISO to read (e.g. `es`, `zh-TW`). Not the store's default language, whose values are the originals. schema: type: string example: es responses: '200': description: The record's translatable fields. content: application/json: schema: $ref: '#/components/schemas/MetafieldTranslationsShowResponse' example: metafield_translations: owner_type: Product owner_id: 48213 lang: es fields: - namespace: custom key: how_to_use value_type: multi_line_text_field original_value: Mix one scoop with water. original_digest: >- 3b1f7c0e5a9d4e2b8c6a1f0d7e3b9a5c2d4f6e8a0b1c3d5e7f9a2b4c6d8e0f1a translation: value: Mezcla una dosis con agua. source_digest: >- 3b1f7c0e5a9d4e2b8c6a1f0d7e3b9a5c2d4f6e8a0b1c3d5e7f9a2b4c6d8e0f1a - namespace: custom key: benefits value_type: list.single_line_text_field original_value: - Energy - Endurance original_digest: >- 9d2c4e6f8a0b1c3d5e7f9a2b4c6d8e0f1a3b5c7d9e1f2a4b6c8d0e2f4a6b8c0d translation: null status: 200 meta: request_uuid: 4c9fc097-1f78-43b8-b8e0-ef3bb7163381 timestamp: '2026-11-13T18:24:12Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: >- The record is not one of the company's, or the feature is off for the company. content: application/json: schema: $ref: '#/components/schemas/MetafieldTranslationsError' example: error: message: Not found details: {} status: 404 meta: request_uuid: 4c9fc097-1f78-43b8-b8e0-ef3bb7163381 timestamp: '2026-11-13T18:24:12Z' '422': description: >- A parameter is missing or invalid, or `lang` is not a language the store sells in, or is its default language. content: application/json: schema: $ref: '#/components/schemas/MetafieldTranslationsError' example: error: message: Unsupported language details: lang: - unsupported locale "fr" status: 422 meta: request_uuid: 4c9fc097-1f78-43b8-b8e0-ef3bb7163381 timestamp: '2026-11-13T18:24:12Z' security: - bearer_auth: [] components: schemas: MetafieldTranslationsShowResponse: type: object required: - metafield_translations - status - meta properties: metafield_translations: type: object required: - owner_type - owner_id - lang - fields properties: owner_type: type: string enum: - Product - Variant - EnrollmentPack owner_id: type: integer lang: type: string description: >- The language the translations are stored under (`zh-TW` for Traditional Chinese, `zh` for Simplified). fields: type: array description: > Each translatable metafield the record holds a value for. A field whose definition is not translatable, or whose type is not one of the five translatable types, is not listed. items: $ref: '#/components/schemas/MetafieldTranslationField' status: type: integer meta: $ref: '#/components/schemas/MetafieldTranslationsMeta' MetafieldTranslationsError: type: object description: Error body of the metafield translation operations. required: - error - status - meta properties: error: type: object required: - message properties: message: type: string details: type: object description: | What was refused. `lang` names a language the store does not sell in, or its default language. `translations` holds one entry per refused item, keyed by its position in the request: `field` for a definition that is missing, not translatable or of a type that cannot be translated, `value` for a value the definition's type refuses, `source_digest` for a missing digest. additionalProperties: true status: type: integer meta: $ref: '#/components/schemas/MetafieldTranslationsMeta' MetafieldTranslationField: type: object description: One translatable field of a record. required: - namespace - key - value_type - original_value - original_digest - translation properties: namespace: type: string example: custom key: type: string example: how_to_use value_type: type: string enum: - single_line_text_field - multi_line_text_field - rich_text_field - list.single_line_text_field - url description: The metafield definition's type. original_value: $ref: '#/components/schemas/MetafieldTranslationValue' original_digest: type: string description: > The digest of the original value. Send it back as `source_digest` when saving a translation of this original. translation: type: - object - 'null' description: | The stored translation, or `null` when there is none. A missing translation is never replaced by fallback text. Compare its `source_digest` with `original_digest`: a difference means the original changed after it was translated. required: - value - source_digest properties: value: $ref: '#/components/schemas/MetafieldTranslationValue' source_digest: type: string MetafieldTranslationsMeta: type: object description: | Response metadata of the metafield translation operations. `request_uuid` and `timestamp` are always present. required: - request_uuid - timestamp properties: request_uuid: type: - string - 'null' description: Identifier of this request, for support. timestamp: type: string format: date-time UnauthorizedError: type: object description: | Bare 401 body — a single `message` string, not the wrapped `ErrorResponse`. required: - message properties: message: type: string example: Invalid credentials. ForbiddenError: description: | Bare 403 body: `{ error }` when a storefront permission is missing, or `{ message }` when the credential is not company-admin tier. oneOf: - type: object required: - error properties: error: type: string example: Not authorized. - type: object required: - message properties: message: type: string example: Not authorized. MetafieldTranslationValue: description: | A translated or original value: a string, or an array of strings for a `list.single_line_text_field` metafield. type: - string - array items: type: string responses: Unauthorized: description: | Missing or invalid bearer token. The body is a bare `{ message }` object — not the wrapped `ErrorResponse` envelope used by 404 / 422. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' Forbidden: description: | Authenticated but lacking the required permission. The body is bare — `{ error }` when the storefront permission is missing, or `{ message }` when the credential is not company-admin tier — not the wrapped `ErrorResponse` envelope used by 404 / 422. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' securitySchemes: bearer_auth: type: http scheme: bearer description: | Bearer token authentication. Accepts company-admin tokens with `storefront.view` for read operations and `storefront.update` for writes and scan triggers (legacy per-resource grants like `categories.update` / `products.view` / etc. are still accepted during the migration), required on every `company` operation. Storefront public operations under `/api/v202604/{resource}` and `/api/v202604/{resource}/{slug}` are unauthenticated (`security: []`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.