Trainings

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

Share Statistics

Share statistics endpoints for media, products, playlists, categories, collections, posts, pages, and enrollment packs

Address Fields

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company

Operations

Company Countries

Operations

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GitHub Installations

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding Info

Operations

Option Values

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments Reports

Operations

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subdomains

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Trainings

Operations

List all trainings

Request

Query
search_querystring

Search trainings by title, description, tags, or category

activeboolean

Filter trainings by active status

sorted_bystring

Sort trainings (e.g., 'created_at_desc', 'title_asc', 'active_desc', 'views_desc')

with_typestring

Filter trainings by type (e.g., 'image', 'video', 'pdf')

pageinteger> 0

Page number for pagination

per_pageinteger( 0 .. 100 ]

Number of records per page

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/trainings?active=true&page=0&per_page=100&search_query=string&sorted_by=string&with_type=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

trainings found with with_type filter

Bodyapplication/json
trainingsArray of objects(Medium)required
trainings[].​idintegerrequired
trainings[].​slugstring or null
trainings[].​custom_slugbooleanrequired
Default false
trainings[].​titlestringrequired
trainings[].​kindstring or null
trainings[].​media_typestringrequired
trainings[].​media_formatstringrequired
trainings[].​image_urlstring or null
trainings[].​video_urlstring or null
trainings[].​pdf_urlstring or null
trainings[].​powerpoint_urlstring or null
trainings[].​durationinteger or null
Default 0
trainings[].​activeboolean or null
Default true
trainings[].​canonical_urlstringrequired
trainings[].​descriptionstring or null
trainings[].​subtitlesobject or null
Default "{}"
trainings[].​comments_countintegerrequired
trainings[].​settingsobject or null
trainings[].​created_atstring(date-time)required
trainings[].​viewsintegerrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
meta.​paginationobject
Response
application/json
{
  "trainings": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

Create a training

Request

Bodyapplication/jsonrequired
trainingobjectrequired
training.​user_idinteger
training.​languagestringnon-empty
training.​image_urlstringnon-empty
training.​video_urlstringnon-empty
training.​pdf_urlstringnon-empty
training.​powerpoint_urlstringnon-empty
training.​titlestringnon-empty
training.​descriptionstringnon-empty
training.​activeboolean
training.​compressed_image_urlstringnon-empty
training.​prompts_enabledboolean
training.​kindstringnon-empty
training.​visibilitystringnon-empty
training.​cta_enabledboolean
training.​cta_action_typestringnon-empty
training.​cta_urlstringnon-empty
training.​cta_button_textstringnon-empty
training.​slugnull or string
training.​custom_slugboolean
training.​no_indexboolean
training.​display_commentsboolean
training.​categorystringnon-empty
training.​display_shopboolean
training.​dam_asset_idinteger
training.​dam_asset_codestringnon-empty
training.​lead_captureboolean
training.​video_shopping_enabledboolean
training.​application_theme_template_idinteger
training.​publish_atnull or string(time)
training.​settingsobject
training.​labelobject
training.​subtitlesArray of objects
training.​available_countriesArray of strings
training.​tags_attributesArray of objects
training.​prompts_attributesArray of objects
training.​attached_shareables_attributesArray of objects
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/trainings \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "training": {
      "user_id": 0,
      "language": "string",
      "image_url": "string",
      "video_url": "string",
      "pdf_url": "string",
      "powerpoint_url": "string",
      "title": "string",
      "description": "string",
      "active": true,
      "compressed_image_url": "string",
      "prompts_enabled": true,
      "kind": "string",
      "visibility": "string",
      "cta_enabled": true,
      "cta_action_type": "string",
      "cta_url": "string",
      "cta_button_text": "string",
      "slug": null,
      "custom_slug": true,
      "no_index": true,
      "display_comments": true,
      "category": "string",
      "display_shop": true,
      "dam_asset_id": 0,
      "dam_asset_code": "string",
      "lead_capture": true,
      "video_shopping_enabled": true,
      "application_theme_template_id": 0,
      "publish_at": null,
      "settings": {},
      "label": {
        "id": 0,
        "title": "string"
      },
      "subtitles": [
        {
          "lang": "string",
          "src": "string"
        }
      ],
      "available_countries": [
        "string"
      ],
      "tags_attributes": [
        {
          "id": 0,
          "_destroy": true,
          "name": "string"
        }
      ],
      "prompts_attributes": [
        {
          "id": 0,
          "title": "string",
          "content": "string",
          "_destroy": true
        }
      ],
      "attached_shareables_attributes": [
        {
          "id": 0,
          "attachment_type": "string",
          "attachment_id": 0,
          "timestamp": "string",
          "_destroy": true
        }
      ]
    }
  }'

Responses

training created

Bodyapplication/json
trainingobjectrequired
training.​idintegerrequired
training.​titlestringrequired
training.​activebooleanrequired
training.​media_typestringrequired
Value"training"
training.​property name*anyadditional property
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "training": {
    "id": 0,
    "title": "string",
    "active": true,
    "media_type": "training"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get a training

Request

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

Responses

training found

Bodyapplication/json
idintegerrequired
slugstring or null
custom_slugbooleanrequired
Default false
titlestringrequired
kindstring or null
media_typestringrequired
media_formatstringrequired
image_urlstring or null
video_urlstring or null
pdf_urlstring or null
powerpoint_urlstring or null
durationinteger or null
Default 0
activeboolean or null
Default true
canonical_urlstringrequired
descriptionstring or null
subtitlesobject or null
Default "{}"
comments_countintegerrequired
settingsobject or null
created_atstring(date-time)required
viewsintegerrequired
application_theme_template_idinteger or null
countriesArray of arraysrequired
tagsArray of arraysrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "id": 0,
  "slug": "string",
  "custom_slug": false,
  "title": "string",
  "kind": "string",
  "media_type": "string",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "powerpoint_url": "string",
  "duration": 0,
  "active": true,
  "canonical_url": "string",
  "description": "string",
  "subtitles": "{}",
  "comments_count": 0,
  "settings": {},
  "created_at": "2019-08-24T14:15:22Z",
  "views": 0,
  "application_theme_template_id": 0,
  "countries": [],
  "tags": [],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a training

Request

Path
idintegerrequired
Bodyapplication/jsonrequired
trainingobjectrequired
training.​user_idinteger
training.​image_urlnull or string
training.​video_urlnull or string
training.​pdf_urlnull or string
training.​powerpoint_urlstringnon-empty
training.​titlestringnon-empty
training.​descriptionnull or string
training.​activeboolean
training.​compressed_image_urlstringnon-empty
training.​prompts_enabledboolean
training.​kindstringnon-empty
training.​visibilitystringnon-empty
training.​cta_enabledboolean
training.​cta_action_typestringnon-empty
training.​cta_urlnull or string
training.​cta_button_textstringnon-empty
training.​slugnull or string
training.​custom_slugboolean
training.​no_indexboolean
training.​display_commentsboolean
training.​categorystringnon-empty
training.​display_shopboolean
training.​dam_asset_idinteger
training.​dam_asset_codestringnon-empty
training.​lead_captureboolean
training.​video_shopping_enabledboolean
training.​application_theme_template_idinteger
training.​publish_atnull or string(time)
training.​settingsobject
training.​labelobject
training.​subtitlesArray of objects
training.​available_countriesArray of strings
training.​tags_attributesArray of objects
training.​prompts_attributesArray of objects
training.​attached_shareables_attributesArray of objects
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v202506/trainings/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "training": {
      "user_id": 0,
      "image_url": null,
      "video_url": null,
      "pdf_url": null,
      "powerpoint_url": "string",
      "title": "string",
      "description": null,
      "active": true,
      "compressed_image_url": "string",
      "prompts_enabled": true,
      "kind": "string",
      "visibility": "string",
      "cta_enabled": true,
      "cta_action_type": "string",
      "cta_url": null,
      "cta_button_text": "string",
      "slug": null,
      "custom_slug": true,
      "no_index": true,
      "display_comments": true,
      "category": "string",
      "display_shop": true,
      "dam_asset_id": 0,
      "dam_asset_code": "string",
      "lead_capture": true,
      "video_shopping_enabled": true,
      "application_theme_template_id": 0,
      "publish_at": null,
      "settings": {
        "player": {
          "primary_color": "string",
          "button_border_radius": "string",
          "control_bar_height": "string",
          "progress_color": "string",
          "volume_color": "string",
          "show_controls": true,
          "autoplay": true,
          "loop": true,
          "muted": true,
          "preload": "string",
          "playback_rates": "string",
          "show_remaining_time": true,
          "responsive": true,
          "fluid": true
        },
        "embed": {
          "behavior": "string",
          "responsive": true,
          "width": "string",
          "height": "string",
          "show_controls": true,
          "autoplay": true,
          "loop": true
        },
        "cta": {
          "enabled": true,
          "type": "string",
          "url": null,
          "button_description": null,
          "button_text": "string",
          "button_color": "string"
        },
        "fair_share": {
          "bg_color": "string",
          "rep_name": "string",
          "rep_avatar": "string",
          "message": "string"
        },
        "live_chat": {
          "enabled": true,
          "color": "string",
          "welcome_message": "string"
        },
        "thumbnail": {
          "show_title": true,
          "show_description": true
        },
        "seo": {
          "title": "string",
          "description": "string",
          "image_url": "string",
          "image_path": "string",
          "block_crawler": true
        }
      },
      "label": {
        "id": 0,
        "title": "string"
      },
      "subtitles": [
        {
          "lang": "string",
          "src": "string"
        }
      ],
      "available_countries": [
        "string"
      ],
      "tags_attributes": [
        {
          "id": 0,
          "_destroy": true,
          "name": "string"
        }
      ],
      "prompts_attributes": [
        {
          "id": 0,
          "title": "string",
          "content": "string",
          "_destroy": true
        }
      ],
      "attached_shareables_attributes": [
        {
          "id": 0,
          "attachment_type": "string",
          "attachment_id": 0,
          "timestamp": "string",
          "_destroy": true
        }
      ]
    }
  }'

Responses

training updated

Bodyapplication/json
trainingobjectrequired
training.​idintegerrequired
training.​titlestringrequired
training.​activebooleanrequired
training.​media_typestringrequired
Value"training"
training.​property name*anyadditional property
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "training": {
    "id": 0,
    "title": "string",
    "active": true,
    "media_type": "training"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a training

Request

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

Responses

training deleted

Bodyapplication/json
trainingobjectrequired
training.​idintegerrequired
training.​messagestringrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "training": {
    "id": 0,
    "message": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

Get a specific media

Request

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

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

Responses

Media retrieved successfully

Bodyapplication/json
idintegerrequired
user_idinteger or null
titlestringrequired
descriptionobject or null
strippedstring or null
media_typestringrequired
Enum"share""update""training""upload"
media_formatstring or null
image_urlstring or null
video_urlstring or null
pdf_urlstring or null
kindstring or null
activebooleanrequired
visibilityinteger or null
share_linkstring or null
preview_linkstring or null
viewsintegerrequired
leadsintegerrequired
watchobject or null
video_statusstring or null
durationinteger or null
cta_urlstring or null
cta_button_textstring or null
cta_enabledbooleanrequired
cta_action_typestring or null
video_shopping_enabledbooleanrequired
prompts_enabledbooleanrequired
ranksArray of strings
settingsobject or null
application_theme_template_idinteger or null
created_atstring(date-time)required
subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects
tagsArray of objects
slugstring or null

URL-friendly slug for the media item

canonical_urlstring or null

The primary URL for accessing this media item on the company's website

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects
commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

publish_atstring or null(date-time)

Scheduled publish date/time. If set to a future date, the media will not be publicly accessible until that time.

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "canonical_url": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string",
  "publish_at": "2019-08-24T14:15:22Z"
}