> ## 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 TikTok Shop > Connect a TikTok Shop to Fluid, choose the warehouse and the products to list, and fix the products TikTok rejects. Connecting TikTok Shop lists your Fluid products in your shop. Fluid creates each product in TikTok, keeps its price and inventory current as they change in Fluid, and imports the orders placed in TikTok. Setup takes a person in a browser for one step: approving Fluid's access in TikTok. ## Before you start * A US TikTok Shop seller account that has finished TikTok's seller verification, and a person who can sign in to it as the shop owner or an admin. * At least one shipping warehouse set up in TikTok Seller Center. You need its warehouse ID for step 3. * 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 tiktok` 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 tiktok --open ``` This prints the TikTok Shop 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 with the TikTok Shop seller account and approve the access Fluid asks for. If your account holds more than one shop, Fluid connects each of them and lists products in the one it connected first. TikTok Shop 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 tiktok ``` The step is done when `connection.status` is `connected`. `connection.account` names the shop Fluid connected. This changes live configuration: it sets the TikTok warehouse whose stock Fluid publishes. Use the warehouse ID from TikTok Seller Center. ```bash theme={null} fluid channels warehouse tiktok 7301845529377196842 --yes ``` Fluid only accepts a TikTok warehouse ID that one of your Fluid warehouses is linked to. If the command fails because the warehouse isn't mapped, ask Fluid support to link your Fluid warehouse to that TikTok warehouse ID, then run it again. Until a warehouse is set, every product fails to publish. This changes live configuration: it sends products to TikTok Shop. 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 tiktok --all --yes ``` To send only some products, name them instead: ```bash theme={null} fluid channels catalog tiktok --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 tiktok ``` `listings.byStatus` counts the listings in each state and `listings.issues` counts the ones that need you. Publishing and TikTok Shop'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 tiktok ``` 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 tiktok --retry --yes`. * For `action: fix_and_relist`, remove the product and add it again so the corrected version is sent: `fluid channels catalog tiktok --remove 4127 --yes`, then `--add 4127 --yes`. * For `action: resolve_on_channel`, TikTok Shop took the listing down. Check the reason in TikTok Shop. 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 TikTok Shop 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 TikTok Shop as it is. | Testing with a few products first, or a catalog where only some products suit TikTok Shop. | Start with a few products if you haven't sold on TikTok Shop before. You'll see what TikTok Shop rejects before you send everything. Each product needs, before it's sent: * A description. Fluid stops a product without one before sending it. * At least one variant with a positive package length, width, height, and weight. * Images. Fluid uploads the product's images in order. * A category. Fluid asks TikTok to recommend one the first time it sends the product. Some categories require attributes Fluid doesn't send, and the publish fails naming them. A product missing one of these fails to publish and shows up in `fluid channels issues tiktok`. TikTok reviews each new product. While it does, `auditStatus` is `auditing`; it ends as `approved` or `audit_failed`. When a variant's price or inventory changes in Fluid, the change goes to TikTok automatically. Other edits, such as a new title or description, aren't sent: remove the product and add it again to send them. To take products off TikTok Shop, use `--remove` with product IDs, or `--remove-all` for every listed product. Removing a product deactivates it in TikTok. Adding it again reactivates it. ## What the status means | Field and value | What it means | What to do | | - | - | - | | `connection.status`: `not_connected` | The company has no TikTok Shop connection. | Run step 1. | | `connection.status`: `connected` | Fluid can reach TikTok Shop. | Continue with the products. | | `connection.status`: `expired` or `deauthorized` | TikTok Shop 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 TikTok Shop. | Check again later. | | listing `status`: `active` | The product is on TikTok Shop. | Nothing. | | listing `status`: `publish_failed` | Fluid couldn't send the product. | Fix what `lastError` names, then retry. | | listing `status`: `platform_deactivated` or `frozen` | TikTok Shop took the listing down. | Check the reason in TikTok Shop. | | listing `status`: `deleted` or `seller_deactivated` | You removed the product. | Add it again to bring it back. | | listing `auditStatus`: `audit_failed` | TikTok Shop'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_shops`.** The account you approved with has no TikTok Shop. Sign in with the shop's seller account and run `connect` again. * **A command fails with `404`.** The company has no TikTok Shop 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 tiktok --remove-all --yes fluid channels disconnect tiktok --yes ``` Both commands change live configuration. Disconnecting doesn't take your products off TikTok Shop: 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 clears its tokens and stops syncing. The output's `stillListed` counts the products left on TikTok Shop. ## Use the API directly The CLI calls these company operations, all authenticated with a Bearer token: 1. [Start the TikTok OAuth connect flow](/api-reference/tiktok/start-the-tiktok-oauth-connect-flow), which returns the sign-in `url`. 2. [Get the company's TikTok Shop connection](/api-reference/tiktok/get-the-companys-tiktok-shop-connection). 3. [Configure the TikTok warehouse used for inventory publishing](/api-reference/tiktok/configure-the-tiktok-warehouse-used-for-inventory-publishing). 4. [Publish Fluid products to the connected TikTok Shop](/api-reference/tiktok/publish-fluid-products-to-the-connected-tiktok-shop). 5. [List the company's TikTok product listings](/api-reference/tiktok/list-the-companys-tiktok-product-listings). 6. [Retry a failed TikTok product listing publish](/api-reference/tiktok/retry-a-failed-tiktok-product-listing-publish). 7. [Unpublish a TikTok product listing](/api-reference/tiktok/unpublish-a-tiktok-product-listing). 8. [Disconnect the company's TikTok Shop connection](/api-reference/tiktok/disconnect-the-companys-tiktok-shop-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.