> ## 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. # Read a Connect integration's status > The Connect sync dashboard's figures for one integration and window: success rate and tier, records synced, held, quarantined and skipped counts, and the top five failure categories. Fluid passes the integration service's numbers through unchanged and caches each reading for 60 seconds. A uuid that is not one of your company's Connect integrations is a 404. An integration with no configured API host is a 503 `connect_unconfigured`, and one the integration service has no record of is a 409 `not_connected`. When the integration service fails or refuses the request, the answer is a 502. Needs the `droplets.view` permission. ## OpenAPI ````yaml /api-reference/company-connect-v2026-10.yaml get /api/company/v2026-10/connect/integrations/{uuid}/status openapi: 3.1.0 info: title: Fluid Company API v2026-10 — Connect version: 2026-10 description: >- Your company's Connect integrations on v2026-10: which back-office platforms (Exigo, Pillars, ByDesign, InfoTrax) are connected to your store, and how each one's syncs are doing. ## Authentication Send a company admin credential as `Authorization: Bearer `: an admin session token or an API token for your company. Every endpoint needs the `droplets.view` permission, because a Connect integration is an installed droplet. The provider order endpoints also need `orders.view`, and the provider customer endpoints `members.view`, because they read that data. Droplet installation tokens are refused. ## Responses Every response wraps the resource under its own key with `status` and `meta`: ```json { "connect_integrations": [{ "uuid": "drp_…", "name": "Exigo" }], "status": 200, "meta": { "request_id": "…", "timestamp": "…" } } ``` Errors use the same envelope with `error.message`, and `error.details.code` names the error: `not_found`, `connect_unconfigured`, `not_connected`, `backend_unavailable`, `backend_rejected`, `provider_totals_unsupported` or `entity_not_synced`. A 401 is a bare `{ "message": … }`. ## Finding an integration `GET /connect/integrations` lists every Connect integration your company has installed, each named by its droplet's `uuid`. It asks no other service, so it answers even when the integration service is down. `reachable: false` means Fluid has no API host configured for that integration, so its status cannot be read yet. ## Reading an integration's status `GET /connect/integrations/{uuid}/status?range=24h` returns the numbers the Connect sync dashboard shows for the same window: success rate, tier, records synced, failures, held, quarantined and skipped counts, and the top failure categories. Fluid passes the integration service's figures through unchanged and adds none of its own. Readings are cached for 60 seconds; `fetched_at` says when this one was taken. The status carries counts and category codes only, never error text or record ids. ## Comparing with the provider `GET /connect/integrations/{uuid}/provider/orders/totals` and `/provider/customers/totals` return how many records the provider (the commission engine) holds for a window, and for orders what they add up to per currency, next to Fluid's own count for the same window. `/provider/orders/reconciliation` and `/provider/customers/reconciliation` match the provider's ids against Fluid's `external_id`s, so a record stamped at different times by the two systems is never counted as missing. Windows default to the hour ending 30 minutes ago. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: Production API server security: [] tags: - name: connect description: >- Your company's Connect integrations, their sync status, and how their records compare with the provider's. x-fluid-section: Droplets paths: /api/company/v2026-10/connect/integrations/{uuid}/status: parameters: - name: uuid in: path required: true description: The integration's droplet uuid, from `uuid` in the list. schema: type: string example: drp_1mjyysle6csm9eb2q2wmffucoetres7cy get: tags: - connect summary: Read a Connect integration's status description: >- The Connect sync dashboard's figures for one integration and window: success rate and tier, records synced, held, quarantined and skipped counts, and the top five failure categories. Fluid passes the integration service's numbers through unchanged and caches each reading for 60 seconds. A uuid that is not one of your company's Connect integrations is a 404. An integration with no configured API host is a 503 `connect_unconfigured`, and one the integration service has no record of is a 409 `not_connected`. When the integration service fails or refuses the request, the answer is a 502. Needs the `droplets.view` permission. operationId: companyConnectIntegrationStatus parameters: - name: range in: query required: false description: The window, `60m`, `24h`, `7d` or `30d`. Defaults to `24h`. schema: type: string enum: - 60m - 24h - 7d - 30d example: 24h responses: '200': description: The integration's status. content: application/json: schema: $ref: '#/components/schemas/ConnectStatusResponse' example: connect_status: uuid: drp_1mjyysle6csm9eb2q2wmffucoetres7cy name: Exigo platform: exigo fetched_at: '2026-10-24T15:32:08Z' integration: initialized: true live_sync_state: armed platform: exigo stats: last_24_hours: sync_count: 1200 failure_count: 12 failure_rate: 1 success_rate: 99 tier: healthy records_synced: 1150 held_count: 2 quarantined_count: 1 skipped_count: 30 waiting_count: 0 error_categories: validation: 9 timeout: 3 last_synced_at: '2026-10-24T15:30:00Z' failure_categories: - entity_type: order direction: outbound error_category: validation count: 9 distinct_records: 7 kind: error actionable: true oldest_updated_at: '2026-10-23T18:02:11Z' newest_updated_at: '2026-10-24T14:47:51Z' status: 200 meta: request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-24T15:32:08Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Not one of your company's Connect integrations. content: application/json: schema: $ref: '#/components/schemas/CodedErrorResponse' example: error: message: Connect integration not found details: code: not_found status: 404 meta: request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-24T15:32:08Z' '409': description: >- The integration service has no record of this installation (`not_connected`). Finish setting the integration up, then read again. content: application/json: schema: $ref: '#/components/schemas/CodedErrorResponse' example: error: message: The integration service has no record of this installation. details: code: not_connected status: 409 meta: request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-24T15:32:08Z' '422': description: Invalid parameters, such as an unknown `range`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: Invalid parameters details: range: - 'must be one of: 60m, 24h, 7d, 30d' status: 422 meta: request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-24T15:32:08Z' '502': description: >- The integration service failed, timed out or could not be reached (`backend_unavailable`), or refused the request (`backend_rejected`). content: application/json: schema: $ref: '#/components/schemas/CodedErrorResponse' example: error: message: The integration service is unavailable. details: code: backend_unavailable status: 502 meta: request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-24T15:32:08Z' '503': description: >- Fluid has no API host configured for this integration (`connect_unconfigured`), so nothing was sent. content: application/json: schema: $ref: '#/components/schemas/CodedErrorResponse' example: error: message: No Connect API host is configured for this integration. details: code: connect_unconfigured status: 503 meta: request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-24T15:32:08Z' security: - bearer_auth: [] components: schemas: ConnectStatusResponse: type: object description: A Connect integration's sync status. required: - connect_status - status - meta properties: connect_status: $ref: '#/components/schemas/ConnectStatus' status: type: integer meta: $ref: '#/components/schemas/Meta' CodedErrorResponse: description: The error envelope with the error's code in `error.details.code`. allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: error: type: object required: - details properties: details: type: object required: - code properties: code: type: string enum: - not_found - connect_unconfigured - not_connected - backend_unavailable - backend_rejected - provider_totals_unsupported - entity_not_synced 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' ConnectStatus: type: object description: One Connect integration's sync status. required: - uuid - name - platform - fetched_at - integration - stats - failure_categories properties: uuid: type: string description: The integration's droplet uuid. name: type: string description: The droplet's name. platform: type: string description: The back-office platform, as in the list. fetched_at: type: string format: date-time description: >- When the integration service answered. Up to 60 seconds ago, since readings are cached. integration: type: object description: The integration's own state on the integration service. additionalProperties: true properties: initialized: type: boolean description: Whether the integration finished its first setup. live_sync_state: type: - string - 'null' description: The live sync's state, such as `armed`. platform: type: string description: The platform as the integration service names it. stats: $ref: '#/components/schemas/ConnectSyncStats' failure_categories: type: array description: The top five failure groups for the window. items: $ref: '#/components/schemas/ConnectFailureCategory' Meta: type: object description: Response metadata included on every response body. required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time UnauthorizedError: type: object description: Bare 401 body, a single `message` string, not the error envelope. required: - message properties: message: type: string example: Invalid credentials. ForbiddenError: description: >- Bare 403 body, `{ error }` when a 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. ConnectSyncStats: type: object description: The integration service's sync statistics, passed through unchanged. additionalProperties: true properties: today: $ref: '#/components/schemas/ConnectSyncWindow' last_24_hours: $ref: '#/components/schemas/ConnectSyncWindow' range_window: $ref: '#/components/schemas/ConnectSyncWindow' by_entity_group: type: object description: The same figures per entity group, such as orders or customers. additionalProperties: true ConnectFailureCategory: type: object description: >- One group of failures by entity type, direction and error category. Counts only, never error text or record ids. additionalProperties: true required: - entity_type - direction - error_category - count properties: entity_type: type: string description: The entity that failed to sync, such as `order` or `customer`. direction: type: string description: Which way the sync ran, such as `inbound` or `outbound`. error_category: type: string description: The error category code. count: type: integer description: Failures in the group. distinct_records: type: integer description: Distinct records among them. kind: type: - string - 'null' description: The kind of failure. actionable: type: - boolean - 'null' description: Whether a person can act on it. oldest_updated_at: type: - string - 'null' format: date-time description: The oldest failure's last update. newest_updated_at: type: - string - 'null' format: date-time description: The newest failure's last update. ConnectSyncWindow: type: object description: >- The dashboard's figures for one window, as the integration service computes them. Fields the service adds later pass through unchanged. additionalProperties: true properties: sync_count: type: integer description: Syncs attempted in the window. failure_count: type: integer description: Syncs that failed. failure_rate: type: - number - 'null' description: Failed syncs as a percentage of syncs, or null with no syncs. success_rate: type: - number - 'null' description: Successful syncs as a percentage of syncs, or null with no syncs. tier: type: - string - 'null' description: >- The success rate's band against the company's thresholds, `healthy`, `good`, `below` or `attention`. records_synced: type: integer description: Distinct records synced. held_count: type: integer description: Syncs held for review. quarantined_count: type: integer description: Records quarantined. skipped_count: type: integer description: Syncs skipped by rule. waiting_count: type: integer description: Syncs waiting on a dependency. error_categories: type: object description: Failures per error category code. additionalProperties: type: integer last_synced_at: type: - string - 'null' format: date-time description: When the last sync in the window finished. responses: Unauthorized: description: >- Missing or invalid bearer token. The body is a bare `{ message }`, not the error envelope. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: message: Invalid credentials. Forbidden: description: >- Not a company admin with `droplets.view` (bare body), or a droplet installation token (the error envelope). content: application/json: schema: oneOf: - $ref: '#/components/schemas/ForbiddenError' - $ref: '#/components/schemas/ErrorResponse' example: message: Not authorized. securitySchemes: bearer_auth: type: http scheme: bearer description: >- A company admin credential for your company. Droplet installation tokens are refused. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.