> ## 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 Order > Create an order from cart ## OpenAPI ````yaml /api-reference/company-v0.yaml post /api/orders 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/orders: post: tags: - orders summary: Create Order description: Create an order from cart operationId: commerce_v0_create_order_from_cart parameters: - name: cart_token in: query required: true description: Token of the cart to create order from schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateOrderFromCartRequestBodyApplicationJsonSchema responses: '200': description: Order created content: application/json: schema: $ref: >- #/components/schemas/CreateOrderFromCartResponse200ApplicationJsonSchema '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '422': description: Order could not be created from the cart content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: CreateOrderFromCartRequestBodyApplicationJsonSchema: type: - object - 'null' properties: order: type: - object - 'null' properties: email: type: - string - number - integer - 'null' status: type: - string - number - integer - 'null' payment_status: type: - string - number - integer - 'null' order_type: type: - string - number - integer - 'null' financial_status: type: - string - number - integer - 'null' order_status: type: - string - number - integer - 'null' fulfillment_status: type: - string - number - integer - 'null' note: type: - string - number - integer - 'null' metafields: type: - array - 'null' description: Metafields for custom data storage items: type: - object - 'null' properties: namespace: type: - string - number - integer - 'null' description: Namespace for the metafield key: type: - string - number - integer - 'null' description: Key for the metafield value: description: Value for the metafield (type depends on value_type) value_type: type: - string - number - integer - 'null' description: Type of the metafield value CreateOrderFromCartResponse200ApplicationJsonSchema: type: - object - 'null' properties: order: type: - object - 'null' properties: id: type: - integer - string - number - 'null' amount_in_base: type: - string - number - integer - 'null' base_to_currency_rate: type: - string - number - integer - 'null' currency_symbol: type: - string - number - integer - 'null' currency_code: type: - string - number - integer - 'null' external_id: type: - string - number - integer - 'null' order_number: type: - string - number - integer - 'null' token: type: - string - number - integer - 'null' note: type: - string - number - integer - 'null' company_logo_url: type: - string - number - integer - 'null' created_at: type: - string - number - integer - 'null' customer: type: - string - number - integer - 'null' email: type: - string - number - integer - 'null' total: type: - string - number - integer - 'null' total_in_currency: type: - string - number - integer - 'null' subtotal: type: - string - number - integer - 'null' subtotal_after_discounts: type: - string - number - integer - 'null' sub_total: type: - string - number - integer - 'null' sub_total_in_currency: type: - string - number - integer - 'null' tax: type: - string - number - integer - 'null' tax_in_currency: type: - string - number - integer - 'null' transaction_fee: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' transaction_fee_in_currency: type: - string - number - integer - 'null' discount: type: - string - number - integer - 'null' discount_in_currency: type: - string - number - integer - 'null' warehouse_id: type: - integer - string - number - 'null' warehouse: anyOf: - title: Warehouse type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' active: type: - boolean - 'null' external_id: type: - string - number - integer - 'null' metadata: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' shipping: type: - string - number - integer - 'null' shipping_in_currency: type: - object - 'null' properties: amount_in_currency: type: - string - number - integer - 'null' surcharge_in_currency: type: - string - number - integer - 'null' refundable_amount: format: float anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' payment_status: type: - string - number - integer - 'null' enrollment_token: type: - string - number - integer - 'null' enrollment_pack: type: - object - 'null' properties: enrollment_pack_id: type: - integer - string - number - 'null' additional_volume: type: - integer - string - number - 'null' slug: type: - string - number - integer - 'null' description: properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' body: type: - string - number - integer - 'null' record_type: type: - string - number - integer - 'null' record_id: type: - integer - string - number - 'null' created_at: type: - string - number - integer - 'null' format: date-time updated_at: type: - string - number - integer - 'null' format: date-time locale: type: - string - number - integer - 'null' anyOf: - type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' - type: - string - number - integer - 'null' enrollment_fee: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' enrollment_fee_in_currency: type: - string - number - integer - 'null' images: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' relateable_type: type: - string - number - integer - 'null' relateable_id: type: - integer - string - number - 'null' image_url: type: - string - number - integer - 'null' image_path: type: - string - number - integer - 'null' position: type: - integer - string - number - 'null' shopify_id: type: - integer - string - number - 'null' created_at: type: - string - number - integer - 'null' format: date-time updated_at: type: - string - number - integer - 'null' format: date-time external_id: type: - integer - string - number - 'null' items: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' allow_subscription: type: - boolean - 'null' creditable_points: type: - integer - string - number - 'null' description: >- Total creditable points for this cart item (points per unit × quantity) cv: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' cv_in_currency: type: - string - number - integer - 'null' cv_total: type: - string - 'null' format: decimal enrollment: type: - boolean - 'null' enrollment_pack_id: type: - integer - string - number - 'null' price: type: - string - number - integer - 'null' description: Unit price for a single item (price per 1 quantity) price_in_currency: type: - string - number - integer - 'null' description: >- Unit price for a single item with currency symbol (price per 1 quantity) total: type: - string - number - integer - 'null' description: Total price for this line item (price × quantity) total_in_currency: type: - string - number - integer - 'null' description: >- Total price for this line item with currency symbol (price × quantity) product_title: type: - string - number - integer - 'null' quantity: type: - integer - string - number - 'null' qv: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' qv_in_currency: type: - string - number - integer - 'null' qv_total: type: - string - 'null' format: decimal subscribe_and_save: type: - string - number - integer - 'null' subscribe_and_save_for_display: type: - string - number - integer - 'null' subscribe_and_save_in_currency: type: - string - number - integer - 'null' subscription: type: - boolean - 'null' subscription_interval: type: - integer - string - number - 'null' subscription_interval_unit: type: - string - number - integer - 'null' subscription_only: type: - boolean - 'null' subscription_plan_id: type: - integer - string - number - 'null' subscription_plans: anyOf: - type: - array - 'null' items: title: Commerce::SubscriptionPlan type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' billing_interval: type: - integer - string - number - 'null' default: 1 minimum: 1 maximum: 29 billing_interval_unit: description: >- Possible values: `day`, `week`, `month`, `year` type: - string - number - integer - 'null' default: month billing_frequency_in_words: type: - string - number - integer - 'null' shipping_interval: type: - integer - string - number - 'null' default: 1 minimum: 1 maximum: 29 shipping_interval_unit: description: >- Possible values: `day`, `week`, `month`, `year` type: - string - number - integer - 'null' default: month volume_interval: type: - integer - string - number - 'null' default: 1 minimum: 1 maximum: 29 volume_interval_unit: description: >- Possible values: `day`, `week`, `month`, `year` type: - string - number - integer - 'null' default: month trial_period: type: - integer - string - number - 'null' minimum: 1 trial_period_unit: description: >- Possible values: `day`, `week`, `month`, `year` type: - string - number - integer - 'null' split_volume: type: - boolean - 'null' default: false allow_max_billing_cycles: type: - boolean - 'null' default: false max_billing_cycles: type: - integer - string - number - 'null' company_default: type: - boolean - 'null' default: false products_count: type: - integer - string - number - 'null' subscribers_count: type: - integer - string - number - 'null' price: type: - string - number - integer - 'null' price_in_currency: type: - string - number - integer - 'null' subscription_start: type: - string - number - integer - 'null' subscribe_and_save: type: - string - number - integer - 'null' subscribe_and_save_in_currency: type: - string - number - integer - 'null' subscribe_and_save_for_display: type: - string - number - integer - 'null' savings_label: type: - string - 'null' description: > Pre-formatted savings string per the plan's `savings_display_mode` (e.g. "Save 10%" or "Save $5.00"). Null when there is no positive savings to advertise. subscription_price: type: - string - number - integer - 'null' subscription_price_in_currency: type: - string - number - integer - 'null' subscription_start: type: - string - number - integer - 'null' format: date tax: type: - string - number - integer - 'null' tax_in_currency: type: - string - number - integer - 'null' total_after_discounts: type: - string - number - integer - 'null' description: >- Final line item total after promo codes are applied (total - discount_amount) total_after_discounts_in_currency: type: - string - number - integer - 'null' description: >- Final line item total after promo codes are applied with currency symbol title: type: - string - number - integer - 'null' display_to_customer: type: - boolean - 'null' metadata: type: - object - 'null' description: A JSON object that can store any custom data structure additionalProperties: $ref: '#/components/schemas/JsonValue' errors: anyOf: - type: - array - 'null' items: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' price: type: - string - number - integer - 'null' price_in_currency: type: - string - number - integer - 'null' subscription_price: anyOf: - type: - string - number - integer - 'null' - type: - integer - string - number - 'null' subscription_price_in_currency: type: - string - number - integer - 'null' title: type: - string - number - integer - 'null' token: type: - string - number - integer - 'null' canonical_url: type: - string - number - integer - 'null' fulfillment_status: type: - string - number - integer - 'null' order_status: type: - string - number - integer - 'null' financial_status: type: - string - number - integer - 'null' delivery_status: type: - string - number - integer - 'null' delivery_method: type: - string - number - integer - 'null' delivery_date: type: - string - number - integer - 'null' channel: type: - string - number - integer - 'null' tags: type: - string - number - integer - 'null' items_count: type: - integer - string - number - 'null' quantity_count: type: - integer - string - number - 'null' items: type: - array - 'null' items: $ref: '#/components/schemas/CompanyOrderLineItem' activities: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' user_id: type: - integer - string - number - 'null' relation_type: type: - string - number - integer - 'null' relation_id: type: - integer - string - number - 'null' contact_id: type: - integer - string - number - 'null' title: type: - string - number - integer - 'null' description: type: - string - number - integer - 'null' formatted_description: type: - string - number - integer - 'null' read_at: type: - string - number - integer - 'null' slug: type: - string - number - integer - 'null' company_id: type: - integer - string - number - 'null' created_at: type: - string - number - integer - 'null' shipping_method: anyOf: - type: - object - 'null' properties: id: type: - string - number - integer - 'null' title: type: - string - number - integer - 'null' delivery_time_estimate: type: - string - number - integer - 'null' - type: - object - 'null' properties: {} payment_details: type: - object - 'null' properties: payment_type: type: - string - number - integer - 'null' details: type: - object - 'null' properties: card_network: type: - string - 'null' card_brand: type: - string - number - integer - 'null' last_four: type: - string - number - integer - 'null' exp_month: type: - string - number - integer - 'null' exp_year: type: - string - number - integer - 'null' logo_url: type: - string - number - integer - 'null' primary_domain_hostname: type: - string - number - integer - 'null' company_subdomain: type: - string - number - integer - 'null' shipping_total: type: - string - number - integer - 'null' shipping_total_for_display: type: - string - number - integer - 'null' ship_to: $ref: '#/components/schemas/CompanyCustomerAddress' bill_to: $ref: '#/components/schemas/CompanyCustomerAddress' shipping_address: $ref: '#/components/schemas/CompanyCartAddress' billing_address: $ref: '#/components/schemas/CompanyCartAddress' company: type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' primary_domain_hostname: type: - string - number - integer - 'null' subdomain: type: - string - number - integer - 'null' logo_url: type: - string - number - integer - 'null' fluid_shop: type: - string - number - integer - 'null' collect_phone: type: - boolean - 'null' require_phone: type: - boolean - 'null' require_billing_zip: type: - boolean - 'null' checkout_primary_button_color: type: - string - number - integer - 'null' checkout_primary_text_color: type: - string - number - integer - 'null' checkout_secondary_button_color: type: - string - number - integer - 'null' checkout_secondary_text_color: type: - string - number - integer - 'null' favicon_url: type: - string - number - integer - 'null' order_on_behalf: type: - boolean - 'null' reward_points_enabled: type: - boolean - 'null' reward_points_label_singular: type: string reward_points_label_plural: type: string collect_sms_marketing: type: - boolean - 'null' collect_email_marketing: type: - boolean - 'null' order_on_behalf_of: type: - boolean - 'null' volume_rep: type: - object - 'null' properties: id: type: - integer - string - number - 'null' email: type: - string - number - integer - 'null' full_name: type: - string - number - integer - 'null' image_url: type: - string - number - integer - 'null' metadata: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' metafields: type: - array - 'null' items: $ref: '#/components/schemas/CompanyMetafield' free_shipping: type: - boolean - 'null' description: Whether the order has free shipping discount_codes: type: - array - 'null' items: type: - string - number - integer - 'null' description: Discount codes applied to the order created_subscriptions: type: - array - 'null' items: type: - string - number - integer - 'null' description: Subscription tokens created from this order digital_only: type: - boolean - 'null' description: Whether the order contains only digital (non-physical) products points_applied: type: - integer - string - number - 'null' description: Total points used for this order points_applied_amount: type: - number - string - integer - 'null' description: Raw numeric points amount value points_applied_amount_in_currency: type: - string - number - integer - 'null' description: Total points in currency amount used for this order order_total_after_points_redemption: type: - number - string - integer - 'null' description: The order total (actual card payment) after points redemption total_points_credited: type: - integer - string - number - 'null' description: Points earned from this order customer_points_balance: type: - integer - string - number - 'null' description: Customer's current points balance source: type: - string - number - integer - 'null' price_inclusive_of_tax: type: - boolean - 'null' price_inclusive_tax_name: type: - string - number - integer - 'null' meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' shop_url: type: - string - number - integer - 'null' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' 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' 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' CompanyCustomerAddress: type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' address3: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' state: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_code: type: - string - number - integer - 'null' description: >- country_id takes precedence if both country_id and country_code provided. subdivision_code: type: - string - number - integer - 'null' default: type: - boolean - 'null' CompanyCartAddress: type: - object - 'null' properties: name: type: - string - number - integer - 'null' address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' address3: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' state: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_code: type: - string - number - integer - 'null' subdivision_code: type: - string - number - integer - 'null' CompanyMetafield: title: LegacyMetafield type: - object - 'null' properties: id: type: - integer - string - number - 'null' 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: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' 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' owner_type: description: >- The type of resource that this metafield belongs to (polymorphic association). type: - string - number - integer - 'null' owner_id: description: The ID of the specific resource that this metafield belongs to. type: - integer - string - number - '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 metafield_definition: $ref: '#/components/schemas/CompanyMetafieldDefinition' 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 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' CompanyMetafieldDefinition: title: MetafieldDefinition type: - object - 'null' properties: id: type: - integer - string - number - 'null' company_id: description: The ID of the company that owns this metafield definition. type: - integer - string - number - 'null' namespace: description: >- A container for related metafield definitions. Used to group definitions by app or functionality. Must be unique within company and owner_resource. type: - string - number - integer - 'null' maxLength: 20 pattern: ^[a-zA-Z0-9_]+$ key: description: >- The unique identifier for the metafield definition within its namespace and owner_resource. Combined with namespace and owner_resource, this must be unique per company. type: - string - number - integer - 'null' maxLength: 30 pattern: ^[a-zA-Z0-9_]+$ name: description: >- Human-readable display name for the metafield definition, shown in admin interfaces and forms. type: - string - number - integer - 'null' maxLength: 100 description: description: >- Detailed explanation of what this metafield definition represents, how it should be used, and any special instructions for content creators. type: - string - number - integer - 'null' value_type: description: >- The data type that defines how metafield values should be validated, stored, and displayed. Determines which validation rules are available. type: - string - number - integer - 'null' validation_rules: description: >- JSON object containing validation constraints that will be applied to metafield values. Available rules depend on the value_type. type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' owner_resource: description: >- The type of resource (model class name) that metafields using this definition can be attached to. Must match the polymorphic owner_type. type: - string - number - integer - 'null' pinned: description: >- Whether this definition should be prominently displayed or prioritized in admin interfaces and forms. type: - boolean - 'null' default: false position: default: 0 description: >- Sort order for displaying this definition relative to others in the same category and owner_resource. Lower numbers appear first. type: - integer - string - number - 'null' locked: description: >- Whether this metafield definition is locked, preventing direct updates or deletions of metafields using this definition. type: - boolean - 'null' default: false created_at: description: Timestamp when the metafield definition was created. type: - string - number - integer - 'null' format: date-time updated_at: description: Timestamp when the metafield definition was last updated. type: - string - number - integer - 'null' format: date-time list_type: description: >- Whether this definition is for list-type metafields that store arrays of values. type: - boolean - 'null' reference_type: description: >- Whether this definition is for reference-type metafields that store references to other resources. type: - boolean - 'null' supported_validations: description: >- Array of validation rule names that are supported for this value_type. type: - array - 'null' items: $ref: '#/components/schemas/JsonValue' validation_description: description: >- Human-readable description of what the value_type represents and its constraints. type: - string - number - integer - 'null' category_ids: description: >- Array of category IDs that this metafield definition is associated with for organizational purposes. items: type: - integer - string - number - 'null' type: - array - 'null' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' 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' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````