/

Get product by slug

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description

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

product

Operations

Get product by slug

Request

Path

slugstringrequired

Product slug

Example: product-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/products/{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

product retrieved successfully

Bodyapplication/json

statusnumberrequired

Example: 200

productobject(Product)required

product.idintegerrequired

product.titlestringrequired

product.image_urlstring or null

product.image_pathstring or null

product.pricenumber or string or null[ 0 .. 99999999 ]

Default "0.0"

product.cvinteger or null

Default 0

product.taxnumber or string or null

Default "0.0"

product.skustring or null

product.metadataobjectrequired

Default "{}"

product.price_in_currencystringrequired

product.tax_in_currencystringrequired

product.cv_in_currencystringrequired

variantsArray of objects(Variant)required

variants[].idintegerrequired

variants[].titlestring or null

Example: "Variant 1"

variants[].image_urlstring or null

Example: "https://via.placeholder.com/150"

variants[].image_pathstring or null

Example: "https://via.placeholder.com/150"

variants[].skustring or null

Example: "SKU-123456"

variants[].primary_imagestring or null

Example: "https://via.placeholder.com/150"

variants[].pricenumber or string or null

Example: 100

variants[].price_in_currencystringrequired

Example: "USD 100.00"

variants[].optionsArray of objectsrequired

variants[].options[].titlestring

Example: "Size"

variants[].options[].valuestring

Example: "XL"

subscription_plansArray of objects(Commerce::SubscriptionPlan)required

subscription_plans[].idintegerrequired

subscription_plans[].namestringrequired

Example: "Test Subscription Plan"

subscription_plans[].billing_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plans[].billing_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plans[].billing_frequency_in_wordsstringrequired

Example: "2 Months"

subscription_plans[].shipping_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plans[].shipping_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plans[].volume_intervalinteger[ 1 .. 29 ]required

Default 1

Example: 1

subscription_plans[].volume_interval_unitstringrequired

Possible values: day, week, month, year

Default "month"

Example: "day"

subscription_plans[].trial_periodinteger or null>= 1

Example: 1

subscription_plans[].trial_period_unitstring or null

Possible values: day, week, month, year

Example: "day"

subscription_plans[].split_volumebooleanrequired

Default false

Example: true

subscription_plans[].allow_skippingboolean or null

Default true

Example: true

subscription_plans[].max_skipsinteger or null>= 1

Example: 1

subscription_plans[].price_adjustment_typestring or null

Example: "percentage or fixed_amount"

subscription_plans[].price_adjustment_amountnumber or null

Example: 10

subscription_plans[].activeboolean or null

Default true

Example: true

subscription_plans[].company_defaultboolean or null

Default false

Example: false

subscription_plans[].created_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plans[].updated_atstring(date-time)required

Example: "2025-03-10T00:00:00Z"

subscription_plans[].products_countinteger or null

Example: 10

subscription_plans[].subscribers_countinteger or null

Example: 10

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,
  "product": {
    "id": 0,
    "title": "string",
    "image_url": "string",
    "image_path": "string",
    "price": "0.0",
    "cv": 0,
    "tax": "0.0",
    "sku": "string",
    "metadata": "{}",
    "price_in_currency": "string",
    "tax_in_currency": "string",
    "cv_in_currency": "string"
  },
  "variants": [
    { … }
  ],
  "subscription_plans": [
    { … }
  ],
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

session

Operations

settings

Operations

widgets

Operations