> ## 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. # Visibility, drafts, and scheduling > What makes a storefront resource live, why drafts don't appear in public lists but still load by slug, and how to publish, unpublish, and schedule. A storefront resource is either **live** — a shopper can find it — or not. Two fields decide which, and public lists and slug lookups treat a resource that isn't live differently. ## The two fields * **`active`** is an on/off switch. When it's `false`, the resource is never live, whatever its `status`. Products use `public` for this switch when you write them. * **`status`** is the lifecycle state: `draft`, `scheduled`, `published`, or `archived`. Pages, media, playlists, and enrollment packs have no `archived` state. A resource is **live** when it is switched on, its `status` is `published`, and any `publish_at` time has passed. There is no separate publish endpoint. You publish, unpublish, and schedule by updating these fields. ## Lists show only live resources A public list, such as `GET /api/v202604/posts`, returns live resources only. Drafts, scheduled resources that haven't gone live yet, and resources switched off never appear in it. Neither do they appear in the product list of a category or collection. The company list, `GET /api/v202604/company/`, returns everything, whatever its state. ## Slug lookups also return drafts A public slug lookup, such as `GET /api/v202604/posts/{slug}`, is looser than a list. It returns a resource that isn't live — a draft, a scheduled resource before its time, or one switched off — so that preview and pre-launch links work. A slug lookup returns `404` only when the resource no longer exists: | Resource | Slug lookup returns `404` for | | - | - | | Products, categories, collections, posts | An `archived` or deleted resource | | Pages, media, playlists, enrollment packs | A deleted resource | When a slug lookup returns a resource that isn't live, its `seo.indexable` is `false`. The storefront page for it tells search engines not to index it. A draft is not private. Anyone who knows or guesses its slug can load it through the public API. Keep unreleased content that must stay secret out of the storefront until it's ready. ## Publish a resource Switch it on and set `status` to `published`: ```bash theme={null} curl -X PATCH "https://api.fluid.app/api/v202604/company/posts/7314" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "post": { "active": true, "status": "published" } }' ``` For a product, send `public: true` instead of `active: true`. ## Unpublish a resource Either switch it off, which keeps its `status`: ```bash theme={null} curl -X PATCH "https://api.fluid.app/api/v202604/company/posts/7314" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "post": { "active": false } }' ``` or move its `status` back to `draft`. Both remove it from public lists, but its slug still loads. To make the slug return `404` as well, set `status` to `archived` on a resource that supports it, or delete the resource. ## Schedule a resource to go live Switch it on, set `status` to `scheduled`, and set `publish_at` to the go-live time: ```bash theme={null} curl -X PATCH "https://api.fluid.app/api/v202604/company/posts/7314" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "post": { "active": true, "status": "scheduled", "publish_at": "2026-10-06T08:00:00Z" } }' ``` Once `publish_at` passes, the resource reads as `published` and appears in public lists. You don't need a second request. Until then it's left out of lists but still loads by slug, so you can preview it. There is only a go-live time. To take a resource down at a set time, update it at that time: switch it off, or archive or delete it. ## What else can hide a resource from a list * **Country availability.** When a list is filtered by country, a resource limited to other countries is left out. Countries never affect a slug lookup. See [Country availability](/storefront/country-availability). * **Language.** When a list is filtered by `filter[language]`, a resource not translated into that language is left out. * **Restricted media.** A medium with restricted visibility, or one uploaded by a rep, is never listed publicly, but it still loads by slug. * **Products not sold in the country.** A product with no variant sold in the requested `country` is left out of the list. ## Next steps * [SEO](/storefront/seo) — how `seo.indexable` is decided. * [Slugs and URLs](/storefront/slugs-and-urls) — the slug a lookup uses.