Entities
/
Delete company entity

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://docs.fluid.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

Announcements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Media

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

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

Entities

Operations

List company entities

Request

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

Responses

entities retrieved

Bodyapplication/json
entitiesArray of objectsrequired
entities[].​idinteger
Example: 1
entities[].​legal_namestring
Example: "Acme Corporation Inc."
entities[].​classificationstring or null
Example: "Corporation"
entities[].​trading_namestring or null
Example: "Acme Corp"
entities[].​country_isostring or null
Example: "US"
entities[].​address1string or null
Example: "123 Business Street"
entities[].​address2string or null
Example: "Suite 100"
entities[].​citystring or null
Example: "New York"
entities[].​provincestring or null
Example: "NY"
entities[].​postal_codestring or null
Example: "10001"
entities[].​registration_numberstring or null
Example: "123456789"
entities[].​date_of_incorporationstring or null
Example: "2020-01-15"
entities[].​primary_mccinteger or null
Example: 5411
entities[].​secondary_mccinteger or null
Example: 5999
entities[].​phone_country_codestring or null
Example: "+1"
entities[].​phonestring or null
Example: "555-123-4567"
entities[].​websitestring or null
Example: "https://acme.com"
entities[].​tax_idstring or null
Example: "GB123456789"
entities[].​principal_same_as_registered_addressboolean
Example: true
entities[].​registered_addressobject or null
entities[].​principal_addressobject or null
entities[].​created_atstring
Example: "2025-01-15T10:30:00Z"
entities[].​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "entities": [
    { … }
  ],
  "meta": {}
}

Create company entity

Request

Path
company_idintegerrequired
Example: 1
Bodyapplication/json
entityobjectrequired
entity.​legal_namestringrequired

Legal name of the entity

Example: "Acme Corporation Inc."
entity.​classificationstring or null

Business classification

Example: "Corporation"
entity.​trading_namestring or null

Trading name

Example: "Acme Corp"
entity.​country_isostring or null

Country ISO code

Example: "US"
entity.​address1string or null

Primary address

Example: "123 Business Street"
entity.​address2string or null

Secondary address

Example: "Suite 100"
entity.​citystring or null

City

Example: "New York"
entity.​provincestring or null

Province/State

Example: "NY"
entity.​postal_codestring or null

Postal code

Example: "10001"
entity.​registration_numberstring or null

Business registration number

Example: "123456789"
entity.​date_of_incorporationstring or null

Date of incorporation

Example: "2020-01-15"
entity.​primary_mccinteger or null

Primary MCC code

Example: 5411
entity.​secondary_mccinteger or null

Secondary MCC code

Example: 5999
entity.​phone_country_codestring or null

Phone country code

Example: "+1"
entity.​phonestring or null

Phone number

Example: "555-123-4567"
entity.​websitestring or null

Website URL

Example: "https://acme.com"
entity.​principal_same_as_registered_addressboolean

Whether principal address is same as registered address

Example: true
entity.​principal_addressobject or null
entity.​registered_addressobject or null
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/entities' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity": {
      "legal_name": "Acme Corporation Inc.",
      "classification": "Corporation",
      "trading_name": "Acme Corp",
      "country_iso": "US",
      "address1": "123 Business Street",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postal_code": "10001",
      "registration_number": "123456789",
      "date_of_incorporation": "2020-01-15",
      "primary_mcc": 5411,
      "secondary_mcc": 5999,
      "phone_country_code": "+1",
      "phone": "555-123-4567",
      "website": "https://acme.com",
      "principal_same_as_registered_address": true,
      "principal_address": {
        "id": 1,
        "address1": "123 Business Street",
        "address2": "Suite 100",
        "address3": "Building A",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country_code": "US",
        "subdivision_code": "NY"
      },
      "registered_address": {
        "id": 1,
        "address1": "123 Business Street",
        "address2": "Suite 100",
        "address3": "Building A",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country_code": "US",
        "subdivision_code": "NY"
      }
    }
  }'

Responses

entity created

Bodyapplication/json
entityobjectrequired
entity.​idinteger
Example: 1
entity.​legal_namestring
Example: "Acme Corporation Inc."
entity.​classificationstring or null
Example: "Corporation"
entity.​trading_namestring or null
Example: "Acme Corp"
entity.​country_isostring or null
Example: "US"
entity.​address1string or null
Example: "123 Business Street"
entity.​address2string or null
Example: "Suite 100"
entity.​citystring or null
Example: "New York"
entity.​provincestring or null
Example: "NY"
entity.​postal_codestring or null
Example: "10001"
entity.​registration_numberstring or null
Example: "123456789"
entity.​date_of_incorporationstring or null
Example: "2020-01-15"
entity.​primary_mccinteger or null
Example: 5411
entity.​secondary_mccinteger or null
Example: 5999
entity.​phone_country_codestring or null
Example: "+1"
entity.​phonestring or null
Example: "555-123-4567"
entity.​websitestring or null
Example: "https://acme.com"
entity.​tax_idstring or null
Example: "GB123456789"
entity.​principal_same_as_registered_addressboolean
Example: true
entity.​registered_addressobject or null
entity.​principal_addressobject or null
entity.​created_atstring
Example: "2025-01-15T10:30:00Z"
entity.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "entity": {
    "id": 1,
    "legal_name": "Acme Corporation Inc.",
    "classification": "Corporation",
    "trading_name": "Acme Corp",
    "country_iso": "US",
    "address1": "123 Business Street",
    "address2": "Suite 100",
    "city": "New York",
    "province": "NY",
    "postal_code": "10001",
    "registration_number": "123456789",
    "date_of_incorporation": "2020-01-15",
    "primary_mcc": 5411,
    "secondary_mcc": 5999,
    "phone_country_code": "+1",
    "phone": "555-123-4567",
    "website": "https://acme.com",
    "tax_id": "GB123456789",
    "principal_same_as_registered_address": true,
    "registered_address": { … },
    "principal_address": { … },
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Get company entity

Request

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

Responses

entity retrieved

Bodyapplication/json
entityobjectrequired
entity.​idinteger
Example: 1
entity.​legal_namestring
Example: "Acme Corporation Inc."
entity.​classificationstring or null
Example: "Corporation"
entity.​trading_namestring or null
Example: "Acme Corp"
entity.​country_isostring or null
Example: "US"
entity.​address1string or null
Example: "123 Business Street"
entity.​address2string or null
Example: "Suite 100"
entity.​citystring or null
Example: "New York"
entity.​provincestring or null
Example: "NY"
entity.​postal_codestring or null
Example: "10001"
entity.​registration_numberstring or null
Example: "123456789"
entity.​date_of_incorporationstring or null
Example: "2020-01-15"
entity.​primary_mccinteger or null
Example: 5411
entity.​secondary_mccinteger or null
Example: 5999
entity.​phone_country_codestring or null
Example: "+1"
entity.​phonestring or null
Example: "555-123-4567"
entity.​websitestring or null
Example: "https://acme.com"
entity.​tax_idstring or null
Example: "GB123456789"
entity.​principal_same_as_registered_addressboolean
Example: true
entity.​registered_addressobject or null
entity.​principal_addressobject or null
entity.​created_atstring
Example: "2025-01-15T10:30:00Z"
entity.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "entity": {
    "id": 1,
    "legal_name": "Acme Corporation Inc.",
    "classification": "Corporation",
    "trading_name": "Acme Corp",
    "country_iso": "US",
    "address1": "123 Business Street",
    "address2": "Suite 100",
    "city": "New York",
    "province": "NY",
    "postal_code": "10001",
    "registration_number": "123456789",
    "date_of_incorporation": "2020-01-15",
    "primary_mcc": 5411,
    "secondary_mcc": 5999,
    "phone_country_code": "+1",
    "phone": "555-123-4567",
    "website": "https://acme.com",
    "tax_id": "GB123456789",
    "principal_same_as_registered_address": true,
    "registered_address": { … },
    "principal_address": { … },
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Update company entity

Request

Path
company_idintegerrequired
Example: 1
idintegerrequired
Example: 1
Bodyapplication/json
entityobjectrequired
entity.​legal_namestring

Legal name of the entity

Example: "Acme Corporation Inc."
entity.​classificationstring or null

Business classification

Example: "Corporation"
entity.​trading_namestring or null

Trading name

Example: "Acme Corp"
entity.​country_isostring or null

Country ISO code

Example: "US"
entity.​address1string or null

Primary address

Example: "123 Business Street"
entity.​address2string or null

Secondary address

Example: "Suite 100"
entity.​citystring or null

City

Example: "New York"
entity.​provincestring or null

Province/State

Example: "NY"
entity.​postal_codestring or null

Postal code

Example: "10001"
entity.​registration_numberstring or null

Business registration number

Example: "123456789"
entity.​date_of_incorporationstring or null

Date of incorporation

Example: "2020-01-15"
entity.​primary_mccinteger or null

Primary MCC code

Example: 5411
entity.​secondary_mccinteger or null

Secondary MCC code

Example: 5999
entity.​phone_country_codestring or null

Phone country code

Example: "+1"
entity.​phonestring or null

Phone number

Example: "555-123-4567"
entity.​websitestring or null

Website URL

Example: "https://acme.com"
entity.​principal_same_as_registered_addressboolean

Whether principal address is same as registered address

Example: true
entity.​principal_addressobject or null
entity.​registered_addressobject or null
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/entities/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity": {
      "legal_name": "Acme Corporation Inc.",
      "classification": "Corporation",
      "trading_name": "Acme Corp",
      "country_iso": "US",
      "address1": "123 Business Street",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postal_code": "10001",
      "registration_number": "123456789",
      "date_of_incorporation": "2020-01-15",
      "primary_mcc": 5411,
      "secondary_mcc": 5999,
      "phone_country_code": "+1",
      "phone": "555-123-4567",
      "website": "https://acme.com",
      "principal_same_as_registered_address": true,
      "principal_address": {
        "id": 1,
        "address1": "123 Business Street",
        "address2": "Suite 100",
        "address3": "Building A",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country_code": "US",
        "subdivision_code": "NY"
      },
      "registered_address": {
        "id": 1,
        "address1": "123 Business Street",
        "address2": "Suite 100",
        "address3": "Building A",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country_code": "US",
        "subdivision_code": "NY"
      }
    }
  }'

