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
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}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

List company languages

Request

List all available languages and their configuration status for the company. Shows which languages are active for the company.

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/settings/languages \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Languages retrieved successfully

Bodyapplication/json
languagesArray of objects(Language)required
languages[].​idintegerrequired
languages[].​namestring or null
Example: "English"
languages[].​isostring or null
Example: "en"
languages[].​company_users_countintegerrequired
Example: 100
languages[].​active_in_companybooleanrequired
Example: true
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "languages": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Configure company language

Request

Add a new language to the company's configuration. This will enable the language for use within the company.

Bodyapplication/json
idintegerrequired
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/settings/languages \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0
  }'

Responses

Language added successfully

Bodyapplication/json
languageobject(Language)required
language.​idintegerrequired
language.​namestring or null
Example: "English"
language.​isostring or null
Example: "en"
language.​company_users_countintegerrequired
Example: 100
language.​active_in_companybooleanrequired
Example: true
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "language": { "id": 0, "name": "English", "iso": "en", "company_users_count": 100, "active_in_company": true }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Remove company language

Request

Remove a language from the company's configuration. This will disable the language for use within the company.

Path
idintegerrequired

Language ID to be removed from company configuration

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

Responses

Language removed successfully

Bodyapplication/json
successbooleanrequired
Example: true
messagestringrequired
Example: "Language removed successfully"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "success": true, "message": "Language removed successfully", "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

Bodyapplication/json
droplet_categoriesArray of objects(DropletCategory)
metaobject
Response
application/json
{ "droplet_categories": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }