> ## 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. # Create a cart for the signed-in member > Create a cart in the member's company and bind it to the signed-in member in one call. The body is the cart create body of the public carts API (country_code is required; items and attribution are optional). The cart is created in the member's company only: a company named in the body is ignored, as are member_id, customer_id and an admin source. The response is the cart already bound to the member and priced for them (wholesale for rep member types), with its token, and it is populated before the response. If the bind is refused no cart is left behind. FairShare on a member host makes this one same-origin call (session cookie plus X-CSRF-Token) instead of a public create followed by a claim; guests keep the public create. Claim stays supported. Requires a writable member credential. ## OpenAPI ````yaml /api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/carts 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. An order's items_count is its number of lines, not units. Individual shipments carry no status: the order's fulfillment_status is the only fulfillment state members read. 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[]. **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 refuses a credential for it with `403` and the standard error envelope, before the operation runs. 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/carts: post: tags: - carts summary: Create a cart for the signed-in member description: >- Create a cart in the member's company and bind it to the signed-in member in one call. The body is the cart create body of the public carts API (country_code is required; items and attribution are optional). The cart is created in the member's company only: a company named in the body is ignored, as are member_id, customer_id and an admin source. The response is the cart already bound to the member and priced for them (wholesale for rep member types), with its token, and it is populated before the response. If the bind is refused no cart is left behind. FairShare on a member host makes this one same-origin call (session cookie plus X-CSRF-Token) instead of a public create followed by a claim; guests keep the public create. Claim stays supported. Requires a writable member credential. operationId: member_carts_create requestBody: required: true content: application/json: schema: type: object required: - country_code additionalProperties: true properties: country_code: type: string example: US items: type: array items: type: object required: - variant_id - quantity properties: variant_id: type: integer quantity: type: integer example: country_code: US items: - variant_id: 482913 quantity: 2 responses: '201': description: The created cart, bound to the member. headers: Cache-Control: description: >- Always includes no-store, because the response carries the cart token. The bearer mount sends no-store; the cookie mount sends private, no-store. schema: type: string enum: - no-store - private, no-store content: application/json: schema: allOf: - $ref: '#/components/schemas/CartEnvelope' - type: object properties: meta: type: object properties: skipped_items: type: array description: >- Requested items that were not added because they are unavailable in the cart's country. Present only when at least one item was skipped; the cart holds the rest. items: type: object properties: variant_id: type: integer reason: type: string example: status: 201 data: id: 0192f4e0-1a2b-7c3d-8e4f-5a6b7c8d9e0f token: ct_6d1f0c2a9b8e4f37 state: start kind: regular currency: USD totals: subtotal: '59.98' discount: '0.0' shipping: '7.5' tax: '4.8' total: '72.28' created_at: '2026-09-29T16:02:11.402913Z' updated_at: '2026-09-30T08:41:55.118204Z' items: - id: 0192f4e2-5d6e-7f80-91a2-b3c4d5e6f7a8 title: Daily Greens variant_title: 30 servings sku: DG-30 quantity: 2 subscription: false unit_price: '29.99' total: '59.98' image_url: https://cdn.fluid.app/products/daily-greens-30.jpg meta: request_uuid: 0192f520-1a2b-7c3d-8e4f-5a6b7c8d9e0f timestamp: '2026-09-30T15:20:00Z' '400': description: >- The request body is not valid JSON, or the cart could not be built from it. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- The member credential can only read, or the CSRF token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: The cart could not be created for this member's company. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- The body is invalid or its items cannot be added, or this membership has no commerce identity to hold carts. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: CartEnvelope: type: object properties: status: type: integer data: $ref: '#/components/schemas/CartDetail' 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 CartDetail: type: object description: One of the member's open carts with the lines shown to the shopper. additionalProperties: false properties: id: type: string format: uuid description: The cart's identifier. token: type: - string - 'null' description: >- The cart's checkout token: the capability the checkout surface uses to edit and pay for this cart, and the identifier of this cart on these routes. Only ever shown for the member's own carts, and only to a credential that can make changes; null for read-only member and portal JWTs. example: ct_6d1f0c2a9b8e4f37 state: type: - string - 'null' description: >- The cart's checkout state; null for an open cart whose state was never set. enum: - start - products - payment_method - authorized - payment_captured - checkout_fail - three_ds_pending - null kind: type: string description: A regular purchase or an enrollment. enum: - regular - enrollment currency: type: string description: ISO 4217 code for every amount in the cart. example: USD totals: $ref: '#/components/schemas/CartTotals' created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time description: Last change to the cart; the list is ordered by it, newest first. items: type: array description: The lines shown to the shopper. items: $ref: '#/components/schemas/CartItem' required: - items - id - token - state - kind - currency - totals - created_at - updated_at 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. subscription_schedule: $ref: '#/components/schemas/SubscriptionSchedule' code: type: string description: >- Machine code for the refusal. This surface serves shoppers, who are never refused for a blackout day. A picked bill date on one is saved on the next open day, and the success response carries the saved date. `next_bill_date_blackout` is kept for clients that already read it. example: next_bill_date_blackout blocked_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The date that was refused, as an ISO 8601 calendar date. example: '2026-11-30' blocked_day: type: integer minimum: 1 maximum: 31 description: >- Present with `next_bill_date_blackout`. The day of the month of `blocked_date`. example: 30 allowed_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The nearest date the merchant's blackout rules allow, the date to offer instead. example: '2026-11-28' required: - request_uuid - timestamp additionalProperties: true CartTotals: type: object description: >- The cart's stored totals in its currency, as decimal strings. Nothing is recalculated on read. additionalProperties: false properties: subtotal: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '89.97' discount: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '10.0' shipping: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '7.5' tax: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '6.4' total: type: - string - 'null' description: The stored total; null while the cart has not been priced. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '93.87' required: - subtotal - discount - shipping - tax - total CartItem: type: object description: >- One line of a cart, retaining its stored quantity and prices. Live catalog fields are returned only when the variant and product belong to the cart's company. Missing or foreign catalog references return null presentation fields and retain the stored line title when available. Lines without a stored price retain null unit_price and total; a stored zero remains zero. additionalProperties: false properties: id: type: string format: uuid title: type: - string - 'null' example: Daily Greens variant_title: type: - string - 'null' example: 30 servings sku: type: - string - 'null' example: DG-30 quantity: type: integer minimum: 1 example: 2 subscription: type: boolean description: Whether this line starts a product subscription at checkout. unit_price: type: - string - 'null' description: Stored unit price, or null when no price is stored. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '29.99' total: type: - string - 'null' description: Stored unit price times quantity, or null when no price is stored. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '59.98' image_url: type: - string - 'null' required: - id - title - variant_title - sku - quantity - subscription - unit_price - total - image_url SubscriptionSchedule: type: object description: >- Current owned billing intent state. Present in detail-read metadata and confirmed Skip/Undo metadata; never in legacy empty-body Skip metadata. Dates use the subscription timezone. The optional applied flag appears only after a confirmed mutation and is false for an accepted replay. additionalProperties: false properties: next_bill_date: type: - string - 'null' format: date description: Current local billing date, or null when unscheduled. latest_skip_id: type: - string - 'null' format: uuid description: >- Latest historical skip UUID, including undone skips, or null before the first skip. Echo this exact epoch when confirming a new skip. pending_skip_id: type: - string - 'null' format: uuid description: Currently undoable skip UUID, or null. pending_skip_date: type: - string - 'null' format: date description: Local date skipped by the pending intent, or null. can_skip: type: boolean description: Whether current plan, state and skip allowance permit a new skip. applied: type: boolean description: >- True only when this request changed the schedule; false for an accepted replay. Omitted on reads. required: - next_bill_date - latest_skip_id - pending_skip_id - pending_skip_date - can_skip 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.