> ## 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. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. > 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. # Connect Meta (Facebook and Instagram) > Connect your Meta business catalog to Fluid, choose the products to list on Facebook and Instagram, and fix the products Meta rejects. Connecting Meta sends your Fluid products to a product catalog in your Meta business, where Facebook, Instagram, and WhatsApp shopping and catalog ads use them. Fluid sends the product data and reads back Meta's review of each product. Setup takes a person in a browser for one step: approving Fluid's access in Meta. ## Before you start * A Meta business portfolio (Business Manager) that owns at least one product catalog, created in Commerce Manager. Fluid sends products to an existing catalog; it doesn't create one. * A person who is an admin of that business portfolio. * A Fluid API token for the company, or your own sign-in with `fluid login`. It needs company admin access: **Company settings** permission to connect and disconnect, and **Products** permission to choose and fix products. * Install and sign in to the CLI: ```bash theme={null} npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-channels fluid login ``` Every `fluid channels` command prints JSON. Failures print a JSON `error` on stderr and exit with a non-zero code. ## Steps In a terminal, `fluid channels walk meta` takes you through these steps one question at a time: it opens the sign-in link, checks the connection, lets you search for the products to send, and asks before each change. ```bash theme={null} fluid channels connect meta --open ``` This prints the Meta sign-in `url` and, with `--open`, opens it in your browser. Nothing changes in Fluid until someone approves it in the next step. Without `--open`, send the `url` to the person who will approve it. The link works once and expires after 10 minutes; run `connect` again for a new one. Sign in to Facebook as an admin of the business portfolio and approve the access Fluid asks for. Fluid connects the first business you manage and every catalog it owns, and lists products in the first. If Meta says the app isn't available to you, contact Fluid support. Meta then sends the browser back to Fluid admin. The address ends in `connect=ok` when the connection saved, or `connect=error&reason=...` when it didn't. Whatever the page shows, check the result from the CLI: ```bash theme={null} fluid channels status meta ``` The step is done when `connection.status` is `connected`. `connection.account` names the catalog Fluid connected. This changes live configuration: it sends products to Meta. Decide first between the whole catalog and selected products; see [Whole catalog or selected products](#whole-catalog-or-selected-products). ```bash theme={null} fluid channels catalog meta --all --yes ``` To send only some products, name them instead: ```bash theme={null} fluid channels catalog meta --add 4127,4128 --yes ``` The output's `added` counts the products sent. Each one starts as a draft and publishes in the background. ```bash theme={null} fluid channels status meta ``` `listings.byStatus` counts the listings in each state and `listings.issues` counts the ones that need you. Publishing and Meta's review take from minutes to a few days. Check again later, backing off between checks, rather than in a loop. ```bash theme={null} fluid channels issues meta ``` Each issue has an `action` and a `hint` that says what to fix. Fix the product in Fluid, then: * For `action: retry`, retry every failed publish at once. This changes live configuration: `fluid channels issues meta --retry --yes`. * For `action: fix_and_relist`, remove the product and add it again so the corrected version is sent: `fluid channels catalog meta --remove 4127 --yes`, then `--add 4127 --yes`. * For `action: resolve_on_channel`, Meta took the listing down. Check the reason in Meta. The step is done when `count` is 0. ## Whole catalog or selected products Fluid lists the products you send, one listing per product. There's no setting that keeps the whole catalog in step with Meta on its own, so the choice is about which products you send now and how you add new ones later. | | Whole catalog (`--all`) | Selected products (`--add`) | | - | - | - | | What's sent | Every active product that isn't listed yet. `--collection 12` narrows it to products in that collection. | Only the product IDs you name. | | Draft and archived products | Never sent. | Sent if you name them, so name active products only. | | Products you create later | Not added automatically. Run `--all` again; it skips products already listed. | Add each one with `--add`. | | Products you removed | Skipped, so running `--all` again never undoes a removal. Pass `--include-removed` to bring them back. | Re-added if you name them. | | Best for | A catalog that's ready for Meta as it is. | Testing with a few products first, or a catalog where only some products suit Meta. | Start with a few products if you haven't sold on Meta before. You'll see what Meta rejects before you send everything. Each product needs, before it's sent: * A SKU on every active variant, unique across the products you list on Meta. * At least one active variant. * A title, description, price, and image. A product with no image of its own is sent with your company's fallback image, which Meta's review may reject. A product missing one of these fails to publish and shows up in `fluid channels issues meta`. Meta reviews each product for every surface it's tagged for, such as Facebook shops, Instagram, and WhatsApp. `review` shows each surface's result. `auditStatus` rolls them up: `audit_failed` if any surface rejected it, `auditing` while any is pending, and `approved` once all approve. Edits you make in Fluid after a product is sent, including price changes, aren't sent to Meta. Remove the product and add it again to send the current version. Fluid sends every product as in stock, whatever its inventory. To take products off Meta, use `--remove` with product IDs, or `--remove-all` for every listed product. Removing a product deletes it from the Meta catalog. ## What the status means | Field and value | What it means | What to do | | - | - | - | | `connection.status`: `not_connected` | The company has no Meta connection. | Run step 1. | | `connection.status`: `connected` | Fluid can reach Meta. | Continue with the products. | | `connection.status`: `expired` or `deauthorized` | Meta no longer accepts Fluid's access. | Run `connect` again and approve it. | | `connection.status`: `disconnected` | Someone disconnected the channel. | Run `connect` again to reconnect. | | listing `status`: `draft` or `pending` | The product is on its way to Meta. | Check again later. | | listing `status`: `active` | The product is on Meta. | Nothing. | | listing `status`: `publish_failed` | Fluid couldn't send the product. | Fix what `lastError` names, then retry. | | listing `status`: `platform_deactivated` or `frozen` | Meta took the listing down. | Check the reason in Meta. | | listing `status`: `deleted` or `seller_deactivated` | You removed the product. | Add it again to bring it back. | | listing `auditStatus`: `audit_failed` | Meta's review rejected the product. | Fix it, then remove it and add it again. | ## Troubleshooting * **`connect` fails with `422`.** Fluid couldn't start the connection, usually because the channel isn't set up for your company yet. Contact Fluid support. * **The address after approving ends in `connect=error`.** The `reason` says why. `invalid_state` means the link was used twice or expired: run `connect` again for a new one. * **The reason is `no_business`.** The Facebook account you approved with doesn't manage a business portfolio. Sign in as an admin of one and run `connect` again. * **The reason is `no_catalogs`.** The business portfolio owns no product catalog. Create one in Commerce Manager, then run `connect` again. * **A command fails with `404`.** The company has no Meta connection. Run step 1. * **A command fails with `403`.** Your token lacks the permission that command needs: **Company settings** for the connection, **Products** for products. * **Adding or removing products fails with `422`.** The connection isn't active. Check `connection.status` and reconnect if it isn't `connected`. ## Disconnect ```bash theme={null} fluid channels catalog meta --remove-all --yes fluid channels disconnect meta --yes ``` Both commands change live configuration. Disconnecting doesn't take your products off Meta: they stay listed and stop syncing, and you can't remove them through Fluid until you reconnect. Remove them first, as above, unless you want them to stay. Fluid forgets its token and stops syncing. The output's `stillListed` counts the products left on Meta. ## Use the API directly The CLI calls these company operations, all authenticated with a Bearer token: 1. [Start the Meta business-login connect flow](/api-reference/meta/start-the-meta-business-login-connect-flow), which returns the sign-in `url`. 2. [Get the company's Meta commerce connection](/api-reference/meta/get-the-companys-meta-commerce-connection). 3. [Publish Fluid products to the connected Meta catalog](/api-reference/meta/publish-fluid-products-to-the-connected-meta-catalog). 4. [List the company's Meta catalog listings](/api-reference/meta/list-the-companys-meta-catalog-listings). 5. [Retry a failed Meta catalog listing publish](/api-reference/meta/retry-a-failed-meta-catalog-listing-publish). 6. [Unpublish a Meta catalog listing](/api-reference/meta/unpublish-a-meta-catalog-listing). 7. [Disconnect the company's Meta commerce connection](/api-reference/meta/disconnect-the-companys-meta-commerce-connection). For the whole catalog, the CLI reads your active products from Fluid's product list and sends their IDs to the publish operation in batches of 50. Retrying only works on a listing whose publish failed. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.