> ## 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.
> 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 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.
> 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.

# Fluid reporting database tables

> The main tables and columns in your Fluid reporting database, the values their status columns take, how the tables join, and how money and currency are stored.

Your Fluid reporting database is a read-only copy of your company's Fluid data that you query in Mist. This page describes its main commerce tables: what's in them, how they join, and what their values mean. To turn the database on, see [Databases](https://docs.fluid.app/help/admin/settings/databases.md). To query it, see [Databases in Mist](https://docs.fluid.app/help/mist/databases.md).

The database has many more tables than the ones here. In Mist, open the database and use **Browse** to see them all.

## What's in the database

* **Only your company's data.** Every table with a `company_id` column holds only your company's rows. Tables without one, such as currency and exchange-rate lists, are shared reference data.
* **A copy, as of the last sync.** The data is as fresh as **Last synced** on the [Databases](https://docs.fluid.app/help/admin/settings/databases.md) screen. A sync replaces the whole copy in one step, so a query never sees a half-finished sync.
* **Deleted records are left out** of `customers`, `members`, `products` and `variants`. `orders` keeps every order, including draft and cancelled orders and orders with a zero total.
* **No foreign keys.** Tables have primary keys on `id`, but no foreign keys. Join on the columns in [How the tables join](#how-the-tables-join).

## Money and currency

* Amounts are decimals in the currency's main unit, such as `49.95` for \$49.95, not cents.
* An order's amounts are in the order's currency, `orders.currency_code`. Line items and refunds are in their order's currency. Never add up amounts in different currencies.
* Columns ending in `_base`, such as `total_price_base`, hold the same amount in US dollars. Use them to total orders across currencies. `orders.base_source` says where the dollar amount came from:
  * `stored`: the dollar amount Fluid recorded with the order.
  * `presentment_usd`: the order was in US dollars, so the order's own amount is used.
  * `official_monthly_rate`: converted with the official exchange rate for the order's month.
  * `unavailable`: no rate was found, and the `_base` columns are empty.
* Subscription prices are in the subscription's own `currency_code`.

## Main tables

### orders

One row per order.

| Column | What it holds |
| - | - |
| `id`, `order_number` | The order's ID and its order number. |
| `status` | The order's status. See [Status values](#status-values). |
| `financial_status`, `fulfillment_status` | Payment and fulfillment status. |
| `type` | `sample`, `customer`, `member`, `enrollment` or `autoship`. |
| `source_name` | Where the order came from, such as `web` or `subscription`. |
| `currency_code`, `total_price`, `subtotal_price`, `total_tax`, `total_discounts`, `total_shipping_price` | Amounts in the order's currency, each with a `_base` twin in US dollars. |
| `current_total_price` and other `current_` columns | The amounts after later changes to the order. |
| `total_refunded` | The amount refunded so far. |
| `cv`, `qv` | Commission and qualifying volume. |
| `member_id` | The buyer. Joins to `members.id` and `customers.member_id`. |
| `email`, `first_name`, `last_name`, `country_code` | Buyer details and the order's country. |
| `processed_at` | The sale date. It can be empty; use `created_at` then. |
| `cancelled_at`, `shipped_at`, `delivered_at`, `created_at` | Dates in the order's life. |

### line\_items

One row per product line on an order. Joins to `orders` on `order_id`, and to `products` and `variants` on `product_id` and `variant_id`.

`price` is the price of one unit, so a line's amount is `price * quantity`. Other columns include `title`, `quantity`, `total_tax`, `total_discount`, `total_refunded`, `cv` and `qv`.

### customers

One row per customer. Joins to orders through `member_id`, not a customer ID. Columns include `email`, `first_name`, `last_name`, `phone`, `orders_count`, `total_spent_in_base`, `last_order_id` and `external_id`.

`orders_count` counts all of the customer's orders. `total_spent_in_base` adds up, in US dollars, only orders whose `financial_status` is `paid`.

### members

One row per member. `id` joins to `orders.member_id`. Columns include `enroller_member_id` and `sponsor_member_id`, which point to other members, and `rank_id` and `member_type_id`.

### products and variants

`products` has one row per product, with `sku`, `status` (`published`, `draft`, `scheduled` or `archived`) and `active`. `variants` has one row per variant, with `product_id`, `sku`, `title` and `active`.

### commerce\_subscriptions

One row per subscription. Columns include `status`, `member_id` (the subscriber), `rep_member_id`, `variant_id`, `quantity`, `current_price`, `currency_code`, `next_billing_date`, `last_bill_date` and `cancelled_at`.

### orders\_subscriptions

Links subscriptions to the orders they created: `order_id` and `subscription_id`. `orders` has no subscription column, so join through this table.

### payments and refunds

`payments` has one row per payment, with `order_id`, `subscription_id`, `status`, `amount`, `amount_in_base`, `refunded_amount` and `currency_code`. `refunds` has one row per refund, with `order_id`, `amount`, `reason` and `refund_type`. `order_item_refunds` links a refund to the line items it covers: `refund_id`, `item_id` (the line item's `id`) and `quantity`.

### order\_reps

The reps on each order: `order_id`, `member_id` and `role`. `role` is `attribution`, `buyer`, `buyer_rep`, `sponsor` or `volume`.

## How the tables join

| From | To | Join on |
| - | - | - |
| `customers` | `orders` | `customers.member_id = orders.member_id` |
| `members` | `orders` | `members.id = orders.member_id` |
| `orders` | `line_items` | `line_items.order_id = orders.id` |
| `line_items` | `products` | `line_items.product_id = products.id` |
| `line_items` | `variants` | `line_items.variant_id = variants.id` |
| `variants` | `products` | `variants.product_id = products.id` |
| `commerce_subscriptions` | `orders` | through `orders_subscriptions`: `subscription_id = commerce_subscriptions.id` and `order_id = orders.id` |
| `payments`, `refunds` | `orders` | `order_id = orders.id` |
| `order_item_refunds` | `line_items` | `order_item_refunds.item_id = line_items.id` |

For example, this query lists last month's best-selling products by units:

```sql theme={null}
SELECT p.title, SUM(li.quantity) AS units
FROM orders o
JOIN line_items li ON li.order_id = o.id
JOIN products p ON p.id = li.product_id
WHERE o.financial_status IN ('paid', 'refund_pending', 'partially_refunded', 'marked_paid')
  AND COALESCE(o.processed_at, o.created_at) >= date_trunc('month', now()) - interval '1 month'
  AND COALESCE(o.processed_at, o.created_at) < date_trunc('month', now())
GROUP BY p.title
ORDER BY units DESC
LIMIT 10;
```

## Status values

| Column | Values |
| - | - |
| `orders.status` | `draft`, `pending`, `pending_review`, `processing`, `completed`, `cancelled`, `archived` |
| `orders.financial_status` | `pending`, `authorized`, `partially_paid`, `paid`, `refund_pending`, `partially_refunded`, `refunded`, `voided`, `marked_free`, `marked_paid` |
| `orders.fulfillment_status` | `unfulfilled`, `in_progress`, `on_hold`, `partially_fulfilled`, `scheduled`, `fulfilled` |
| `orders.source_name` | `web`, `mobile`, `admin`, `backoffice`, `subscription`, `enrollment`, `tiktok`, `amazon` |
| `commerce_subscriptions.status` | `pending`, `active`, `paused`, `past_due`, `cancelled` |
| `payments.status` | `unsent`, `sent`, `received`, `success`, `declined`, `pending`, `error`, `expired`, `reconciling` |

There's no flag for test orders. Sample orders have `type = 'sample'`.

To count revenue the way the admin's **Home** dashboard does, see [Commerce metrics](https://docs.fluid.app/concepts/metrics.md).

## Related pages

* [Databases in Mist](https://docs.fluid.app/help/mist/databases.md)
* [Databases in the admin](https://docs.fluid.app/help/admin/settings/databases.md)
* [Commerce metrics](https://docs.fluid.app/concepts/metrics.md)


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