> ## 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. # Fix a connector with Mist > Ask Mist what's failing in your Exigo connector, check one record, then approve the fixes Mist plans before anything changes in your back office. Mist can look inside a connected back-office integration and help you fix it. Ask in plain words, such as "Why didn't order 10482 sync to Exigo?" or "What's failing in our Exigo sync?". Mist runs the integration's actions for you: checks that only read, and fixes that change records. A fix never runs until you approve its plan. Today this works for Exigo. Mist works only on the company you're signed in to. ## Before you start * Your company has the Exigo connector installed and connected. See [Back-office connectors](https://docs.fluid.app/help/admin/droplets/integrations.md). * You're signed in to Mist as an admin of the company. Mist acts as you, and it can't use a company API, partner or droplet token for this. * Your role has the **Integration Ops** permissions you need. On the [Roles](https://docs.fluid.app/help/admin/settings/roles.md) screen, **Integration Ops** is in the **Settings** card. Open it to switch each permission on or off: | Permission | What it lets you do | | - | - | | **See and preview integration ops actions and their history** | List the actions, run the checks, preview a fix and see the history. Every other permission needs this one. | | **Run standard integration ops actions** | Apply fixes marked `run`. Also needed to cancel a running fix. | | **Run high-risk integration ops actions** | Apply fixes marked `run_guarded`, the riskiest kind. | Each action has a tier: `view`, `run` or `run_guarded`. You need the permission for an action's tier to preview or apply it. An action that changes records always needs at least **Run standard integration ops actions** to apply, whatever its tier. ## Ask Mist what's failing Mist works from the safest check to the riskiest change: 1. It lists what's failing, grouped by cause, with how many different records each group affects. See [What failure groups mean](https://docs.fluid.app/help/admin/droplets/integrations.md#what-failure-groups-mean). 2. It checks one record from a group to find out what happened to it. 3. Depending on what it finds, it tests the connection, checks the connector's webhooks, or checks your mappings. 4. Only when the cause is fixed does it offer to retry the records that failed. Checks that only read are their own answer. Mist shows you the result and every warning, and there's nothing to approve. What Mist can check, all with the `view` tier: * What's failing, grouped by cause. Groups whose source data needs fixing are counted separately, because a retry won't help them. * What happened to one record. * Whether Fluid can reach and sign in to Exigo. A passing test doesn't guarantee that every sync works. * Whether the connector's webhook subscriptions are all there and active. * Whether your mappings have gaps, blank matches, or values that differ only by case or spaces. * The products reconciliation. Mist reads the last saved check and never runs a new one. If there's no recent check, open **Reconciliation** on the connector's screen and click **Check now**, then ask again. See [Check reconciliation](https://docs.fluid.app/help/admin/droplets/integrations.md#check-reconciliation). Fixes Mist can plan include retrying failed records (`run`) and registering missing webhooks or turning inactive ones back on (`run_guarded`). Mist reads the full list of actions from your integration, with each action's tier, before it uses one. A retry follows the same rules as a replay on the connector's screen. See [Which records you can replay](https://docs.fluid.app/help/admin/droplets/integrations.md#which-records-you-can-replay). ## Approve a fix When a fix would change records, Mist first previews it. The preview changes nothing in your integration, but it's recorded in the history. **1. Read the plan** Mist tells you what the fix will do: how many records, which ones, and any warnings, such as changes that can't be undone. Read every warning. **2. Approve or decline** An approval card appears in the chat. Click **Approve** to run exactly that plan, or **Decline** to stop. The card then reads **Approved** or **Declined**. **3. Check the result** Mist runs the fix and follows it until it finishes. A fix ends as succeeded, partly succeeded, failed or cancelled. Mist tells you which. An approval covers one plan, once, for 15 minutes. If the plan changes, or the connector's settings change before the fix runs, Mist previews again and asks you again. To stop a fix that's still waiting or running, ask Mist to cancel it. A fix that's waiting stops at once. A running fix stops as soon as it can. A finished fix can't be cancelled. If an action has an undo action, Mist tells you its name. Mist doesn't run it for you. ## When Mist stops Mist doesn't retry on its own. It stops and tells you what it checked when: | What Mist tells you | What it means | What to do | | - | - | - | | Writes are turned off (`writes_disabled`) | Fluid has fixes that change records turned off. Previews still work, so you can see the plan. | Don't look for another way to make the change. If you need the fix, contact Fluid support. | | You don't have permission | Your role lacks the permission for the action's tier. | Ask an admin who manages roles to update your role on the [Roles](https://docs.fluid.app/help/admin/settings/roles.md) screen. | | The plan can't be applied any more | The preview expired, was already used, or the request or the connector's settings changed since the preview. | Let Mist preview again and approve the new plan. If the plan was already used, Mist checks the history first, so the fix doesn't run twice. | | No confirmed answer when applying | The fix may have run anyway. | Let Mist check the fix's status and history before anything else. Don't approve it again. | | The integration service is unavailable | Fluid couldn't reach the integration. | Try again later. | Mist also stops when a retry fails again for the same reason, when the cause is on your back office's side, such as credentials or data only you can correct, or when a plan affects far more records than you expected. If you need help with a fix Mist can't make: > [!NOTE] > > Email Fluid support at [help@fluid.app](mailto:help@fluid.app). The [Getting help](https://docs.fluid.app/help/getting-help.md) page lists what to include in your request. ## See what Mist did Ask Mist for the integration's history. It lists every preview and every fix applied, by anyone at your company. ## Related pages * [Back-office connectors](https://docs.fluid.app/help/admin/droplets/integrations.md) * [Roles](https://docs.fluid.app/help/admin/settings/roles.md) * [Chats](https://docs.fluid.app/help/mist/chats.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.