Lists asset paths for an existing asset

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

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

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 - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/dam/assets/{code}/asset_paths/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

asset path destroyed

Creates a new asset

Request

Bodymultipart/form-datarequired

Binary file upload for the digital asset. Maximum file size: 100MB.

string

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

Responses

asset created

Retrieves an asset by code

Request

Path

codestringrequired

Unique code identifier for the asset

Example: LOGO-001

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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"
  }
}

Returns all variants for an existing asset

Request

Path

codestringrequired

Asset code

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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

Bodymultipart/form-datarequired

filestring(binary)required

Binary file upload for the variant. Maximum file size: 100MB.

tagsstring

Optional comma-separated list of tags (e.g., 'en,en-us'). No square brackets or quotes allowed.

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/dam/assets/{code}/variants' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F tags=string

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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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",
    "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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/dam/assets/{code}/variants/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

variant deleted

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

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Fluid Commerce APIs (1.0)

Admins

Agreements

ApplePay

Application Theme Templates

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Callback Schemas

Carts

Categories

Collections

Companies

Company Admins

Company Custom Catch Ups

Company Discounts

Company Mobile Widgets

Company Pages

Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Company Webhook Events

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

DAM Query

Dam

Lists asset paths for an existing asset

Request

Responses

Was this helpful?

Creates asset paths for an existing asset

Request

Responses

Was this helpful?

Destroys an asset path

Request

Responses

Was this helpful?

Creates a new asset

Request

Responses

Was this helpful?

Retrieves an asset by code

Request

Responses

Was this helpful?

Updates an existing asset

Request

Responses

Was this helpful?

Deletes an asset

Request

Responses

Was this helpful?

Returns all variants for an existing asset

Request

Responses

Was this helpful?

Creates variants for an existing asset

Request

Responses

Was this helpful?

Returns a specific variant for an existing asset

Request

Responses

Was this helpful?

Updates tags for a specific variant

Request

Responses

Was this helpful?

Destroys a variant for an existing asset