Clone an 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

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

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

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/application_themes?page=1&per_page=10' \
  -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://docs.fluid.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",
    "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

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/application_themes/{id}' \
  -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",
    "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://docs.fluid.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",
    "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://docs.fluid.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://docs.fluid.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",
    "application_theme_templates": [ … ],
    "images": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Get current active application theme

Request

curl -i -X GET \
  https://docs.fluid.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",
    "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://docs.fluid.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"
  },
  "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://docs.fluid.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://docs.fluid.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"
  }
}

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

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

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

Fluid Commerce APIs (1.0)

Agreements

ApplePay

Application Themes

List application themes

Request

Responses

Was this helpful?

Create an application theme

RequestExpand all

Responses

Was this helpful?

Get an application theme

Request

Responses

Was this helpful?

Update an application theme

RequestExpand all

Responses

Was this helpful?

Delete an application theme

Request

Responses

Was this helpful?

Clone an application theme

Request

Responses

Was this helpful?

Get current active application theme

Request

Responses

Was this helpful?

Import an application theme

Request

Responses

Was this helpful?

Export an application theme

Request

Responses

Was this helpful?

Import an application theme from zip file

Request

Responses

Was this helpful?

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Carts

Company Custom Catch Ups

Company Discounts

Company Droplets

Company Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

Domains

Drop Zones

Droplets

Enrollment Packs

Enrollments

Fantasy Points

Fluid Pay

GlobalEmbeds

Inventory Levels

Multi-Factor Authentications

Notifications

Order Fulfillments

Orders

Pages

Payment

Payment Accounts

Request

Request