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

company.api.json

company.api.yaml

Overview

E-mail support@fluid.app

License MIT

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

Checkout

Operations

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

Menus

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

Search

Operations

Global search across all searchable models

Request

Perform global search across enabled models using Searchkick. Results are always filtered by company_id for data security. Supports model boosting, faceted search, and pagination.

Bodyapplication/json

qstringrequired

Search query string (required)

modelsArray of strings

Array of model types to search. Available: order. Default: all available models

pageinteger

Page number for pagination (default: 1)

per_pageinteger

Number of results per page (default: 20, max: 100)

filtersobject

curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/search \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "q": "string",
    "models": [
      "string"
    ],
    "page": 0,
    "per_page": 0,
    "filters": {
      "status": "string",
      "active": true
    }
  }'

Responses

Empty search results

Bodyapplication/json

resultsArray of objectsrequired

results[].idintegerrequired

Unique identifier for the result

Example: 123

results[].search_typestringrequired

Type of the search result

Example: "commerce/order"

results[].search_titlestringrequired

Display title for the result

Example: "Order #12345"

results[].search_descriptionstring or null

Brief description of the result

Example: "awaiting_payment • $100.00"

results[].search_urlstring or null

URL path to view the result

Example: "/orders/123"

results[].resourceobjectrequired

Model-specific data

results[].resource.property name*anyadditional property

results[].created_atstring(date-time)required

When result was created

Example: "2025-01-28T12:00:00Z"

results[].updated_atstring(date-time)required

When result was last updated

Example: "2025-01-28T12:00:00Z"

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring(date-time)

Example: "2025-01-28T12:00:00Z"

meta.total_countinteger

Total number of matching results

Example: 25

meta.current_pageinteger

Current page number

Example: 1

meta.per_pageinteger

Results per page

Example: 20

meta.total_pagesinteger

Total number of pages

Example: 2

Response

application/json

{
  "results": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2025-01-28T12:00:00Z",
    "total_count": 25,
    "current_page": 1,
    "per_page": 20,
    "total_pages": 2
  }
}

Operations

Shop

Operations

Sitemap

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

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

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