Responses

entity updated

Bodyapplication/json
entityobjectrequired
entity.​idinteger
Example: 1
entity.​legal_namestring
Example: "Acme Corporation Inc."
entity.​classificationstring or null
Example: "Corporation"
entity.​trading_namestring or null
Example: "Acme Corp"
entity.​country_isostring or null
Example: "US"
entity.​address1string or null
Example: "123 Business Street"
entity.​address2string or null
Example: "Suite 100"
entity.​citystring or null
Example: "New York"
entity.​provincestring or null
Example: "NY"
entity.​postal_codestring or null
Example: "10001"
entity.​registration_numberstring or null
Example: "123456789"
entity.​date_of_incorporationstring or null
Example: "2020-01-15"
entity.​primary_mccinteger or null
Example: 5411
entity.​secondary_mccinteger or null
Example: 5999
entity.​phone_country_codestring or null
Example: "+1"
entity.​phonestring or null
Example: "555-123-4567"
entity.​websitestring or null
Example: "https://acme.com"
entity.​tax_idstring or null
Example: "GB123456789"
entity.​principal_same_as_registered_addressboolean
Example: true
entity.​registered_addressobject or null
entity.​principal_addressobject or null
entity.​created_atstring
Example: "2025-01-15T10:30:00Z"
entity.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "entity": {
    "id": 1,
    "legal_name": "Acme Corporation Inc.",
    "classification": "Corporation",
    "trading_name": "Acme Corp",
    "country_iso": "US",
    "address1": "123 Business Street",
    "address2": "Suite 100",
    "city": "New York",
    "province": "NY",
    "postal_code": "10001",
    "registration_number": "123456789",
    "date_of_incorporation": "2020-01-15",
    "primary_mcc": 5411,
    "secondary_mcc": 5999,
    "phone_country_code": "+1",
    "phone": "555-123-4567",
    "website": "https://acme.com",
    "tax_id": "GB123456789",
    "principal_same_as_registered_address": true,
    "registered_address": { … },
    "principal_address": { … },
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Delete company entity

Request

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

Responses

entity deleted

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

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Search

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantCountries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Get a specific media

Request

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

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

Responses

Media retrieved successfully

Bodyapplication/json
idinteger
user_idinteger or null
titlestring
descriptionobject or null
media_typestring
media_formatstring or null
strippedstring or null
share_linkstring or null
preview_linkstring or null
video_urlstring or null
image_urlstring or null
pdf_urlstring or null
activeboolean
viewsinteger
leadsinteger
watchobject or null
video_statusstring or null
durationinteger or null
kindstring or null
cta_urlstring or null
cta_button_textstring or null
cta_action_typestring or null
cta_enabledboolean
labelstring or null
display_tagstring or null
promptsArray of objects
attached_shareablesArray of objects
ranksArray of objects
visibilityinteger or null
video_shopping_enabledboolean
prompts_enabledboolean
created_atstring
application_theme_template_idinteger or null
settingsobject
countriesArray of objects
Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "media_type": "string",
  "media_format": "string",
  "stripped": "string",
  "share_link": "string",
  "preview_link": "string",
  "video_url": "string",
  "image_url": "string",
  "pdf_url": "string",
  "active": true,
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "kind": "string",
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_action_type": "string",
  "cta_enabled": true,
  "label": "string",
  "display_tag": "string",
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "ranks": [
    {}
  ],
  "visibility": 0,
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "created_at": "string",
  "application_theme_template_id": 0,
  "settings": {},
  "countries": [
    { … }
  ]
}