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

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

returns an array of companies using a droplet

Request

Path
uuidstringrequired
Query
paginationobject
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/droplets/{uuid}/companies?page=0&per_page=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns list of companies subscribed to the droplet

Bodyapplication/json
companiesArray of objects(Company)
metaobject
Response
application/json
{ "companies": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": {} } }

An array of available droplets

Request

Query
paginationobject
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/droplets?category=string&page=0&per_page=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns a list of droplets

Bodyapplication/json
dropletsArray of objects(Droplet)required
droplets[].​uuidstringrequired
droplets[].​namestringrequired
droplets[].​categoriesArray of stringsrequired
droplets[].​activeboolean or null
Default false
droplets[].​publicly_availableboolean or null
Default false
droplets[].​embed_urlstring or null
droplets[].​created_atstring(date-time)required
droplets[].​settingsobject or null(Droplet::Settings)
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
meta.​paginationobject
Response
application/json
{ "droplets": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": {} } }

creates a droplet

Request

Bodyapplication/json
dropletobjectrequired
droplet.​namestringnon-emptyrequired
droplet.​embed_urlstringnon-emptyrequired
droplet.​settingsobject
droplet.​categoriesArray of strings
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/droplets \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "droplet": {
      "name": "string",
      "embed_url": "string",
      "settings": {
        "marketplace_page": {
          "title": "string",
          "summary": "string",
          "logo_url": "string"
        },
        "details_page": {
          "title": "string",
          "summary": "string",
          "logo_url": "string",
          "features": [
            {
              "name": "string",
              "summary": "string",
              "details": "string",
              "image_url": "string",
              "video_url": "string"
            }
          ]
        },
        "service_operational_countries": [
          "string"
        ]
      },
      "categories": [
        "string"
      ]
    }
  }'

Responses

droplet created successfully

Bodyapplication/json
dropletobject(Droplet)required
droplet.​uuidstringrequired
droplet.​namestringrequired
droplet.​categoriesArray of stringsrequired
droplet.​activeboolean or null
Default false
droplet.​publicly_availableboolean or null
Default false
droplet.​embed_urlstring or null
droplet.​created_atstring(date-time)required
droplet.​settingsobject or null(Droplet::Settings)
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "droplet": { "uuid": "string", "name": "string", "categories": [], "active": false, "publicly_available": false, "embed_url": "string", "created_at": "2019-08-24T14:15:22Z", "settings": {} }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

shows a droplet

Request

Path
uuidstringrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/droplets/{uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns a single droplet

Bodyapplication/json
dropletobject(Droplet)required
droplet.​uuidstringrequired
droplet.​namestringrequired
droplet.​categoriesArray of stringsrequired
droplet.​activeboolean or null
Default false
droplet.​publicly_availableboolean or null
Default false
droplet.​embed_urlstring or null
droplet.​created_atstring(date-time)required
droplet.​settingsobject or null(Droplet::Settings)
droplet.​updated_atstring(date-time)required
droplet.​owner_companyobject(Company)required
droplet.​owner_company.​idintegerrequired
droplet.​owner_company.​namestringrequired
Example: "Acme, Inc."
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "droplet": { "uuid": "string", "name": "string", "categories": [], "active": false, "publicly_available": false, "embed_url": "string", "created_at": "2019-08-24T14:15:22Z", "settings": {}, "updated_at": "2019-08-24T14:15:22Z", "owner_company": {} }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

updates a droplet

Request

Update an existing droplet. Regular users can update most fields (active, name, embed_url, settings, categories) on droplets owned by their company. Only root admins can update publicly_available and company_id fields. Root admins can update any droplet.

Path
uuidstringrequired

Droplet UUID

Bodyapplication/json

Droplet update parameters

uuidstringnon-emptyrequired
dropletobjectrequired
droplet.​activeboolean
droplet.​publicly_availableboolean
droplet.​company_idinteger
droplet.​namestringnon-empty
droplet.​embed_urlstringnon-empty
droplet.​settingsobject
droplet.​categoriesArray of strings
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/droplets/{uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuid": "string",
    "droplet": {
      "active": true,
      "publicly_available": true,
      "company_id": 0,
      "name": "string",
      "embed_url": "string",
      "settings": {
        "marketplace_page": {
          "title": "string",
          "summary": "string",
          "logo_url": "string"
        },
        "details_page": {
          "title": "string",
          "summary": "string",
          "logo_url": "string",
          "features": [
            {
              "name": "string",
              "summary": "string",
              "details": "string",
              "image_url": "string",
              "video_url": "string"
            }
          ]
        },
        "service_operational_countries": [
          "string"
        ]
      },
      "categories": [
        "string"
      ]
    }
  }'

Responses

droplet updated successfully by root admin with root admin fields

Bodyapplication/json
dropletobject(Droplet)required
droplet.​uuidstringrequired
droplet.​namestringrequired
droplet.​categoriesArray of stringsrequired
droplet.​activeboolean or null
Default false
droplet.​publicly_availableboolean or null
Default false
droplet.​embed_urlstring or null
droplet.​created_atstring(date-time)required
droplet.​settingsobject or null(Droplet::Settings)
droplet.​updated_atstring(date-time)required
droplet.​owner_companyobject(Company)required
droplet.​owner_company.​idintegerrequired
droplet.​owner_company.​namestringrequired
Example: "Acme, Inc."
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "droplet": { "uuid": "string", "name": "string", "categories": [], "active": false, "publicly_available": false, "embed_url": "string", "created_at": "2019-08-24T14:15:22Z", "settings": {}, "updated_at": "2019-08-24T14:15:22Z", "owner_company": {} }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

deletes a droplet

Request

Path
uuidstringrequired
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/droplets/{uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

droplet deleted successfully

Bodyapplication/json
dropletobjectrequired
droplet.​uuidstringrequired
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
Response
application/json
{ "droplet": { "uuid": "string" }, "meta": { "request_id": "string", "timestamp": "string" } }

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

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