> ## 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. # SEO for storefront resources > What the seo object on a storefront resource means, how Fluid fills in values you haven't set, when a page is indexable, and how to control SEO through the API. SEO — search engine optimization — is what search engines and link previews show for a storefront page: its title, its description, its preview image, and whether it should be indexed at all. Every storefront resource carries its SEO in an `seo` object, and you control it through the company API. ## The `seo` object Every storefront response includes `seo` with four fields: | Field | What it is | | - | - | | `title` | The page title shown in search results and link previews | | `description` | The summary shown under the title | | `image_url` | The preview image for link previews, sized 1200×630 | | `indexable` | Whether search engines are invited to index the page right now | These are the values the storefront page itself uses, so the API and the rendered page always agree. None of them is ever `null`. ## Values you haven't set You don't have to set SEO. When a field has no SEO value of its own, Fluid fills it from the next source in line: | Field | Filled from, in order | | - | - | | `title` | SEO title → resource `title` → store name | | `description` | SEO description → resource `description` → store's default description | | `image_url` | SEO image → resource image → store's default image | Descriptions are stripped of HTML and cut to 200 characters. On company responses, `seo.id` tells you where the values come from. A number means the resource has its own SEO settings. `null` means every value is filled in from the resource or the store. SEO settings are stored once per resource, in the store's default language. When you read a resource with another `lang`, `seo` is filled from the resource's translated `title`, `description`, and image instead. ## When a page is indexable `seo.indexable` is `true` only when nothing is stopping search engines. It's `false` when any of these is true: * The resource isn't live — for example a draft, or a scheduled resource before its time. See [Visibility, drafts, and scheduling](/storefront/visibility). * You opted the resource out by writing `indexable: false`. * The store blocks search engine indexing for the whole storefront. * The product isn't published to the storefront. A `false` value means the storefront page tells search engines not to index it. ## Set SEO Write SEO with `search_engine_optimizer_attributes` on a company create or update. The shape is the same on every resource: ```bash theme={null} curl -X PATCH "https://api.fluid.app/api/v202604/company/products/60311" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "product": { "search_engine_optimizer_attributes": { "id": 9215, "title": "Beet Blend | Cold-pressed beet concentrate", "description": "Cold-pressed beet concentrate for daily endurance support.", "image_url": "https://cdn.fluid.app/seo/beet-blend-share.png", "indexable": true } } }' ``` Include `id` when the resource already has SEO settings. Read it from `seo.id` on a company response. With `id`, only the fields you send change. Without it, the request **replaces** the resource's SEO settings, and any field you don't send falls back to its default. * **Write and read keys differ.** You write `search_engine_optimizer_attributes` and read `seo`. Sending an `seo` object in a write returns `422`. * **To remove a custom value, send `null`** for that field. It then falls back as described above. * **To keep a resource out of search engines**, send `indexable: false`. The resource stays live for shoppers. ## Slugs and canonical URLs A resource's slug is part of its public URL, and every response returns the full address as `canonical_url`. You can't set `canonical_url` directly — change the slug instead. Changing a slug changes the URL search engines have indexed, so do it sparingly. See [Slugs and URLs](/storefront/slugs-and-urls). ## Checklist * Give every live resource a clear `title` and `description`. They're the SEO fallbacks. * Set SEO values only where the page should read differently in search results than on the page itself. * Pin slugs on pages you promote, so a rename doesn't change their URL. * Use `indexable: false` for pages that should work for shoppers but stay out of search results, such as thank-you or member-only pages. * Check `seo.indexable` on the public slug lookup before you share a URL you expect to be indexed.