> ## 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. > 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 where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > 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 — 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. # Feature a product on MySite > Feature an existing company product through the shared native writer. Preserve legacy management eligibility, including unpublished products. Require MySite access and a writable member credential. Reject ownership fields and duplicate favorites; invalidate MySite after commit. ## OpenAPI ````yaml /api-reference/member-themes-v2026-10.yaml post /api/member/v2026-10/mysite/favorites openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Themes description: >- MySite settings, available themes, custom links, featured products and visit statistics for the authenticated member. The bearer alone determines the member and company. Settings support existing reads and theme selection. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: mysite-settings x-fluid-section: Members description: Read supported MySite settings and change the selected theme. - name: mysite-themes x-fluid-section: Members description: Available company MySite themes. - name: mysite-links x-fluid-section: Members description: Manage the authenticated member's custom links and their order. - name: mysite-favorites x-fluid-section: Members description: Manage products featured on the authenticated member’s MySite. - name: mysite-stats x-fluid-section: Members description: >- Visits to and leads captured by the authenticated member's MySite, from the daily member rollup. A period is the trailing 7, 30, 90 or 365 UTC days including today, or every day on record (the default, the lifetime counts the profile fields carry). Today is recomputed every 15 minutes, the 364 days before it nightly, and older days weekly. paths: /api/member/v2026-10/mysite/favorites: post: tags: - mysite-favorites summary: Feature a product on MySite description: >- Feature an existing company product through the shared native writer. Preserve legacy management eligibility, including unpublished products. Require MySite access and a writable member credential. Reject ownership fields and duplicate favorites; invalidate MySite after commit. operationId: member_mysite_favorites_create requestBody: required: true content: application/json: schema: type: object description: >- Existing product and optional position in the shared MySite content order. additionalProperties: false required: - product_id properties: position: type: integer minimum: 1 maximum: 2147483647 description: >- Optional positive position in the shared MySite content order; omitted products are placed at the top. product_id: type: string format: uuid description: >- Public UUID of an existing product in the bearer member’s company. example: product_id: 01900000-0000-7000-8000-000000000001 position: 1 responses: '201': description: The saved featured product and its public favorite identifier. content: application/json: schema: $ref: '#/components/schemas/FavoriteEnvelope' '400': description: The request body is not valid JSON. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: Membership has no MySite access, or this credential cannot write. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: No company product matches the supplied identifier. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- Invalid product or position parameters, duplicate favorite, or a product changed concurrently. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: FavoriteEnvelope: type: object description: Successful featured-product creation with the saved favorite. example: status: 201 data: id: 019a0488-a22d-78b9-a989-dcbca61d3c3d product: id: 019a0488-8d12-753e-b623-27368412244e title: Daily Wellness Kit image_url: https://cdn.primex.com/products/daily-wellness-kit.jpg url: https://shop.primex.com/products/daily-wellness-kit position: 1 meta: request_uuid: 019a0489-1215-7461-ad49-ab123315c4b1 timestamp: '2026-10-01T13:00:00Z' required: - status - data - meta properties: status: type: integer data: $ref: '#/components/schemas/Favorite' meta: $ref: '#/components/schemas/ResponseMeta' ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta Favorite: type: object description: A product featured on the member’s MySite, not a private bookmark. additionalProperties: false required: - id - product - position properties: id: type: string format: uuid description: Public favorite UUID. position: type: - integer - 'null' description: >- Position in the shared MySite content order; null only for historical unpositioned rows. product: type: object description: >- Existing company product, including unpublished products the member can manage. additionalProperties: false required: - id - title - image_url - url properties: id: type: string format: uuid description: Public product UUID. title: type: - string - 'null' description: Localized product title. image_url: type: - string - 'null' description: >- Localized product image with the existing DAM and legacy fallbacks. url: type: string description: Canonical company storefront product URL. ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. required: - request_uuid - timestamp additionalProperties: true securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.