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

List company bank accounts

Request

Path
company_idintegerrequired
Example: 1
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/companies/{company_id}/bank_accounts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

bank accounts retrieved

Bodyapplication/json
bank_accountsArray of objectsrequired
bank_accounts[].​idinteger
Example: 1
bank_accounts[].​entity_idinteger
Example: 1
bank_accounts[].​bank_namestring
Example: "Chase Bank"
bank_accounts[].​holder_namestring
Example: "John Doe"
bank_accounts[].​account_numberstring
Example: "1234567890"
bank_accounts[].​routing_numberstring or null
Example: "021000021"
bank_accounts[].​swift_bicstring or null
Example: "CHASUSUS33"
bank_accounts[].​country_isostring or null
Example: "US"
bank_accounts[].​currency_isostring or null
Example: "USD"
bank_accounts[].​citystring or null
Example: "New York"
bank_accounts[].​primaryboolean
Example: false
bank_accounts[].​statusstring
Enum"active""inactive"
Example: "active"
bank_accounts[].​last_3_months_bank_statements_file_urlstring or null
Example: "https://example.com/bank-statements.pdf"
bank_accounts[].​last_3_months_bank_statements_file_namestring or null
Example: "bank-statements.pdf"
bank_accounts[].​bank_letter_or_voided_check_file_urlstring or null
Example: "https://example.com/bank-letter.pdf"
bank_accounts[].​bank_letter_or_voided_check_file_namestring or null
Example: "bank-letter.pdf"
bank_accounts[].​created_atstring
Example: "2025-01-15T10:30:00Z"
bank_accounts[].​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{ "bank_accounts": [ {} ], "meta": {} }

Create company bank account

Request

Path
company_idintegerrequired
Example: 1
Bodyapplication/json
bank_accountobjectrequired
bank_account.​entity_idintegerrequired

Associated entity ID

Example: 1
bank_account.​bank_namestringrequired

Bank name

Example: "Chase Bank"
bank_account.​holder_namestringrequired

Account holder name

Example: "John Doe"
bank_account.​account_numberstringrequired

Bank account number

Example: "1234567890"
bank_account.​routing_numberstring or null

Bank routing number

Example: "021000021"
bank_account.​swift_bicstring or null

SWIFT/BIC code

Example: "CHASUSUS33"
bank_account.​country_isostring or null

Country ISO code

Example: "US"
bank_account.​currency_isostring or null

Currency ISO code

Example: "USD"
bank_account.​citystring or null

City

Example: "New York"
bank_account.​primaryboolean

Whether this is the primary bank account

Example: false
bank_account.​statusstring

Bank account status (active or inactive)

Enum"active""inactive"
Example: "active"
bank_account.​last_3_months_bank_statements_file_urlstring or null

Last 3 months bank statements document file URL

Example: "https://example.com/bank-statements.pdf"
bank_account.​last_3_months_bank_statements_file_namestring or null

Last 3 months bank statements document file name

Example: "bank-statements.pdf"
bank_account.​bank_letter_or_voided_check_file_urlstring or null

Bank letter or voided check document file URL

Example: "https://example.com/bank-letter.pdf"
bank_account.​bank_letter_or_voided_check_file_namestring or null

Bank letter or voided check document file name

Example: "bank-letter.pdf"
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/companies/{company_id}/bank_accounts' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account": {
      "entity_id": 1,
      "bank_name": "Chase Bank",
      "holder_name": "John Doe",
      "account_number": "1234567890",
      "routing_number": "021000021",
      "swift_bic": "CHASUSUS33",
      "country_iso": "US",
      "currency_iso": "USD",
      "city": "New York",
      "primary": false,
      "status": "active",
      "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf",
      "last_3_months_bank_statements_file_name": "bank-statements.pdf",
      "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf",
      "bank_letter_or_voided_check_file_name": "bank-letter.pdf"
    }
  }'

Responses

bank account created

