Retrieve popup widget

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://docs.fluid.app/_mock/docs/apis/public/

https://api.fluid.app/

Orders

Operations

affiliate

Operations

carts

Operations

checkout

Operations

commerce

Operations

enrollment-packs

Operations

events

Operations

lead

Operations

page

Operations

url

Operations

fingerprint

Operations

media

Operations

playlist

Operations

product

Operations

root_themes

Operations

session

Operations

settings

Operations

widgets

Operations

Retrieve banner widget

Request

Bodyapplication/json

urlstringrequired

Example: "https://example.com/products/123"

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://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/widgets/banners \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://example.com/products/123",
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

banner widget found

Bodyapplication/json

bannerBannerWidget (object) or nullrequired

One of:

A banner widget

banner.placementstringrequired

Where the banner appears on the page

Enum"top""bottom"

banner.behaviorstringrequired

How the banner behaves on the page

Enum"persistent""dismissible""sticky"

banner.contentobjectrequired

banner.content.banner_textstring

Example: "Welcome to our site!"

banner.content.button_textstring

Example: "Learn More"

banner.content.button_urlstring(uri)

Example: "https://example.com/learn"

banner.stylesobjectrequired

banner.styles.background_colorstring

Example: "#ffffff"

banner.styles.text_colorstring

Example: "#000000"

banner.styles.border_radiusstring

Example: "8px"

metaobjectrequired

meta.request_idstring or null

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "banner": {
    "placement": "top",
    "behavior": "persistent",
    "content": { … },
    "styles": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieve cart widget

Request

Bodyapplication/json

urlstringrequired

Example: "https://example.com/products/123"

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://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/widgets/carts \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://example.com/products/123",
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

cart widget found

Bodyapplication/json

cartCartWidget (object) or nullrequired

One of:

A cart widget

cart.placementstringrequired

Which side of the screen the cart slides out from

Enum"right""left"

cart.contentobjectrequired

cart.stylesobjectrequired

cart.triggerobjectrequired

metaobjectrequired

meta.request_idstring or null

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "cart": {
    "placement": "right",
    "content": {},
    "styles": {},
    "trigger": {}
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieve chat widget

Request

Bodyapplication/json

urlstringrequired

Example: "https://example.com/products/123"

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://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/widgets/chats \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://example.com/products/123",
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

chat widget found

Bodyapplication/json

chatChatWidget (object) or nullrequired

One of:

A chat widget

chat.contentobjectrequired

chat.stylesobjectrequired

chat.triggerobjectrequired

chat.lead_captureobjectrequired

metaobjectrequired

meta.request_idstring or null

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "chat": {
    "content": {},
    "styles": {},
    "trigger": {},
    "lead_capture": {}
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieve popup widget

Request

Bodyapplication/json

urlstringrequired

Example: "https://example.com/products/123"

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://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/widgets/popups \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://example.com/products/123",
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

popup widget found

Bodyapplication/json

popupPopupWidget (object) or nullrequired

One of:

A popup widget

popup.placementstringrequired

Where the popup should be displayed

Value"modal"

popup.contentobjectrequired

popup.stylesobjectrequired

popup.behaviorstringrequired

When the popup should be displayed

Value"timer"

popup.lead_captureobjectrequired

Lead capture configuration for the popup

metaobjectrequired

meta.request_idstring or null

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "popup": {
    "placement": "modal",
    "content": {},
    "styles": {},
    "behavior": "timer",
    "lead_capture": {}
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Fluid SDK API Documentation (0.0.6)

Orders

affiliate

carts

checkout

commerce

enrollment-packs

events

lead

page

url

fingerprint

media

playlist

product

root_themes

session

settings

widgets

Retrieve banner widget

Request

Responses

Was this helpful?

Retrieve cart widget

Request

Responses

Was this helpful?

Retrieve chat widget

Request

Responses

Was this helpful?

Retrieve popup widget

Request

Responses

Was this helpful?

Fluid SDK API Documentation (0.0.6)

Orders

affiliate

carts

checkout

commerce

enrollment-packs

events

lead

page

url

fingerprint

media

playlist

product

root_themes

session

settings

widgets

Retrieve banner widget

RequestExpand all

Responses

Was this helpful?

Retrieve cart widget

RequestExpand all

Responses

Was this helpful?

Retrieve chat widget

RequestExpand all

Responses

Was this helpful?

Retrieve popup widget

RequestExpand all

Responses

Was this helpful?

Request

Request

Request

Request