product

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
company.api.json
company.api.yaml
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

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

Menus

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

Search

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

Get product by slug in a foreign local includes the correct variants

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://docs.fluid.app/_mock/docs/apis/company.api/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.​cvinteger or null
Default 0
product.​taxnumber or string or null
Default "0.0"
product.​skustring or null
product.​metadataobjectrequired
Default "{}"
product.​external_idstring or null
product.​pricenumber or string or null[ 0 .. 99999999 ]
Default "0.0"
product.​introductionstring or null
product.​price_in_currencystringrequired
product.​tax_in_currencystringrequired
product.​cv_in_currencystringrequired
product.​metafieldsArray of objects(LegacyMetafield)required
product.​metafields[].​idintegerrequired
product.​metafields[].​namespacestring<= 20 characters^[a-zA-Z0-9_]+$required

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"
product.​metafields[].​keystring<= 30 characters^[a-zA-Z0-9_]+$required

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"
product.​metafields[].​valuestring or objectrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"
product.​metafields[].​value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"
product.​metafields[].​descriptionstring or null

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"
product.​metafields[].​owner_typestringrequired

The type of resource that this metafield belongs to (polymorphic association).

Example: "Product"
product.​metafields[].​owner_idintegerrequired

The ID of the specific resource that this metafield belongs to.

Example: 12345
product.​metafields[].​created_atstring(date-time)required

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"
product.​metafields[].​updated_atstring(date-time)required

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"
product.​metafields[].​metafield_definitionobject or null(MetafieldDefinition)
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[].​allow_max_billing_cyclesbooleanrequired
Default false
Example: true
subscription_plans[].​max_billing_cyclesinteger or null
Example: 3
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",
    "cv": 0,
    "tax": "0.0",
    "sku": "string",
    "metadata": "{}",
    "external_id": "string",
    "price": "0.0",
    "introduction": "string",
    "price_in_currency": "string",
    "tax_in_currency": "string",
    "cv_in_currency": "string",
    "metafields": [ … ]
  },
  "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

url

Operations

widgets

Operations