> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, run `fluid signup` from the Fluid CLI, or call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Update an order (PUT) > The PUT form of `PATCH /api/orders/{id}`. Both methods reach one update action, take the same body and return the same responses. Read that operation for the details. ## OpenAPI ````yaml /api-reference/company-v0.yaml put /api/orders/{id} openapi: 3.1.0 info: title: Fluid Company API description: | **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/orders/{id}: put: tags: - orders summary: Update an order (PUT) description: |- The PUT form of `PATCH /api/orders/{id}`. Both methods reach one update action, take the same body and return the same responses. Read that operation for the details. operationId: commerce_v0_update_order_put parameters: - name: id in: path required: true description: Order ID schema: type: integer requestBody: $ref: '#/components/requestBodies/UpdateOrder' responses: '200': $ref: '#/components/responses/UpdateOrderOk' '401': $ref: '#/components/responses/UpdateOrderUnauthorized' '403': $ref: '#/components/responses/UpdateOrderForbidden' '422': $ref: '#/components/responses/UpdateOrderUnprocessable' security: - bearer_auth: [] components: requestBodies: UpdateOrder: content: application/json: schema: $ref: '#/components/schemas/UpdateOrderRequestBodyApplicationJsonSchema' description: Request payload example: order: note: Leave the cases at the loading dock on Slough Avenue. external_id: NS-SO-77120 metadata: sales_channel: phone metafields: - namespace: custom key: purchase_order value: PO-2026-0917 value_type: string required: true responses: UpdateOrderOk: description: >- The updated order with its items, addresses, totals and warehouse. `meta.shop_url` is the company's storefront base URL. content: application/json: schema: $ref: >- #/components/schemas/CreateOrderFromCartResponse200ApplicationJsonSchema example: order: id: 48213 order_number: DM-10482 token: fo_7Kq2ZtW9xYbN4cRhJ3mLpV enrollment_member_type: null resulting_member_type: null pricing_snapshot: null external_id: NS-SO-77120 email: holly.flax@dundermifflin.com first_name: Holly last_name: Flax status: awaiting_shipment order_status: completed financial_status: paid fulfillment_status: unfulfilled source: admin currency_code: USD currency_symbol: $ amount: '63.41' subtotal: '54.99' tax: '4.42' shipping: '4.0' note: Leave the cases at the loading dock on Slough Avenue. warehouse_id: 311 items_count: 1 quantity_count: 1 company_subdomain: dunder-mifflin primary_domain_hostname: shop.dundermifflin.com created_at: '2026-09-14T15:40:52Z' updated_at: '2026-09-14T16:05:11Z' meta: request_id: 5e2a8c14-7d3b-4f96-a0c1-9b6e3d2f8a47 timestamp: '2026-09-14T16:05:11Z' shop_url: https://shop.dundermifflin.com UpdateOrderUnauthorized: description: >- Missing or invalid credentials, or the caller is not an admin of the company. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' UpdateOrderForbidden: description: | The admin's role lacks `orders.update`, or the update sets `financial_status` to `marked_paid`, `paid` or `partially_paid` without `orders.mark_paid`, or to `marked_free` without `orders.mark_free`. The order is unchanged. content: application/json: schema: $ref: '#/components/schemas/StandardForbiddenResponse' UpdateOrderUnprocessable: description: >- Invalid order attributes, an attempted internal snapshot write without order read access, or a tax_label change (tax_label is set by the tax provider and cannot be changed). The order is unchanged. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' example: error_message: unprocessable entity errors: metadata: - tax_and_shipping_settings requires order read access schemas: UpdateOrderRequestBodyApplicationJsonSchema: type: - object - 'null' properties: order: type: - object - 'null' properties: note: type: - string - number - integer - 'null' description: Order note external_id: type: - string - number - integer - 'null' description: External system identifier for the order (optional) financial_status: type: string description: | Financial status to set on the order. `marked_paid`, `paid` and `partially_paid` require the `orders.mark_paid` permission, and `marked_free` requires `orders.mark_free`. metadata: type: - object - 'null' description: Additional order metadata additionalProperties: $ref: '#/components/schemas/JsonValue' sale_date: type: - string - number - integer - 'null' format: date-time description: Sale date and time in UTC (optional) metafields: type: - array - 'null' description: Metafields for custom data storage items: $ref: '#/components/schemas/CompanyMetafieldUpdateRequest' 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: Subscription plan 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 apply_to_volume: description: >- Reduce this plan's line CV/QV by the same percentage as its subscription price discount. 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 customer_points_balance_decimal: type: string pattern: ^-?\d+\.\d{4}$ example: '120.0000' description: >- The same figure as customer_points_balance, as a decimal string with four places; customer_points_balance is this figure rounded down to a whole number once points carry fractions. source: type: - string - number - integer - 'null' price_inclusive_of_tax: type: - boolean - 'null' deprecated: true description: >- Whether the prices are inclusive of tax (deprecated, use totals.price_inclusive_of_tax — this field is not gated on the tax strategy and can disagree with the served totals) price_inclusive_tax_name: type: - string - 'null' deprecated: true description: >- The tax name shown beside an inclusive price (deprecated, use totals.tax_label) totals: $ref: '#/components/schemas/TaxTotalsBreakdown' 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' UnauthorizedResponse: type: object properties: message: type: string required: - message StandardForbiddenResponse: description: Common legacy forbidden 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' CompanyMetafieldUpdateRequest: type: - object - 'null' properties: id: type: - integer - string - number - 'null' description: Metafield ID (for updates) 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 _destroy: type: - boolean - 'null' description: Mark for deletion 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' TaxTotalsBreakdown: type: object additionalProperties: false description: >- Display-ready totals breakdown. 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. Deliberately omits a grand total — the authoritative charge stays on the sibling total/amount fields. properties: gross_subtotal: type: string description: Catalog sum of line-item prices (customer display). gross_subtotal_in_currency: type: string description: gross_subtotal formatted in the order's currency. net_subtotal: type: string description: Items subtotal excluding embedded item tax. net_subtotal_in_currency: type: string description: net_subtotal formatted in the order's currency. item_tax: type: string description: Embedded tax attributable to the items. item_tax_in_currency: type: string description: item_tax formatted in the order's currency. shipping_net: type: string description: Shipping charge excluding embedded shipping tax. shipping_net_in_currency: type: string description: shipping_net formatted in the order's currency. shipping_tax: type: string description: Embedded tax attributable to shipping. shipping_tax_in_currency: type: string description: shipping_tax formatted in the order's currency. total_tax: type: string description: Combined item and shipping tax. total_tax_in_currency: type: string description: total_tax formatted in the order's currency. price_inclusive_of_tax: type: boolean description: >- Whether the served numbers carved tax out of the catalog prices. Gated on the resolved tax strategy, so it always agrees with these numbers. Not a historical record. The monetary amounts in this breakdown are history-safe: they are split from the line tax and the combined tax total persisted with the order, never from today's rate. This inclusive-versus-exclusive classification is not: it is resolved from the CURRENT company/country tax configuration, not the configuration in force on the order date. If a company changes its tax strategy or a country toggles inclusive pricing, this flag — and with it how the persisted tax is decomposed across `net_subtotal`, `item_tax`, `shipping_net` and `shipping_tax` — changes for orders that were already placed. Do not read it as how the order was taxed at the time it was placed. tax_label: type: - string - 'null' description: The resolved tax-line label (e.g. "VAT"), or null. 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 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 code: type: string description: >- Machine code for the refusal, for example `payment_unconfirmed`, or `next_bill_date_blackout` when a merchant caller picks a bill date on a blackout day. A customer JWT is never refused for a blackout day; its date is saved on the next open day. blocked_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The date that was refused, as an ISO 8601 calendar date. example: '2026-11-30' blocked_day: type: integer minimum: 1 maximum: 31 description: >- Present with `next_bill_date_blackout`. The day of the month of `blocked_date`. example: 30 allowed_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The nearest date the merchant's blackout rules allow, the date to offer instead. example: '2026-11-28' payment_uuid: type: string description: >- Present with `payment_unconfirmed`. The payment to look up before charging again. error_details: type: array minItems: 1 description: >- Every reason this checkout was refused, each with a stable `code`, the cart `field` to fix, and the `payment` outcome. items: $ref: '#/components/schemas/CheckoutErrorDetail' coded_recovery: type: boolean description: >- Present and true when the company routes checkout refusals by `error_details` (CHECKOUT_CODED_REFUSALS). Temporary; removed with that flag. 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' CheckoutErrorDetail: description: >- One refusal reason, in the same vocabulary as `checkout_blockers`, with where to send the shopper and what happened to the payment. type: object additionalProperties: false required: - code - field - payment - message properties: code: type: string description: Stable refusal code. Codes reuse the `checkout_blockers` codes. field: type: - string - 'null' description: >- The cart API path to send the shopper to, for example `shipping_address.postal_code` or `items[123]`, or null. payment: type: string enum: - not_attempted - declined - unknown - held description: >- `not_attempted`: fix the cause and resubmit. `declined`: the payment was refused; resubmit with another method. `declined` reflects the stored payment status; for some gateways an unconfirmed failure is still reported as `declined`. `unknown`: money may have moved; check the order before charging again. `held`: the cart's only money is the payment a resubmit reuses. Fix the field and resubmit with the same payment method; checkout will not charge again. message: type: string description: The English message for this entry. Not translated. 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.