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

Enrollment Packs

Operations

List all enrollment packs

Request

Query
pageinteger

Page number

per_pageinteger

Items per page

sorted_bystring

Sort order

search_querystring

Search term

statusstring

Filter by status

with_country_idArray of integers

Filter by country IDs

languagestring

Language filter

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/enrollment_packs?language=string&page=0&per_page=0&search_query=string&sorted_by=string&status=string&with_country_id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

enrollment packs found

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

Create a new enrollment pack

Request

Bodyapplication/json
enrollment_packobjectrequired
enrollment_pack.​titlestringnon-emptyrequired
enrollment_pack.​descriptionstringrequired
enrollment_pack.​activeboolean
enrollment_pack.​membership_after_one_monthboolean
enrollment_pack.​membership_optionalboolean
enrollment_pack.​enrollment_feenumber
enrollment_pack.​application_theme_template_idinteger
enrollment_pack.​country_idsArray of integers
enrollment_pack.​additional_volumeinteger
enrollment_pack.​member_enrollable_products_attributesArray of objects
enrollment_pack.​subscription_enrollable_products_attributesArray of objects
enrollment_pack.​images_attributesArray of objects
enrollment_pack.​enrollment_pack_agreementsArray of objects
language_isostringnon-empty
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/enrollment_packs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrollment_pack": {
      "title": "string",
      "description": "string",
      "active": true,
      "membership_after_one_month": true,
      "membership_optional": true,
      "enrollment_fee": 0,
      "application_theme_template_id": 0,
      "country_ids": [
        0
      ],
      "additional_volume": 0,
      "member_enrollable_products_attributes": [
        {
          "variant_id": 0
        }
      ],
      "subscription_enrollable_products_attributes": [
        {
          "variant_id": 0,
          "subscription_plan_id": 0
        }
      ],
      "images_attributes": [
        {
          "image_url": "string",
          "position": 0
        }
      ],
      "enrollment_pack_agreements": [
        {
          "agreement_id": 0,
          "required": true
        }
      ]
    },
    "language_iso": "string"
  }'

Responses

enrollment pack created

Bodyapplication/json
enrollment_packobject
metaobject
Response
application/json
{ "enrollment_pack": { "enrollment_pack_id": 0, "slug": "string", "token": "string", "title": "string", "active": true, "description": {}, "enrollment_fee": "string", "membership_after_one_month": true, "membership_optional": true, "status": "string", "additional_volume": 0, "application_theme_template_id": 0, "country_ids": [], "member_enrollable_products": [], "subscription_enrollable_products": [], "images": [], "enrollment_pack_agreements": [] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Bulk update enrollment pack status

Request

Bodyapplication/json
idsArray of stringsrequired
statusstringrequired
Enum"active""draft"
curl -i -X PATCH \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/enrollment_packs/bulk_status_update \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "string"
    ],
    "status": "active"
  }'

Responses

enrollment packs updated

Bodyapplication/json
messagestring
updated_countinteger
idsArray of integers
metaobject
Response
application/json
{ "message": "string", "updated_count": 0, "ids": [ 0 ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Retrieves a specific enrollment pack

Request

Path
idstringrequired

Enrollment pack ID

Query
language_isostring
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/enrollment_packs/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

enrollment pack found

Bodyapplication/json
enrollment_packobject
metaobject
Response
application/json
{ "enrollment_pack": { "enrollment_pack_id": 0, "slug": "string", "token": "string", "title": "string", "active": true, "description": {}, "enrollment_fee": "string", "membership_after_one_month": true, "membership_optional": true, "status": "string", "additional_volume": 0, "application_theme_template_id": 0, "country_ids": [], "member_enrollable_products": [], "subscription_enrollable_products": [], "images": [], "enrollment_pack_agreements": [] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Delete an enrollment pack

Request

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

Responses

enrollment pack deleted

Bodyapplication/json
messagestring
enrollment_packobject
metaobject
Response
application/json
{ "message": "string", "enrollment_pack": { "id": 0 }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Update an enrollment pack

Request

Path
idstringrequired
Bodyapplication/json
idstringnon-emptyrequired
enrollment_packobjectrequired
enrollment_pack.​titlestringnon-empty
enrollment_pack.​descriptionstring
enrollment_pack.​activeboolean
enrollment_pack.​membership_after_one_monthboolean
enrollment_pack.​membership_optionalboolean
enrollment_pack.​enrollment_feenumber
enrollment_pack.​application_theme_template_idinteger
enrollment_pack.​country_idsArray of integers
enrollment_pack.​additional_volumeinteger
enrollment_pack.​member_enrollable_products_attributesArray of objects
enrollment_pack.​subscription_enrollable_products_attributesArray of objects
enrollment_pack.​images_attributesArray of objects
enrollment_pack.​enrollment_pack_agreementsArray of objects
language_isostringnon-empty
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/enrollment_packs/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "enrollment_pack": {
      "title": "string",
      "description": "string",
      "active": true,
      "membership_after_one_month": true,
      "membership_optional": true,
      "enrollment_fee": 0,
      "application_theme_template_id": 0,
      "country_ids": [
        0
      ],
      "additional_volume": 0,
      "member_enrollable_products_attributes": [
        {
          "id": 0,
          "variant_id": 0,
          "_destroy": true
        }
      ],
      "subscription_enrollable_products_attributes": [
        {
          "id": 0,
          "variant_id": 0,
          "subscription_plan_id": 0,
          "_destroy": true
        }
      ],
      "images_attributes": [
        {
          "id": 0,
          "image_url": "string",
          "position": 0,
          "_destroy": true
        }
      ],
      "enrollment_pack_agreements": [
        {
          "id": 0,
          "agreement_id": 0,
          "required": true,
          "_destroy": true
        }
      ]
    },
    "language_iso": "string"
  }'

Responses

enrollment pack updated

Bodyapplication/json
enrollment_packobject
metaobject
Response
application/json
{ "enrollment_pack": { "enrollment_pack_id": 0, "slug": "string", "token": "string", "title": "string", "active": true, "description": {}, "enrollment_fee": "string", "membership_after_one_month": true, "membership_optional": true, "status": "string", "additional_volume": 0, "application_theme_template_id": 0, "country_ids": [], "member_enrollable_products": [], "subscription_enrollable_products": [], "images": [], "enrollment_pack_agreements": [] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

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

Get enrollment pack by slug

Request

Path
slugstringrequired

Enrollment pack slug

Example: example-slug
Bodyapplication/json
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/enrollment_packs/{slug}' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

Enrollment pack retrieved successfully

Bodyapplication/json
statusnumberrequired
Example: 200
enrollment_packobjectrequired
enrollment_pack.​slugstringrequired
enrollment_pack.​enrollment_pack_idinteger
enrollment_pack.​titlestringrequired
enrollment_pack.​descriptionobjectrequired
enrollment_pack.​description.​idinteger
enrollment_pack.​description.​namestring
enrollment_pack.​description.​bodystring
enrollment_pack.​description.​record_typestring
enrollment_pack.​description.​record_idinteger
enrollment_pack.​description.​created_atstring
enrollment_pack.​description.​updated_atstring
enrollment_pack.​description.​localestring
enrollment_pack.​enrollment_feestringrequired
enrollment_pack.​additional_volumestring or null
enrollment_pack.​tokenstringrequired
metadataobject(ResponseMetadata)required
metadata.​fluid_shopstringrequired
metadata.​fluid_sessionstringrequired
metadata.​fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)
Example: "en_US"
metadata.​request_uuidstring(uuid)required
metadata.​timestampstringrequired
Response
application/json
{ "status": 200, "enrollment_pack": { "slug": "string", "enrollment_pack_id": 0, "title": "string", "description": {}, "enrollment_fee": "string", "additional_volume": "string", "token": "string" }, "metadata": { "fluid_shop": "string", "fluid_session": "string", "fluid_locale": "en_US", "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8", "timestamp": "string" } }

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations