Fluid Company APIs (1.0)

The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.

For APIs that authenticate with User tokens, see the Rep APIs documentation.

Download OpenAPI description
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/company.api/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Activities

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Resources

Operations

Application Theme Templates

Operations

Application Themes

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 Countries

Operations

Contacts

Operations

Conversations

Operations

Countries

Operations

Currencies

Operations

Customer Notes

Operations

Customer Orders

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Lists asset paths for an existing asset

Request

Path
codestringrequired

Asset code

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/asset_paths' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

asset paths retrieved

Bodyapplication/json
asset_pathsArray of objects(Dam::AssetPath)
metaobject
Response
application/json
{ "asset_paths": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Creates asset paths for an existing asset

Request

Path
codestringrequired

Asset code

Bodyapplication/json
asset_pathsArray of stringsrequired

Array of tree paths to create

Example: ["homepage.hero.logo","product.gallery.main"]
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/asset_paths' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "asset_paths": [
      "homepage.hero.logo",
      "product.gallery.main"
    ]
  }'

Responses

mixed valid and invalid paths

Destroys an asset path

Request

Path
codestringrequired

Asset code

idintegerrequired

Asset path ID

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/asset_paths/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

asset path destroyed

Creates a DAM asset from ImageKit upload metadata

Request

Bodyapplication/jsonrequired
assetobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/backfill_imagekit \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "asset": {
      "imagekit_file_id": "ik_file_123456789",
      "imagekit_url": "https://ik.imagekit.io/company/image.jpg",
      "name": "Product Hero Image",
      "description": "High-resolution product image",
      "tags": "en,en-us,product,featured",
      "file_size": 1024000,
      "mime_type": "image/jpeg",
      "width": 1920,
      "height": 1080
    }
  }'

Responses

asset backfilled successfully

Bodyapplication/json
assetobject(Dam::Asset)
metaobject
Response
application/json
{ "asset": { "id": 0, "code": "ABC789", "name": "string", "description": "string", "category": "images", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "default_variant_id": "string", "canonical_path": "string", "company": "string", "default_variant_url": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Errors when multiple asset types are provided

Request

Bodymultipart/form-data

Binary file upload for the digital asset. Maximum file size: 100MB. Required when using asset parameter group.

string
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data'

Responses

placeholder asset created with minimal parameters

Retrieves an asset by code

Request

Path
codestringrequired

Unique code identifier for the asset

Example: LOGO-001
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

asset found

Bodyapplication/json
assetobject(Dam::Asset)
metaobject
Response
application/json
{ "asset": { "id": 0, "code": "ABC789", "name": "string", "description": "string", "category": "images", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "default_variant_id": "string", "canonical_path": "string", "company": "string", "default_variant_url": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Updates an existing asset

Request

Path
codestringrequired

Unique code identifier for the asset

Example: ACMELG
Bodyapplication/jsonrequired
namestring

Updated display name for the asset

Example: "Updated Asset Name"
descriptionstring

Updated description for the asset

Example: "Updated asset description"
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Asset Name",
    "description": "Updated asset description"
  }'

Responses

asset updated with partial data

Bodyapplication/json
assetobject(Dam::Asset)
metaobject
Response
application/json
{ "asset": { "id": 0, "code": "ABC789", "name": "string", "description": "string", "category": "images", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "default_variant_id": "string", "canonical_path": "string", "company": "string", "default_variant_url": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Deletes an asset

Request

Path
codestringrequired

Unique code identifier for the asset

Example: ACMELG
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

asset deleted successfully

Bodyapplication/json
assetobject(Dam::Asset)
metaobject
Response
application/json
{ "asset": { "id": 0, "code": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Discard an asset (soft delete)

Request

Path
codestringrequired

Unique code identifier for the asset

Example: ACMELG
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/discard' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

asset discarded successfully

Bodyapplication/json
assetobject(Dam::Asset)
metaobject
Response
application/json
{ "asset": { "id": 0, "code": "string", "discarded_at": "2019-08-24T14:15:22Z", "name": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Creates ImageKit authentication credentials for large file uploads

Request

curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/imagekit_auth \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

authentication credentials created successfully

Bodyapplication/json
tokenstring
signaturestring
expireinteger
folderstring
metaobject
Response
application/json
{ "token": "string", "signature": "string", "expire": 0, "folder": "string", "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Returns all variants for an existing asset

Request

Path
codestringrequired

Asset code

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/variants' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

variants retrieved

Creates variants for an existing asset

Request

Path
codestringrequired

Unique asset code identifier

Body
arrays
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/variants' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data'

Responses

variants created

Bodyapplication/json
variantsArray of Dam::Variant (object) or objects
metaobject
Response
application/json
{ "variants": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Returns a specific variant for an existing asset

Request

Path
codestringrequired

Asset code

idstringrequired

Variant ID

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/variants/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

non-default variant retrieved

Updates tags for a specific variant

Request

Path
codestringrequired

Asset code

idstringrequired

Variant ID

Bodyapplication/json
tagsArray of strings

Array of tag names to assign to the variant (replaces all existing tags)

curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/variants/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tags": [
      "string"
    ]
  }'

Responses

variant updated without tags parameter

Bodyapplication/json
variantobject(Dam::Variant)
metaobject
Response
application/json
{ "variant": { "id": "string", "file_name": "string", "mime_type": "string", "metadata": {}, "checksum": "string", "tags": [], "default": true, "url": "string", "media_type": "string", "is_original": true, "is_text": true, "content": "string", "updated_at": "2019-08-24T14:15:22Z" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Destroys a variant for an existing asset

Request

Path
codestringrequired

Asset code

idstringrequired

Variant ID

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{code}/variants/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

variant deleted

Discards a variant for an existing asset (soft delete)

Request

Path
asset_codestringrequired

Asset code

idstringrequired

Variant ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/dam/assets/{asset_code}/variants/{id}/discard' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

variant discarded successfully

Default MySites

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

Events

Operations

FairShare Order Journey

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

Global Embeds

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

MCC Codes

Operations

Media

Operations

Messages

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Points

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Product Bundles

Operations

Product Images

Operations

Product Subscription Plans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Recipients

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tiles

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variant Images

Operations

Variant Inventory Levels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations