> ## 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. # Show one accessible order > Returns an own purchase or volume-credited order within the credential’s company. Credited-only orders omit email, phone and billing/shipping addresses. Authentication runs before conditional cache handling. Responses are private with a 30-second freshness lifetime. ## OpenAPI ````yaml /api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/orders/{id} 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. Order item counts and individual shipment statuses are not exposed because maintained source fields do not yet exist. 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[]. 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/{id}: get: tags: - orders summary: Show one accessible order description: >- Returns an own purchase or volume-credited order within the credential’s company. Credited-only orders omit email, phone and billing/shipping addresses. Authentication runs before conditional cache handling. Responses are private with a 30-second freshness lifetime. operationId: member_orders_show parameters: - name: id in: path required: true description: External order UUID. schema: type: string format: uuid responses: '200': description: The accessible order and its detail. content: application/json: schema: $ref: '#/components/schemas/OrderEnvelope' headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' '304': description: The authenticated member representation matches If-None-Match. 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' '404': description: >- Missing order, malformed identifier, or order outside the member and company scope. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: OrderEnvelope: type: object description: One accessible order. properties: status: type: integer description: HTTP response status. const: 200 data: $ref: '#/components/schemas/OrderDetail' meta: $ref: '#/components/schemas/ResponseMeta' required: - status - data - meta 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 OrderDetail: type: object description: >- Accessible order detail. Credited-only orders omit buyer contact fields until a visibility policy is available. additionalProperties: false properties: id: type: string description: External order identifier. format: uuid number: type: - string - 'null' description: >- Human-readable order number, or null for an unnumbered historical order. relationship: type: string description: >- Own purchases are placed; other orders credited to this member are credited. Placed wins when both apply, including with the credited filter. An order of one of the member's contacts that the member neither placed nor is credited for appears only in GET /contacts/{id}/orders, as contact. enum: - placed - credited - contact status: type: string description: Current order lifecycle state. enum: - draft - pending - pending_review - processing - completed - cancelled - archived financial_status: type: string description: Current payment state. enum: - pending - authorized - partially_paid - paid - refund_pending - partially_refunded - refunded - voided - marked_free - marked_paid fulfillment_status: type: string description: Overall order fulfillment state. enum: - unfulfilled - in_progress - on_hold - partially_fulfilled - scheduled - fulfilled placed_at: type: string description: Sale time, falling back to creation time for historical orders. format: date-time currency: type: string description: ISO 4217 currency code for all amounts in this order. example: USD total: type: string description: Order total in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' customer: type: object description: >- Stored purchaser reference and name, omitted for credited-only orders until a company visibility policy permits disclosure. additionalProperties: false properties: id: type: - string - 'null' description: >- Native member identifier; null for orders linked only through legacy customer metadata. format: uuid name: type: - string - 'null' description: Purchaser name recorded on the order. required: - id - name volume: type: object description: >- Commissionable and qualifying volume, omitted when the company hides customer-facing volume. additionalProperties: false properties: cv: type: - string - 'null' description: Commissionable volume in the order currency. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' qv: type: - string - 'null' description: Qualifying volume in the order currency. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' required: - cv - qv line_items: type: array description: Order lines, loaded only on the detail endpoint. items: $ref: '#/components/schemas/LineItem' email: type: - string - 'null' description: Recorded purchaser email; present only for an own purchase. phone: type: - string - 'null' description: Recorded purchaser phone; present only for an own purchase. shipping_address: description: Shipping address or null; omitted for credited-only orders. oneOf: - $ref: '#/components/schemas/Address' - type: 'null' billing_address: description: Billing address or null; omitted for credited-only orders. oneOf: - $ref: '#/components/schemas/Address' - type: 'null' shipments: type: array description: Recorded shipment tracking information. items: $ref: '#/components/schemas/Shipment' totals: type: object description: Order amounts in the enclosing order currency. additionalProperties: false properties: subtotal: type: string description: Order subtotal in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' shipping: type: string description: Order shipping in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' tax: type: string description: Order tax in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' discount: type: string description: Order discount in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' total: type: string description: Order total in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' required: - subtotal - shipping - tax - discount - total required: - id - number - relationship - status - financial_status - fulfillment_status - placed_at - currency - total - line_items - shipments - totals 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. required: - request_uuid - timestamp additionalProperties: true LineItem: type: object description: One order line with its external identifier and stored amounts. additionalProperties: false properties: id: type: string description: External order line identifier. format: uuid title: type: - string - 'null' description: >- Recorded product title, falling back to a current product in the order company. variant_title: type: - string - 'null' description: >- Customer-facing variant title, including archived catalog records in the order company; null for an absent or unnamed variant or unavailable or foreign parent product. sku: type: - string - 'null' description: >- Variant stock keeping unit, including archived catalog records in the order company; null for an absent or blank SKU or unavailable or foreign parent product. quantity: type: integer description: Ordered quantity. unit_price: type: string description: Stored unit price in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' total: type: string description: Unit price multiplied by quantity in major currency units. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '45.98' image_url: type: - string - 'null' description: >- Owned variant image URL, including archived variants/products, falling back to the current owned item product image; null when neither eligible source provides an image. required: - id - title - variant_title - sku - quantity - unit_price - total - image_url Address: type: object description: Normalized order address, with the historical JSON snapshot as fallback. additionalProperties: false properties: name: type: - string - 'null' description: Recorded name. address1: type: - string - 'null' description: Recorded address1. address2: type: - string - 'null' description: Recorded address2. city: type: - string - 'null' description: Recorded city. state: type: - string - 'null' description: Recorded state. postal_code: type: - string - 'null' description: Recorded postal code. country_code: type: - string - 'null' description: Recorded country code. phone: type: - string - 'null' description: Recorded phone. required: - name - address1 - address2 - city - state - postal_code - country_code - phone Shipment: type: object description: >- Recorded tracking information; individual shipment status is not stored and is omitted. additionalProperties: false properties: carrier: type: - string - 'null' description: Recorded shipping carrier. tracking_number: type: - string - 'null' description: Carrier tracking number. tracking_url: type: - string - 'null' description: Stored tracking URL, or a URL derived by the carrier integration. required: - carrier - tracking_number - tracking_url 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 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.