ApplicationThemeTemplates
/
Get available variables for a theme template

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 Themes

Operations

ApplicationThemeTemplates

Operations

Lists all theme templates

Request

Query
application_theme_idstringrequired

ID of the application theme

curl -i -X GET \
  'https://fluid-commerce.redocly.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://fluid-commerce.redocly.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",
      "themeable_type": "product",
      "content": "string",
      "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",
    "default": false,
    "content": "<html><body>This is a default template</body></html>",
    "stylesheet": "body { background-color: #fff; }",
    "variables": {},
    "themeable_type": "product",
    "status": "draft",
    "url": "https://test.example.com/home?preview=true&theme_template_id=1",
    "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

Query
versionstring

Version of the theme template to retrieve

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_theme_templates/{id}?version=string' \
  -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",
    "default": false,
    "content": "<html><body>This is a default template</body></html>",
    "stylesheet": "body { background-color: #fff; }",
    "variables": {},
    "themeable_type": "product",
    "status": "draft",
    "url": "https://test.example.com/home?preview=true&theme_template_id=1",
    "created_at": "2025-05-03T04:58:11Z",
    "updated_at": "2025-05-03T04:58:11Z",
    "versions": [ … ]
  },
  "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

Query
versionstring

Version of the theme template to retrieve

Bodyapplication/json
application_theme_templateobject
publishboolean
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_theme_templates/{id}?version=string' \
  -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",
    "default": false,
    "content": "<html><body>This is a default template</body></html>",
    "stylesheet": "body { background-color: #fff; }",
    "variables": {},
    "themeable_type": "product",
    "status": "draft",
    "url": "https://test.example.com/home?preview=true&theme_template_id=1",
    "created_at": "2025-05-03T04:58:11Z",
    "updated_at": "2025-05-03T04:58:11Z",
    "versions": [ … ]
  },
  "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

Query
versionstring

Version of the theme template to retrieve

curl -i -X DELETE \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_theme_templates/{id}?version=string' \
  -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://fluid-commerce.redocly.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",
    "default": false,
    "content": "<html><body>This is a default template</body></html>",
    "stylesheet": "body { background-color: #fff; }",
    "variables": {},
    "themeable_type": "product",
    "status": "draft",
    "url": "https://test.example.com/home?preview=true&theme_template_id=1",
    "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"
  }
}

Sets a theme template as default

Request

Path
idstringrequired

ID of the theme template to set as default

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

Responses

template set as default

Bodyapplication/json
idinteger
Example: 1
application_theme_idinteger
Example: 1
namestring
Example: "Default Theme Template"
defaultboolean
Example: false
contentstring
Example: "<html><body>This is a default template</body></html>"
stylesheetstring
Example: "body { background-color: #fff; }"
variablesobject
Example: {}
themeable_typestring
Enum"product""medium""enrollment_pack""shop_page""navbar""library""page""components""library_navbar""sections"
Example: "product"
statusstring
Example: "draft"
urlstring or null
Example: "https://test.example.com/home?preview=true&theme_template_id=1"
created_atstring or null(date-time)
Example: "2025-05-03T04:58:11Z"
updated_atstring or null(date-time)
Example: "2025-05-03T04:58:11Z"
metaobject
Response
application/json
{
  "id": 1,
  "application_theme_id": 1,
  "name": "Default Theme Template",
  "default": false,
  "content": "<html><body>This is a default template</body></html>",
  "stylesheet": "body { background-color: #fff; }",
  "variables": {},
  "themeable_type": "product",
  "status": "draft",
  "url": "https://test.example.com/home?preview=true&theme_template_id=1",
  "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://fluid-commerce.redocly.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",
    "default": false,
    "content": "<html><body>This is a default template</body></html>",
    "stylesheet": "body { background-color: #fff; }",
    "variables": {},
    "themeable_type": "product",
    "status": "draft",
    "url": "https://test.example.com/home?preview=true&theme_template_id=1",
    "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
versionstring

Version of the theme template to retrieve

Bodyapplication/json
resourcesArray of objects
application_theme_templateobject
curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_theme_templates/{id}/render_page?version=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resources": [
      {
        "id": 0,
        "type": "product"
      }
    ],
    "application_theme_template": {
      "content": "string",
      "stylesheet": "string",
      "variables": "string"
    }
  }'

Responses

template found

Bodyapplication/json
liquid_contentstring
html_contentstring
page_stylesheetstring

Stylesheet for the rendered page. Includes all the css needed by the page.

template_stylesheetstring

Stylesheet for the template itself.

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

Get available variables for a theme template

Request

Get available variables that can be used in the theme template

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

Responses

available variables found

Bodyapplication/json
available_variablesobject

Object containing available template variables

Example: {"company":{"name":"ACME Inc.","subdomain":"acme"},"template":{"company_name":"ACME Inc.","site_url":"https://example.com"}}
metaobject

Metadata about the request and response

Response
application/json
{
  "available_variables": {
    "company": { … },
    "template": { … }
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Publishes the template

Request

Path
idstringrequired

ID of the theme template

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_theme_templates/{id}/publish?version=string' \
  -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",
    "default": false,
    "content": "<html><body>This is a default template</body></html>",
    "stylesheet": "body { background-color: #fff; }",
    "variables": {},
    "themeable_type": "product",
    "status": "draft",
    "url": "https://test.example.com/home?preview=true&theme_template_id=1",
    "created_at": "2025-05-03T04:58:11Z",
    "updated_at": "2025-05-03T04:58:11Z",
    "versions": [ … ]
  },
  "meta": {
    "request_id": "aec35efe-1cdc-48ac-94e6-616831786625",
    "timestamp": "2025-05-03T04:58:11Z"
  }
}

Returns all available themeables for theme template

Request

Path
idstringrequired
Query
selectedboolean

Filter themeables that are already assigned to this template

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

Responses

returns all themeables

Bodyapplication/json
available_themeablesArray of objects

List of themeables that use the specified template

metaobject

Metadata about the request and response

Response
application/json
{
  "available_themeables": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "pagination": { … }
  }
}

Updates themeable records to be used by the specified template

Request

Path
idstringrequired
Query
query_paramsobject
curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/application_theme_templates/{id}/themeables_update?added_ids=1%2C2&removed_ids=3' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

themeables updated

Bodyapplication/json
removed_countinteger

Number of themeables unassigned from this template

updated_countinteger

Number of themeables assigned to this template

metaobject
Response
application/json
{
  "removed_count": 0,
  "updated_count": 0,
  "meta": {
    "request_id": "aec35efe-1cdc-48ac-94e6-616831786625",
    "timestamp": "2025-05-03T04:58:11Z"
  }
}

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

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

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

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

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations