> ## 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. > 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. > 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/auth-v0.yaml covers the unversioned auth surface (/api/... paths — authentication, MFA, social auth, and token exchange); 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. > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. # Create refund for items ## OpenAPI ````yaml /api-reference/company-v0.yaml post /api/refunds/items openapi: 3.1.0 info: title: Fluid Company API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app - url: https://{company}.fluid.app description: Production server with company subdomain variables: company: default: myco description: Company subdomain security: [] paths: /api/refunds/items: post: tags: - refunds summary: Create refund for items operationId: commerce_v0_create_refund_for_items requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateRefundForItemsRequestBodyApplicationJsonSchema responses: '201': description: Refund created content: application/json: schema: $ref: >- #/components/schemas/CreateRefundForItemsResponse201ApplicationJsonSchema '202': description: >- Refund accepted by the payment provider but not yet settled. The order stays unrefunded until the provider confirms it; the request must not be retried, since a second dispatch would refund the shopper twice. content: application/json: schema: type: object properties: message: type: string description: What the provider still owes before the refund settles. refund_status: type: string enum: - pending description: Marks the refund as accepted but unsettled. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' security: - bearer_auth: [] components: schemas: CreateRefundForItemsRequestBodyApplicationJsonSchema: type: - object - 'null' properties: order_id: type: - integer - string - number - 'null' order_items: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' amount: type: - number - string - integer - 'null' quantity: type: - integer - string - number - 'null' cv: type: - number - string - 'null' format: decimal qv: type: - number - string - 'null' format: decimal restock: type: - boolean - 'null' reason: type: - string - number - integer - 'null' CreateRefundForItemsResponse201ApplicationJsonSchema: type: - object - 'null' properties: refund: type: - object - 'null' properties: id: type: - integer - string - number - 'null' order_id: type: - integer - string - number - 'null' amount: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' reason: type: - string - number - integer - 'null' refund_type: type: - string - number - integer - 'null' order: title: Commerce::Order type: - object - 'null' properties: id: type: - integer - string - number - 'null' first_name: type: - string - number - integer - 'null' last_name: type: - string - number - integer - 'null' email: type: - string - number - integer - 'null' phone: type: - string - number - integer - 'null' order_number: type: - string - number - integer - 'null' status: type: - string - number - integer - 'null' order_type: type: - string - number - integer - 'null' source: type: - string - number - integer - 'null' amount: default: '0.0' anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' amount_in_base: default: '0.0' anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' base_to_currency_rate: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' note: type: - string - number - integer - 'null' currency_code: type: - string - number - integer - 'null' created_at: type: - string - number - integer - 'null' format: date-time updated_at: type: - string - number - integer - 'null' format: date-time metadata: type: - object - 'null' default: '{}' additionalProperties: $ref: '#/components/schemas/JsonValue' token: type: - string - number - integer - 'null' refundable_amount: type: - string - number - integer - 'null' order_status: type: - string - number - integer - 'null' fulfillment_status: type: - string - number - integer - 'null' financial_status: type: - string - number - integer - 'null' warehouse_id: type: - integer - string - number - 'null' points_applied: default: 0 type: - integer - string - number - 'null' points_applied_amount: type: - number - string - integer - 'null' points_applied_amount_in_currency: type: - string - number - integer - 'null' order_total_after_points_redemption: type: - number - string - integer - 'null' total_points_credited: type: - integer - string - number - 'null' customer_points_balance: type: - integer - string - number - 'null' free_shipping: type: - boolean - 'null' description: Whether the order has free shipping discount_codes: default: [] description: Discount codes applied to the order type: - array - 'null' items: $ref: '#/components/schemas/JsonValue' created_subscriptions: default: [] description: Subscription tokens created from this order type: - array - 'null' items: $ref: '#/components/schemas/JsonValue' order_item_refunds: type: - array - 'null' items: type: - object - 'null' properties: id: anyOf: - type: - integer - string - number - 'null' - type: - string - number - integer - 'null' quantity: type: - integer - string - number - 'null' item: $ref: '#/components/schemas/CompanyOrderLineItem' meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' 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' CompanyOrderLineItem: type: - object - 'null' properties: id: type: - integer - string - number - 'null' price: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' price_in_currency: type: - string - number - integer - 'null' tax: type: - string - number - integer - 'null' tax_in_currency: type: - string - number - integer - 'null' discount_amount: type: - string - number - integer - 'null' discount_amount_in_currency: type: - string - number - integer - 'null' cv: type: - string - 'null' format: decimal cv_in_currency: type: - string - number - integer - 'null' qv: type: - string - 'null' format: decimal qv_in_currency: type: - string - number - integer - 'null' product_title: type: - string - number - integer - 'null' variant_title: type: - string - number - integer - 'null' variant_image: type: - string - number - integer - 'null' variant_id: type: - integer - string - number - 'null' quantity: type: - integer - string - number - 'null' title: type: - string - number - integer - 'null' total: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' image_url: type: - string - number - integer - 'null' sku: type: - string - number - integer - 'null' display_price: type: - string - number - integer - 'null' display_total: type: - string - number - integer - 'null' refundable_amount: format: float anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' enrollment_pack_id: type: - integer - string - number - 'null' display_to_customer: type: - boolean - 'null' free_item: type: - boolean - 'null' bundled_items: type: - array - 'null' items: $ref: '#/components/schemas/CompanyBundledItem' ordered_variant: type: - array - 'null' items: type: - object - 'null' properties: option_type: type: - string - number - integer - 'null' value: type: - string - number - integer - 'null' product: $ref: '#/components/schemas/CompanyOrderItemProduct' variant: $ref: '#/components/schemas/CompanyOrderItemVariant' default_language: type: - string - number - integer - 'null' translations: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' 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' CompanyBundledItem: type: - object - 'null' properties: variant_id: type: - integer - string - number - 'null' product_id: type: - integer - string - number - 'null' product_title: type: - string - number - integer - 'null' variant_title: type: - string - number - integer - 'null' option_titles: type: - array - 'null' items: type: - string - number - integer - 'null' quantity: type: - integer - string - number - 'null' display_to_customer: type: - boolean - 'null' CompanyOrderItemProduct: type: - object - 'null' properties: id: type: - integer - string - number - 'null' title: type: - string - number - integer - 'null' introduction: type: - string - number - integer - 'null' cv: type: - string - 'null' format: decimal cv_in_currency: type: - string - number - integer - 'null' external_id: type: - string - number - integer - 'null' image_path: type: - string - number - integer - 'null' image_url: type: - string - number - integer - 'null' price: type: - string - number - integer - 'null' price_in_currency: type: - string - number - integer - 'null' sku: type: - string - number - integer - 'null' tax: type: - string - number - integer - 'null' tax_in_currency: type: - string - number - integer - 'null' canonical_url: type: - string - number - integer - 'null' metadata: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' metafields: type: - array - 'null' items: $ref: '#/components/schemas/CompanyProductMetafield' CompanyOrderItemVariant: type: - object - 'null' properties: id: type: - integer - string - number - 'null' title: type: - string - number - integer - 'null' image_path: type: - string - number - integer - 'null' image_url: type: - string - number - integer - 'null' primary_image: type: - string - number - integer - 'null' price: type: - string - number - integer - 'null' price_in_currency: type: - string - number - integer - 'null' currency_code: type: - string - number - integer - 'null' sku: type: - string - number - integer - 'null' options: type: - array - 'null' items: type: - object - 'null' properties: title: type: - string - number - integer - 'null' value: type: - string - number - integer - 'null' ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' 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' Meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' format: date-time CompanyProductMetafield: title: LegacyMetafield type: - object - 'null' properties: namespace: description: >- A container for related metafields. Commonly used to group metafields by app or functionality. type: - string - number - integer - 'null' maxLength: 20 pattern: ^[a-zA-Z0-9_]+$ key: description: >- The unique identifier for the metafield within its namespace. Must be unique per namespace and owner. type: - string - number - integer - 'null' maxLength: 30 pattern: ^[a-zA-Z0-9_]+$ value: description: The actual data stored in the metafield. Type depends on value_type. anyOf: - type: - string - number - integer - 'null' - type: - integer - string - number - 'null' - type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' - type: - boolean - 'null' - type: - number - string - integer - 'null' value_type: description: >- The data type that defines how the value should be interpreted and validated. type: - string - number - integer - 'null' description: description: >- Optional human-readable description explaining the purpose of this metafield. type: - string - number - integer - 'null' created_at: description: Timestamp when the metafield was created. type: - string - number - integer - 'null' format: date-time updated_at: description: Timestamp when the metafield was last updated. type: - string - number - integer - 'null' format: date-time locked: description: >- Whether this metafield is locked and cannot be updated or deleted directly. type: - boolean - 'null' metafield_definition: description: >- The definition that defines validation rules and structure for this metafield type: - object - 'null' 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 description: Bearer token authentication ````