> ## 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. # Storefront API overview > What the Fluid storefront API covers, which resources it serves, the current version, and how its public and company endpoints fit together. The storefront API serves the content a Fluid store shows its shoppers: products, the groupings that organize them, and the pages, posts, and media around them. You read it to render a storefront, and you write it to manage that content from your own tools. ## Current version The current storefront version is **v2026-04**. Its paths start with `/api/v202604/`. Every storefront resource is available on it, and there is no newer storefront version. Older Fluid APIs still serve some of the same resources — for example the unversioned company API's product, page, and media endpoints. Those endpoints remain available, but they don't receive new fields or behavior. Build new integrations on v2026-04. ## Resources The storefront API has eight resources. They share one design, so once you know one you know most of the others. | Resource | What it is | Public catalog | | - | - | - | | Products | Items you sell, with variants and country pricing | [List](/api-reference/storefront/public-products-catalog) · [By slug](/api-reference/storefront/public-product-by-slug) | | Categories | A nested tree that organizes products or other content | [List](/api-reference/storefront/public-categories-catalog) · [By slug](/api-reference/storefront/public-category-by-slug) | | Collections | Flat, hand-picked groups of products | [List](/api-reference/storefront/public-collections-catalog) · [By slug](/api-reference/storefront/public-collection-by-slug) | | Pages | Standalone storefront pages built from a theme template | [List](/api-reference/storefront/public-pages-catalog) · [By slug](/api-reference/storefront/public-page-by-slug) | | Posts | Blog posts | [List](/api-reference/storefront/public-posts-blog-catalog) · [By slug](/api-reference/storefront/public-post-by-slug) | | Media | Videos, images, PDFs, and other files | [List](/api-reference/storefront/public-media-catalog) · [By slug](/api-reference/storefront/public-medium-by-slug) | | Playlists | Curated sets of media | [List](/api-reference/storefront/list-playlists-public-storefront-catalog) · [By slug](/api-reference/storefront/show-a-playlist-public-by-slug) | | Enrollment packs | Bundles a new member buys to join | [List](/api-reference/storefront/public-enrollment-packs-catalog) · [By slug](/api-reference/storefront/public-enrollment-pack-by-slug) | See [Storefront resources](/storefront/resources) for what each one adds to the shared design. ## Two kinds of endpoint Every resource has two sets of endpoints: * **Public endpoints** — `/api/v202604/` and `/api/v202604//`. No token. They serve what a shopper may see, and you call them on the store's own host. * **Company endpoints** — `/api/v202604/company/` and `/api/v202604/company//`. A Bearer token is required. They serve and manage everything, including content that isn't live yet, and you call them on `https://api.fluid.app`. See [Public and company endpoints](/storefront/public-and-company-endpoints) for how they differ. ## What every resource shares * **The same response fields.** Every resource returns `id`, `slug`, `title`, `description`, `image_url`, `canonical_url`, `images`, `active`, `status`, `publish_at`, `seo`, `metafields`, and `languages`, then adds its own. * **The same visibility model.** Lists show only live content. Looking up a slug directly can return content that isn't live yet. See [Visibility, drafts, and scheduling](/storefront/visibility). * **The same list controls.** Search with `q`, filter with `filter[...]`, sort with `sort`, and page with `page[cursor]` and `page[limit]`. * **The same translation model.** See [Translate storefront resources](/storefront/translations). * **The same SEO model.** See [SEO for storefront resources](/storefront/seo). Metafields are returned in full on the public endpoints. Never store private or internal data in a storefront resource's metafields. See [Metafields](/storefront/metafields). ## Guides Hosts, authentication, addressing, and what each side returns. The eight resources and what makes each one different. Browse, search, and filter, then create with the company API. What makes a resource live, and what drafts return. How slugs are set, pinned, and turned into URLs. What search engines see, and how to control it. Attach your own typed data to any resource. Limit a resource to the countries it's sold in. Write and read a resource in more than one language. Nest categories and walk the tree. Credit paths, attribution, add to cart, and media on a Fluid storefront.