> ## 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. # Import an order > Import an order that already exists in an external system (for example Exigo) into Fluid. The order, its line items, embedded shipping/billing addresses, and tracking records are recorded in a single transaction, bypassing the cart, checkout, and payment flow. This is the EntitySync order-import endpoint the integrations layer posts to. Requires a company-admin bearer token holding the orders:update permission. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml post /api/v2025-06/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/orders: post: tags: - orders summary: Import an order description: >- Import an order that already exists in an external system (for example Exigo) into Fluid. The order, its line items, embedded shipping/billing addresses, and tracking records are recorded in a single transaction, bypassing the cart, checkout, and payment flow. This is the EntitySync order-import endpoint the integrations layer posts to. Requires a company-admin bearer token holding the orders:update permission. operationId: admin_v2025_06_orders_post requestBody: required: true content: application/json: example: order: external_id: EXG-558120 order_number: DM-EXG-558120 currency_code: USD email: robert.california@sabre.com first_name: Robert last_name: California phone: '+15705550199' sale_date: '2026-09-03T16:20:00Z' amount: 119.97 subtotal: 109.98 tax_amount: 7.42 shipping_amount: 2.57 discount: 0 amount_paid: 119.97 order_status: completed fulfillment_status: fulfilled financial_status: paid source: backoffice cv: 100 qv: 100 metadata: legacy_system: exigo legacy_order_id: '558120' items: - sku: DM-20LB-CASE name: Dunder Mifflin 20lb Copy Paper quantity: 2 unit_price: 54.99 cv: 50 qv: 50 external_id: EXG-558120-1 ship_to: name: Robert California address1: 1725 Slough Avenue city: Scranton state: PA postal_code: '18505' country_code: US bill_to: name: Robert California address1: 1725 Slough Avenue city: Scranton state: PA postal_code: '18505' country_code: US tracking_informations: - tracking_number: 1Z999AA10123456784 shipping_carrier: UPS schema: type: object required: - order properties: order: type: object required: - items - currency_code description: The order to import. properties: items: type: array minItems: 1 description: Line items on the order. At least one is required. items: type: object required: - sku - name - quantity - unit_price properties: sku: type: string description: >- Product/variant SKU used to resolve the catalog record. name: type: string description: Line item title. quantity: type: integer minimum: 1 unit_price: type: number description: Price per unit in the order currency. cv: type: - integer - 'null' description: Commissionable volume for the item. qv: type: - integer - 'null' description: Qualifying volume for the item. external_id: type: - string - 'null' description: External system identifier for the line item. currency_code: type: string description: ISO 4217 currency code for the order. Required. email: type: - string - 'null' first_name: type: - string - 'null' last_name: type: - string - 'null' phone: type: - string - 'null' external_id: type: - string - 'null' description: External system identifier for the order. order_number: type: - string - 'null' sale_date: type: - string - 'null' format: date-time shipped_on: type: - string - 'null' format: date-time amount: type: - number - 'null' description: Total order amount. Defaults to 0 when omitted. subtotal: type: - number - 'null' tax_amount: type: - number - 'null' shipping_amount: type: - number - 'null' discount: type: - number - 'null' amount_paid: type: - number - 'null' description: Amount paid, stored in order metadata. order_status: type: - string - 'null' description: Order status. Defaults to "completed". fulfillment_status: type: - string - 'null' description: Fulfillment status. Defaults to "unfulfilled". financial_status: type: - string - 'null' description: Financial status. Defaults to "pending". order_class: type: - string - 'null' description: Order class. Defaults to "customer_order". warehouse_id: type: - integer - 'null' description: >- Fluid warehouse ID. Must belong to the authenticated company. shipping_method_id: type: - string - 'null' description: Shipping method identifier, stored in order metadata. cv: type: - integer - 'null' description: Order-level commissionable volume. qv: type: - integer - 'null' description: Order-level qualifying volume. source: type: - string - 'null' description: Order source. Defaults to "backoffice". metadata: type: - object - 'null' description: Arbitrary metadata (max 50 keys). customer_id: type: - integer - 'null' description: Fluid customer ID used to resolve the buyer. customer_external_id: type: - string - 'null' description: External customer ID used to resolve the buyer. ship_to: type: - object - 'null' description: Embedded shipping address. properties: name: type: - string - 'null' address1: type: - string - 'null' address2: type: - string - 'null' address3: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' postal_code: type: - string - 'null' country_code: type: - string - 'null' bill_to: type: - object - 'null' description: Embedded billing address. properties: name: type: - string - 'null' address1: type: - string - 'null' address2: type: - string - 'null' address3: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' postal_code: type: - string - 'null' country_code: type: - string - 'null' tracking_informations: type: array description: Per-shipment tracking records. items: type: object required: - tracking_number properties: tracking_number: type: string shipping_carrier: type: - string - 'null' responses: '201': description: Order imported content: application/json: example: order: id: 730301 first_name: Robert last_name: California email: robert.california@sabre.com phone: '+15705550199' order_number: DM-EXG-558120 status: awaiting_payment order_type: imported source: backoffice amount: '119.97' amount_in_base: '119.97' base_to_currency_rate: '1.0' note: null currency_code: USD created_at: '2026-09-15T14:32:07.861Z' updated_at: '2026-09-15T14:32:07.861Z' metadata: legacy_system: exigo legacy_order_id: '558120' token: e1c6b9a4d27f4c08b3a5f9d6e2c7b184 refundable_amount: '119.97' order_status: completed fulfillment_status: fulfilled financial_status: paid warehouse_id: null points_applied: 0 points_applied_amount: 0 points_applied_amount_in_currency: $0.00 order_total_after_points_redemption: 119.97 total_points_credited: 0 free_shipping: false discount_codes: [] created_subscriptions: [] meta: request_id: 4f1c2a9e-7b3d-4e8a-9c61-2d5f8a0b3e17 timestamp: '2026-09-15T14:32:08Z' schema: type: object additionalProperties: false required: - order - meta properties: order: type: object description: The imported order in its default representation. properties: id: type: integer first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: - string - 'null' phone: type: - string - 'null' order_number: type: - string - 'null' status: type: - string - 'null' order_type: type: string source: type: string amount: type: string amount_in_base: type: - string - 'null' base_to_currency_rate: type: - string - 'null' note: type: - string - 'null' currency_code: type: string created_at: type: string format: date-time updated_at: type: string format: date-time metadata: type: object token: type: string refundable_amount: type: - string - 'null' order_status: type: string fulfillment_status: type: string financial_status: type: string warehouse_id: type: - integer - 'null' points_applied: type: integer points_applied_amount: type: - number - 'null' points_applied_amount_in_currency: type: - string - 'null' order_total_after_points_redemption: type: - number - 'null' total_points_credited: type: integer free_shipping: type: boolean discount_codes: type: array created_subscriptions: type: array meta: $ref: '#/components/schemas/Meta' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: The authenticated admin lacks the orders.update permission. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: Customer or warehouse referenced by the order was not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Invalid parameters (for example a missing or blank currency_code) 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' 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' 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' 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 ````