Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description

public.json

public.yaml

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://fluid-commerce.redocly.app/_mock/docs/apis/public/

Production API server

https://api.fluid.app/

Local development server

https://api.fluid.test/

Orders

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

lead

Operations

page

Operations

url

Operations

fingerprint

Operations

media

Operations

playlist

Operations

Get playlist by slug

Request

Path

slugstringrequired

Playlist slug

Example: playlist-slug

Bodyapplication/json

metadataobject(RequestMetadata)required

metadata.fluid_shopstringrequired

Example: "myshop"

metadata.fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required

Example: "fs_szwdDuRbqEe7AV7sXk7vVq"

metadata.fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)

Example: "en_US"

metadata.fluid_journeystring

metadata.attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)

Any of:

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/public/api/public/v2025-06/playlists/{slug}' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

playlist retrieved successfully

Bodyapplication/json

statusnumberrequired

Example: 200

libraryobject(Library)required

library.idintegerrequired

library.slugstring or null

library.titlestringrequired

library.library_itemsArray of objects(LibraryItem)required

library.library_items[].typestringrequired

library.library_items[].itemobjectrequired

library.productsArray of objects(Product)required

library.products[].idintegerrequired

library.products[].titlestringrequired

library.products[].image_urlstring or null

library.products[].image_pathstring or null

library.products[].pricenumber or string or null[ 0 .. 99999999 ]

Default "0.0"

library.products[].cvinteger or null

Default 0

library.products[].taxnumber or string or null

Default "0.0"

library.products[].skustring or null

library.products[].metadataobjectrequired

Default "{}"

library.products[].price_in_currencystringrequired

library.products[].tax_in_currencystringrequired

library.products[].cv_in_currencystringrequired

library.enrollment_packsArray of objects(EnrollmentPack)required

library.enrollment_packs[].idintegerrequired

library.enrollment_packs[].titlestringrequired

library.enrollment_packs[].statusstringrequired

library.enrollment_packs[].image_urlstringrequired

metadataobject(ResponseMetadata)required

metadata.fluid_shopstringrequired

metadata.fluid_sessionstringrequired

metadata.fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)

Example: "en_US"

metadata.request_uuidstring(uuid)required

metadata.timestampstringrequired

Response

application/json

{
  "status": 200,
  "library": {
    "id": 0,
    "slug": "string",
    "title": "string",
    "library_items": [ … ],
    "products": [ … ],
    "enrollment_packs": [ … ]
  },
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

Get playlist by slug (deprecated)Deprecated

Request

Bodyapplication/json

libraryobjectrequired

library.idstring

Playlist slug

Example: "test-playlist-slug"

metadataobject(RequestMetadata)required

metadata.fluid_shopstringrequired

Example: "myshop"

metadata.fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required

Example: "fs_szwdDuRbqEe7AV7sXk7vVq"

metadata.fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)

Example: "en_US"

metadata.fluid_journeystring

metadata.attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)

Any of:

curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/public/api/public/v2025-06/playlists \
  -H 'Content-Type: application/json' \
  -d '{
    "library": {
      "id": "test-playlist-slug"
    },
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

playlist retrieved successfully

Bodyapplication/json

statusnumberrequired

Example: 200

libraryobject(Library)required

library.idintegerrequired

library.slugstring or null

library.titlestringrequired

library.library_itemsArray of objects(LibraryItem)required

library.library_items[].typestringrequired

library.library_items[].itemobjectrequired

library.productsArray of objects(Product)required

library.products[].idintegerrequired

library.products[].titlestringrequired

library.products[].image_urlstring or null

library.products[].image_pathstring or null

library.products[].pricenumber or string or null[ 0 .. 99999999 ]

Default "0.0"

library.products[].cvinteger or null

Default 0

library.products[].taxnumber or string or null

Default "0.0"

library.products[].skustring or null

library.products[].metadataobjectrequired

Default "{}"

library.products[].price_in_currencystringrequired

library.products[].tax_in_currencystringrequired

library.products[].cv_in_currencystringrequired

library.enrollment_packsArray of objects(EnrollmentPack)required

library.enrollment_packs[].idintegerrequired

library.enrollment_packs[].titlestringrequired

library.enrollment_packs[].statusstringrequired

library.enrollment_packs[].image_urlstringrequired

metadataobject(ResponseMetadata)required

metadata.fluid_shopstringrequired

metadata.fluid_sessionstringrequired

metadata.fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)

Example: "en_US"

metadata.request_uuidstring(uuid)required

metadata.timestampstringrequired

Response

application/json

{
  "status": 200,
  "library": {
    "id": 0,
    "slug": "string",
    "title": "string",
    "library_items": [ … ],
    "products": [ … ],
    "enrollment_packs": [ … ]
  },
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

product

Operations

session

Operations

settings

Operations

widgets

Operations

Fluid SDK API Documentation (0.0.6)

Orders

affiliate

carts

checkout

enrollment-packs

events

lead

page

url

fingerprint

media

playlist

Get playlist by slug

Request

Responses

Was this helpful?

Get playlist by slug (deprecated)Deprecated

Request

Responses

Was this helpful?

product

session

settings

widgets

Fluid SDK API Documentation (0.0.6)

Orders

affiliate

carts

checkout

enrollment-packs

events

lead

page

url

fingerprint

media

playlist

Get playlist by slug

RequestExpand all

Responses

Was this helpful?

Get playlist by slug (deprecated)Deprecated

RequestExpand all

Responses

Was this helpful?

product

session

settings

widgets

Request

Request