> ## 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 credited orders for a rep > Lists orders credited to the rep, newest first. Filter with start_date, end_date, status, customer_id, subscription_id, search_query, within_days, unfulfilled, unpaid, type, cart_source, country_isos, or metadata. Uses offset pagination with page and per_page (default 10). meta also carries order statistics for the filtered set (average and total CV, average and total amount in base currency, fulfilled order count); when the set is larger than 10,000 orders the statistics are skipped unless force_stats=true. Requires a company admin-tier Bearer token with orders view permission. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml get /api/v2025-06/reps/{rep_id}/credited_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/v2025-06/reps/{rep_id}/credited_orders: get: tags: - reps summary: List credited orders for a rep description: >- Lists orders credited to the rep, newest first. Filter with start_date, end_date, status, customer_id, subscription_id, search_query, within_days, unfulfilled, unpaid, type, cart_source, country_isos, or metadata. Uses offset pagination with page and per_page (default 10). meta also carries order statistics for the filtered set (average and total CV, average and total amount in base currency, fulfilled order count); when the set is larger than 10,000 orders the statistics are skipped unless force_stats=true. Requires a company admin-tier Bearer token with orders view permission. operationId: admin_v2025_06_reps_credited_orders_get parameters: - name: rep_id in: path required: true schema: type: string - name: page in: query required: false description: Page number (offset pagination, starting at 1). schema: type: integer minimum: 1 default: 1 - name: per_page in: query required: false description: Orders per page. Defaults to 10. schema: type: integer default: 10 - name: start_date in: query required: false description: Only orders on or after this date. schema: type: string format: date - name: end_date in: query required: false description: Only orders on or before this date. schema: type: string format: date - name: status in: query required: false description: Order status to filter by, or all. schema: type: string - name: search_query in: query required: false description: Free-text search across the order and customer. schema: type: string - name: force_stats in: query required: false description: >- Calculate meta statistics even when the filtered set exceeds 10,000 orders. schema: type: boolean responses: '200': description: Success content: application/json: example: orders: - id: 730512 first_name: Holly last_name: Flax email: holly.flax@dundermifflin.com order_number: DM104827 status: shipped amount: '54.99' amount_in_base: '54.99' base_to_currency_rate: '1.0' currency_code: USD created_at: '2026-09-08T16:21:09Z' updated_at: '2026-09-10T08:14:52Z' order_status: completed fulfillment_status: fulfilled financial_status: paid currency_symbol: $ items_count: 1 quantity_count: 1 order_on_behalf_of: false sale_date: '2026-09-08T16:21:09Z' total_display_amount: $54.99 total_cv: '38.5' total_qv: '38.5' customer: id: 90522 full_name: Holly Flax email: holly.flax@dundermifflin.com external_id: CUST-2291 orders_count: 4 active_subscriptions_count: 1 inactive_subscriptions_count: 0 first_item: title: Dunder Mifflin 20lb Copy Paper image_url: >- https://cdn.fluid.app/dunder-mifflin/products/20lb-copy-paper.jpg meta: request_id: 2b5e8c1f-7d3a-4096-8e42-c1f9a6d3b750 timestamp: '2026-09-15T14:40:22Z' pagination: current_page: 1 total_pages: 1 total_count: 1 per_page: 10 average_cv: '38.5' total_cv: '38.5' average_amount_base: 54.99 total_amount_base: 54.99 fulfilled_orders_count: 1 schema: type: object properties: orders: type: array items: type: object properties: id: type: integer first_name: type: string last_name: type: string email: type: string order_number: type: string status: type: string description: >- Legacy order status, for example awaiting_shipment or shipped. source: type: string amount: type: - string - number - 'null' amount_in_base: type: - string - number - 'null' base_to_currency_rate: type: - string - number - 'null' note: type: string currency_code: type: string created_at: type: string format: date-time updated_at: type: string format: date-time token: type: string order_status: type: string fulfillment_status: type: string financial_status: type: string warehouse_id: type: integer 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 currency_symbol: type: string items_count: type: integer quantity_count: type: integer external_id: type: string order_on_behalf_of: type: boolean sale_date: type: string 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 orders_count: type: integer active_subscriptions_count: type: integer inactive_subscriptions_count: type: integer first_item: type: object properties: title: type: string image_url: type: string subscription: type: object 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' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 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' ErrorResponse: type: object required: - error_message - errors - meta properties: 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 ````