> ## 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. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/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. # Updates a theme resource > Submit member template dependencies together with members_sites.json using member_files so navigation is captured before any file changes. The files and member graph apply atomically; a rejected dependency rolls back the bundle. Existing single-resource writes remain supported. Missing manifests preserve existing configuration; deleting the file is refused. ## OpenAPI ````yaml /api-reference/themes-v0.yaml put /api/application_themes/{application_theme_id}/resources openapi: 3.1.0 info: title: Fluid Themes API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/application_themes/{application_theme_id}/resources: put: tags: - applicationthemeresources summary: Updates a theme resource description: >- Submit member template dependencies together with members_sites.json using member_files so navigation is captured before any file changes. The files and member graph apply atomically; a rejected dependency rolls back the bundle. Existing single-resource writes remain supported. Missing manifests preserve existing configuration; deleting the file is refused. operationId: updateThemeResource parameters: - name: application_theme_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: application_theme_resource: type: object properties: key: type: string content: type: - string - 'null' member_files: type: array maxItems: 5000 description: >- Optional text dependencies for members_sites.json only. Keys must be declared template, page, layout, or menu-reference paths, or their variables.json/styles.css sidecars. Duplicate paths, internal backing templates, the manifest itself, and binary assets are rejected. items: type: object properties: key: type: string content: type: string required: - key - content additionalProperties: false dam_asset: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' required: - key base_sha: type: - string - 'null' description: >- Merge-aware push guard. Optional; skipped when absent or null (backward compat / --force). See the preflight endpoint for the same contract. example: application_theme_resource: key: product/paper_product_page/index.liquid content: |- {% layout 'theme' %}

{{ product.title }}

{{ product.sku }}

base_sha: 9c3e1b7a42f06d58e2a91c4b7d03f6e85a12bc47 responses: '200': description: Success content: application/json: schema: type: object properties: application_theme_resource: $ref: '#/components/schemas/ApplicationThemeResource' content_version_sha: type: string description: >- Server's fresh content_version_sha after the write. Thread forward as the next call's base_sha. member_resources: type: array description: >- Final resources for member_files after portable menu references have been rewritten to destination handles. Present only for bundled member uploads. items: $ref: '#/components/schemas/ApplicationThemeResource' required: - application_theme_resource example: application_theme_resource: resource_type: ApplicationThemeTemplate resource_id: 48213 key: product/paper_product_page/index.liquid content: |- {% layout 'theme' %}

{{ product.title }}

{{ product.sku }}

checksum: >- a1c9e8f7d6b5a4c3e2f1d0b9a8c7e6f5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a9 url: null content_version_sha: e71d04a9c35b28f6a0d9173c4be58f2a61c0d93b meta: request_id: 4f1c2a9e-7b3d-4e8a-9c61-2d5f8a0b3e17 timestamp: '2026-09-22T15:04:12Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '404': description: >- Theme or public resource not found. Internal member backing templates are not public resources. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Stale base_sha — server has advanced since last pull. content: application/json: schema: $ref: '#/components/schemas/StaleBaseShaResponse' '422': description: >- Invalid member document or member_files bundle, unsupported dependency, or refused manifest deletion. Submit an explicit empty versioned document to clear the theme's member configuration. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] components: schemas: JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ApplicationThemeResource: type: object properties: resource_type: type: - string - 'null' resource_id: type: - integer - 'null' key: type: string content: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: string - type: 'null' checksum: type: - string - 'null' url: type: - string - 'null' required: - key - checksum UnauthorizedResponse: type: object properties: message: type: string required: - message ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' StaleBaseShaResponse: type: object description: >- 409 response body when the CLI's base_sha does not match the theme's current content_version_sha. The remote_sha under `meta` tells the CLI what SHA the server is at now so the CLI can prompt the user to pull first (or --force to overwrite). properties: error_message: type: string errors: type: object additionalProperties: true meta: type: object properties: request_id: type: string timestamp: type: string format: date-time remote_sha: type: string required: - request_id - timestamp - remote_sha required: - error_message - errors - meta ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````