> ## 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, 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. 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, carts, checkout sessions and orders. 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 //products/; see /concepts/agentic-commerce. > 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/.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/ 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. > 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. # Count and total the member's orders over a period > Count and total the authenticated member's own orders in their company over a trailing period, for a dashboard card that would otherwise page the whole order list to sum it. `placed` is the member's own purchases and `credited` the orders whose volume is credited to them, found as `GET /api/member/v2026-10/orders` finds them; an order that is both counts once, under `placed`. Each group counts its orders by status; its `order_count` and `order_total` leave cancelled orders out. Drafts are never counted. Totals are in the platform base currency, as the member's statistics report them. Orders are dated by their sale date, or their creation when they have none. No parameter selects another owner. A site's script acting for a share holder reads own purchases only, and `credited` is null. Responses are private and reauthorized before 304. ## OpenAPI ````yaml /api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/orders/summary openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Commerce description: > Order and product-subscription history for the authenticated member. The bearer credential determines member and company; query filters cannot change either. Uses the same member credentials as the People API. Money is serialized as decimal strings in the enclosing currency. An order's items_count is its number of lines, not units. Individual shipments carry no status: the order's fulfillment_status is the only fulfillment state members read. A subscription's next-charge total (next_total, next_order_preview) carries the known pre-reward-points renewal charge when it can be stated from stored facts without pricing the renewal; it is null for current-rate, bundled, tax-inclusive, tax-exempt, audience-discount, expiring-discount or missing-fact subscriptions. Its subtotal is net of discounts. Authoritative saved per-line amounts are also exposed on the detail's items[]. **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 refuses a credential for it with `403` and the standard error envelope, before the operation runs. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: orders description: The signed-in member’s own purchases and volume-credited orders. x-fluid-section: Members - name: subscriptions description: The signed-in member’s own product subscriptions. x-fluid-section: Members - name: carts description: >- The signed-in member's own carts, addressed by checkout token, and claiming a guest cart. x-fluid-section: Commerce paths: /api/member/v2026-10/orders/summary: get: tags: - orders summary: Count and total the member's orders over a period description: >- Count and total the authenticated member's own orders in their company over a trailing period, for a dashboard card that would otherwise page the whole order list to sum it. `placed` is the member's own purchases and `credited` the orders whose volume is credited to them, found as `GET /api/member/v2026-10/orders` finds them; an order that is both counts once, under `placed`. Each group counts its orders by status; its `order_count` and `order_total` leave cancelled orders out. Drafts are never counted. Totals are in the platform base currency, as the member's statistics report them. Orders are dated by their sale date, or their creation when they have none. No parameter selects another owner. A site's script acting for a share holder reads own purchases only, and `credited` is null. Responses are private and reauthorized before 304. operationId: member_orders_summary parameters: - name: period in: query required: false description: >- The trailing period to count: that many UTC days, today included, through now. `all` counts every order. Defaults to `30d`. schema: type: string enum: - 7d - 30d - 90d - 1y - all default: 30d responses: '200': description: The member's orders in the period, counted and totalled. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/OrderSummaryEnvelope' example: status: 200 data: period: 30d since: '2026-10-13T00:00:00.000Z' placed: order_count: 2 order_total: '125.00' by_status: - status: pending count: 0 - status: pending_review count: 0 - status: processing count: 1 - status: completed count: 1 - status: cancelled count: 0 - status: archived count: 0 credited: order_count: 6 order_total: '412.80' by_status: - status: pending count: 0 - status: pending_review count: 0 - status: processing count: 0 - status: completed count: 6 - status: cancelled count: 1 - status: archived count: 0 meta: request_uuid: 019a23a4-9211-71bf-8fa5-a5f31a82a0df timestamp: '2026-11-11T12:00:00Z' '304': description: The authenticated member's counts are unchanged. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' '401': description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- The credential belongs to a sandbox test company that cannot be reached now, because sandbox access is turned off for its live company or the live company was deleted. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- The period is not one of the supported values, or the request carries another query parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: headers: ETag: description: >- Fingerprint of this member's representation. Send it back in If-None-Match to skip the body while it is unchanged. schema: type: string CacheControl: description: Standard HTTP Cache-Control directive. Always private for this surface. schema: type: string example: max-age=60, private schemas: OrderSummaryEnvelope: type: object description: The authenticated member's own orders in a period, counted and totalled. required: - status - data - meta additionalProperties: false properties: status: type: integer const: 200 data: type: object required: - period - since - placed - credited additionalProperties: false properties: period: type: string enum: - 7d - 30d - 90d - 1y - all description: The period counted. since: type: - string - 'null' format: date-time description: >- The UTC start of the period, midnight UTC of its first day, or null for `all`. placed: $ref: '#/components/schemas/OrderSummaryCounts' credited: description: >- The orders credited to the member that they did not buy, or null when the request reads own purchases only. oneOf: - $ref: '#/components/schemas/OrderSummaryCounts' - type: 'null' meta: $ref: '#/components/schemas/ResponseMeta' ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta OrderSummaryCounts: type: object description: One group of the member's orders in the period. required: - order_count - order_total - by_status additionalProperties: false properties: order_count: type: integer minimum: 0 description: Orders in the group that are not cancelled. order_total: type: string pattern: ^-?[0-9]+\.[0-9]{2}$ description: >- The amount of the orders in `order_count`, in the platform base currency, as a decimal string. by_status: type: array description: >- Orders per status, cancelled included. Always six entries, in this order, zeros included; drafts are never counted. minItems: 6 maxItems: 6 items: type: object required: - status - count additionalProperties: false properties: status: type: string enum: - pending - pending_review - processing - completed - cancelled - archived description: An order status. count: type: integer minimum: 0 description: Orders in this status. ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. subscription_schedule: $ref: '#/components/schemas/SubscriptionSchedule' code: type: string description: >- Machine code for the refusal. This surface serves shoppers, who are never refused for a blackout day. A picked bill date on one is saved on the next open day, and the success response carries the saved date. `early_order_confirmation_required` marks a shopper's earlier date that needs confirming. `next_bill_date_blackout` is kept for clients that already read it. example: next_bill_date_blackout blocked_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The date that was refused, as an ISO 8601 calendar date. example: '2026-11-30' blocked_day: type: integer minimum: 1 maximum: 31 description: >- Present with `next_bill_date_blackout`. The day of the month of `blocked_date`. example: 30 allowed_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The nearest date the merchant's blackout rules allow, the date to offer instead. example: '2026-11-28' scheduled_date: type: string format: date description: >- Present with `early_order_confirmation_required`. The next bill date the subscription was scheduled to use, as an ISO 8601 calendar date. example: '2026-12-10' last_bill_date: type: - string - 'null' format: date description: >- Present with `early_order_confirmation_required`. The last local billed date, or null when the subscription has never billed. example: '2026-11-10' requested_date: type: string format: date description: >- Present with `early_order_confirmation_required`. The earlier date the request asked to save. example: '2026-11-30' required: - request_uuid - timestamp additionalProperties: true SubscriptionSchedule: type: object description: >- Current owned billing intent state. Present in detail-read metadata and confirmed Skip/Undo metadata; never in legacy empty-body Skip metadata. Dates use the subscription timezone. The optional applied flag appears only after a confirmed mutation and is false for an accepted replay. additionalProperties: false properties: next_bill_date: type: - string - 'null' format: date description: Current local billing date, or null when unscheduled. latest_skip_id: type: - string - 'null' format: uuid description: >- Latest historical skip UUID, including undone skips, or null before the first skip. Echo this exact epoch when confirming a new skip. pending_skip_id: type: - string - 'null' format: uuid description: Currently undoable skip UUID, or null. pending_skip_date: type: - string - 'null' format: date description: Local date skipped by the pending intent, or null. can_skip: type: boolean description: Whether current plan, state and skip allowance permit a new skip. applied: type: boolean description: >- True only when this request changed the schedule; false for an accepted replay. Omitted on reads. required: - next_bill_date - latest_skip_id - pending_skip_id - pending_skip_date - can_skip securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.