> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > 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 where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > 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 — 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. # Orders > Find, create, fulfill, refund and cancel orders, export order reports, and review the details of each order. Use the **Orders** screen to find and review your company's orders, place orders for customers, and fulfill, refund or cancel them. ## Where to find it In the admin sidebar, under **Commerce**, select **Orders**. To open this screen, your role needs **View only** or **Full access** for **Orders**. To create, edit, archive or cancel orders, it needs **Full access** for **Orders**. Fulfilling needs **Full access** for **Fulfillments**, and refunding needs **Full access** for **Refunds**. On the [Roles](/help/admin/settings/roles) screen, **Orders**, **Fulfillments** and **Refunds** are areas in the **Commerce** card. Set access from each area's menu, not the card's. ## What's on the screen **New Order** and **Export** are at the top of the page. ### Stats The stats bar shows **Total Orders**, **Total Sales (USD)**, **Avg Order Amount (USD)**, **Total CV** and **Avg CV**. Use the date menu on the bar to choose a range: **Today**, **Month to date**, **Year to date**, **This week**, **Last 7 days**, **30 days**, **60 days**, **90 days** or **All time**. The page opens on **All time**. ### Orders list * The tabs filter by order status: **All**, **Draft**, **Pending**, **Processing**, **Completed**, **Archived**, **Cancelled** and **Pending Review**. * Use the search box to find orders. * **Filters** opens a panel with **Start Date**, **End Date**, **Countries**, **Order Type** (**Sample**, **Customer**, **Member**, **Enrollment** or **Autoship**), **Source** (**Storefront** or **Mobile App**) and **Status**. Click **Apply Filters**, or **Reset All** to clear them. The start and end dates and the stats bar's date menu set the same range for both the stats and the list. The list has these columns: **Order #**, **Date**, **Customer**, **Items**, **Total**, **Status**, **Payment**, **Type**, **Fulfillment** and **Subscription**. **Fulfillment** appears only if your role can view fulfillments. **Subscription** links to the subscription that created the order. You can sort by **Order #**, **Date**, **Customer**, **Total** and **Status**. Unsorted, the newest orders come first. Click an order to open it. A banner above the stats bar offers a new version of the table. Click **Try it** to use it, or **Switch back** to return. In the new table, the date menu on the stats bar is gone, and the date range is in its **Filters** menu. ## Create an order Click **New Order**. In the **Customer** card, search for the customer, or click **Create a new customer**. In the **Shipping Address** card, click **Edit** to choose another address or add one. You can't add products until the order has a shipping address with a country. Click **Search products** and choose the variants you want. If your role allows price overrides, **Add Custom Item** adds a line with your own title, price and quantity. In **Order Summary**, click **Add Shipping or Delivery**, choose a method and click **Apply**. Click **Add discount** to apply a promo code. In the **Credit** card, search for the rep who receives the order's CV/QV. Add a note in the **Notes** card. In the **Payment Method** card, click **Edit** to choose or add the customer's card. If your store requires a phone number on every order, enter it in the **Phone number** card and click **Save**. If the **Customer agreements** card appears, review each agreement with the customer and check it only after they agree. Click **Charge Card** to charge the selected card. **Charge Card** needs a payment method, and a physical order also needs a shipping method. **Send Invoice** emails the customer an invoice; it doesn't charge the card or place the order. If your role allows it, **More options** has **Mark As Paid** and **Mark As Free**. Both place the order without charging the card. When agreements apply, confirm them in the **Confirm customer agreements** dialog by clicking **Confirm and place order**. ## Order page The top of the order page shows the order number and its status badges: order status, payment, fulfillment, source and type. Below them are the sale date and the **External ID**, the order's ID in your back-office system. The main column has the items to fulfill and the fulfillments already made, the **Order Summary**, **Metafields**, and an **Activity** timeline where your team can post comments. Posting needs **Full access** for **Orders**. Customers don't see these comments. The side column has the **Customer**, **Shipping Address**, **Payment Method**, **Notes** and **Agreements** cards, and the **Fluid Fair Share™** card, which shows who receives credit for the order. **USD Conversion** appears for orders in other currencies. The header has **Print**, which downloads the order as a PDF, and a **More** menu. In **More**, **Create Invoice** opens the **Invoice Builder**, where you lay out an invoice and click **Export PDF**. For completed or archived orders, **More** also has **Archive** or **Unarchive**. Archived orders can't be refunded or fulfilled, so unarchive an order first if you need to. ### Edit order details With **Full access** for **Orders** you can: * Click the sale date to change the date and time, then click **Save**. Subscription orders set their sale date automatically. * Click **Edit** on **Shipping Address**, choose or enter the address, then click **Update address** in the **Before you save** dialog. * Click **Edit** on **Notes**, enter the note and click **Save**. Changing the shipping address doesn't change the taxes or shipping already charged. If the package has already shipped, the carrier may not get the new address in time. ## Fulfill items On the order page, click **Fulfill Items** on the unfulfilled items. The **Fulfill Order** page opens. Adjust how many of each item you're shipping now. Under **Tracking Information**, enter a **Tracking Number** and choose a **Shipping Carrier** (**FedEx**, **UPS**, **USPS** or **DHL**). Fill in both for each row. Click **Add Another Tracking Number** for more packages. In **Summary**, check or clear **Send a notification to the customer**. It starts from your company's fulfillment email setting. Click **Fulfill Items**. You return to the order page. If the order is on hold, an **On hold** banner appears and you can't fulfill it. Click **Remove hold** to set it back to unfulfilled. This needs **Full access** for **Fulfillments**. ## Refund an order On the order page, click **Refund**. To refund by item, set the **Quantity**, **CV** and **QV** for each item. Refunded items are removed from the order. To refund an amount instead, choose a type in **Manual Refund**. **All**, **Tax**, **Shipping** and **Product Cost** fill in the full amount still available for that part, so check the **Amount** and lower it to refund less. **Partial** starts empty. **CV** and **QV** refund volume only and have no amount. While a manual amount is entered, you can't select items. For an item refund, check **Restock items** to return the items to inventory. You can't restock items on a fulfilled order. Enter a **Reason for refund**. It's required, up to 500 characters, and only staff can see it. Click the **Refund** button at the top, which shows the amount. Check the details and click **Confirm Refund**. Refunds can't be undone. ## Cancel an order On the order page, click **Cancel Order**. It appears only on orders that can be cancelled. Optionally enter a **Reason for cancellation**, which only staff can see. **Restock all items** is checked by default. Click **Cancel Order**, or **Keep Order** to go back. Cancelling can't be undone. If the order's payment was only authorized, cancelling voids the authorization. A card hold that's still pending can take 3 to 7 days to drop off the customer's card. Orders held for fraud review show **Review** instead. Click it, optionally enter a reason, and click **Approve Order**, or **Cancel Order** and then **Confirm Cancel**. Cancelling a held order also refunds it. **Review** needs **Full access** for **Orders**. ## Export orders Click **Export**. The **Download** dialog starts with the date range from the stats bar. Choose **Countries**, **Status**, **Report Type** and **Timezone**, and adjust the **Start Date** and **End Date**. **Order Report** has one row per order. **Shipping Report** has one row per item, with billing and tracking details. Click **Export**. The CSV file downloads. ## Frequently asked questions In **Manual Refund**, **All** refunds everything still refundable, and **Partial** refunds an amount you enter. **Tax**, **Shipping** and **Product Cost** refund only that part of the order, and **CV** and **QV** refund only volume. **All** and **Partial** always appear and are grayed out when nothing is left. The other types appear only when the order has that amount left to refund, and **Shipping** doesn't appear when free shipping was applied. If the customer paid with points, check **Refund redeemed** (it shows your company's name for points) to return them; **All** checks it for you. You can refund an order more than once until nothing refundable remains. The refund page shows how much has already been refunded. After a manual refund, item selection is turned off for that order, so later refunds are manual too. If the refund page says a refund is awaiting settlement by the payment provider, wait. That amount is held back until the provider confirms, so it can't be refunded twice. Hover over the grayed-out **Refund** button to see the reason. If **Refund** doesn't appear but **Cancel Order** does, cancel the order instead. Archived and cancelled orders can't be fulfilled. An order on hold can't be fulfilled until you remove the hold. See [Fulfill items](#fulfill-items). Refund it from its order, like any other order. In the orders list, orders that came from a subscription show a link in the **Subscription** column. Open the order and click **Refund**. ## Related pages * [Commerce](/help/admin/commerce) * [Subscriptions](/help/admin/subscriptions) * [Promo Codes](/help/admin/promo-codes) * [Roles](/help/admin/settings/roles) * [Communications](/help/admin/settings/communications) * [Shipping](/help/admin/settings/shipping) * [We-Commerce](/concepts/we-commerce) * [Order currency](/concepts/order-currency) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.