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

Lists all theme templates

Request

Query
application_theme_idstringrequired

ID of the application theme

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

Responses

templates found

Bodyapplication/json
templatesArray of objects
metaobject
Response
application/json
{ "templates": [ {} ], "meta": { "request_id": "aec35efe-1cdc-48ac-94e6-616831786625", "timestamp": "2025-05-03T04:58:11Z" } }

Creates a theme template

Request

Query
application_theme_idstringrequired

ID of the application theme

Bodyapplication/json
application_theme_templateobject
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/application_theme_templates?application_theme_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application_theme_template": {
      "name": "string",
      "content": "string",
      "themeable_type": "product",
      "stylesheet": "string",
      "variables": "string"
    }
  }'

Responses

template created

Bodyapplication/json
application_theme_templateobject
metaobject
Response
application/json
{ "application_theme_template": { "id": 1, "application_theme_id": 1, "name": "Default Theme Template", "content": "<html><body>This is a default template</body></html>", "stylesheet": "body { background-color: #fff; }", "variables": {}, "themeable_type": "product", "status": "draft", "created_at": "2025-05-03T04:58:11Z", "updated_at": "2025-05-03T04:58:11Z" }, "meta": { "request_id": "aec35efe-1cdc-48ac-94e6-616831786625", "timestamp": "2025-05-03T04:58:11Z" } }

Retrieves a theme template

Request

Path
idstringrequired

ID of the theme template

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

Responses

template found

Bodyapplication/json
application_theme_templateobject
metaobject
Response
application/json
{ "application_theme_template": { "id": 1, "application_theme_id": 1, "name": "Default Theme Template", "content": "<html><body>This is a default template</body></html>", "stylesheet": "body { background-color: #fff; }", "variables": {}, "themeable_type": "product", "status": "draft", "created_at": "2025-05-03T04:58:11Z", "updated_at": "2025-05-03T04:58:11Z" }, "meta": { "request_id": "aec35efe-1cdc-48ac-94e6-616831786625", "timestamp": "2025-05-03T04:58:11Z" } }

Updates a theme template

Request

Path
idstringrequired

ID of the theme template

Bodyapplication/json
application_theme_templateobject
publishboolean
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/application_theme_templates/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application_theme_template": {
      "name": "string",
      "content": "string",
      "themeable_type": "string",
      "stylesheet": "string",
      "variables": "string"
    },
    "publish": true
  }'

Responses

template updated

Bodyapplication/json
application_theme_templateobject
metaobject
Response
application/json
{ "application_theme_template": { "id": 1, "application_theme_id": 1, "name": "Default Theme Template", "content": "<html><body>This is a default template</body></html>", "stylesheet": "body { background-color: #fff; }", "variables": {}, "themeable_type": "product", "status": "draft", "created_at": "2025-05-03T04:58:11Z", "updated_at": "2025-05-03T04:58:11Z" }, "meta": { "request_id": "aec35efe-1cdc-48ac-94e6-616831786625", "timestamp": "2025-05-03T04:58:11Z" } }

Deletes a theme template

Request

Path
idstringrequired

ID of the theme template

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

Responses

template deleted

Clones a theme template

Request

Path
idstringrequired

ID of the theme template to clone

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

Responses

template cloned

Bodyapplication/json
application_theme_templateobject
metaobject
Response
application/json
{ "application_theme_template": { "id": 1, "application_theme_id": 1, "name": "Default Theme Template", "content": "<html><body>This is a default template</body></html>", "stylesheet": "body { background-color: #fff; }", "variables": {}, "themeable_type": "product", "status": "draft", "created_at": "2025-05-03T04:58:11Z", "updated_at": "2025-05-03T04:58:11Z" }, "meta": { "request_id": "aec35efe-1cdc-48ac-94e6-616831786625", "timestamp": "2025-05-03T04:58:11Z" } }

Gets version diff information

Request

Path
idstringrequired

ID of the theme template

Query
versioninteger

Version number to compare with

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

Responses

version diff found

Bodyapplication/json
auditobject
application_theme_templateobject
metaobject
Response
application/json
{ "audit": { "version": 0, "created_at": "2019-08-24T14:15:22Z", "user_id": "string", "user_name": "string", "changes": {} }, "application_theme_template": { "id": 1, "application_theme_id": 1, "name": "Default Theme Template", "content": "<html><body>This is a default template</body></html>", "stylesheet": "body { background-color: #fff; }", "variables": {}, "themeable_type": "product", "status": "draft", "created_at": "2025-05-03T04:58:11Z", "updated_at": "2025-05-03T04:58:11Z" }, "meta": { "request_id": "aec35efe-1cdc-48ac-94e6-616831786625", "timestamp": "2025-05-03T04:58:11Z" } }

Renders a page for a theme template

Request

Path
idstringrequired

ID of the theme template

Query
resource_idinteger

ID of the resource to render

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

Responses

page rendered

Bodyapplication/json
liquid_contentstring
html_contentstring
metaobject
Response
application/json
{ "liquid_content": "string", "html_content": "string", "meta": { "request_id": "aec35efe-1cdc-48ac-94e6-616831786625", "timestamp": "2025-05-03T04:58:11Z" } }

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

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