> ## 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. # Count the company's orders > Exact number of the authenticated company's orders matching the same `filter[...]` parameters as `GET /api/v202604/orders`, under the same credential-derived visibility. Use it when a list response carries no `meta.pagination.total_count`. The list omits the total when the database answered, so its first page never waits on a count. The count is cached for 60 seconds per company, caller visibility and filter set; `calculated_at` says when it was computed. A count that does not finish within the server's time limit returns `200` with `total_count: null`, and that answer is cached for the same 60 seconds. `search`, `sort` and `page` are not accepted and return `422`. ## OpenAPI ````yaml /api-reference/commerce-v2026-04.yaml get /api/v202604/orders/count openapi: 3.1.0 info: title: Fluid Commerce v2026-04 API version: v2026-04 description: >- Post-checkout order editing — atomically insert items and adjustments into existing orders. Powers integrations like droplet-driven free-gift flows. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: order_edits description: >- Post-checkout order editing — atomically insert items and add adjustments or discounts to existing orders, with an optional dry-run preview of the recalculated totals. - name: orders description: >- Company order listing — a cursor-paginated index of the authenticated company's orders, answered from the database or the search index per request, with free-text search and filtering on status, type, country, customer, rep, subscription and effective sale date. x-fluid-section: Commerce paths: /api/v202604/orders/count: get: tags: - orders summary: Count the company's orders description: | Exact number of the authenticated company's orders matching the same `filter[...]` parameters as `GET /api/v202604/orders`, under the same credential-derived visibility. Use it when a list response carries no `meta.pagination.total_count`. The list omits the total when the database answered, so its first page never waits on a count. The count is cached for 60 seconds per company, caller visibility and filter set; `calculated_at` says when it was computed. A count that does not finish within the server's time limit returns `200` with `total_count: null`, and that answer is cached for the same 60 seconds. `search`, `sort` and `page` are not accepted and return `422`. operationId: commerce_v2026_04_count_orders parameters: - $ref: '#/components/parameters/OrderFilterStatus' - $ref: '#/components/parameters/OrderFilterType' - $ref: '#/components/parameters/OrderFilterOrderNumber' - $ref: '#/components/parameters/OrderFilterCartSource' - $ref: '#/components/parameters/OrderFilterCartToken' - $ref: '#/components/parameters/OrderFilterCustomerId' - $ref: '#/components/parameters/OrderFilterUserCompanyId' - $ref: '#/components/parameters/OrderFilterSubscriptionId' - $ref: '#/components/parameters/OrderFilterCountryIsos' - $ref: '#/components/parameters/OrderFilterStartDate' - $ref: '#/components/parameters/OrderFilterEndDate' - $ref: '#/components/parameters/OrderFilterTimezone' responses: '200': description: The count, or null when it did not finish in time. content: application/json: schema: $ref: '#/components/schemas/OrderCountResponse' example: total_count: 137 calculated_at: '2026-10-05T10:15:00Z' status: 200 meta: request_uuid: 3f9c2a7e-5b1d-4e8a-9c6f-2d7b8e4a1c05 timestamp: '2026-10-05T10:15:02Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' security: - bearer_auth: [] components: parameters: OrderFilterStatus: name: filter[status] in: query required: false description: | Restrict to one order status. The sentinel `all` imposes no constraint and is equivalent to omitting the filter. schema: type: string enum: - all - draft - pending - pending_review - processing - completed - cancelled - archived example: completed OrderFilterType: name: filter[type] in: query required: false description: Restrict to one order class. schema: type: string enum: - sample_order - customer_order - member_order - enrollment_order - autoship_order example: customer_order OrderFilterOrderNumber: name: filter[order_number] in: query required: false description: Exact match on the human-facing order number. schema: type: string OrderFilterCartSource: name: filter[cart_source] in: query required: false description: Restrict to orders whose originating cart carried this source value. schema: type: string OrderFilterCartToken: name: filter[cart_token] in: query required: false description: >- Restrict to orders placed from the cart with this exact token. A token that matches no cart of the company returns no orders. schema: type: string example: ct_a1b2c3d4 OrderFilterCustomerId: name: filter[customer_id] in: query required: false description: >- Restrict to one customer's orders, matched on either the owning member or a legacy customer id carried on order metadata. schema: type: integer OrderFilterUserCompanyId: name: filter[user_company_id] in: query required: false description: >- Restrict to orders a given rep holds volume credit on, addressed by legacy UserCompany id. schema: type: integer OrderFilterSubscriptionId: name: filter[subscription_id] in: query required: false description: Restrict to orders belonging to one subscription. schema: type: integer OrderFilterCountryIsos: name: filter[country_isos] in: query required: false description: >- Comma-separated ISO-2 country codes; matches the order's own country, not the shipping address. schema: type: string example: US,CA OrderFilterStartDate: name: filter[start_date] in: query required: false description: | Inclusive lower bound on the effective sale date, as a calendar date resolved through `filter[timezone]`. schema: type: string format: date example: '2026-08-01' OrderFilterEndDate: name: filter[end_date] in: query required: false description: | Inclusive upper bound on the effective sale date, as a calendar date resolved through `filter[timezone]`. schema: type: string format: date example: '2026-08-31' OrderFilterTimezone: name: filter[timezone] in: query required: false description: | IANA timezone used to resolve `filter[start_date]` and `filter[end_date]` to day boundaries, so a day means the caller's day. Defaults to UTC; `Etc/Unknown` is treated as absent. An unrecognised zone returns 422. schema: type: string example: America/New_York schemas: OrderCountResponse: type: object description: | The number of orders matching the request's filters. required: - total_count - calculated_at - status - meta properties: total_count: type: - integer - 'null' minimum: 0 description: >- Exact number of matching orders, or null when the count did not finish within the server's time limit. calculated_at: type: string format: date-time description: >- When this count was computed. A cached count keeps its original time. status: type: integer description: HTTP status code, repeated in the body (`200` on success). meta: type: object description: Response metadata — request correlation fields. required: - request_uuid - timestamp properties: request_uuid: type: - string - 'null' description: Server-assigned identifier for this request. timestamp: type: string format: date-time description: Server time the response was generated. UnauthorizedError: type: object description: | Bare 401 body — a single `message` string, not the wrapped `ErrorResponse`. required: - message properties: message: type: string description: >- Human-readable reason the credential was rejected (e.g. missing or invalid bearer token). example: Invalid credentials. ForbiddenError: description: | One of the three 403 bodies: - bare `{ message }` when the credential is not company-admin tier (e.g. a rep token) - bare `{ error }` when the admin-tier credential lacks the `orders.update` permission - the wrapped `ErrorResponse` when the credential has `orders.update` but sends an override-shaped operation without the `orders.override` permission oneOf: - type: object required: - message properties: message: type: string description: | Authorization failure message. Present on the bare-`message` 403 body returned when the credential is not company-admin tier (e.g. a rep token). example: Not authorized. - type: object required: - error properties: error: type: string description: | Authorization failure message. Present on the bare-`error` 403 body returned when an admin-tier credential lacks the `orders.update` permission. example: Not authorized. - $ref: '#/components/schemas/ErrorResponse' ErrorResponse: type: object required: - error - status - meta properties: error: type: object description: >- Error detail object carrying the human-readable `message` and optional field-level `details`. required: - message properties: message: type: string description: Human-readable summary of what went wrong. details: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' description: Field-level error details (e.g. failed validations). status: type: integer description: >- HTTP status code of the error, repeated in the body for convenience (e.g. `422`). meta: $ref: '#/components/schemas/Meta' description: Response metadata (`request_id` and `timestamp`). 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' Meta: type: object properties: request_id: type: - string - 'null' description: | Server-assigned identifier for this request, echoed for correlation with logs and support; `null` when none was assigned. timestamp: type: string format: date-time description: >- Server time the response was generated, as an ISO-8601 UTC timestamp. responses: Unauthorized: description: | Missing or invalid bearer token. The body is a bare `{ message }` object — not the wrapped `ErrorResponse` envelope used by 400 / 404 / 422. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' Forbidden: description: | Authenticated but not authorized. Three paths produce 403, each with its own body shape: - Credential is not company-admin tier (e.g. a rep token) — bare `{ message }`. - Admin tier but missing the `orders.update` permission — bare `{ error }`. - Has `orders.update` but sends an override-shaped operation (an adjustment op, a line-item op flagged `overridden: true`, or a manual-source discount op) without the `orders.override` permission — wrapped `ErrorResponse`. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' UnprocessableEntity: description: >- Business error (e.g. variant not found, editor failure, cross-company discount). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearer_auth: type: http scheme: bearer description: | Bearer token authentication. Accepts company tokens, partner tokens, public tokens, droplet installation tokens, and user_company tokens. The authenticated credential determines `editor_type` and `editor_id` on the resulting order-edit audit records — the payload never carries either field. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.