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

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

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

company countries retrieved

Request

List all countries configured for the company

Path

company_idintegerrequired

Example: 1

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

Responses

company countries retrieved

Bodyapplication/json

company_countriesArray of objectsrequired

company_countries[].idinteger

Example: 791909808

company_countries[].base_shippingstring

Example: "0.0"

company_countries[].countryobject

company_countries[].currencystring

Example: "USD"

company_countries[].defaultboolean

Example: true

company_countries[].entityobject or null

company_countries[].entity_legally_registeredboolean or null

company_countries[].handling_feestring or null

company_countries[].pause_incomplete_enrollmentboolean or null

company_countries[].settlement_currencystring or null

company_countries[].updated_atstring

Example: "2025-09-01T18:25:43Z"

metaobjectrequired

meta.request_idstring

Example: "fa1d485c-6e72-44a0-9fb9-2a0fa9e7311e"

meta.timestampstring

Example: "2025-09-01T18:25:44Z"

meta.paginationobject

Response

application/json

{
  "company_countries": [
    { … }
  ],
  "meta": {
    "request_id": "fa1d485c-6e72-44a0-9fb9-2a0fa9e7311e",
    "timestamp": "2025-09-01T18:25:44Z",
    "pagination": { … }
  }
}

Create company country

Request

Path

company_idintegerrequired

Example: 1

Bodyapplication/json

company_countryobjectrequired

company_country.currencystringrequired

Currency code

Example: "USD"

company_country.entity_idinteger or null

Associated entity ID

Example: 1

company_country.entity_legally_registeredboolean or null

Whether entity is legally registered

Example: true

company_country.settlement_currencystring or null

Settlement currency

Example: "USD"

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/company_countries' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_country": {
      "currency": "USD",
      "entity_id": 1,
      "entity_legally_registered": true,
      "settlement_currency": "USD"
    }
  }'

Responses

company country created

Bodyapplication/json

company_countryobjectrequired

company_country.idinteger

Example: 791909808

company_country.base_shippingstring

Example: "0.0"

company_country.countryobject

company_country.currencystring

Example: "USD"

company_country.defaultboolean

Example: true

company_country.entityobject or null

company_country.entity_legally_registeredboolean or null

company_country.handling_feestring or null

company_country.pause_incomplete_enrollmentboolean or null

company_country.settlement_currencystring or null

company_country.updated_atstring

Example: "2025-09-01T18:25:43Z"

metaobjectrequired

Response

application/json

{
  "company_country": {
    "id": 791909808,
    "base_shipping": "0.0",
    "country": { … },
    "currency": "USD",
    "default": true,
    "entity": {},
    "entity_legally_registered": true,
    "handling_fee": "string",
    "pause_incomplete_enrollment": true,
    "settlement_currency": "string",
    "updated_at": "2025-09-01T18:25:43Z"
  },
  "meta": {}
}

Get company country

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}/company_countries/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

company country retrieved

Bodyapplication/json

company_countryobjectrequired

company_country.idinteger

Example: 791909808

company_country.base_shippingstring

Example: "0.0"

company_country.countryobject

company_country.currencystring

Example: "USD"

company_country.defaultboolean

Example: true

company_country.entityobject or null

company_country.entity_legally_registeredboolean or null

company_country.handling_feestring or null

company_country.pause_incomplete_enrollmentboolean or null

company_country.settlement_currencystring or null

company_country.updated_atstring

Example: "2025-09-01T18:25:43Z"

metaobjectrequired

Response

application/json

{
  "company_country": {
    "id": 791909808,
    "base_shipping": "0.0",
    "country": { … },
    "currency": "USD",
    "default": true,
    "entity": {},
    "entity_legally_registered": true,
    "handling_fee": "string",
    "pause_incomplete_enrollment": true,
    "settlement_currency": "string",
    "updated_at": "2025-09-01T18:25:43Z"
  },
  "meta": {}
}

Update company country

Request

Path

company_idintegerrequired

Example: 1

idintegerrequired

Example: 1

Bodyapplication/json

company_countryobjectrequired

company_country.currencystring or null

Currency code

Example: "USD"

company_country.entity_idinteger or null

Associated entity ID

Example: 1

company_country.entity_legally_registeredboolean or null

Whether entity is legally registered

Example: true

company_country.settlement_currencystring or null

Settlement currency

Example: "USD"

curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/company_countries/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_country": {
      "currency": "USD",
      "entity_id": 1,
      "entity_legally_registered": true,
      "settlement_currency": "USD"
    }
  }'

Responses

company country updated

Bodyapplication/json

company_countryobjectrequired

company_country.idinteger

Example: 791909808

company_country.base_shippingstring

Example: "0.0"

company_country.countryobject

company_country.currencystring

Example: "USD"

company_country.defaultboolean

Example: true

company_country.entityobject or null

company_country.entity_legally_registeredboolean or null

company_country.handling_feestring or null

company_country.pause_incomplete_enrollmentboolean or null

company_country.settlement_currencystring or null

company_country.updated_atstring

Example: "2025-09-01T18:25:43Z"

metaobjectrequired

Response

application/json

{
  "company_country": {
    "id": 791909808,
    "base_shipping": "0.0",
    "country": { … },
    "currency": "USD",
    "default": true,
    "entity": {},
    "entity_legally_registered": true,
    "handling_fee": "string",
    "pause_incomplete_enrollment": true,
    "settlement_currency": "string",
    "updated_at": "2025-09-01T18:25:43Z"
  },
  "meta": {}
}

Delete company country

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}/company_countries/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

company country deleted

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

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

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

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

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Fluid Commerce APIs (1.0)

Admins

Agreements

Announcements

ApplePay

Application Theme Templates

Application Themes

ApplicationThemeTemplates

Authentication

Bank Accounts

Callback Definitions

Callback Registrations

Callback Schemas

Carts

Categories

Collections

Companies

Company Admins

Company Countries

company countries retrieved

Request

Responses

Was this helpful?

Create company country

RequestExpand all

Responses

Was this helpful?

Get company country

Request

Responses

Was this helpful?

Update company country

RequestExpand all

Responses

Was this helpful?

Delete company country

Request

Responses

Was this helpful?

Company Custom Catch Ups

Company Discounts

Company Email Settings

Company Mobile Widgets

Company Pages

Pages

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Company Webhook Events

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

DAM Query

Dam

Default Libraries

DefaultMySites

Devices

Display Settings

Domains

Drop Zones

Droplet Categories

Droplet Installations

Droplets

Enrollment Packs

Enrollments

Entities

FairShare Order Journey

Fantasy Points

Feature Flags

File Resources

Fluid Pay

Form Elements

Forms

GlobalEmbeds

Impersonation

Inventory Levels

Request

Request