Application Themes
/
Get current active application theme

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

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

List application themes

Request

Get all application themes with optional filters

Query
pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
root_themesboolean

If true, returns root themes instead of company-specific themes

Default false
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_themes?page=1&per_page=10&root_themes=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
application_themesArray of objects
metaobject
Response
application/json
{
  "application_themes": [
    { … }
  ],
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z",
    "total_count": 42,
    "total_pages": 3,
    "current_page": 1,
    "per_page": 10
  }
}

Create an application theme

Request

Bodyapplication/json
application_themeobjectrequired
application_theme.​namestringrequired

Name of the application theme

Example: "Modern Theme"
application_theme.​descriptionstring

Description of the application theme

Example: "A clean modern theme"
application_theme.​statusstring

Status of the application theme

Example: "draft"
application_theme.​variablesstring

Theme variables in JSON format

application_theme.​custom_stylesheetstring

Custom CSS for the theme

application_theme.​global_stylesheetstring

Global CSS for the theme

application_theme.​cover_image_urlstring

URL for the cover image

Example: "https://example.com/image.jpg"
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_themes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application_theme": {
      "name": "Modern Theme",
      "description": "A clean modern theme",
      "status": "draft",
      "variables": "string",
      "custom_stylesheet": "string",
      "global_stylesheet": "string",
      "cover_image_url": "https://example.com/image.jpg"
    }
  }'

Responses

created

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 1,
    "company_id": 123,
    "name": "Modern Theme",
    "description": null,
    "cover_image": "https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file",
    "status": "draft",
    "variables": "{\"primary_color\": \"#ff0000\", \"secondary_color\": \"#00ff00\"}",
    "custom_stylesheet": "body { background-color: #fff; }",
    "global_stylesheet": "h1 { color: #333; }",
    "created_at": "2023-07-24T10:00:00.000Z",
    "updated_at": "2023-07-24T10:00:00.000Z",
    "version": "1.0",
    "outdated": false,
    "versions": [],
    "application_theme_templates": [],
    "images": []
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Get an application theme

Request

Path
idintegerrequired

Application Theme ID

Query
versioninteger

Version of the theme to retrieve

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

Responses

successful

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 1,
    "company_id": 123,
    "name": "Modern Theme",
    "description": null,
    "cover_image": "https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file",
    "status": "draft",
    "variables": "{\"primary_color\": \"#ff0000\", \"secondary_color\": \"#00ff00\"}",
    "custom_stylesheet": "body { background-color: #fff; }",
    "global_stylesheet": "h1 { color: #333; }",
    "created_at": "2023-07-24T10:00:00.000Z",
    "updated_at": "2023-07-24T10:00:00.000Z",
    "version": "1.0",
    "outdated": false,
    "versions": [],
    "application_theme_templates": [],
    "images": []
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update an application theme

Request

Path
idintegerrequired

Application Theme ID

Bodyapplication/json
application_themeobjectrequired
application_theme.​namestring

Name of the application theme

Example: "Updated Theme Name"
application_theme.​descriptionstring

Description of the application theme

Example: "Updated description"
application_theme.​statusstring

Status of the application theme

Example: "draft"
application_theme.​variablesstring

Theme variables in JSON format

application_theme.​custom_stylesheetstring

Custom CSS for the theme

application_theme.​global_stylesheetstring

Global CSS for the theme

application_theme.​cover_image_urlstring

URL for the cover image

Example: "https://example.com/updated-image.jpg"
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_themes/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "application_theme": {
      "name": "Updated Theme Name",
      "description": "Updated description",
      "status": "draft",
      "variables": "string",
      "custom_stylesheet": "string",
      "global_stylesheet": "string",
      "cover_image_url": "https://example.com/updated-image.jpg"
    }
  }'

Responses

success

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 1,
    "company_id": 123,
    "name": "Modern Theme",
    "description": null,
    "cover_image": "https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file",
    "status": "draft",
    "variables": "{\"primary_color\": \"#ff0000\", \"secondary_color\": \"#00ff00\"}",
    "custom_stylesheet": "body { background-color: #fff; }",
    "global_stylesheet": "h1 { color: #333; }",
    "created_at": "2023-07-24T10:00:00.000Z",
    "updated_at": "2023-07-24T10:00:00.000Z",
    "version": "1.0",
    "outdated": false,
    "versions": [],
    "application_theme_templates": [],
    "images": []
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Delete an application theme

Request

Path
idintegerrequired

Application Theme ID

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

Responses

success

Bodyapplication/json
messagestring
Example: "Theme was successfully destroyed."
metaobject
Response
application/json
{
  "message": "Theme was successfully destroyed.",
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Clone an application theme

Request

Path
idintegerrequired

Application Theme ID to clone

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

Responses

success

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 0,
    "company_id": 0,
    "name": "string",
    "description": null,
    "cover_image": "string",
    "status": "string",
    "variables": "string",
    "custom_stylesheet": "string",
    "global_stylesheet": "string",
    "created_at": "string",
    "updated_at": "string",
    "version": "string",
    "outdated": true,
    "versions": [ … ],
    "application_theme_templates": [ … ],
    "images": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Get theme assets

Request

Path
idintegerrequired

Application Theme ID

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

Responses

success

Bodyapplication/json
file_resourcesArray of objects(FileResource)
metaobject
Response
application/json
{
  "file_resources": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Get current active application theme

Request

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

Responses

successful

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 1,
    "company_id": 123,
    "name": "Modern Theme",
    "description": null,
    "cover_image": "https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file",
    "status": "draft",
    "variables": "{\"primary_color\": \"#ff0000\", \"secondary_color\": \"#00ff00\"}",
    "custom_stylesheet": "body { background-color: #fff; }",
    "global_stylesheet": "h1 { color: #333; }",
    "created_at": "2023-07-24T10:00:00.000Z",
    "updated_at": "2023-07-24T10:00:00.000Z",
    "version": "1.0",
    "outdated": false,
    "versions": [],
    "application_theme_templates": [],
    "images": []
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Import an application theme

Request

Path
idintegerrequired

Application Theme ID to import

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

Responses

success

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 0,
    "company_id": 0,
    "name": "string",
    "description": null,
    "cover_image": "string",
    "status": "string",
    "variables": "string",
    "custom_stylesheet": "string",
    "global_stylesheet": "string",
    "created_at": "string",
    "updated_at": "string",
    "version": "string",
    "outdated": true
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Export an application theme

Request

Path
idintegerrequired

Application Theme ID to export

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

Responses

success

Bodyapplication/json
urlstring
Example: "https://storage.example.com/theme-export.zip"
metaobject
Response
application/json
{
  "url": "https://storage.example.com/theme-export.zip",
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Import an application theme from zip file

Request

Bodyapplication/json
zip_file_urlstringrequired

URL to a zip file containing a theme

Example: "https://storage.example.com/theme-import.zip"
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_themes/import_zip \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "zip_file_url": "https://storage.example.com/theme-import.zip"
  }'

Responses

success

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 0,
    "company_id": 0,
    "name": "string",
    "description": null,
    "cover_image": "string",
    "status": "string",
    "variables": "string",
    "custom_stylesheet": "string",
    "global_stylesheet": "string",
    "created_at": "string",
    "updated_at": "string",
    "application_theme_templates": [ … ],
    "images": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Gets version diff information

Request

Path
idstringrequired

ID of the theme

Query
versioninteger

Version number to compare with

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

Responses

version diff found

Bodyapplication/json
auditobject
metaobject
Response
application/json
{
  "audit": {
    "version": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "user_id": "string",
    "user_name": "string",
    "changes": {}
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Publishes the theme

Request

Path
idstringrequired

ID of the theme

Query
versionstring

Version of the theme template to publish. If not specified, the latest version will be published.

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_themes/{id}/publish?version=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

versioned template published

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 1,
    "company_id": 123,
    "name": "Modern Theme",
    "description": null,
    "cover_image": "https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file",
    "status": "draft",
    "variables": "{\"primary_color\": \"#ff0000\", \"secondary_color\": \"#00ff00\"}",
    "custom_stylesheet": "body { background-color: #fff; }",
    "global_stylesheet": "h1 { color: #333; }",
    "created_at": "2023-07-24T10:00:00.000Z",
    "updated_at": "2023-07-24T10:00:00.000Z",
    "version": "1.0",
    "outdated": false,
    "versions": [],
    "application_theme_templates": [],
    "images": []
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Upgrade an application theme

Request

Path
idintegerrequired

ID of the theme to upgrade

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

Responses

theme upgraded successfully

Bodyapplication/json
application_themeobject
metaobject
Response
application/json
{
  "application_theme": {
    "id": 1,
    "company_id": 123,
    "name": "Modern Theme",
    "description": null,
    "cover_image": "https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file",
    "status": "draft",
    "variables": "{\"primary_color\": \"#ff0000\", \"secondary_color\": \"#00ff00\"}",
    "custom_stylesheet": "body { background-color: #fff; }",
    "global_stylesheet": "h1 { color: #333; }",
    "created_at": "2023-07-24T10:00:00.000Z",
    "updated_at": "2023-07-24T10:00:00.000Z",
    "version": "1.0",
    "outdated": false,
    "versions": [],
    "application_theme_templates": [],
    "images": []
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

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

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

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

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations