> ## 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. # Find and create storefront resources > List, search, filter, and page through storefront resources, look one up by slug or id, and create new ones with the company API. Every storefront resource is found and created the same way. The examples here use posts. Swap `posts` for any other resource path, and `post` for that resource's body key — see [Storefront resources](/storefront/resources) for the list. ## List a resource `GET /api/v202604/` returns a page of **live** resources: the ones a shopper can see right now. Call it on the store's own host, with no token: ```bash theme={null} curl "https://acme.fluid.app/api/v202604/posts" ``` Rows come back in an array named after the resource, next to a `status` and a `meta` block: ```json theme={null} { "status": 200, "posts": [ { "id": 7314, "slug": "spring-training-plan", "title": "Your spring training plan", "description": "Four weeks of workouts to build a base before race season.", "image_url": "https://cdn.fluid.app/posts/7314/cover.jpg", "canonical_url": "https://acme.fluid.app/home/blog/spring-training-plan", "active": true, "status": "published", "publish_at": null, "countries": [], "languages": ["en"] } ], "meta": { "request_id": "7f3c2a90-1c2b-4d5e-9aaa-112233445566", "timestamp": "2026-09-29T12:34:56Z", "pagination": { "cursor": null, "next_cursor": "eyJpZCI6NzMxNH0", "prev_cursor": null, "limit": 25 } } } ``` ### Search, filter, and sort Every resource list accepts these query parameters: Free-text search over `title` and `description`. An ISO-2 country code. Returns resources available in that country, including unrestricted ones. Products use `country` instead. See [Country availability](/storefront/country-availability). A language code. Returns only resources translated into that language. Not available on products. A sort key. Prefix it with `-` for descending order, for example `-created_at`. Each resource has its own default order — see [Storefront resources](/storefront/resources). The language to return text in, for example `fr`. Omit it for the store's default language. Some resources add their own filters, such as `filter[parent_id]` on categories or `filter[media_type]` on media. See [Storefront resources](/storefront/resources). ```bash theme={null} curl "https://acme.fluid.app/api/v202604/posts?q=training&filter[country]=GB&sort=-created_at" ``` ### Page through results Lists use cursor pagination. Pass `meta.pagination.next_cursor` back as `page[cursor]` to get the next page, and repeat until `next_cursor` is `null`. `page[limit]` sets the page size: the default is `25` and the maximum is `100`. A larger value returns `422`. ```bash theme={null} curl "https://acme.fluid.app/api/v202604/posts?page[limit]=50&page[cursor]=eyJpZCI6NzMxNH0" ``` ## Look one up by slug `GET /api/v202604//{slug}` returns one resource, under its singular key: ```bash theme={null} curl "https://acme.fluid.app/api/v202604/posts/spring-training-plan" ``` A slug lookup can return a resource that isn't in the public list, such as a draft. See [Visibility, drafts, and scheduling](/storefront/visibility) before you rely on it. ## Find anything as an admin The company list returns **every** resource of that type, whatever its state. Call it on `https://api.fluid.app` with a Bearer token: ```bash theme={null} curl "https://api.fluid.app/api/v202604/company/posts" \ -H "Authorization: Bearer " ``` It accepts the same parameters as the public list, plus two that the public side ignores: One `status` value, such as `draft` or `published`. On products, use `active`, `draft`, or `archived`. `"true"` or `"false"`. Not available on products. ```bash theme={null} curl "https://api.fluid.app/api/v202604/company/posts?filter[status]=draft" \ -H "Authorization: Bearer " ``` To fetch one resource as an admin, use its numeric `id`: ```bash theme={null} curl "https://api.fluid.app/api/v202604/company/posts/7314" \ -H "Authorization: Bearer " ``` ## Create a resource `POST /api/v202604/company/` creates a resource. Wrap the fields in the resource's body key. `title` is the only required field: ```bash theme={null} curl -X POST "https://api.fluid.app/api/v202604/company/posts" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "post": { "title": "Your spring training plan" } }' ``` A fuller create can set the slug, lifecycle, countries, metafields, and SEO in one request: ```bash theme={null} curl -X POST "https://api.fluid.app/api/v202604/company/posts" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "post": { "title": "Your spring training plan", "description": "Four weeks of workouts to build a base before race season.", "slug": "spring-training-plan", "custom_slug": true, "active": true, "status": "scheduled", "publish_at": "2026-10-06T08:00:00Z", "country_isos": ["GB", "US"], "metafields_attributes": [ { "namespace": "custom", "key": "reading_time", "value": "6 min", "value_type": "single_line_text_field" } ], "search_engine_optimizer_attributes": { "title": "Spring training plan: four weeks to race-ready", "description": "A four-week base-building plan for runners.", "indexable": true } } }' ``` A successful create returns `201` with the new resource under its singular key. Things to know when you write: * **Updates change only what you send.** `PATCH /api/v202604/company//{id}` leaves every key you leave out as it was. * **Unknown keys are rejected.** A key the write schema doesn't define returns `422`. Don't send a response object back as a write: fields like `countries` and `seo` are read-only. * **SEO is written and read under different keys.** Write it as `search_engine_optimizer_attributes`. Read it as `seo`. See [SEO](/storefront/seo). * **Visibility is two fields.** `active` (or `public`, for products) switches the resource on or off, and `status` sets its lifecycle. See [Visibility, drafts, and scheduling](/storefront/visibility). * **Slugs are generated unless you pin one.** See [Slugs and URLs](/storefront/slugs-and-urls). * **Metafields are public.** Everything in `metafields` is returned by the public endpoints, so keep private data out of them. ## Next steps * [Visibility, drafts, and scheduling](/storefront/visibility) * [Slugs and URLs](/storefront/slugs-and-urls) * [Country availability](/storefront/country-availability)