> ## 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. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/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. # List orders > Returns the company's orders, newest sale first, using cursor pagination: pass page[cursor] and page[limit] (default 20, maximum 100) and follow meta.pagination.next_cursor / prev_cursor. Filter by status, type, customer, member (user_company_id), subscription, order number, date range (start_date / end_date, optionally interpreted in timezone), within_days, cart_source, or country_isos, and use search to match order number, email, name, phone, or customer fields. Alongside pagination, meta carries aggregate figures for the whole filtered set (average/total CV and base-currency amount, fulfilled count); for more than 10,000 matching orders these are skipped unless force_stats=true. Requires a Bearer token with orders view permission. Company admins see every order; a non-admin member sees only orders they placed or are the buyer rep on; a customer token sees only that customer's orders. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml get /api/v202506/orders openapi: 3.1.0 info: title: Fluid Admin v2025-06 API version: v2025-06 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/v202506/orders: get: tags: - orders summary: List orders description: >- Returns the company's orders, newest sale first, using cursor pagination: pass page[cursor] and page[limit] (default 20, maximum 100) and follow meta.pagination.next_cursor / prev_cursor. Filter by status, type, customer, member (user_company_id), subscription, order number, date range (start_date / end_date, optionally interpreted in timezone), within_days, cart_source, or country_isos, and use search to match order number, email, name, phone, or customer fields. Alongside pagination, meta carries aggregate figures for the whole filtered set (average/total CV and base-currency amount, fulfilled count); for more than 10,000 matching orders these are skipped unless force_stats=true. Requires a Bearer token with orders view permission. Company admins see every order; a non-admin member sees only orders they placed or are the buyer rep on; a customer token sees only that customer's orders. operationId: admin_v2025_06_list_orders parameters: - name: params in: query required: false description: Query parameters for filtering, pagination, and sorting schema: type: object properties: page: type: object properties: cursor: type: string description: Cursor for pagination limit: type: integer description: Number of records per page (max 100) sort: type: string description: Sort order (prefix with - for descending) enum: - created_at - '-created_at' - id - '-id' - order_status - '-order_status' - status - '-status' - customer_name - '-customer_name' - customer - '-customer' - amount - '-amount' search: type: string description: >- Search across order number, email, name, phone, and customer fields status: type: string description: Filter by order status type: type: string description: Filter by order type/class customer_id: type: integer description: Filter by customer ID user_company_id: type: integer description: Filter by user company ID subscription_id: type: integer description: Filter by subscription ID start_date: type: string format: date description: Filter orders from this date end_date: type: string format: date description: Filter orders until this date timezone: type: string description: Timezone for date filtering within_days: type: integer description: Filter orders within N days cart_source: type: string description: Filter by cart source country_isos: type: string description: Filter by country ISO codes force_stats: type: boolean description: Force stats calculation for large datasets order_number: type: string description: Filter by order number responses: '200': description: Success content: application/json: example: orders: - id: 730215 email: holly.flax@dundermifflin.com order_number: DM-1042 status: awaiting_shipment source: web amount: '143.40' amount_in_base: '143.40' base_to_currency_rate: '1.0' note: null currency_code: USD created_at: '2026-09-14T15:22:08.412Z' updated_at: '2026-09-14T15:24:51.093Z' token: b7e2c9f4a1d84e6f9c3a5d7e8f0b1c2d in_flight_refund_total: '0.0' pending_refunds: [] order_status: processing fulfillment_status: unfulfilled financial_status: paid warehouse_id: 3107 points_applied: 0 points_applied_amount: 0 points_applied_amount_in_currency: $0.00 order_total_after_points_redemption: 143.4 total_points_credited: 143 starts_subscription: false currency_symbol: $ items_count: 2 quantity_count: 3 external_id: null order_on_behalf_of: false sale_date: '2026-09-14T15:22:08.412Z' total_display_amount: $143.40 total_cv: '110.0' total_qv: '110.0' customer: id: 48213 full_name: Holly Flax email: holly.flax@dundermifflin.com external_id: null orders_count: 4 active_subscriptions_count: 0 inactive_subscriptions_count: 0 first_item: title: Dunder Mifflin 20lb Copy Paper image_url: >- https://cdn.fluid.app/uploads/companies/1405/products/20lb-copy-paper/cover.jpg subscription: null - id: 730209 email: jan.levinson@serenitybycandles.com order_number: DM-1041 status: awaiting_shipment source: web amount: '54.99' amount_in_base: '54.99' base_to_currency_rate: '1.0' note: null currency_code: USD created_at: '2026-09-14T11:02:37.918Z' updated_at: '2026-09-14T11:03:10.224Z' token: 9a4c7e2b6d1f48a3b5e0c8d2f7a1b6e4 in_flight_refund_total: '0.0' pending_refunds: [] order_status: processing fulfillment_status: unfulfilled financial_status: paid warehouse_id: 3107 points_applied: 0 points_applied_amount: 0 points_applied_amount_in_currency: $0.00 order_total_after_points_redemption: 54.99 total_points_credited: 54 starts_subscription: true currency_symbol: $ items_count: 1 quantity_count: 1 external_id: null order_on_behalf_of: false sale_date: '2026-09-14T11:02:37.918Z' total_display_amount: $54.99 total_cv: '50.0' total_qv: '50.0' customer: id: 48201 full_name: Jan Levinson email: jan.levinson@serenitybycandles.com external_id: null orders_count: 7 active_subscriptions_count: 1 inactive_subscriptions_count: 0 first_item: title: Dunder Mifflin 20lb Copy Paper image_url: >- https://cdn.fluid.app/uploads/companies/1405/products/20lb-copy-paper/cover.jpg subscription: subscription_token: sub_3f8b1e6c9a2d4b7e status: active meta: request_id: 4f1c2a9e-7b3d-4e8a-9c61-2d5f8a0b3e17 timestamp: '2026-09-15T14:32:08Z' pagination: cursor: null limit: 20 prev_cursor: null next_cursor: >- eyJpZCI6NzMwMjA5LCJzYWxlX2RhdGUiOiIyMDI2LTA5LTE0VDExOjAyOjM3WiJ9 total_count: 318 average_cv: '42.5' total_cv: '13515.0' average_amount_base: 87.42 total_amount_base: 27799.56 fulfilled_orders_count: 281 schema: type: object properties: orders: type: array items: type: object required: - starts_subscription properties: id: type: integer email: type: string order_number: type: string status: type: - string - 'null' order_type: type: integer order_class: type: string description: >- Order classification (e.g. sample_order, customer_order, member_order, enrollment_order, autoship_order). Present only for company-admin callers. source: type: string amount: type: string amount_in_base: type: string base_to_currency_rate: type: - string - 'null' note: type: - string - 'null' currency_code: type: string created_at: type: string format: date-time updated_at: type: string format: date-time token: type: string refundable_amount: type: string in_flight_refund_total: type: - string - number - 'null' description: >- Total of refunds the payment provider has accepted but not yet settled, reserved against refundable_amount. pending_refunds: type: array description: >- Refunds the provider has accepted but not settled. Absent from refunds and refund_total until settlement. items: type: object properties: amount: type: - string - number - 'null' requested_at: type: - string - 'null' format: date-time provider_refund_id: type: - string - 'null' order_items: type: array description: >- Units reserved by this refund. Empty for a custom refund, which reserves an amount but no units. items: type: object properties: id: type: - integer - 'null' quantity: type: - integer - 'null' order_status: type: string fulfillment_status: type: string financial_status: type: string warehouse_id: type: - integer - 'null' points_applied: type: integer points_applied_amount: type: number points_applied_amount_in_currency: type: string order_total_after_points_redemption: type: number total_points_credited: type: integer starts_subscription: type: boolean description: Whether this order created a subscription. currency_symbol: type: string items_count: type: integer quantity_count: type: integer external_id: type: - string - 'null' order_on_behalf_of: type: boolean sale_date: type: - string - 'null' format: date-time total_display_amount: type: string total_cv: type: string format: decimal total_qv: type: string format: decimal customer: type: object properties: id: type: integer full_name: type: string email: type: string external_id: type: - string - 'null' orders_count: type: integer active_subscriptions_count: type: integer inactive_subscriptions_count: type: integer first_item: type: - object - 'null' properties: title: type: string image_url: type: - string - 'null' subscription: type: - object - 'null' properties: subscription_token: type: string status: type: string meta: $ref: '#/components/schemas/Meta' additionalProperties: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' security: - bearer_auth: [] components: schemas: 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' 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' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' 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' securitySchemes: bearer_auth: type: http scheme: bearer ````