> ## 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. # URL Redirects > Send visitors from an old or marketing URL on your storefront to a new address with a permanent redirect, and keep rep credit intact. Use the URL Redirects screen to send visitors from one path on your storefront to another address. Each redirect is permanent (HTTP 301), so search engines move their listing to the new address. Redirects are the recommended way to keep marketing and legacy URLs working. A marketing URL such as `/tv-offer`, or an address from your old website such as `/beet-blend-powder.html`, is what customers without a rep type or click: from TV, print, ads, or old links. Redirect it to the real product or page, such as `/home/products/beet-blend`. Reps don't use those URLs. When they share from the Fluid mobile app or their own links, they use credited paths such as `//products/beet-blend`, so they still get credit. A redirect doesn't establish credit, and it doesn't take away credit a visitor already has. See [Rep credit](/help/admin/sitemap#rep-credit). ## Where to find it The URL Redirects screen isn't in the admin sidebar. To open it, do either of these: * Go to [admin.fluid.app/url\_redirects](https://admin.fluid.app/url_redirects). * Type `redirects` in the **Search Fluid** box at the top of the admin sidebar, then select **Url Redirects**. The search result appears for admins. ## What's on the screen The top of the screen has **Export** and **Add URL Redirect**. **Export** downloads your redirects as a CSV file. The table lists your redirects, with the **Old Path**, the **New Path**, and when each was created. Edit or delete a redirect from its row. ## Add a redirect 1. Click **Add URL Redirect**. 2. In **Old Path**, enter the path visitors arrive on, such as `/tv-offer`. It must start with `/` and can't contain spaces. 3. In **Redirect to Path**, enter where they should go. Use a path on your storefront, such as `/home/products/beet-blend`, or a full URL that starts with `https://`. 4. Save. ## How redirects work * **Exact path only.** `/tv-offer` redirects, but `/tv-offer/extra` doesn't. The query string isn't part of the match. * **The query string isn't forwarded.** The visitor arrives at exactly the address in **Redirect to Path**. * **Every storefront domain.** A redirect works on each domain your storefront uses. * **Redirects come first.** If a [custom route](/help/admin/sitemap#create-a-custom-route) uses the same path, the redirect wins. * **A rep's username wins over a redirect.** A redirect on `/jordan-lee` doesn't fire while an active rep has the username `jordan-lee`. Changes can be slow to reach a path visitors have already requested. Fluid remembers each path's redirect lookup for up to 30 days, and adding, editing, or deleting a redirect doesn't always reset that today. Add a redirect before you publish or move the URL. If a redirect doesn't take effect, contact Fluid support. ## Paths you can't redirect Fluid rejects an **Old Path** that: * Contains `/app`, `/www`, `/fluid`, `/api`, `/shop`, or `/cable` anywhere, or `/cart/`, `/checkout/`, or `/admin/`. These match as text, so `/apple-cider` and `/shop-sale` are rejected too. Choose another path, such as `/cider` or `/sale`. * Matches one of your storefront's own pages, such as `//products/`. * Already has a redirect. ## Redirect or custom route? Both can send visitors somewhere else. Pick by what the URL needs: | You want to | Use | | - | - | | Point a marketing or legacy URL at a product or page for good | A redirect on this screen (permanent, 301) | | Send visitors from different countries to different places | A custom route's country routes on the [Sitemap](/help/admin/sitemap#country-specific-routing) screen (temporary, 302) | | Keep the URL itself in the address bar | A non-credited custom route. Read [Rep credit](/help/admin/sitemap#rep-credit) first | ## Related * [Sitemap](/help/admin/sitemap) * [Domains](/help/admin/settings/domains) * [Custom routes for theme developers](/themes/custom-routes) Email Fluid support at [help@fluid.app](mailto:help@fluid.app). The [Getting help](/help/getting-help) page lists what to include in your request. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.