> ## 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. > Never use /api/company/v1 or /api/v1 paths, page/per_page params, or offset pagination — they are legacy. > 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). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. # Complete checkout > Converts the cart into an order and returns it. Pass the payment reference as the `payment_uuid` query parameter and send an `Idempotency-Key` header so a retried request never places a second order. Access is scoped by the `cart_token` in the path — the endpoint itself does not require authentication. In Fluid's recommended server-side integration you send a company bearer token (`Authorization: Bearer `) on every cart request; it is optional at the endpoint but drives cart attribution and wallet resolution for companies using isolated payment tokens (see the Headless Commerce guide). `payment_uuid` is produced upstream by the Cart payment surface (`payments-v2026-04` tokenize/authorize, including the `requires_3ds` branch) — it does not originate on this surface; see the Cart payment reference for how to obtain it. Completion is final: once the cart converts to an order it is locked and any further mutation returns `410`. Returns `404` when the cart is not found and `422` when the cart cannot be completed. ## OpenAPI ````yaml /api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/carts/{cart_token}/complete openapi: 3.1.0 info: title: Fluid Checkout API description: >- **Fluid Checkout API — for building a checkout directly against REST.** Use this surface if you are integrating server-to-server or building your own checkout UI. It covers the full order lifecycle (cart → address → shipping → discount → complete → order) plus the logged-in customer's account: saved addresses, saved payment methods, order history, loyalty points, and subscription management (pause, resume, skip, cancel, retry). **The cart token in the URL scopes cart access** — creating a cart, adding items, applying a discount, and completing a cart need no bearer token. Among the cart operations, a Bearer token is required only for `carts/{cart_token}/sync`, `carts/{cart_token}/volume_rep`, and `carts/{cart_token}/discount/manual`. Off the cart, a token is required for everything under `customers/me` and `subscriptions`, and for the store and directory lookups (`store/config`, `store/languages`, `reps`, `users`) and `subscription_bundles`. `store/countries` accepts a token but does not require one — it returns the same list either way. **If you are using the `@fluid-app` FairShare SDK in a theme or storefront, you are not calling this surface** — the SDK calls the Fluid Public SDK API (`public-v2025-06`). Do not mix the two against one cart: they share the same cart records and services, but their request shapes differ. See [Choosing a cart surface](https://docs.fluid.app/api/choosing-a-cart-surface) for the operation map and boundary. version: v2026-04 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: carts description: >- Create, read, and mutate checkout carts (email, address, country, language, shipping, recalculation, completion). - name: cart-auth description: >- Cart-scoped customer authentication — magic-link challenge, verification, identity, and logout. - name: cart-discount description: >- Apply, list, and remove cart discount codes, including admin manual discounts. - name: cart-items description: Add, update, and remove line items on a cart. - name: cart-points description: Apply and remove loyalty points on a cart. - name: customers description: The authenticated customer's profile and company memberships. - name: customer-addresses description: The authenticated customer's saved shipping/billing addresses. - name: customer-orders description: The authenticated customer's order history. - name: customer-payment-methods description: The authenticated customer's saved payment methods and tokenization. - name: customer-points description: The authenticated customer's loyalty point balances. - name: directory description: Company rep and user directory lookups. - name: enrollments description: >- Public enrollment forms — retrieve a form and submit, update, or upload field answers. - name: orders description: Public order lookup by token. - name: products description: Public product queries for the storefront checkout. - name: store description: >- Store-level checkout configuration — countries, languages, address fields, agreements, drop zones, and Apple Pay domain verification. - name: subscriptions description: >- Manage subscriptions — pause, resume, skip, cancel, reactivate, retry, and failed-cycle waivers. - name: subscription-bundles description: List and create subscription bundles. paths: /api/checkout/v2026-04/carts/{cart_token}/complete: post: tags: - carts summary: Complete checkout description: > Converts the cart into an order and returns it. Pass the payment reference as the `payment_uuid` query parameter and send an `Idempotency-Key` header so a retried request never places a second order. Access is scoped by the `cart_token` in the path — the endpoint itself does not require authentication. In Fluid's recommended server-side integration you send a company bearer token (`Authorization: Bearer `) on every cart request; it is optional at the endpoint but drives cart attribution and wallet resolution for companies using isolated payment tokens (see the Headless Commerce guide). `payment_uuid` is produced upstream by the Cart payment surface (`payments-v2026-04` tokenize/authorize, including the `requires_3ds` branch) — it does not originate on this surface; see the Cart payment reference for how to obtain it. Completion is final: once the cart converts to an order it is locked and any further mutation returns `410`. Returns `404` when the cart is not found and `422` when the cart cannot be completed. operationId: checkout_v2026_04_complete_cart parameters: - name: cart_token in: path required: true description: Cart token schema: type: string - name: payment_uuid in: query required: false description: Payment UUID from a prior tokenize/authorize step schema: type: string - name: Idempotency-Key in: header required: false description: Idempotency key for safe retries schema: type: string responses: '200': description: Returns the completed order content: application/json: schema: $ref: '#/components/schemas/OrderResponse' '404': description: Cart not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: [] components: schemas: OrderResponse: description: Single order type: object additionalProperties: false required: - order - meta properties: order: type: object additionalProperties: false properties: id: type: integer description: Numeric primary key of the order. email: type: - string - 'null' description: Buyer email on the order; `null` when none was captured. order_number: type: string description: Human-facing order number shown to the buyer. source: type: - string - 'null' description: Channel/source the order originated from; `null` when unset. amount_in_base: type: string description: Order total expressed in the company's base currency. base_to_currency_rate: type: - string - 'null' description: >- Exchange rate applied from base currency to `currency_code`; `null` when 1:1. note: type: - string - 'null' description: Free-form order note; `null` when none. currency_code: type: string description: ISO 4217 currency the order is priced in. created_at: type: string format: date-time description: ISO 8601 time the order was created. token: type: string description: > Opaque order token. This is the value passed to `GET /api/checkout/v2026-04/orders/{token}` to retrieve the order (e.g. on an order-confirmation page); it is returned by `complete_cart`. refundable_amount: type: - string - number order_status: type: - string - 'null' description: Overall order status; `null` when not yet set. fulfillment_status: type: - string - 'null' description: >- Fulfillment/shipment status of the order; `null` when not yet set. financial_status: type: - string - 'null' description: >- Payment/financial status of the order (e.g. paid, refunded); `null` when not yet set. warehouse_id: type: - integer - 'null' points_applied: type: integer points_applied_amount: type: number points_applied_amount_in_currency: type: string order_total_after_points_redemption: type: number total_points_credited: type: integer free_shipping: type: boolean description: '`true` when the order shipped free.' discount_codes: type: array description: Discount codes applied to the order. items: type: string created_subscriptions: type: array description: Tokens of subscriptions created by this order. items: type: string product_discount_codes: type: array items: type: string shipping_discount_codes: type: array items: type: string currency_symbol: type: - string - 'null' items_count: type: integer description: Number of distinct line items on the order. quantity_count: type: integer description: Total quantity across all line items. external_id: type: - string - 'null' customer_points_balance: type: integer order_on_behalf_of: type: - boolean - 'null' digital_only: type: boolean enrollment_token: type: - string - 'null' shipping_total: type: string description: Total shipping charge on the order. shipping_total_for_display: type: string description: Currency-formatted shipping total for display. company_logo_url: type: - string - 'null' primary_domain_hostname: type: - string - 'null' company_subdomain: type: - string - 'null' shipping: type: string transaction_fee: type: string transaction_fee_in_currency: type: string subtotal: type: string description: Item subtotal before tax, shipping, and discounts. sub_total: type: string description: >- Alias of `subtotal` (item subtotal before tax/shipping/discounts). tax: type: string description: Total tax on the order. discount: type: string description: Total discount applied to the order. customer: type: - string - 'null' description: Customer display string on the order; `null` when anonymous. total: type: string description: Grand total the buyer paid. subtotal_after_discounts: type: - string - number description: Item subtotal after discounts, before tax and shipping. total_in_currency: type: string tax_in_currency: type: string discount_in_currency: type: string sub_total_in_currency: type: string totals: type: object additionalProperties: false required: - gross_subtotal - gross_subtotal_in_currency - net_subtotal - net_subtotal_in_currency - item_tax - item_tax_in_currency - shipping_net - shipping_net_in_currency - shipping_tax - shipping_tax_in_currency - total_tax - total_tax_in_currency - price_inclusive_of_tax - tax_label description: >- Display-ready totals breakdown sourced from Commerce::Totals (STU2-2580). Decomposes the inclusive-tax figures so clients render the net subtotal, item tax, shipping net and shipping VAT without re-deriving them. Each money component carries a raw boundary-rounded decimal string plus its currency-formatted `_in_currency` sibling. properties: gross_subtotal: type: string description: Catalog sum of line-item prices (customer display). gross_subtotal_in_currency: type: string net_subtotal: type: string description: Items subtotal excluding embedded item tax. net_subtotal_in_currency: type: string item_tax: type: string description: Embedded tax attributable to the items. item_tax_in_currency: type: string shipping_net: type: string description: Shipping charge excluding embedded shipping tax. shipping_net_in_currency: type: string shipping_tax: type: string description: Embedded tax attributable to shipping. shipping_tax_in_currency: type: string total_tax: type: string description: Combined item and shipping tax. total_tax_in_currency: type: string price_inclusive_of_tax: type: boolean description: Whether catalog prices include tax. tax_label: type: - string - 'null' description: The resolved tax-line label (e.g. "VAT"), or null. payment_status: type: - string - 'null' delivery_status: type: - string - 'null' delivery_method: type: - string - 'null' channel: type: - string - 'null' tags: type: - string - 'null' delivery_date: type: - string - 'null' current_adjustment_total: type: string current_subtotal: type: string current_discount: type: string current_tax: type: string current_shipping: type: string current_amount: type: string current_cv: type: - string - 'null' format: decimal current_qv: type: - string - 'null' format: decimal price_inclusive_of_tax: type: - boolean - 'null' price_inclusive_tax_name: type: - string - 'null' amount: type: string first_name: type: - string - 'null' last_name: type: - string - 'null' order_confirmation_url: type: - string - 'null' order_type: type: - string - 'null' phone: type: - string - 'null' status: type: - string - 'null' updated_at: type: string format: date-time recurring: type: array items: $ref: '#/components/schemas/CheckoutOrderRecurringItem' metadata: type: - object - 'null' additionalProperties: true volume_rep: oneOf: - $ref: '#/components/schemas/CheckoutOrderVolumeRep' - type: 'null' payment_details: oneOf: - $ref: '#/components/schemas/CheckoutOrderPaymentDetails' - type: 'null' shipping_in_currency: type: object additionalProperties: false properties: amount_in_currency: type: string surcharge_in_currency: type: string enrollment_pack: oneOf: - $ref: '#/components/schemas/CheckoutOrderEnrollmentPack' - type: 'null' shipping_method: type: object additionalProperties: false properties: id: type: - integer - string - 'null' title: type: - string - 'null' delivery_time_estimate: type: - string - 'null' shipping_address: oneOf: - $ref: '#/components/schemas/CheckoutOrderAddressSnapshot' - type: 'null' billing_address: oneOf: - $ref: '#/components/schemas/CheckoutOrderAddressSnapshot' - type: 'null' ship_to: oneOf: - $ref: '#/components/schemas/CheckoutOrderAddress' - type: 'null' bill_to: oneOf: - $ref: '#/components/schemas/CheckoutOrderAddress' - type: 'null' company: oneOf: - $ref: '#/components/schemas/CheckoutOrderCompany' - type: 'null' country: oneOf: - $ref: '#/components/schemas/CheckoutOrderCountry' - type: 'null' warehouse: oneOf: - $ref: '#/components/schemas/CheckoutOrderWarehouse' - type: 'null' items: type: array items: $ref: '#/components/schemas/CheckoutOrderItem' activities: type: array items: $ref: '#/components/schemas/CheckoutOrderActivity' adjustments: type: array items: $ref: '#/components/schemas/CheckoutOrderAdjustment' metafields: type: array items: $ref: '#/components/schemas/CheckoutOrderMetafield' tracking_informations: type: array items: $ref: '#/components/schemas/CheckoutOrderTrackingInformation' meta: type: object additionalProperties: false required: - request_id - timestamp - shop_url properties: request_id: type: - string - 'null' timestamp: type: string format: date-time shop_url: type: string ErrorResponse: type: object additionalProperties: false required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/CheckoutMeta' CheckoutOrderRecurringItem: description: >- One recurring-subtotal entry per subscription plan on the completed cart (OrderBlueprinter with_recurring). type: object additionalProperties: false properties: subtotal: description: BigDecimal sum of the plan's line totals; serializes as a string. type: string subtotal_in_currency: type: string interval: type: integer interval_unit: description: Translated billing interval unit label. type: string subtotal_for_display: type: string start_date: description: yyyy-mm-dd next bill date. type: string CheckoutOrderVolumeRep: description: Volume rep summary (OrderBlueprinter with_associations). type: object additionalProperties: false properties: id: type: - integer - 'null' email: type: - string - 'null' full_name: type: - string - 'null' image_url: type: - string - 'null' CheckoutOrderPaymentDetails: description: >- Order payment summary (OrderBlueprinter.payment_method_blueprint). payment_type/payment_title are always present; source only appears for credit-card style payments. details carries the processor-specific keys - the full closed union across all processors is enumerated below. type: object additionalProperties: false properties: source: type: - string - 'null' payment_type: type: string payment_title: type: - string - 'null' details: type: object additionalProperties: false properties: card_network: type: - string - 'null' card_brand: type: - string - 'null' last_four: type: - string - 'null' exp_month: type: - string - integer - 'null' exp_year: type: - string - integer - 'null' paypal_id: type: - string - 'null' status: type: - string - 'null' currency: type: - string - 'null' amount: type: - string - number - 'null' affirm_id: type: - string - 'null' checkout_id: type: - string - 'null' created: type: - string - number - 'null' auth_expiration: type: - string - number - 'null' transaction_id: type: - string - 'null' authorization_token: type: - string - 'null' session_id: type: - string - 'null' intent: type: - string - 'null' payment_method_id: type: - integer - 'null' logo_url: type: - string - 'null' CheckoutOrderEnrollmentPack: description: >- Enrollment pack on the order's cart (EnrollmentPackBlueprinter cart view). type: object additionalProperties: false properties: enrollment_pack_id: type: integer slug: type: - string - 'null' token: type: - string - 'null' title: type: - string - 'null' description: type: - string - 'null' enrollment_fee: description: Decimal column; serializes as a string. type: - string - 'null' additional_volume: type: - integer - 'null' canonical_url: type: - string - 'null' enrollment_fee_in_currency: type: - string - 'null' price: type: string price_in_currency: type: - string - 'null' subscription_price: type: string subscription_price_in_currency: type: - string - 'null' images: type: array items: $ref: '#/components/schemas/CheckoutOrderImage' items: type: array items: $ref: '#/components/schemas/CheckoutOrderEnrollmentCartItem' CheckoutOrderAddressSnapshot: description: >- AddressModel#to_h snapshot stored on the order's JSONB shipping_address / billing_address columns. type: object additionalProperties: false 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' subdivision_code: type: - string - 'null' phone: type: - string - 'null' CheckoutOrderAddress: description: >- Ship-to / bill-to address (AddressBlueprinter). id is null when the source is a frozen AddressModel snapshot. type: object additionalProperties: false properties: id: type: - integer - 'null' name: type: - string - 'null' address1: type: - string - 'null' address2: type: - string - 'null' address3: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' subdivision_code: type: - string - 'null' postal_code: type: - string - 'null' country_code: type: - string - 'null' country_num_code: type: - integer - 'null' phone: type: - string - 'null' default: type: - boolean - 'null' CheckoutOrderCompany: description: Company summary (CompanyBlueprint cart_checkout view). type: object additionalProperties: false properties: id: type: integer name: type: - string - 'null' favicon_url: type: - string - 'null' primary_domain_hostname: type: - string - 'null' subdomain: type: - string - 'null' logo_url: type: - string - 'null' fluid_shop: type: - string - 'null' collect_phone: type: boolean require_phone: type: boolean require_billing_zip: type: boolean checkout_primary_button_color: type: - string - 'null' checkout_primary_text_color: type: - string - 'null' checkout_secondary_button_color: type: - string - 'null' checkout_secondary_text_color: type: - string - 'null' order_on_behalf: type: boolean reward_points_enabled: type: boolean reward_points_apply_to_subtotal: type: boolean reward_points_label_singular: type: string reward_points_label_plural: type: string collect_sms_marketing: type: boolean collect_email_marketing: type: boolean bundle_subscriptions: type: boolean isolated_payment_tokens: type: boolean kount_environment: type: string kount_client_id: type: - string - 'null' CheckoutOrderCountry: description: Country details (CountryBlueprinter with_additional_info view). type: object additionalProperties: false properties: id: type: integer name: type: - string - 'null' iso: type: - string - 'null' iso_name: type: - string - 'null' iso3: type: - string - 'null' currency_code: type: - string - 'null' currency_symbol: type: - string - 'null' province_required: type: boolean tax_enabled: type: - boolean - 'null' price_inclusive_of_tax: type: boolean price_inclusive_tax_name: type: string tax_standard_rate: type: - number - 'null' CheckoutOrderWarehouse: description: Warehouse summary (WarehouseBlueprinter order_update view). type: object additionalProperties: false properties: id: type: integer name: type: - string - 'null' active: type: - boolean - 'null' external_id: type: - string - 'null' metadata: type: - object - 'null' additionalProperties: true CheckoutOrderItem: description: >- Order line item (Commerce::ItemBlueprinter public_order_confirmation view). type: object additionalProperties: false properties: id: type: integer title: type: - string - 'null' quantity: type: integer price: description: Decimal column; serializes as a string. type: - string - 'null' total: description: price * quantity as BigDecimal; serializes as a string. type: string image_url: type: - string - 'null' variant_id: type: - integer - 'null' tax: type: - string - 'null' cv: type: - string - 'null' format: decimal qv: type: - string - 'null' format: decimal enrollment_pack_id: type: - integer - 'null' display_to_customer: type: - boolean - 'null' discount_amount: type: - string - 'null' free_item: type: - boolean - 'null' price_in_currency: type: string tax_in_currency: type: string cv_in_currency: type: string qv_in_currency: type: string discount_amount_in_currency: type: string sku: type: - string - 'null' display_price: type: string display_total: type: string ordered_variant: type: array items: type: object additionalProperties: false properties: option_type: type: string value: type: string total_after_discounts: type: string refundable_amount: description: >- BigDecimal (string) normally; the [x, 0].max guard can yield an Integer 0 (number) when fully refunded. type: - string - number bundled_items: type: array items: type: object additionalProperties: true product: oneOf: - $ref: '#/components/schemas/CheckoutOrderProduct' - type: 'null' variant: oneOf: - $ref: '#/components/schemas/CheckoutOrderVariant' - type: 'null' product_title: type: - string - 'null' variant_title: type: - string - 'null' variant_image: oneOf: - $ref: '#/components/schemas/CheckoutOrderImage' - type: 'null' subscription: type: - boolean - 'null' subscription_interval: type: - integer - 'null' subscription_interval_unit: type: - string - 'null' subscribe_and_save: type: - string - number - 'null' subscribe_and_save_in_currency: type: - string - 'null' subscribe_and_save_for_display: type: - string - 'null' subscription_price_in_currency: type: - string - 'null' subscription_plan_id: type: - integer - 'null' CheckoutOrderActivity: description: Order activity entry (ActivityBlueprinter default view). type: object additionalProperties: false properties: id: type: integer user_id: type: integer relation_type: type: - string - 'null' relation_id: type: - integer - 'null' contact_id: type: - integer - 'null' title: type: - string - 'null' description: type: - string - 'null' read_at: type: - string - 'null' format: date-time slug: type: - string - 'null' company_id: type: - integer - 'null' created_at: type: string format: date-time formatted_description: type: - string - 'null' CheckoutOrderAdjustment: description: Post-checkout order adjustment (Commerce::OrderAdjustmentBlueprinter). type: object additionalProperties: false properties: id: type: integer amount: description: Decimal column; serializes as a string. type: string label: type: string adjustment_type: type: string description: type: - string - 'null' source_type: type: - string - 'null' source_id: type: - string - 'null' created_at: type: string format: date-time CheckoutOrderMetafield: description: >- Legacy metafield with its definition (LegacyMetafieldBlueprint with_definition view). type: object additionalProperties: false properties: id: type: integer namespace: type: string key: type: string value: $ref: '#/components/schemas/JsonValue' value_type: type: string description: type: - string - 'null' owner_type: type: string owner_id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time metafield_definition: oneOf: - $ref: '#/components/schemas/CheckoutOrderMetafieldDefinition' - type: 'null' CheckoutOrderTrackingInformation: description: Per-shipment tracking record (TrackingInformationBlueprinter). type: object additionalProperties: false properties: id: type: integer tracking_number: type: string shipping_carrier: type: - string - 'null' tracking_url: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time 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' CheckoutMeta: type: object additionalProperties: false required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time CheckoutOrderImage: description: >- Raw Image row rendered via as_json (variant_image on order items and enrollment pack images) - includes every column. type: object additionalProperties: false properties: id: type: integer external_id: type: - string - 'null' image_path: type: - string - 'null' image_url: type: - string - 'null' image_url_i18n: description: Locale-keyed image URL overrides. type: object additionalProperties: type: string position: type: - integer - 'null' relateable_id: type: integer relateable_type: type: string created_at: type: string format: date-time updated_at: type: string format: date-time uuid_v7: type: string CheckoutOrderEnrollmentCartItem: description: >- Cart line belonging to the enrollment pack (Commerce::CartItemBlueprinter enroll_items view). type: object additionalProperties: false properties: id: type: integer title: type: - string - 'null' quantity: type: integer price: type: - string - 'null' tax: type: - string - 'null' cv: type: - string - 'null' format: decimal qv: type: - string - 'null' format: decimal enrollment_pack_id: type: - integer - 'null' subscription: type: - boolean - 'null' display_to_customer: type: - boolean - 'null' cv_total: type: string format: decimal qv_total: type: string format: decimal total: type: string metadata: type: - object - 'null' additionalProperties: true price_in_currency: type: string tax_in_currency: type: string cv_in_currency: type: string qv_in_currency: type: string total_in_currency: type: string total_after_discounts_in_currency: type: string line_total_in_currency: type: string line_total_after_discounts_in_currency: type: string unit_price_display_authoritative: type: boolean allow_subscription: type: boolean total_after_discounts: type: - string - number enrollment: type: boolean subscription_plan_id: type: - integer - 'null' subscription_plans: type: array items: $ref: '#/components/schemas/CheckoutOrderCartItemSubscriptionPlan' subscription_only: type: - boolean - 'null' subscription_interval: type: - integer - 'null' subscription_interval_unit: type: - string - 'null' subscription_interval_unit_identifier: type: - string - 'null' subscription_price: type: - string - number - 'null' subscription_price_in_currency: type: - string - 'null' subscription_start: type: - string - 'null' subscribe_and_save: type: - string - number - 'null' subscribe_and_save_in_currency: type: - string - 'null' subscribe_and_save_for_display: type: - string - 'null' errors: description: >- Checkout validation errors keyed by field, each value a list of messages. type: array items: type: object additionalProperties: type: array items: type: string creditable_points: type: - integer - number product_title: type: - string - 'null' CheckoutOrderProduct: description: Product summary on an order item (ProductBlueprinter item view). type: object additionalProperties: false properties: id: type: integer title: type: - string - 'null' image_url: type: - string - 'null' image_path: type: - string - 'null' cv: type: - string - 'null' format: decimal tax: type: - string - 'null' sku: type: - string - 'null' metadata: type: - object - 'null' additionalProperties: true external_id: type: - string - 'null' canonical_url: type: - string - 'null' price: description: >- VariantCountry price/wholesale decimal; serializes as a string, null when no variant country resolves. type: - string - number - 'null' introduction: type: - string - 'null' price_in_currency: type: string tax_in_currency: type: string cv_in_currency: type: string metafields: type: array items: $ref: '#/components/schemas/CheckoutOrderMetafield' product_bundle_groups: type: array items: $ref: '#/components/schemas/CheckoutOrderProductBundleGroup' CheckoutOrderVariant: description: Variant summary on an order item (VariantBlueprinter default view). type: object additionalProperties: false properties: id: type: integer title: type: - string - 'null' display_name: type: - string - 'null' image_url: type: - string - 'null' image_path: type: - string - 'null' sku: type: - string - 'null' primary_image: type: - string - 'null' price: type: - string - number - 'null' price_in_currency: type: string currency_code: type: - string - 'null' options: type: array items: type: object additionalProperties: false properties: title: type: string value: type: string 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' CheckoutOrderMetafieldDefinition: description: Metafield definition (MetafieldDefinitionBlueprint default view). type: object additionalProperties: false properties: id: type: integer company_id: type: integer namespace: type: string key: type: string name: type: string description: type: - string - 'null' value_type: type: string validation_rules: $ref: '#/components/schemas/JsonValue' owner_resource: type: string pinned: type: - boolean - 'null' position: type: - integer - 'null' locked: type: - boolean - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time list_type: type: boolean reference_type: type: boolean supported_validations: type: array items: type: string validation_description: type: - string - 'null' category_ids: type: array items: type: integer ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' CheckoutOrderCartItemSubscriptionPlan: description: >- Subscription plan rendered for a cart line (SubscriptionPlanBlueprinter cart_item view). type: object additionalProperties: false properties: id: type: integer name: type: string billing_interval: type: integer billing_interval_unit: description: Translated interval unit label. type: string billing_interval_unit_identifier: type: string billing_frequency_in_words: type: string shipping_interval: type: integer shipping_interval_unit: type: string volume_interval: type: integer volume_interval_unit: type: string trial_period: type: - integer - 'null' trial_period_unit: type: - string - 'null' split_volume: type: boolean allow_max_billing_cycles: type: boolean max_billing_cycles: type: - integer - 'null' savings_display_mode: type: string company_default: type: - boolean - 'null' products_count: type: - integer - 'null' subscribers_count: type: - integer - 'null' price: type: - string - 'null' price_in_currency: type: string subscription_start: type: string format: date-time subscribe_and_save: type: - string - number - 'null' subscribe_and_save_in_currency: type: - string - 'null' subscribe_and_save_for_display: type: - string - 'null' savings_label: type: - string - 'null' CheckoutOrderProductBundleGroup: description: >- Bundle group on a bundle product (ProductBundleGroupBlueprinter default view). type: object additionalProperties: false properties: id: type: integer title: type: string description: type: - string - 'null' group_type: type: string purpose: type: string min_selections: type: - integer - 'null' max_selections: type: - integer - 'null' selection_type: type: - string - 'null' pricing_config: type: - object - 'null' additionalProperties: false properties: pricing_type: type: string hidden: type: boolean fixed_price: type: - string - number - 'null' min_price: type: - string - number - 'null' country_pricing: type: array items: type: object additionalProperties: false properties: country_code: type: - string - 'null' enabled: type: - boolean - 'null' price: type: - string - number - 'null' wholesale: type: - string - number - 'null' subscription_price: type: - string - number - 'null' wholesale_subscription_price: type: - string - number - 'null' points: type: - string - number - 'null' cv: type: - number - string - 'null' qv: type: - number - string - 'null' wholesale_cv: type: - number - string - 'null' wholesale_qv: type: - number - string - 'null' allow_subscriptions: type: boolean force_subscriptions: type: boolean sort_order: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time images: type: array items: type: object additionalProperties: false properties: id: type: integer image_url: type: - string - 'null' image_path: type: - string - 'null' position: type: - integer - 'null' dam_asset_code: type: - string - 'null' bundle_group_items: type: array items: $ref: '#/components/schemas/CheckoutOrderBundleGroupItem' CheckoutOrderBundleGroupItem: description: One selectable item of a bundle group (BundleGroupItemBlueprinter). type: object additionalProperties: false properties: id: type: integer quantity: type: integer sort_order: type: integer config: type: object additionalProperties: false properties: price: type: - string - number - 'null' pc_price: type: - string - number - 'null' resolved_price: type: string resolved_wholesale_price: type: string resolved_cv: type: string format: decimal resolved_qv: type: string format: decimal resolved_wholesale_cv: type: string format: decimal resolved_wholesale_qv: type: string format: decimal cv: type: string format: decimal qv: type: string format: decimal pc_cv: type: string format: decimal pc_qv: type: string format: decimal is_default: type: boolean quantity: type: integer max_quantity: type: - integer - 'null' allow_subscription: type: boolean force_subscription: type: boolean has_subscription_plans: type: boolean subscription_plans: type: array items: type: object additionalProperties: false properties: id: type: integer subscription_price_in_currency: type: - string - 'null' subscribe_and_save_in_currency: type: - string - 'null' subscribe_and_save_for_display: type: - string - 'null' wholesale_subscription_price_in_currency: type: - string - 'null' wholesale_subscribe_and_save_in_currency: type: - string - 'null' wholesale_subscribe_and_save_for_display: type: - string - 'null' image_url: type: - string - 'null' available_country_codes: type: array items: type: string country_prices: type: object additionalProperties: type: - string - number - 'null' variant: oneOf: - $ref: '#/components/schemas/CheckoutOrderBundleGroupVariant' - type: 'null' CheckoutOrderBundleGroupVariant: description: >- Variant with shallow product (VariantBlueprinter with_product_shallow view) inside bundle group items. type: object additionalProperties: false properties: id: type: integer title: type: - string - 'null' display_name: type: - string - 'null' image_url: type: - string - 'null' image_path: type: - string - 'null' sku: type: - string - 'null' primary_image: type: - string - 'null' price: type: - string - number - 'null' price_in_currency: type: string currency_code: type: - string - 'null' options: type: array items: type: object additionalProperties: false properties: title: type: string value: type: string customer_limit: type: - integer - 'null' active_variant_countries: type: array items: type: string product: oneOf: - $ref: '#/components/schemas/CheckoutOrderProductShallow' - type: 'null' CheckoutOrderProductShallow: description: >- Product summary without bundle groups or metafields (ProductBlueprinter item_without_bundle_groups view), used inside bundle-group item variants. type: object additionalProperties: false properties: id: type: integer title: type: - string - 'null' image_url: type: - string - 'null' image_path: type: - string - 'null' cv: type: - string - 'null' format: decimal tax: type: - string - 'null' sku: type: - string - 'null' metadata: type: - object - 'null' additionalProperties: true external_id: type: - string - 'null' canonical_url: type: - string - 'null' price: type: - string - number - 'null' introduction: type: - string - 'null' price_in_currency: type: string tax_in_currency: type: string cv_in_currency: type: string ````