> ## 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. > 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 — 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. # Set or clear a TikTok listing's category override > Sets, changes or clears (with null) the TikTok category an admin chose for a listing, overriding TikTok's recommendation on the next publish. Only the id format is checked here; leaf and known-id validation arrives with the category browse endpoint, and until then TikTok rejects an unknown or non-leaf category when the listing is published. Only JSON null clears the override; an empty string is rejected as invalid_category_id. When the listing is published on TikTok and the effective category differs from the one TikTok last received, a resync is queued so the change reaches TikTok (an identical retry queues it again if the first queueing failed); otherwise the override is only stored. A listing that is draft (a publish is queued), deleted or seller_deactivated cannot be edited: wait for the queued publish, or reactivate first. Requires a company admin token with the products.update permission and an active TikTok Shop connection. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml patch /api/v202506/tiktok/product_listings/{id} openapi: 3.1.0 info: title: Fluid Admin v2025-06 API description: | **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v2025-06 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: feature-flags description: >- Read and change a company's feature flags, and, for root admins, read the flag catalogue with each flag's summary and description. x-fluid-section: Developers - name: tokens description: >- Create and manage the company's API credentials: partner and public tokens, and the scoped clients that replace them for a company on identity sign-in, and for every company once scoped client creation is switched on for all. x-fluid-section: Developers - name: products description: >- Products, variants and their prices, including the per-price-type price grid of a bundle product. x-fluid-section: Commerce - name: tiktok description: >- The company's TikTok Shop connection, its logistics warehouses, product listings, and orders. x-fluid-section: Sales channels paths: /api/v202506/tiktok/product_listings/{id}: patch: tags: - tiktok summary: Set or clear a TikTok listing's category override description: >- Sets, changes or clears (with null) the TikTok category an admin chose for a listing, overriding TikTok's recommendation on the next publish. Only the id format is checked here; leaf and known-id validation arrives with the category browse endpoint, and until then TikTok rejects an unknown or non-leaf category when the listing is published. Only JSON null clears the override; an empty string is rejected as invalid_category_id. When the listing is published on TikTok and the effective category differs from the one TikTok last received, a resync is queued so the change reaches TikTok (an identical retry queues it again if the first queueing failed); otherwise the override is only stored. A listing that is draft (a publish is queued), deleted or seller_deactivated cannot be edited: wait for the queued publish, or reactivate first. Requires a company admin token with the products.update permission and an active TikTok Shop connection. operationId: admin_v202506_tiktok_product_listing_patch parameters: - name: id in: path required: true schema: type: integer requestBody: required: true content: application/json: example: tiktok_category_override_id: '601450' schema: type: object required: - tiktok_category_override_id properties: tiktok_category_override_id: type: - string - 'null' pattern: ^[0-9]{1,20}$ description: >- The TikTok category id to publish under, or null to clear the override. An empty string is rejected. responses: '200': description: Success content: application/json: example: product_listing: id: 27418 tiktok_product_id: '1729587461203847291' product_id: 91274 product_title: Hydrating Face Serum tiktok_category_id: '600966' tiktok_category_override_id: '601450' effective_tiktok_category_id: '601450' status: active audit_status: approved last_published_at: '2026-09-22T14:05:37.000Z' last_synced_at: '2026-09-29T09:12:44.000Z' last_error: null status: 200 meta: request_uuid: 8b4e2f71-3c9a-4d6e-b1f0-5a7c9e2d4b18 timestamp: '2026-09-30T16:42:11Z' schema: type: object properties: product_listing: $ref: '#/components/schemas/TiktokProductListing' status: type: integer meta: $ref: '#/components/schemas/Meta' additionalProperties: false '401': description: No valid bearer token was provided. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The caller is authenticated but is not a company admin, or lacks the products.update permission, or the caller is a droplet token. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: >- The company has never connected a TikTok Shop, or `id` does not match a listing on this connection. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: >- Invalid parameters, the TikTok Shop connection is not active, the listing is not editable (error.details.type is listing_not_editable with its status), the category id is malformed or an empty string (error.details.type is invalid_category_id), or the listing was updated concurrently (error.details.type is listing_changed; retry). content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: TiktokProductListing: description: >- A Fluid product's TikTok product-level listing. status and audit_status are TikTok's two orthogonal lifecycle axes — a listing can be "active" (live) while still "auditing" (pending review). type: object properties: id: type: integer product_id: type: integer product_title: type: - string - 'null' description: >- The product's title, read from Fluid's current catalog record for the listing's product_id; null if that product has since been discarded. tiktok_product_id: type: - string - 'null' tiktok_category_id: type: - string - 'null' description: >- The category TikTok recommended or the publisher last resolved for this listing. An admin override, when set, takes precedence; see effective_tiktok_category_id. tiktok_category_override_id: type: - string - 'null' description: >- The category an admin chose for this listing, or null when none is set. Set it with PATCH on the listing, or with category_overrides when creating listings. effective_tiktok_category_id: type: - string - 'null' description: >- The category a publish uses - tiktok_category_override_id when set, otherwise tiktok_category_id. Null until the first publish resolves one. status: type: string description: >- draft until the first publish attempt; active once TikTok confirms the listing; seller_deactivated/platform_deactivated/frozen for TikTok-side removals; publish_failed when the publish call errored; deleted for a locally-removed draft that was never published. enum: - draft - pending - active - seller_deactivated - platform_deactivated - frozen - publish_failed - deleted audit_status: type: - string - 'null' description: >- Nil until TikTok's first publish response or status refresh reports a review state. enum: - auditing - pre_approved - approved - audit_failed - null last_published_at: type: - string - 'null' format: date-time last_synced_at: type: - string - 'null' format: date-time last_error: type: - object - 'null' audit_reasons: type: - object - 'null' additionalProperties: true description: >- TikTok's audit detail from the last status refresh — everything under the product's audit object except status, such as not_submitted_reasons and pre_approved_reasons. Unknown keys TikTok adds pass through verbatim. Null when TikTok reports no reasons, and cleared on the next refresh once they go away. sku_listings: type: array description: >- The listing's per-SKU state, including the SKU-level error when TikTok rejected that variant. items: type: object properties: id: type: integer variant_id: type: integer seller_sku: type: string tiktok_sku_id: type: - string - 'null' last_error: type: - object - 'null' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time pagination: type: object description: >- Rotulus cursor-pagination metadata (Api::MetaPagination#to_h), present on cursor-paginated responses such as GET /api/v2025-06/prices. total_count is only present when the endpoint opts into a total count. properties: cursor: type: - string - 'null' limit: type: integer prev_cursor: type: - string - 'null' next_cursor: type: - string - 'null' total_count: type: integer UnauthorizedResponse: type: object properties: message: type: string error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.