Fluid Company APIs (1.0)

The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.

For APIs that authenticate with User tokens, see the Rep APIs documentation.

Download OpenAPI description
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/company.api/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Activities

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Resources

Operations

Application Theme Templates

Operations

Application Themes

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Show a checkout settings

Request

Show the current checkout settings for the company.

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/settings/checkout \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

checkout settings shown

Bodyapplication/json
idintegerrequired
namestringrequired
favicon_urlstring or null
primary_domain_hostnamestring or null
Example: "acme.com"
subdomainstring or null
Example: "acme"
logo_urlstring or null
Example: "https://acme.com/logo.png"
fluid_shopboolean or null
Example: true
collect_phonebooleanrequired
Example: true
require_phonebooleanrequired
Example: true
require_billing_zipbooleanrequired
Example: true
checkout_primary_button_colorstring or null
Example: "#000000"
checkout_primary_text_colorstring or null
Example: "#FFFFFF"
checkout_secondary_button_colorstring or null
Example: "#000000"
checkout_secondary_text_colorstring or null
Example: "#FFFFFF"
order_on_behalfbooleanrequired
Example: false
use_juspay_gatewaybooleanrequired
Example: false
reward_points_enabledbooleanrequired
Example: false
Response
application/json
{ "id": 0, "name": "string", "favicon_url": "string", "primary_domain_hostname": "acme.com", "subdomain": "acme", "logo_url": "https://acme.com/logo.png", "fluid_shop": true, "collect_phone": true, "require_phone": true, "require_billing_zip": true, "checkout_primary_button_color": "#000000", "checkout_primary_text_color": "#FFFFFF", "checkout_secondary_button_color": "#000000", "checkout_secondary_text_color": "#FFFFFF", "order_on_behalf": false, "use_juspay_gateway": false, "reward_points_enabled": false }

Update a checkout settings

Request

Update the current checkout settings for the company.

Bodyapplication/json
checkoutobjectrequired
checkout.​collect_phoneboolean
checkout.​require_phoneboolean
checkout.​require_billing_zipboolean
checkout.​checkout_primary_button_colorstring
checkout.​checkout_primary_text_colorstring
checkout.​checkout_secondary_button_colorstring
checkout.​checkout_secondary_text_colorstring
checkout.​order_on_behalfboolean
Example: false
curl -i -X PUT \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/settings/checkout \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "checkout": {
      "collect_phone": true,
      "require_phone": true,
      "require_billing_zip": true,
      "checkout_primary_button_color": "string",
      "checkout_primary_text_color": "string",
      "checkout_secondary_button_color": "string",
      "checkout_secondary_text_color": "string",
      "order_on_behalf": false
    }
  }'

Responses

checkout settings updated

Bodyapplication/json
idintegerrequired
namestringrequired
favicon_urlstring or null
primary_domain_hostnamestring or null
Example: "acme.com"
subdomainstring or null
Example: "acme"
logo_urlstring or null
Example: "https://acme.com/logo.png"
fluid_shopboolean or null
Example: true
collect_phonebooleanrequired
Example: true
require_phonebooleanrequired
Example: true
require_billing_zipbooleanrequired
Example: true
checkout_primary_button_colorstring or null
Example: "#000000"
checkout_primary_text_colorstring or null
Example: "#FFFFFF"
checkout_secondary_button_colorstring or null
Example: "#000000"
checkout_secondary_text_colorstring or null
Example: "#FFFFFF"
order_on_behalfbooleanrequired
Example: false
use_juspay_gatewaybooleanrequired
Example: false
reward_points_enabledbooleanrequired
Example: false
Response
application/json
{ "id": 0, "name": "string", "favicon_url": "string", "primary_domain_hostname": "acme.com", "subdomain": "acme", "logo_url": "https://acme.com/logo.png", "fluid_shop": true, "collect_phone": true, "require_phone": true, "require_billing_zip": true, "checkout_primary_button_color": "#000000", "checkout_primary_text_color": "#FFFFFF", "checkout_secondary_button_color": "#000000", "checkout_secondary_text_color": "#FFFFFF", "order_on_behalf": false, "use_juspay_gateway": false, "reward_points_enabled": false }

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Conversations

Operations

Countries

Operations

Currencies

Operations

Customer Notes

Operations

Customer Orders

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default MySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

Events

Operations

FairShare Order Journey

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

Global Embeds

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

MCC Codes

Operations

Media

Operations

Messages

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Points

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Product Bundles

Operations

Product Images

Operations

Product Subscription Plans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Recipients

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tiles

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variant Images

Operations

Variant Inventory Levels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

affiliate

Operations

carts

Operations

checkout

Operations

Record a checkout starting

Request

Bodyapplication/json
cart_tokenstringrequired
metadataobject(RequestMetadata)required
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​fluid_journeystring
metadata.​attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)
Any of:
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/public/v2025-06/events/checkout/started \
  -H 'Content-Type: application/json' \
  -d '{
    "cart_token": "string",
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

checkout started

Bodyapplication/json
statusnumberrequired
Example: 201
metadataobject(ResponseMetadata)required
Example: {"fluid_shop":"myshop","fluid_session":"fs_szwdDuRbqEe7AV7sXk7vVq","request_uuid":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-01-01T00:00:00Z"}
metadata.​fluid_shopstringrequired
Example: "myshop"
metadata.​fluid_sessionstringrequired
Example: "fs_szwdDuRbqEe7AV7sXk7vVq"
metadata.​fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​request_uuidstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
metadata.​timestampstringrequired
Example: "2025-01-01T00:00:00Z"
Response
application/json
{ "status": 201, "metadata": { "fluid_shop": "string", "fluid_session": "string", "fluid_locale": "en_US", "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8", "timestamp": "string" } }

enrollment-packs

Operations

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations