Settings - Companies
/
Get company details

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

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

Admins

Operations

Agreements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Settings - Companies

Operations

List all companies

Request

List all companies. Accessible only by root admins.

Query
pageinteger>= 1

Page number for pagination

per_pageinteger[ 1 .. 100 ]

Number of records per page (default: 25)

sorted_bystring

Sort the result by a specific field

search_querystring

Search query to filter companies

statusstring

Filter by status

Headers
Authorizationstringrequired

Bearer token for authentication

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/companies?page=1&per_page=1&search_query=string&sorted_by=string&status=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Companies retrieved successfully

Bodyapplication/json
companiesArray of objectsrequired
companies[].​idinteger
companies[].​activeboolean
companies[].​sandboxboolean
companies[].​base_urlstring
companies[].​created_atstring(date)
companies[].​logo_urlstring
companies[].​namestring
companies[].​users_countstring
companies[].​user_companyobject
metaobjectrequired
meta.​request_idstring
meta.​timestampstring(date_time)
meta.​current_pageinteger
meta.​next_pageinteger or null
meta.​prev_pageinteger or null
meta.​total_pagesinteger
meta.​total_countinteger
meta.​countinteger
Response
application/json
{
  "companies": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "current_page": 0,
    "next_page": 0,
    "prev_page": 0,
    "total_pages": 0,
    "total_count": 0,
    "count": 0
  }
}

Add new company

Request

Add new company

Headers
Authorizationstringrequired

Bearer token for authentication

Bodyapplication/jsonrequired

Company details for creation

namestringrequired
Example: "Acme Corporation"
subdomainstringrequired
Example: "acme"
domainstring
Example: "acme.com"
colorstring
Example: "#0C7CF6"
transaction_feenumber
Example: 1.9
activeboolean
Example: true
sandboxboolean
Example: false
is_mlmboolean
Example: true
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/companies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Acme Corporation",
    "subdomain": "acme",
    "domain": "acme.com",
    "color": "#0C7CF6",
    "transaction_fee": 1.9,
    "active": true,
    "sandbox": false,
    "is_mlm": true
  }'

Responses

Company created successfully

Bodyapplication/json
companyobject(Company)required
company.​idintegerrequired
company.​namestringrequired
Example: "Acme, Inc."
company.​activeboolean or null
Default true
company.​shippingstring or null

Company shipping. Possible values: Flat Country, Droplet, Free, Product-based

Example: "fluid-rates"
company.​allow_free_shippingboolean or null
Example: true
company.​sandboxbooleanrequired

Whether the company is in sandbox mode for testing

Example: false
company.​is_mlmbooleanrequired

Whether the company is a Multi-Level Marketing (MLM) business

Example: true
company.​fluid_shopstringrequired
Example: "acme.fluid.app"
company.​domainstringrequired
Example: "acme.com"
company.​colorstringrequired
Example: "#000000"
company.​transaction_feenumberrequired

Transaction fee for the company

Example: 1.9
company.​tax_classstringrequired

Tax class for the company

Enum"fluid""custom""droplet""tax_free"
Example: "fluid"
company.​appstore_urlstring or null

App Store URL for the company's mobile app

Example: "https://apps.apple.com/us/app/acme-app/id123456789"
company.​playstore_urlstring or null

Google Play Store URL for the company's mobile app

Example: "https://play.google.com/store/apps/details?id=com.acme.app"
company.​shopify_order_feenumber or string or null

Shopify order fee for the company

Default "1.99"
Example: 0.1
company.​pre_purchase_enrollment_fieldsboolean or null
Example: true
company.​allow_signupboolean or null

Whether to allow self-signup

Example: true
company.​company_paysboolean or null

Whether the company pays for self-signup

Example: true
company.​olumo_tokenstring or null

OLUMO token for the company

Example: "1234567890"
company.​apn_bundlestring or null

APN bundle for the company

Example: "com.acme.app"
company.​ibi_bundlestring or null

IBI bundle for the company

Example: "com.acme.app"
company.​signup_urlstring or null

Signup URL for the company

Example: "https://acme.com/signup"
metaobjectrequired
meta.​request_idstring
meta.​timestampstring(date_time)
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "company": {
    "id": 0,
    "name": "Acme, Inc.",
    "active": true,
    "shipping": "fluid-rates",
    "allow_free_shipping": true,
    "sandbox": false,
    "is_mlm": true,
    "fluid_shop": "acme.fluid.app",
    "domain": "acme.com",
    "color": "#000000",
    "transaction_fee": 1.9,
    "tax_class": "fluid",
    "appstore_url": "https://apps.apple.com/us/app/acme-app/id123456789",
    "playstore_url": "https://play.google.com/store/apps/details?id=com.acme.app",
    "shopify_order_fee": 0.1,
    "pre_purchase_enrollment_fields": true,
    "allow_signup": true,
    "company_pays": true,
    "olumo_token": "1234567890",
    "apn_bundle": "com.acme.app",
    "ibi_bundle": "com.acme.app",
    "signup_url": "https://acme.com/signup"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get company details

Request

Get detailed information about a specific company. Accessible only by root admins.

Path
idintegerrequired

Company ID

Headers
Authorizationstringrequired

Bearer token for authentication

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/companies/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Company details retrieved successfully

Bodyapplication/json
idintegerrequired
namestringrequired
Example: "Acme, Inc."
activeboolean or nullrequired
Default true
shippingstring or null

Company shipping. Possible values: Flat Country, Droplet, Free, Product-based

Example: "fluid-rates"
allow_free_shippingboolean or null
Example: true
sandboxboolean

Whether the company is in sandbox mode for testing

Example: false
is_mlmboolean

Whether the company is a Multi-Level Marketing (MLM) business

Example: true
fluid_shopstringrequired
Example: "acme.fluid.app"
domainstring
Example: "acme.com"
colorstring
Example: "#000000"
transaction_feenumber

Transaction fee for the company

Example: 1.9
tax_classstringrequired

Tax class for the company

Enum"fluid""custom""droplet""tax_free"
Example: "fluid"
appstore_urlstring or null

App Store URL for the company's mobile app

Example: "https://apps.apple.com/us/app/acme-app/id123456789"
playstore_urlstring or null

Google Play Store URL for the company's mobile app

Example: "https://play.google.com/store/apps/details?id=com.acme.app"
shopify_order_feenumber or string or null

Shopify order fee for the company

Default "1.99"
Example: 0.1
pre_purchase_enrollment_fieldsboolean or null
Example: true
allow_signupboolean or null

Whether to allow self-signup

Example: true
company_paysboolean or null

Whether the company pays for self-signup

Example: true
olumo_tokenstring or null

OLUMO token for the company

Example: "1234567890"
apn_bundlestring or null

APN bundle for the company

Example: "com.acme.app"
ibi_bundlestring or null

IBI bundle for the company

Example: "com.acme.app"
signup_urlstring or null

Signup URL for the company

Example: "https://acme.com/signup"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "id": 0,
  "name": "Acme, Inc.",
  "active": true,
  "shipping": "fluid-rates",
  "allow_free_shipping": true,
  "sandbox": false,
  "is_mlm": true,
  "fluid_shop": "acme.fluid.app",
  "domain": "acme.com",
  "color": "#000000",
  "transaction_fee": 1.9,
  "tax_class": "fluid",
  "appstore_url": "https://apps.apple.com/us/app/acme-app/id123456789",
  "playstore_url": "https://play.google.com/store/apps/details?id=com.acme.app",
  "shopify_order_fee": 0.1,
  "pre_purchase_enrollment_fields": true,
  "allow_signup": true,
  "company_pays": true,
  "olumo_token": "1234567890",
  "apn_bundle": "com.acme.app",
  "ibi_bundle": "com.acme.app",
  "signup_url": "https://acme.com/signup",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update company details

Request

Update specific company details. Currently supports updating appstore_url and playstore_url. Accessible only by root admins.

Path
idintegerrequired

Company ID

Headers
Authorizationstringrequired

Bearer token for authentication

Bodyapplication/jsonrequired

Company details to update

appstore_urlstring or null
Example: "https://apps.apple.com/us/app/acme-app/id123456789"
One of:
string
playstore_urlstring or null
Example: "https://play.google.com/store/apps/details?id=com.acme.app"
One of:
string
sandboxboolean

Whether the company is in sandbox mode for testing

Example: false
order_on_behalfboolean
Example: false
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/companies/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appstore_url": "https://apps.apple.com/us/app/acme-app/id123456789",
    "playstore_url": "https://play.google.com/store/apps/details?id=com.acme.app",
    "sandbox": false,
    "order_on_behalf": false
  }'

Responses

Company updated successfully

Bodyapplication/json
idintegerrequired
namestringrequired
Example: "Acme, Inc."
activeboolean or nullrequired
Default true
shippingstring or null

Company shipping. Possible values: Flat Country, Droplet, Free, Product-based

Example: "fluid-rates"
allow_free_shippingboolean or null
Example: true
sandboxboolean

Whether the company is in sandbox mode for testing

Example: false
is_mlmboolean

Whether the company is a Multi-Level Marketing (MLM) business

Example: true
fluid_shopstringrequired
Example: "acme.fluid.app"
domainstring
Example: "acme.com"
colorstring
Example: "#000000"
transaction_feenumber

Transaction fee for the company

Example: 1.9
tax_classstringrequired

Tax class for the company

Enum"fluid""custom""droplet""tax_free"
Example: "fluid"
appstore_urlstring or null

App Store URL for the company's mobile app

Example: "https://apps.apple.com/us/app/acme-app/id123456789"
playstore_urlstring or null

Google Play Store URL for the company's mobile app

Example: "https://play.google.com/store/apps/details?id=com.acme.app"
shopify_order_feenumber or string or null

Shopify order fee for the company

Default "1.99"
Example: 0.1
pre_purchase_enrollment_fieldsboolean or null
Example: true
allow_signupboolean or null

Whether to allow self-signup

Example: true
company_paysboolean or null

Whether the company pays for self-signup

Example: true
olumo_tokenstring or null

OLUMO token for the company

Example: "1234567890"
apn_bundlestring or null

APN bundle for the company

Example: "com.acme.app"
ibi_bundlestring or null

IBI bundle for the company

Example: "com.acme.app"
signup_urlstring or null

Signup URL for the company

Example: "https://acme.com/signup"
metaobjectrequired
meta.​request_idstring
meta.​timestampstring(date_time)
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "id": 0,
  "name": "Acme, Inc.",
  "active": true,
  "shipping": "fluid-rates",
  "allow_free_shipping": true,
  "sandbox": false,
  "is_mlm": true,
  "fluid_shop": "acme.fluid.app",
  "domain": "acme.com",
  "color": "#000000",
  "transaction_fee": 1.9,
  "tax_class": "fluid",
  "appstore_url": "https://apps.apple.com/us/app/acme-app/id123456789",
  "playstore_url": "https://play.google.com/store/apps/details?id=com.acme.app",
  "shopify_order_fee": 0.1,
  "pre_purchase_enrollment_fields": true,
  "allow_signup": true,
  "company_pays": true,
  "olumo_token": "1234567890",
  "apn_bundle": "com.acme.app",
  "ibi_bundle": "com.acme.app",
  "signup_url": "https://acme.com/signup",
  "meta": {
    "request_id": "string",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete Company

Request

Delete a specific company. This will soft delete the company and initiate background job for permanent delete. Accessible only by root admins.

Path
idintegerrequired
Headers
Authorizationstringrequired

Bearer token for authentication

curl -i -X DELETE \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/companies/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Company was successfully destroyed

Bodyapplication/json
idintegerrequired
Example: 1
messagestringrequired
Example: "Company was successfully destroyed."
metaobject
Response
application/json
{
  "id": 1,
  "message": "Company was successfully destroyed.",
  "meta": {
    "request_id": "string",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations