> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > 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. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > 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 except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — 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. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Update a Site > Token-authenticated; requires `storefront.update` and a signed-in admin. Only the keys sent change. A `status` change runs after the other fields are saved. While a moderator suspension stands (`suspended_at`), the site cannot be published, scheduled, activated or made public (422), and its `status` cannot change (422); its other fields can still be edited. Triggers fresh Lighthouse and compliance scans. With `lang`, only the translated fields (`description` and `image_url`) are written for that locale; `title` is not translated. ## OpenAPI ````yaml /api-reference/storefront-v2026-04.yaml patch /api/v202604/company/sites/{id} openapi: 3.1.0 info: title: Fluid Storefront v2026-04 API version: v2026-04 description: > The modernized storefront surface, covering all eight storefront resources: **Categories**, **Collections**, **Products**, **Posts**, **Pages**, **Media**, **Enrollment Packs**, and **Playlists**. ## Two surfaces Every resource is exposed twice, and the pair is the thing to understand first: - **Public** — `/api/v202604/{resource}` and `/api/v202604/{resource}/{slug}`. Unauthenticated (`security: []`); the store is resolved from the request subdomain. Addressed by `slug`, the same identifier that appears in `canonical_url`. Lists return only live rows. Show-by-slug is looser so preview links work: draft, scheduled, and inactive rows resolve with `seo.indexable: false`, and country availability never restricts it. Show returns 404 only for archived or deleted products, categories, collections, and posts, and for deleted pages, media, playlists, and enrollment packs (which have no archived state). - **Company** — `/api/v202604/company/{resource}`. Bearer-token authenticated, addressed by `id`, and returns every row whatever its lifecycle state, so an admin can manage drafts and archives. Full CRUD plus the standardized `shares`, `lighthouse`, and `compliance` member actions on each resource. Path segments use the storefront's nouns, not the database's: `enrollment-packs` and `playlists` (the Library model). ## One response shape Every resource response opens with the same canonical "common top", in the same order, before any resource-specific fields: id, slug, title, description, image_url, canonical_url, images, active, status, publish_at, seo, metafields, languages That means a consumer can render any storefront resource from one code path. `seo` is always present and always fully populated — the server resolves it through a priority chain (SEO record → resource field → store default → built-in), so there is no client-side fallback logic and the API can never disagree with the rendered ``. `metafields`, `languages`, and (where applicable) `countries` are always arrays, never null. ## Lifecycle `status` is the canonical four-value contract — `draft`, `scheduled`, `published`, `archived` — and resolves at the API boundary: a stored `scheduled` row whose `publish_at` has passed reads as `published` with no write required. `active` is the separate merchant on/off toggle; a resource is live only when it is both active and resolved-published. Company create and update auto-queue Lighthouse and compliance scans, so the scores on the member actions always describe the current state of the resource. ## Listing and pagination Index endpoints share one query surface: `lang`, `q` (full-text search over title and description), `filter[…]`, `sort`, and cursor pagination via `page[cursor]` / `page[limit]` (default 25, max 100). Follow `meta.pagination.next_cursor`; do not construct cursors. Products additionally take `country`, which selects the country-relative price and currency AND gates availability. Categories and Collections expose their products from their own path — `GET /api/v202604/categories/{slug}/products` — which is the products catalog scoped to one owner, with the same card shape, filters, sorting, and pagination. ## Translating a resource Translations are written inline on the resource's own create/update. There is no separate translations endpoint and no `translations` object in the payload — the `lang` query parameter selects the locale a request reads or writes. **Read** a locale with `lang` on any GET: GET /api/v202604/company/collections/4821?lang=fr Translated fields (`title`, `description`, `image_url`, and each resource's own translated fields) come back inline in that locale. Any field with no `fr` translation falls back to its `en` value, so a partially-translated resource never renders blank. On reads an unsupported or unknown `lang` is ignored and the response comes back in the default locale. The `languages` array on every response lists exactly the locales that carry a translation, always including the default. **Write** a locale with `lang` on POST/PATCH: PATCH /api/v202604/company/collections/4821?lang=fr { "collection": { "title": "Essentiels bien-être" } } Omitting `lang` writes the store's default locale — the store's own default language, not the platform's. A store selling in French treats `lang=fr` as its default write. On every resource except products, a translation PATCH is TEXT ONLY: against any other locale, everything but the translated fields is ignored, so translating a title can never change the slug, move `status`, or change `country_isos`, metafields, SEO, or associations. Send those in a request against the store's default locale instead. Products are the exception. A product PATCH with a non-default `lang` is NOT text-only: it writes the translated fields for that locale AND applies every other field in the payload to the product itself. When translating a product, send only the translated fields. Creating is different: POST always writes the store's default locale whatever `lang` says, and keeps its full payload. A resource created under a translation would have no value in the store's own language and would take its slug from the translation. `lang` is still validated on POST, so an unsupported locale is a 422 rather than a surprise. On a write, a `lang` the store does not sell in returns 422 — translations are never written to a locale the store has not enabled. Add the language to the store first. The typical flow is: create in the default locale, then one PATCH per additional locale carrying only the translated text. **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: >- Company operations (`/api/v202604/company/...`). The Bearer token identifies the company. - url: https://{company}.fluid.app description: >- Public storefront reads (`/api/v202604/`). These carry no token, so the company is resolved from the request host: the company's Fluid subdomain or a custom domain connected to the company. Sent to api.fluid.app, they return 404. variables: company: default: acme description: Your company's Fluid subdomain security: [] tags: - name: storefront description: | Unauthenticated public surface that backs storefront pages and AEO crawlers. All operations are `security: []`. - name: company description: | Token-authenticated company surface that backs the admin UI and integrations. - name: options description: >- Product options used to define variant attributes and coordinate safe option-value updates. x-fluid-section: Commerce - name: member-sites description: >- The public sites a company's members made, listed by member without a token. x-fluid-section: Storefront - name: sites description: | A company's own sites as storefront resources: the public catalog and show, and the company CRUD with shares, Lighthouse and compliance. x-fluid-section: Storefront paths: /api/v202604/company/sites/{id}: patch: tags: - sites summary: Update a Site description: | Token-authenticated; requires `storefront.update` and a signed-in admin. Only the keys sent change. A `status` change runs after the other fields are saved. While a moderator suspension stands (`suspended_at`), the site cannot be published, scheduled, activated or made public (422), and its `status` cannot change (422); its other fields can still be edited. Triggers fresh Lighthouse and compliance scans. With `lang`, only the translated fields (`description` and `image_url`) are written for that locale; `title` is not translated. operationId: companySiteUpdate parameters: - $ref: '#/components/parameters/LangWrite' - name: id description: The site's id. in: path required: true schema: type: integer - $ref: '#/components/parameters/Lang' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SiteUpdateRequest' example: site: description: >- Paper, toner and the people who sell them, straight from the Scranton branch. status: archived responses: '200': description: The updated Site. content: application/json: schema: $ref: '#/components/schemas/SiteCompanyShowResponse' example: status: 200 meta: request_id: 7f3c9a1e-52d4-4b8e-9c61-2a8e4f0d7b35 timestamp: '2026-11-09T14:08:31Z' site: id: 52018 slug: scranton-branch title: Scranton Branch description: >- Paper, toner and the people who sell them, straight from the Scranton branch. image_url: >- https://ik.imagekit.io/fluidapp/dunder-mifflin/sites/scranton-branch.png canonical_url: https://shop.dundermifflin.com/home/sites/scranton-branch images: thumb: url: >- https://ik.imagekit.io/fluidapp/tr:w-200,c-at_max,f-auto,q-70/dunder-mifflin/sites/scranton-branch.png width: 200 medium: url: >- https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/dunder-mifflin/sites/scranton-branch.png width: 600 large: url: >- https://ik.imagekit.io/fluidapp/tr:w-1200,c-at_max,f-auto,q-80/dunder-mifflin/sites/scranton-branch.png width: 1200 active: true status: archived publish_at: null created_at: '2026-11-01T12:00:00Z' updated_at: '2026-11-08T09:30:00Z' seo: title: Scranton Branch description: >- Paper, toner and the people who sell them, straight from the Scranton branch. image_url: >- https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/dunder-mifflin/sites/scranton-branch.png indexable: false id: null metafields: [] languages: - en countries: [] visibility: public owner_kind: company required: false position: 0 lock_version: 5 suspended_at: null suspension_reason: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': description: | Validation failed. Also answered when a moderator suspended the site and the write would publish, schedule or activate it or make it public (message `Site is suspended`, `details` naming the refused field, `status` when the request names none). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: Site is suspended details: status: - is suspended status: 422 meta: request_id: 7f3c9a1e-52d4-4b8e-9c61-2a8e4f0d7b35 timestamp: '2026-11-09T14:08:31Z' security: - bearer_auth: [] components: parameters: LangWrite: name: lang in: query required: false description: | Locale to WRITE, and to render the response in. ISO code (e.g. `fr`, `de`); omit to write the store's default locale. On PATCH, a locale other than the store's own default writes ONLY the translated fields on every resource except products — slug, lifecycle, countries, metafields, SEO, and associations in the same payload are ignored, so translating a title cannot change the slug or move `status`. Send those in a request against the store's default locale. Each resource's schema marks which of its fields are translatable; a site's are `description` and `image_url`, so a site's `title` sent with such a `lang` is not written. Products are the exception: a product PATCH with a non-default `lang` writes the translated fields for that locale AND applies every other field sent. Send only the translated fields when translating a product. POST always writes the store's default locale, whatever `lang` says, and keeps its full payload. A resource's base values are its default-locale values, so a resource created under a translation would read back blank in the store's own language. `lang` is still validated on POST. Translate a resource after it exists, with PATCH. The comparison is against the STORE's default language, not the platform's — a store selling in French treats `lang=fr` as its default write, not a translation. On a write, a locale the store does not sell in returns 422. See "Translating a resource" in the API description. schema: type: string example: fr Lang: name: lang in: query required: false description: | Response locale. ISO code (e.g. `fr`, `de`). When omitted, responds in the company's default locale. On reads an unsupported or unknown locale is ignored — the response comes back in the default locale, never a 422. Any translated field with no value in the requested locale falls back to its `en` value. schema: type: string example: fr schemas: SiteUpdateRequest: type: object required: - site additionalProperties: false properties: site: $ref: '#/components/schemas/SiteWrite' SiteCompanyShowResponse: allOf: - $ref: '#/components/schemas/Envelope' - type: object required: - site properties: site: $ref: '#/components/schemas/SiteAuthenticated' ErrorResponse: type: object required: - error - status - meta properties: error: type: object required: - message properties: message: type: string details: type: object additionalProperties: true status: type: integer meta: $ref: '#/components/schemas/Meta' SiteWrite: type: object additionalProperties: false properties: title: type: string description: The site's title. example: Scranton Branch slug: type: - string - 'null' description: | The site's slug. Proposed from the title when blank on create. A later title change never changes it. example: scranton-branch description: type: - string - 'null' description: Longer-form copy describing the site. image_url: type: - string - 'null' description: The site's primary image. visibility: type: - string - 'null' enum: - private - public - null description: >- Who may open the site. Only a public site is listed or shown publicly. active: type: - boolean - 'null' description: The merchant's on/off toggle. status: type: - string - 'null' enum: - draft - scheduled - published - archived - null description: | Moves the site through its owner lifecycle. `published` publishes the site's current content and clears a future `publish_at`; `draft`, `scheduled` and `archived` take it off the storefront; `scheduled` needs a `publish_at`. Archiving is the owner's choice, not a moderator suspension. A suspended site cannot be published or scheduled (422); it can be drafted or archived and stays suspended. publish_at: type: - string - 'null' format: date-time description: When a scheduled site goes live. country_isos: type: - array - 'null' items: type: string description: | ISO codes restricting availability. `[]` clears restrictions; key omitted leaves countries unchanged. metafields_attributes: type: array description: | Metafields to add, change, or delete, matched by `namespace` + `key`, with the same rules as every storefront resource. Send `_destroy: true` to delete one. items: type: object required: - namespace - key - value - value_type properties: namespace: type: string key: type: string value: {} value_type: type: string description: type: - string - 'null' _destroy: type: - boolean - 'null' search_engine_optimizer_attributes: type: - object - 'null' description: The site's SEO overrides. The response key is `seo`. properties: id: type: - integer - 'null' title: type: - string - 'null' description: type: - string - 'null' image_url: type: - string - 'null' indexable: type: - boolean - 'null' Envelope: type: object description: | Shared success envelope for list / show / create / update responses: the resource payload is returned alongside a top-level integer `status` and `meta`. Composed onto each resource response via `allOf`. required: - status - meta properties: status: type: integer example: 200 meta: $ref: '#/components/schemas/Meta' SiteAuthenticated: description: | Authenticated (company-surface) Site read shape: the public `SiteBase` plus the admin fields `required`, `position` and `lock_version`, and the read-only moderator suspension (`suspended_at`, `suspension_reason`). allOf: - $ref: '#/components/schemas/SiteBase' - type: object required: - required - position - lock_version - suspended_at - suspension_reason properties: required: type: boolean description: Whether every member is shown the site. example: false position: type: integer description: The site's place in the company's list of sites. example: 0 lock_version: type: integer description: The site's optimistic lock version; it moves on every write. example: 3 suspended_at: type: - string - 'null' format: date-time description: | When a moderator suspended the site, or null. Read-only: a suspension is a moderator action, separate from the owner's `status`, and this API cannot set or lift it. A suspended site is off the public storefront whatever its status, and its `status` cannot be changed until the suspension is lifted. example: null suspension_reason: type: - string - 'null' description: >- Why a moderator suspended the site, or null. Read-only. Null for a droplet whose attached role cannot view the storefront. example: null unevaluatedProperties: false UnauthorizedError: type: object description: | Bare 401 body — a single `message` string, not the wrapped `ErrorResponse`. required: - message properties: message: type: string example: Invalid credentials. ForbiddenError: description: | Bare 403 body: `{ error }` when a storefront permission is missing, or `{ message }` when the credential is not company-admin tier. oneOf: - type: object required: - error properties: error: type: string example: Not authorized. - type: object required: - message properties: message: type: string example: Not authorized. Meta: type: object description: | Response metadata included on every successful response body. `request_id` and `timestamp` are always present; list endpoints also add `pagination`. required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time pagination: $ref: '#/components/schemas/Pagination' SiteBase: type: object description: | Storefront Site — a company site as a storefront resource. Like a page, it is a METADATA surface: the site itself opens at `canonical_url`, not in the API. The common top matches every other v202604 storefront resource. `status` is resolved at read time from the stored lifecycle and `publish_at`: a site published or scheduled with a future `publish_at` reads `scheduled`, a site published or scheduled with a null or past `publish_at` reads `published`, and a site its owner archived reads `archived`. "Live" = `active == true` AND resolved `status == published` AND `visibility == public` AND not suspended by a moderator. required: - id - slug - title - description - image_url - canonical_url - images - active - status - publish_at - seo - metafields - languages - countries - visibility - owner_kind properties: id: type: integer description: The site's id on the v202604 surface. example: 52018 slug: type: string description: The site's slug, the last segment of `canonical_url`. example: scranton-branch title: type: string description: The site's title. Not translated. example: Scranton Branch description: type: - string - 'null' description: Longer-form copy describing the site. Translatable via `lang`. example: >- Paper, toner and the people who sell them, straight from the Scranton branch. image_url: type: - string - 'null' description: The site's primary image. Translatable via `lang`. example: >- https://ik.imagekit.io/fluidapp/dunder-mifflin/sites/scranton-branch.png canonical_url: type: string description: Where the site opens on the store domain, `/home/sites/{slug}`. example: https://shop.dundermifflin.com/home/sites/scranton-branch images: $ref: '#/components/schemas/ResponsiveImageSet' active: type: boolean description: The merchant's on/off toggle. An inactive site is never live. example: true status: type: string enum: - draft - scheduled - published - archived description: | Lifecycle, resolved at read time. `draft` = never published; `scheduled` = waiting for a future `publish_at`; `published` = live now; `archived` = put away by its owner. A moderator suspension is not a status: a suspended site keeps the status it had. example: published publish_at: type: - string - 'null' format: date-time description: When a scheduled site goes live. null = no schedule. example: null created_at: type: string format: date-time description: When the site was created (ISO 8601, UTC). Read-only. example: '2026-11-01T12:00:00Z' updated_at: type: string format: date-time description: When the site was last modified (ISO 8601, UTC). Read-only. example: '2026-11-08T09:30:00Z' seo: $ref: '#/components/schemas/Seo' metafields: type: array description: The site's embedded metafields. items: $ref: '#/components/schemas/Metafield' languages: type: array description: The language ISO codes the site has content in. items: type: string example: - en countries: type: array items: type: string description: | ISO codes restricting availability. Empty array means available in every country the company sells in (unrestricted). example: [] visibility: type: string enum: - private - public description: | Who may open the site. Only a `public` site is a public storefront resource; the public catalog and show never return a private one. example: public owner_kind: type: string enum: - company description: >- Who owns the site. Always `company` on this surface; members' sites are not storefront resources. example: company Pagination: type: object required: - cursor - limit - prev_cursor - next_cursor properties: cursor: type: - string - 'null' limit: type: integer example: 25 prev_cursor: type: - string - 'null' next_cursor: type: - string - 'null' ResponsiveImageSet: type: - object - 'null' description: | Three ImageKit-transformed renditions of the resource's primary image: 200/600/1200 wide, scale-down only, format auto-negotiated. `null` when the resource has no image. properties: thumb: $ref: '#/components/schemas/ImageRendition' medium: $ref: '#/components/schemas/ImageRendition' large: $ref: '#/components/schemas/ImageRendition' Seo: type: object description: > Render-ready search-engine optimization metadata. ALWAYS present on every storefront response — never null. Values are resolved server-side via this priority chain: - `title` SEO title → resource title → company name - `description` SEO desc → resource desc → company default → "Live Free." - `image_url` SEO image → resource og_image → resource image → company default → hardcoded - `indexable` whether the storefront page invites search engines right now — the EFFECTIVE decision Frontends, AEO crawlers, and SDKs can render directly from these values — no client-side fallback logic, no chance of HTML and JSON API drifting. `id` and `stored` are exposed only on the authenticated surface: `id` distinguishes a merchant-configured SEO row from inherited defaults, and `stored` holds what the merchant has set, before any fallback. required: - title - description - image_url - indexable properties: title: type: string example: Summer Sale — Up to 40% Off description: Resolved title. Never null. description: type: string example: Shop the July clearance event before it ends. description: Resolved description. Never null. image_url: type: string example: >- https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/seo/9215.png description: Resolved OG-ready 1200×630 image URL. Never null. indexable: type: boolean example: true description: >- Whether this resource's storefront page invites search engines right now. False means the page emits a noindex meta tag. Reflects the company-wide indexing flag, the resource's live state, and the merchant's opt-out together — not a single stored column. id: type: - integer - 'null' example: 9215 description: >- Authenticated-only. SearchEngineOptimizer row id when one exists; null when the values are inherited from the resource / company / hardcoded defaults. stored: type: object description: >- Authenticated-only. What the merchant has set, before any fallback, so an admin client can copy a resource's SEO without storing inherited values. The text fields come from the SEO row and are null when it has none or does not exist. required: - title - description - image_url - indexable properties: title: type: - string - 'null' example: Summer Sale description: The row's own title, or null when it has none. description: type: - string - 'null' example:

Shop the July clearance event.

description: >- The row's own description as entered, which can include markup, or null when it has none. image_url: type: - string - 'null' example: https://cdn.fluid.app/seo/9215.png description: >- The row's own image URL before the OG transform, or null when it has none. indexable: type: boolean example: true description: >- The resource's own crawler setting. False means its SEO row or a legacy per-model flag hides it from search engines. Unlike the resolved `indexable`, it ignores the company-wide flag and the resource's live state, and it is present even when the resource has no SEO row. Metafield: type: object description: | A custom field attached to a resource, addressed by `namespace` + `key` (unique per resource). Metafields have no `id`. **Metafields are public.** Every metafield on a resource is returned in full on the unauthenticated public storefront endpoints, not only on the company endpoints. Never store secrets, internal notes, or personal data in a metafield. required: - namespace - key - value - value_type properties: namespace: type: string description: Grouping namespace. At most 20 characters, `[A-Za-z0-9_]` only. example: custom key: type: string description: >- Key within the namespace. At most 30 characters, `[A-Za-z0-9_]` only. example: material value: description: The stored value, returned as stored and shaped by `value_type`. example: cotton value_type: type: string description: | The metafield's data type. One of `single_line_text_field`, `multi_line_text_field`, `rich_text_field`, `number_integer`, `number_decimal`, `date`, `date_time`, `boolean`, `json`, `color`, `url`, `weight`, `volume`, `dimension`, `rating`, `money`, `file_reference`, `page_reference`, `product_reference`, `variant_reference`, `collection_reference`, `mixed_reference`, or `list.` where `` is one of `single_line_text_field`, `number_integer`, `number_decimal`, `date`, `date_time`, `color`, `url`, `file_reference`, `page_reference`, `product_reference`, `variant_reference`, `collection_reference`, `mixed_reference`. `value` is validated against this type (a mismatch returns 422) and is returned as stored. When the company has a metafield definition for the same `namespace` + `key` (set in Fluid Admin), that definition constrains the type and validation rules. example: single_line_text_field description: type: - string - 'null' example: The primary material used in this product created_at: type: string format: date-time example: '2026-05-01T12:00:00Z' updated_at: type: string format: date-time example: '2026-05-01T12:00:00Z' locked: type: - boolean - 'null' example: false ImageRendition: type: object required: - url - width properties: url: type: string example: >- https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/categories/4821.png width: type: integer example: 600 responses: Unauthorized: description: | Missing or invalid bearer token. The body is a bare `{ message }` object — not the wrapped `ErrorResponse` envelope used by 404 / 422. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' Forbidden: description: | Authenticated but lacking the required permission. The body is bare — `{ error }` when the storefront permission is missing, or `{ message }` when the credential is not company-admin tier — not the wrapped `ErrorResponse` envelope used by 404 / 422. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearer_auth: type: http scheme: bearer description: | Bearer token authentication. Accepts company-admin tokens with `storefront.view` for read operations and `storefront.update` for writes and scan triggers (legacy per-resource grants like `categories.update` / `products.view` / etc. are still accepted during the migration), required on every `company` operation. Storefront public operations under `/api/v202604/{resource}` and `/api/v202604/{resource}/{slug}` are unauthenticated (`security: []`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.