Bodyapplication/json
bank_accountobjectrequired
bank_account.​idinteger
Example: 1
bank_account.​entity_idinteger
Example: 1
bank_account.​bank_namestring
Example: "Chase Bank"
bank_account.​holder_namestring
Example: "John Doe"
bank_account.​account_numberstring
Example: "1234567890"
bank_account.​routing_numberstring or null
Example: "021000021"
bank_account.​swift_bicstring or null
Example: "CHASUSUS33"
bank_account.​country_isostring or null
Example: "US"
bank_account.​currency_isostring or null
Example: "USD"
bank_account.​citystring or null
Example: "New York"
bank_account.​primaryboolean
Example: false
bank_account.​statusstring
Enum"active""inactive"
Example: "active"
bank_account.​last_3_months_bank_statements_file_urlstring or null
Example: "https://example.com/bank-statements.pdf"
bank_account.​last_3_months_bank_statements_file_namestring or null
Example: "bank-statements.pdf"
bank_account.​bank_letter_or_voided_check_file_urlstring or null
Example: "https://example.com/bank-letter.pdf"
bank_account.​bank_letter_or_voided_check_file_namestring or null
Example: "bank-letter.pdf"
bank_account.​created_atstring
Example: "2025-01-15T10:30:00Z"
bank_account.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{ "bank_account": { "id": 1, "entity_id": 1, "bank_name": "Chase Bank", "holder_name": "John Doe", "account_number": "1234567890", "routing_number": "021000021", "swift_bic": "CHASUSUS33", "country_iso": "US", "currency_iso": "USD", "city": "New York", "primary": false, "status": "active", "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf", "last_3_months_bank_statements_file_name": "bank-statements.pdf", "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf", "bank_letter_or_voided_check_file_name": "bank-letter.pdf", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" }, "meta": {} }

Get company bank account

Request

Path
company_idintegerrequired
Example: 1
idintegerrequired
Example: 1
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/companies/{company_id}/bank_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

bank account retrieved

Bodyapplication/json
bank_accountobjectrequired
bank_account.​idinteger
Example: 1
bank_account.​entity_idinteger
Example: 1
bank_account.​bank_namestring
Example: "Chase Bank"
bank_account.​holder_namestring
Example: "John Doe"
bank_account.​account_numberstring
Example: "1234567890"
bank_account.​routing_numberstring or null
Example: "021000021"
bank_account.​swift_bicstring or null
Example: "CHASUSUS33"
bank_account.​country_isostring or null
Example: "US"
bank_account.​currency_isostring or null
Example: "USD"
bank_account.​citystring or null
Example: "New York"
bank_account.​primaryboolean
Example: false
bank_account.​statusstring
Enum"active""inactive"
Example: "active"
bank_account.​last_3_months_bank_statements_file_urlstring or null
Example: "https://example.com/bank-statements.pdf"
bank_account.​last_3_months_bank_statements_file_namestring or null
Example: "bank-statements.pdf"
bank_account.​bank_letter_or_voided_check_file_urlstring or null
Example: "https://example.com/bank-letter.pdf"
bank_account.​bank_letter_or_voided_check_file_namestring or null
Example: "bank-letter.pdf"
bank_account.​created_atstring
Example: "2025-01-15T10:30:00Z"
bank_account.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{ "bank_account": { "id": 1, "entity_id": 1, "bank_name": "Chase Bank", "holder_name": "John Doe", "account_number": "1234567890", "routing_number": "021000021", "swift_bic": "CHASUSUS33", "country_iso": "US", "currency_iso": "USD", "city": "New York", "primary": false, "status": "active", "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf", "last_3_months_bank_statements_file_name": "bank-statements.pdf", "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf", "bank_letter_or_voided_check_file_name": "bank-letter.pdf", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" }, "meta": {} }

Update company bank account

Request

Path
company_idintegerrequired
Example: 1
idintegerrequired
Example: 1
Bodyapplication/json
bank_accountobjectrequired
bank_account.​entity_idinteger or null

Associated entity ID

Example: 1
bank_account.​bank_namestring or null

Bank name

Example: "Chase Bank"
bank_account.​holder_namestring or null

Account holder name

Example: "John Doe"
bank_account.​account_numberstring or null

Bank account number

Example: "1234567890"
bank_account.​routing_numberstring or null

Bank routing number

Example: "021000021"
bank_account.​swift_bicstring or null

SWIFT/BIC code

Example: "CHASUSUS33"
bank_account.​country_isostring or null

Country ISO code

Example: "US"
bank_account.​currency_isostring or null

Currency ISO code

Example: "USD"
bank_account.​citystring or null

City

Example: "New York"
bank_account.​primaryboolean

Whether this is the primary bank account

Example: false
bank_account.​statusstring

Bank account status (active or inactive)

Enum"active""inactive"
Example: "active"
bank_account.​last_3_months_bank_statements_file_urlstring or null

Last 3 months bank statements document file URL

Example: "https://example.com/bank-statements.pdf"
bank_account.​last_3_months_bank_statements_file_namestring or null

Last 3 months bank statements document file name

Example: "bank-statements.pdf"
bank_account.​bank_letter_or_voided_check_file_urlstring or null

Bank letter or voided check document file URL

Example: "https://example.com/bank-letter.pdf"
bank_account.​bank_letter_or_voided_check_file_namestring or null

Bank letter or voided check document file name

Example: "bank-letter.pdf"
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/companies/{company_id}/bank_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account": {
      "entity_id": 1,
      "bank_name": "Chase Bank",
      "holder_name": "John Doe",
      "account_number": "1234567890",
      "routing_number": "021000021",
      "swift_bic": "CHASUSUS33",
      "country_iso": "US",
      "currency_iso": "USD",
      "city": "New York",
      "primary": false,
      "status": "active",
      "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf",
      "last_3_months_bank_statements_file_name": "bank-statements.pdf",
      "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf",
      "bank_letter_or_voided_check_file_name": "bank-letter.pdf"
    }
  }'

Responses

bank account updated

Bodyapplication/json
bank_accountobjectrequired
bank_account.​idinteger
Example: 1
bank_account.​entity_idinteger
Example: 1
bank_account.​bank_namestring
Example: "Chase Bank"
bank_account.​holder_namestring
Example: "John Doe"
bank_account.​account_numberstring
Example: "1234567890"
bank_account.​routing_numberstring or null
Example: "021000021"
bank_account.​swift_bicstring or null
Example: "CHASUSUS33"
bank_account.​country_isostring or null
Example: "US"
bank_account.​currency_isostring or null
Example: "USD"
bank_account.​citystring or null
Example: "New York"
bank_account.​primaryboolean
Example: false
bank_account.​statusstring
Enum"active""inactive"
Example: "active"
bank_account.​last_3_months_bank_statements_file_urlstring or null
Example: "https://example.com/bank-statements.pdf"
bank_account.​last_3_months_bank_statements_file_namestring or null
Example: "bank-statements.pdf"
bank_account.​bank_letter_or_voided_check_file_urlstring or null
Example: "https://example.com/bank-letter.pdf"
bank_account.​bank_letter_or_voided_check_file_namestring or null
Example: "bank-letter.pdf"
bank_account.​created_atstring
Example: "2025-01-15T10:30:00Z"
bank_account.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{ "bank_account": { "id": 1, "entity_id": 1, "bank_name": "Chase Bank", "holder_name": "John Doe", "account_number": "1234567890", "routing_number": "021000021", "swift_bic": "CHASUSUS33", "country_iso": "US", "currency_iso": "USD", "city": "New York", "primary": false, "status": "active", "last_3_months_bank_statements_file_url": "https://example.com/bank-statements.pdf", "last_3_months_bank_statements_file_name": "bank-statements.pdf", "bank_letter_or_voided_check_file_url": "https://example.com/bank-letter.pdf", "bank_letter_or_voided_check_file_name": "bank-letter.pdf", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" }, "meta": {} }

Delete company bank account

Request

Path
company_idintegerrequired
Example: 1
idintegerrequired
Example: 1
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/companies/{company_id}/bank_accounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

bank account deleted

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

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