> ## 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 a product's explicit catalog prices > Every active price type's explicit catalog prices for one product's variants, across every market and currency. Read-only and set-based (Retail::CatalogPriceReader) -- never a per-cell resolve. Gated on products.view AND Retail::PricingWrites.catalog_writes_enabled? for the company. Requires admin tier. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml get /api/v2025-06/products/{product_id}/prices openapi: 3.1.0 info: title: Fluid Admin v2025-06 API description: | **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. version: v2025-06 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: orders description: >- Read an order's detail and journey, and preview the points a refund of a selection returns before it is sent. x-fluid-section: Commerce - name: payments-reports description: >- Report on a company's payments over a period: transaction volume and amount, gateway latency, and approval and error rates, overall or per payment account. x-fluid-section: Payments - name: feature-flags description: >- Read and change a company's feature flags, and, for root admins, read the flag catalogue with each flag's summary and description. x-fluid-section: Developers - name: tokens description: >- Create and manage the company's API credentials: partner and public tokens, and the scoped clients that replace them for a company on identity sign-in, and for every company once scoped client creation is switched on for all. x-fluid-section: Developers - name: products description: >- Products, variants and their prices, including the per-price-type price grid of a bundle product. x-fluid-section: Commerce - name: tiktok description: >- The company's TikTok Shop connection, its logistics warehouses, category tree, product listings, and orders. x-fluid-section: Sales channels - name: ads description: >- The ad accounts a company advertises from. List what a connected Meta Business token can see and pick the ad account, Facebook Page and Instagram account Fluid launches ads into. Campaigns themselves stay on Meta. x-fluid-section: Sales channels - name: members description: >- Members and the member types that group them, including the company's default shopper member type. x-fluid-section: Members paths: /api/v2025-06/products/{product_id}/prices: get: tags: - products summary: List a product's explicit catalog prices description: >- Every active price type's explicit catalog prices for one product's variants, across every market and currency. Read-only and set-based (Retail::CatalogPriceReader) -- never a per-cell resolve. Gated on products.view AND Retail::PricingWrites.catalog_writes_enabled? for the company. Requires admin tier. operationId: admin_v2025_06_products_prices_index parameters: - name: product_id in: path required: true schema: type: string responses: '200': description: The product's catalog price grid. content: application/json: schema: $ref: '#/components/schemas/CatalogPricesResponse' '401': description: Missing or invalid credentials. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: The caller is not admin tier or lacks products.view permission. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: No product with this id belongs to the current company. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Catalog writes are not enabled for this company. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: CatalogPricesResponse: type: object description: >- Every active price type's explicit catalog prices, across every market and currency, for a set of variants. Rows are sparse: a (variant, market, currency, price type) cell with nothing explicitly priced produces no row. The exception is a company priced without the one-time fallback: wherever a plan-less subscription list exists with no row for the variant, a row is emitted with `subscription: {unset: true}`, and its `one_time` is whatever is stored for the variant (null only when nothing is stored). required: - price_types - markets - variants - rows - no_fallback - status - meta additionalProperties: false properties: price_types: type: array items: $ref: '#/components/schemas/CatalogPriceType' markets: type: array items: $ref: '#/components/schemas/CatalogPriceMarket' variants: type: array items: $ref: '#/components/schemas/CatalogPriceVariant' rows: type: array items: $ref: '#/components/schemas/CatalogPriceRow' no_fallback: type: boolean description: >- Whether the company is on the no-fallback pricing gate. When true, a cleared explicit subscription price is refused (price_required) rather than falling back to the one-time price. status: type: integer const: 200 meta: $ref: '#/components/schemas/Meta' UnauthorizedResponse: type: object properties: message: type: string error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' CatalogPriceType: type: object description: >- An active (non-archived) Company::PricingTier as the catalog price read API exposes it. `system` mirrors Company::PricingTier#system? (tier_level < 100) rather than a stored column. required: - id - name - system - tier_level additionalProperties: false properties: id: type: string format: uuid name: type: string system: type: boolean tier_level: type: integer CatalogPriceMarket: type: object description: A company market and the currencies its region supports. required: - id - name - currency_codes additionalProperties: false properties: id: type: string format: uuid name: type: string currency_codes: type: array items: type: string country_codes: type: object description: >- The countries a price in this market reaches, keyed by upcased currency code. Each value is a sorted array of upcased ISO country codes. Empty when no country resolves to this market with a destination currency; the company's first market also receives countries whose region has no market. additionalProperties: type: array items: type: string subscription_offered: type: array description: >- The price type and currency pairs that have a plan-less subscription list in this market, whether or not any variant has a row in it. items: type: object required: - pricing_tier_id - currency_code additionalProperties: false properties: pricing_tier_id: type: string format: uuid currency_code: type: string CatalogPriceVariant: type: object description: >- A variant covered by the request, labeled for the bulk editor -- NOT sparse like `rows`, so every variant in scope appears here even when it has no explicit catalog price anywhere. required: - id - product_id - product_title - title - sku - is_bundle additionalProperties: false properties: id: type: integer product_id: type: integer product_title: type: - string - 'null' title: type: - string - 'null' sku: type: - string - 'null' is_bundle: type: boolean unwritable_system_cells: type: array description: >- Retail/Wholesale (market, currency) cells this variant cannot be written in because a matched country has no active price row for it. items: type: object required: - market_id - currency_code additionalProperties: false properties: market_id: type: string format: uuid currency_code: type: string CatalogPriceRow: type: object description: One (variant, market, currency, price type) cell. required: - variant_id - market_id - currency_code - pricing_tier_id - one_time - subscription additionalProperties: false properties: variant_id: type: integer market_id: type: string format: uuid currency_code: type: string pricing_tier_id: type: string format: uuid one_time: anyOf: - $ref: '#/components/schemas/CatalogOneTimePrice' - type: 'null' subscription: anyOf: - $ref: '#/components/schemas/CatalogSubscriptionPrice' - type: 'null' 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 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' ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' 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' CatalogOneTimePrice: type: object description: >- An explicit one-time catalog price row. price is a decimal string at the currency's exponent (e.g. "19.99"), matching the money wire convention. compare_at_price, cv, and qv are the same format but nullable -- present in the response but null when the row carries no value for that field. required: - price - compare_at_price - cv - qv - points additionalProperties: false properties: price: type: string format: decimal compare_at_price: type: - string - 'null' format: decimal cv: type: - string - 'null' format: decimal qv: type: - string - 'null' format: decimal points: type: integer CatalogSubscriptionPrice: description: >- An explicit subscription catalog price, or a marker that the plan-less subscription list exists but carries no row for this variant, meaning, for a company priced with the one-time fallback, the price follows the one-time price. See features/member-pricing/DECISION-UNSET-SUBSCRIPTION-PRICE.md: a missing subscription LIST (not this object at all -- `subscription: null` on the row) is a separate, unrelated miss. For a company priced without the one-time fallback, a plan-less list with no row for this variant is reported as `{unset: true}` (nothing to follow; the cell is editable, and any stored one-time price stays on the row) rather than the follows-one-time marker. price is a decimal string at the currency's exponent, matching CatalogOneTimePrice; cv and qv are the same format but nullable. volume_overrides_one_time is always emitted on an explicit row (PLAN-SUBSCRIPTION-VOLUME.md slice S1c): true when this row's cv/qv was explicitly set apart from its tier's one-time cv/qv. oneOf: - type: object required: - price - cv - qv - volume_overrides_one_time additionalProperties: false properties: price: type: string format: decimal cv: type: - string - 'null' format: decimal qv: type: - string - 'null' format: decimal volume_overrides_one_time: type: boolean - type: object required: - follows_one_time additionalProperties: false properties: follows_one_time: type: boolean const: true - type: object required: - unset additionalProperties: false properties: unset: type: boolean const: true ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.