> ## 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. > 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. # List an order's edits with their before and after snapshots > Returns the order's edit history, oldest first. Each edit carries who made it (`editor_type`, `editor_id`), its `revision`, and the order's state before and after it (`before_snapshot`, `after_snapshot`) when the edit stored them. Available to admin credentials only, and only while admin order editing is on for the order's company. An admin credential without the flag on for the order's company, a droplet or system credential, or another company's order answers 404. ## OpenAPI ````yaml /api-reference/commerce-v2026-04.yaml get /api/v202604/orders/{order_id}/edits 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. **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 in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. 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. x-fluid-section: Commerce - 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/{order_id}/edits: get: tags: - order_edits summary: List an order's edits with their before and after snapshots description: | Returns the order's edit history, oldest first. Each edit carries who made it (`editor_type`, `editor_id`), its `revision`, and the order's state before and after it (`before_snapshot`, `after_snapshot`) when the edit stored them. Available to admin credentials only, and only while admin order editing is on for the order's company. An admin credential without the flag on for the order's company, a droplet or system credential, or another company's order answers 404. operationId: commerce_v2026_04_list_order_edits parameters: - $ref: '#/components/parameters/OrderId' responses: '200': description: The order's edits, oldest first. content: application/json: schema: $ref: '#/components/schemas/OrderEditHistoryResponse' examples: history: summary: One admin edit that changed a line quantity value: edits: - id: 4821 revision: 1 editor_type: admin editor_id: '3107' operations: - id: 4821 edit_type: item_modified description: Changed quantity edit_changes: {} created_at: '2026-04-01T12:00:00Z' total_before: '110.00' total_after: '120.00' before_snapshot: currency_code: USD totals: amount_cents: 11000 current_amount_cents: 11000 lines: - id: 90211 sku: TEE-BLK-M title: Black Tee quantity: 1 unit_price_cents: 11000 after_snapshot: currency_code: USD totals: amount_cents: 11000 current_amount_cents: 12000 lines: - id: 90211 sku: TEE-BLK-M title: Black Tee quantity: 2 unit_price_cents: 6000 status: 200 meta: request_id: 018f2c1a-8b3a-7e6d-9f10-2a3b4c5d6e7f timestamp: '2026-04-01T12:00:00Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' security: - bearer_auth: [] components: parameters: OrderId: name: order_id in: path required: true description: | Primary-key id of the order to edit. Must belong to the authenticated company; an unknown id or an order owned by another company returns 404. schema: type: integer schemas: OrderEditHistoryResponse: description: Response of GET /api/v202604/orders/{order_id}/edits. type: object required: - edits - status - meta properties: edits: type: array items: $ref: '#/components/schemas/OrderEditHistoryEntry' status: type: integer description: HTTP status code, repeated in the body. meta: $ref: '#/components/schemas/Meta' OrderEditHistoryEntry: description: >- One edit transaction. The operations it applied share one revision and one pair of snapshots. An edit with no revision (a droplet edit) is an entry of its own. type: object required: - id - editor_type - operations - created_at properties: id: type: integer description: The id of the transaction's first edit row. editor_type: type: string editor_id: type: - string - 'null' operations: type: array items: type: object required: - id - edit_type properties: id: type: integer edit_type: type: string description: type: - string - 'null' edit_changes: type: object created_at: type: string format: date-time revision: type: - integer - 'null' description: Rises by one per snapshotted admin edit of the order. total_before: type: - string - 'null' description: >- The order's total before the edit as a decimal in the order's currency, or null when no snapshot was stored. total_after: type: - string - 'null' description: >- The order's total after the edit as a decimal in the order's currency, or null when no snapshot was stored. before_snapshot: type: - object - 'null' description: The order's state before the edit, when stored. after_snapshot: type: - object - 'null' description: The order's state after the edit, when stored. 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. 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' 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`. - An admin credential on a company with order editing released (LaunchDarkly `admin-order-editing`) whose order editing setting is off — wrapped `ErrorResponse`, message `order_editing_disabled`. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' NotFound: description: Order does not exist or does not belong to the authenticated company. 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.