> ## 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 <token>; 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.
> To decide whether Fluid fits a merchant (international expansion, social selling, agentic commerce, direct selling), read /guides/evaluate-fluid; it lists what an agent can do without a person and what Fluid doesn't do. To compare Fluid with Shopify, BigCommerce, Salesforce Commerce Cloud, commercetools, WooCommerce, Wix, Exigo or DirectScale, read /guides/compare-platforms. Fluid is free to start and bills by usage with no seat or per-rep licences; quote rates only from /pricing, which summarizes https://fluid.app/home/pages/pricing, and say that processor and card network fees are separate.
> Every live Fluid storefront serves /llms.txt, /agents.md, .md and .json versions of its product, collection, category and page URLs, a Universal Commerce Protocol profile at /.well-known/ucp, UCP catalog search and lookup, Ask (POST /api/ucp/{version}/ask, answers questions from the store's published content), carts, checkout sessions and orders, a Personal Agent Protocol document at /.well-known/poppy.json, and an A2A Agent Card at /.well-known/agent-card.json with a JSON-RPC endpoint at /api/a2a. A checkout session completes inside the agent with Google Pay when the store's profile lists the com.google.pay payment handler; otherwise hand the shopper the continue_url to hosted checkout. A member's share link is /<username>/products/<slug>; see /concepts/agentic-commerce, /concepts/poppy, /concepts/ucp and /concepts/a2a.
> 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.
> To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP site_deploy tool publishes server functions sent inline that import nothing; publish functions with imports, and convert a Site to an App, with the fluid sites CLI. A Site can serve light server code: each functions/<name>.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/<name> on the Site's own host; publish it with fluid deploy, or inline through the MCP site_deploy tool when it imports nothing. See /sites/functions and /sites/rest-api.
> 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.
> To create a URL redirect, create a custom route on the Sitemap: POST /api/theme_region_rules with redirect_type redirect, a redirect_url, region_code default, route_kind non_credit and redirect_status_code 301 or 302. See /themes/custom-routes#create-a-redirect-with-the-api. Never use /api/redirects; those legacy redirects are no longer used, and the admin's Sitemap screen doesn't show them.
> 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.

# Connect Pinterest

> Connect a Pinterest business account to Fluid, publish products to its catalog as shoppable Pins, and fix the products Pinterest rejects.

Connecting Pinterest sends your Fluid products to the catalog on your Pinterest business account, where they appear as shoppable Pins. Buyers check out on your Fluid storefront, so there are no Pinterest orders to import. Setup takes a person in a browser for one step: approving Fluid's access in Pinterest. Every other step is an API call.

## Before you start

* A Pinterest business account, and a person who can sign in to it.
* The Pinterest account isn't connected to another Fluid company. One account connects to one company.
* A Fluid API token for the company with company admin access: **Company settings** permission to connect and disconnect, and **Products** permission to publish products. The examples use it as `$FLUID_TOKEN`.
* A live company. A test store can't connect a sales channel.

## Steps

**1. Start the connection**

```bash theme={null}
curl -X POST "https://api.fluid.app/api/v202506/pinterest/connection/authorize_url" \
  -H "Authorization: Bearer $FLUID_TOKEN"
```

The response's `url` is the Pinterest sign-in link. Nothing changes in Fluid until someone approves it in the next step. Open the link yourself, or send it to the person who will approve it. The link works once and expires after 10 minutes; call `authorize_url` again for a new one.

**2. Approve Fluid in Pinterest**

Sign in with the Pinterest business account and approve the access Fluid asks for: reading the account, and reading and writing its catalogs.

Pinterest 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:

```bash theme={null}
curl "https://api.fluid.app/api/v202506/pinterest/connection" \
  -H "Authorization: Bearer $FLUID_TOKEN"
```

The step is done when `connection.status` is `connected`. `connection.account_name` names the Pinterest account Fluid connected.

**3. Publish products**

This changes live configuration: it adds products to your Pinterest catalog. Start with a few products if you haven't sold on Pinterest before.

```bash theme={null}
curl -X POST "https://api.fluid.app/api/v202506/pinterest/catalog_listings" \
  -H "Authorization: Bearer $FLUID_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"product_ids": [91274, 91302]}'
```

Fluid creates one listing per product and publishes it in the background. Products already on the catalog are skipped, so sending the same IDs again is safe.

**4. Check the catalog**

```bash theme={null}
curl "https://api.fluid.app/api/v202506/pinterest/catalog_listings" \
  -H "Authorization: Bearer $FLUID_TOKEN"
```

Repeat until no listing is `draft` or `pending` and no `audit_status` is `auditing`. Each listing becomes `active` once Pinterest ingests it, with `audit_status` `approved`. The list is newest first, 25 per page; pass `meta.pagination.next_cursor` back as `page[cursor]` for the next page, or `filter[product_id]` to check one product.

**5. Fix rejected products**

A listing with `status` `publish_failed` or `audit_status` `audit_failed` didn't make it onto the catalog. `last_error` says why. Fix the product in Fluid, then retry the listing:

```bash theme={null}
curl -X POST "https://api.fluid.app/api/v202506/pinterest/catalog_listings/48230/retry" \
  -H "Authorization: Bearer $FLUID_TOKEN"
```

The step is done when no listing is `publish_failed` or has `audit_status` `audit_failed`.

## What each product needs

* A SKU on every active variant, unique across the products you list on Pinterest.
* A title, description and price. A product with no image of its own is sent with your company's fallback image, which Pinterest may reject.

A product missing one of these fails to publish, and `last_error` names what's missing.

## What the status means

| Field and value | What it means | What to do |
| - | - | - |
| `connection.status`: `pending` | The sign-in link was created but nobody has approved it yet. | Finish step 2, or start again. |
| `connection.status`: `connected` | Fluid can reach Pinterest. | Publish products. |
| `connection.status`: `expired` or `deauthorized` | Pinterest no longer accepts Fluid's access. | Run step 1 again and approve it. |
| `connection.status`: `disconnected` | Someone disconnected the channel. | Run step 1 again to reconnect. |
| listing `status`: `draft` or `pending` | The product is on its way to Pinterest. | Check again later. |
| listing `status`: `active` | The product is on your Pinterest catalog. | Nothing. |
| listing `status`: `publish_failed` | Fluid couldn't send the product. | Fix what `last_error` names, then retry. |
| listing `status`: `platform_deactivated` or `frozen` | Pinterest took the listing down. | Check the reason in Pinterest. |
| listing `status`: `deleted` or `seller_deactivated` | You removed the product. | Publish it again to bring it back. |
| listing `audit_status`: `audit_failed` | Pinterest rejected the product. | Fix it, then retry. |

## Troubleshooting

* **`authorize_url` fails with `422`.** Fluid couldn't start the connection. A test store gets this every time. Otherwise 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: start again for a new one.
* **The reason is `no_account`.** Pinterest didn't return a usable account. Sign in with a Pinterest business account and start again.
* **The reason is `account_already_connected`.** Another Fluid company already holds this Pinterest account. Disconnect it there first.
* **A call fails with `404`.** The company has never connected Pinterest. Run step 1.
* **A call fails with `403`.** Your token lacks the permission that call needs: **Company settings** for the connection, **Products** for products.
* **Publishing or retrying fails with `422`.** The connection isn't active, or the listing can't be retried. Check `connection.status` and reconnect if it isn't `connected`.

## Remove products and disconnect

To take one product off Pinterest, delete its listing. This removes its items from your Pinterest catalog:

```bash theme={null}
curl -X DELETE "https://api.fluid.app/api/v202506/pinterest/catalog_listings/48230" \
  -H "Authorization: Bearer $FLUID_TOKEN"
```

To disconnect:

```bash theme={null}
curl -X DELETE "https://api.fluid.app/api/v202506/pinterest/connection" \
  -H "Authorization: Bearer $FLUID_TOKEN"
```

Disconnecting leaves your catalog Pins on Pinterest, but Fluid stops syncing products until you connect again. Remove the listings first if you want the Pins gone.

## API reference

* [Start the Pinterest connect flow](https://docs.fluid.app/api-reference/pinterest/start-the-pinterest-connect-flow.md)
* [Get the company's Pinterest connection](https://docs.fluid.app/api-reference/pinterest/get-the-companys-pinterest-connection.md)
* [Publish Fluid products to the connected Pinterest catalog](https://docs.fluid.app/api-reference/pinterest/publish-fluid-products-to-the-connected-pinterest-catalog.md)
* [List the company's Pinterest catalog listings](https://docs.fluid.app/api-reference/pinterest/list-the-companys-pinterest-catalog-listings.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.