Variants

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
Languages
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 Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

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 - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

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

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Show variant

Request

Retrieve a specific variant by ID

Path
idintegerrequired

Variant ID

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/variants/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
variantobject(Variant)required
variant.​idintegerrequired
variant.​titlestring or null
Example: "Variant 1"
variant.​image_urlstring or null
Example: "https://via.placeholder.com/150"
variant.​image_pathstring or null
Example: "https://via.placeholder.com/150"
variant.​skustring or null
Example: "SKU-123456"
variant.​primary_imagestring or null
Example: "https://via.placeholder.com/150"
variant.​pricenumber or null
Example: 100
variant.​price_in_currencystringrequired
Example: "USD 100.00"
variant.​optionsArray of objectsrequired
variant.​options[].​titlestring
Example: "Size"
variant.​options[].​valuestring
Example: "XL"
variant.​is_masterboolean or null
Default false
variant.​track_quantityboolean or null
Default false
variant.​bar_codestring or null
variant.​limit_subscriptionboolean or null
Default false
variant.​subscription_max_qtyinteger or null
variant.​customer_limitinteger or null>= 0
Default 0
variant.​keep_sellingboolean or null
Default false
variant.​activebooleanrequired
Default true
variant.​allow_subscriptionbooleanrequired
Default true
variant.​subscription_onlybooleanrequired
Default false
variant.​shipping_included_in_pricebooleanrequired
Default false
variant.​inventory_quantityintegerrequired
Default 0
variant.​option_attrsArray of arraysrequired
variant.​physicalboolean or null
variant.​unit_of_sizestring or null
Example: "cm"
variant.​heightnumber or null
Example: "13"
variant.​widthnumber or null
Example: "6"
variant.​lengthnumber or null
Example: "12"
variant.​unit_of_weightstring or null
Example: "kg"
variant.​weightstring or null
Example: "3.2"
variant.​hs_codestring or null
Example: "3.2"
variant.​buyablebooleanrequired
variant.​imagesArray of arraysrequired
variant.​inventory_levelsArray of arraysrequired
variant.​limit_quantity_per_customerbooleanrequired
variant.​country_of_originobject or null(Country)
variant.​variant_countriesArray of objects(VariantCountry)required
variant.​variant_countries[].​idintegerrequired
variant.​variant_countries[].​variant_idintegerrequired
variant.​variant_countries[].​activeboolean or null
Default true
variant.​variant_countries[].​currency_codestring or null
variant.​variant_countries[].​pricenumber or string or null[ 0 .. 99999999 ]
Default "0.0"
variant.​variant_countries[].​shippingnumber or string or null
Default "0.0"
variant.​variant_countries[].​shipping_timestring or null
variant.​variant_countries[].​subscription_pricenumber or string or null
Default "0.0"
variant.​variant_countries[].​wholesalenumber or string or null
Default "0.0"
variant.​variant_countries[].​wholesale_subscription_pricenumber or string or null
Default "0.0"
variant.​variant_countries[].​cost_of_goods_soldnumber or string or null
Default "0.0"
variant.​variant_countries[].​compare_pricenumber or string or null
Default "0.0"
variant.​variant_countries[].​country_codestringrequired
variant.​variant_countries[].​display_pricestringrequired
variant.​variant_countries[].​display_subscription_pricestringrequired
variant.​variant_countries[].​display_wholesalestringrequired
variant.​variant_countries[].​display_wholesale_subscription_pricestringrequired
variant.​variant_countries[].​cvinteger or null
Default 0
variant.​variant_countries[].​qvinteger or null
Default 0
variant.​variant_countries[].​pc_cvinteger or null
variant.​variant_countries[].​pc_qvinteger or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "variant": {
    "id": 0,
    "title": "Variant 1",
    "image_url": "https://via.placeholder.com/150",
    "image_path": "https://via.placeholder.com/150",
    "sku": "SKU-123456",
    "primary_image": "https://via.placeholder.com/150",
    "price": 100,
    "price_in_currency": "USD 100.00",
    "options": [ … ],
    "is_master": false,
    "track_quantity": false,
    "bar_code": "string",
    "limit_subscription": false,
    "subscription_max_qty": 0,
    "customer_limit": 0,
    "keep_selling": false,
    "active": true,
    "allow_subscription": true,
    "subscription_only": false,
    "shipping_included_in_price": false,
    "inventory_quantity": 0,
    "option_attrs": [],
    "physical": true,
    "unit_of_size": "cm",
    "height": "13",
    "width": "6",
    "length": "12",
    "unit_of_weight": "kg",
    "weight": "3.2",
    "hs_code": "3.2",
    "buyable": true,
    "images": [],
    "inventory_levels": [],
    "limit_quantity_per_customer": true,
    "country_of_origin": { … },
    "variant_countries": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update variant

Request

Update a specific variant with pricing, inventory, and attribute data

Path
idintegerrequired

Variant ID

Bodyapplication/json
variantobjectrequired
variant.​option_attrsArray of strings

Variant option attributes

variant.​skustring

Stock keeping unit

variant.​is_masterboolean

Whether this is the master variant

variant.​titlestring

Variant title

variant.​track_quantityboolean

Whether to track inventory quantity

variant.​bar_codestring

Product barcode

variant.​limit_subscriptionboolean

Whether to limit subscription purchases

variant.​subscription_max_qtyinteger

Maximum subscription quantity

variant.​customer_limitinteger

Customer purchase limit

variant.​keep_sellingboolean

Continue selling when out of stock

variant.​activeboolean

Whether variant is active

variant.​allow_subscriptionboolean

Whether subscription is allowed

variant.​shipping_included_in_priceboolean

Whether shipping is included in price

variant.​subscription_onlyboolean

Whether variant is subscription only

variant.​physicalboolean

Whether the variant is a physical product

variant.​country_of_origin_idinteger

ID of the country where the product originates

variant.​unit_of_sizestring

Unit of measurement for dimensions (e.g., cm, in)

variant.​heightnumber(float)

Product height

variant.​widthnumber(float)

Product width

variant.​lengthnumber(float)

Product length

variant.​unit_of_weightstring

Unit of measurement for weight (e.g., lb, kg)

variant.​weightstring

Product weight

variant.​hs_codestring

Harmonized System code for international trade

variant.​images_attributesArray of objects

Image attachments for the variant

variant.​inventory_levels_attributesArray of objects

Inventory levels for different warehouses

variant.​variant_countries_attributesArray of objectsrequired

Country-specific pricing and settings

variant.​variant_countries_attributes[].​idinteger

Variant country ID (for updates)

variant.​variant_countries_attributes[].​activebooleanrequired

Whether variant is active in country

variant.​variant_countries_attributes[].​country_idintegerrequired

Country ID

variant.​variant_countries_attributes[].​pricenumber(decimal)required

Base price

variant.​variant_countries_attributes[].​wholesalenumber(decimal)

Wholesale price

variant.​variant_countries_attributes[].​compare_pricenumber(decimal)

Compare at price

variant.​variant_countries_attributes[].​cvinteger

Commission value

variant.​variant_countries_attributes[].​qvinteger

Qualification value

variant.​variant_countries_attributes[].​pc_cvinteger

Personal customer CV

variant.​variant_countries_attributes[].​pc_qvinteger

Personal customer QV

variant.​variant_countries_attributes[].​cost_of_goods_soldnumber(decimal)

Cost of goods sold

variant.​variant_countries_attributes[].​shippingnumber(decimal)

Shipping cost

variant.​variant_countries_attributes[].​taxnumber(decimal)

Tax amount

variant.​variant_countries_attributes[].​_destroyboolean

Mark for deletion

curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/variants/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "variant": {
      "option_attrs": [
        "string"
      ],
      "sku": "string",
      "is_master": true,
      "title": "string",
      "track_quantity": true,
      "bar_code": "string",
      "limit_subscription": true,
      "subscription_max_qty": 0,
      "customer_limit": 0,
      "keep_selling": true,
      "active": true,
      "allow_subscription": true,
      "shipping_included_in_price": true,
      "subscription_only": true,
      "physical": true,
      "country_of_origin_id": 0,
      "unit_of_size": "string",
      "height": 0.1,
      "width": 0.1,
      "length": 0.1,
      "unit_of_weight": "string",
      "weight": "string",
      "hs_code": "string",
      "images_attributes": [
        {
          "id": 0,
          "position": 0,
          "image_url": "string",
          "_destroy": true
        }
      ],
      "inventory_levels_attributes": [
        {
          "id": 0,
          "warehouse_id": 0,
          "available": 0,
          "committed": 0,
          "on_hand": 0,
          "unavailable": 0,
          "_destroy": true
        }
      ],
      "variant_countries_attributes": [
        {
          "id": 0,
          "active": true,
          "country_id": 0,
          "price": 0,
          "wholesale": 0,
          "compare_price": 0,
          "cv": 0,
          "qv": 0,
          "pc_cv": 0,
          "pc_qv": 0,
          "cost_of_goods_sold": 0,
          "shipping": 0,
          "tax": 0,
          "_destroy": true
        }
      ]
    }
  }'

Responses

Variant updated successfully

Bodyapplication/json
variantobject(Variant)required
variant.​idintegerrequired
variant.​titlestring or null
Example: "Variant 1"
variant.​image_urlstring or null
Example: "https://via.placeholder.com/150"
variant.​image_pathstring or null
Example: "https://via.placeholder.com/150"
variant.​skustring or null
Example: "SKU-123456"
variant.​primary_imagestring or null
Example: "https://via.placeholder.com/150"
variant.​pricenumber or null
Example: 100
variant.​price_in_currencystringrequired
Example: "USD 100.00"
variant.​optionsArray of objectsrequired
variant.​options[].​titlestring
Example: "Size"
variant.​options[].​valuestring
Example: "XL"
variant.​is_masterboolean or null
Default false
variant.​track_quantityboolean or null
Default false
variant.​bar_codestring or null
variant.​limit_subscriptionboolean or null
Default false
variant.​subscription_max_qtyinteger or null
variant.​customer_limitinteger or null>= 0
Default 0
variant.​keep_sellingboolean or null
Default false
variant.​activebooleanrequired
Default true
variant.​allow_subscriptionbooleanrequired
Default true
variant.​subscription_onlybooleanrequired
Default false
variant.​shipping_included_in_pricebooleanrequired
Default false
variant.​inventory_quantityintegerrequired
Default 0
variant.​option_attrsArray of arraysrequired
variant.​physicalboolean or null
variant.​unit_of_sizestring or null
Example: "cm"
variant.​heightnumber or null
Example: "13"
variant.​widthnumber or null
Example: "6"
variant.​lengthnumber or null
Example: "12"
variant.​unit_of_weightstring or null
Example: "kg"
variant.​weightstring or null
Example: "3.2"
variant.​hs_codestring or null
Example: "3.2"
variant.​buyablebooleanrequired
variant.​imagesArray of arraysrequired
variant.​inventory_levelsArray of arraysrequired
variant.​limit_quantity_per_customerbooleanrequired
variant.​country_of_originobject or null(Country)
variant.​variant_countriesArray of objects(VariantCountry)required
variant.​variant_countries[].​idintegerrequired
variant.​variant_countries[].​variant_idintegerrequired
variant.​variant_countries[].​activeboolean or null
Default true
variant.​variant_countries[].​currency_codestring or null
variant.​variant_countries[].​pricenumber or string or null[ 0 .. 99999999 ]
Default "0.0"
variant.​variant_countries[].​shippingnumber or string or null
Default "0.0"
variant.​variant_countries[].​shipping_timestring or null
variant.​variant_countries[].​subscription_pricenumber or string or null
Default "0.0"
variant.​variant_countries[].​wholesalenumber or string or null
Default "0.0"
variant.​variant_countries[].​wholesale_subscription_pricenumber or string or null
Default "0.0"
variant.​variant_countries[].​cost_of_goods_soldnumber or string or null
Default "0.0"
variant.​variant_countries[].​compare_pricenumber or string or null
Default "0.0"
variant.​variant_countries[].​country_codestringrequired
variant.​variant_countries[].​display_pricestringrequired
variant.​variant_countries[].​display_subscription_pricestringrequired
variant.​variant_countries[].​display_wholesalestringrequired
variant.​variant_countries[].​display_wholesale_subscription_pricestringrequired
variant.​variant_countries[].​cvinteger or null
Default 0
variant.​variant_countries[].​qvinteger or null
Default 0
variant.​variant_countries[].​pc_cvinteger or null
variant.​variant_countries[].​pc_qvinteger or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "variant": {
    "id": 0,
    "title": "Variant 1",
    "image_url": "https://via.placeholder.com/150",
    "image_path": "https://via.placeholder.com/150",
    "sku": "SKU-123456",
    "primary_image": "https://via.placeholder.com/150",
    "price": 100,
    "price_in_currency": "USD 100.00",
    "options": [ … ],
    "is_master": false,
    "track_quantity": false,
    "bar_code": "string",
    "limit_subscription": false,
    "subscription_max_qty": 0,
    "customer_limit": 0,
    "keep_selling": false,
    "active": true,
    "allow_subscription": true,
    "subscription_only": false,
    "shipping_included_in_price": false,
    "inventory_quantity": 0,
    "option_attrs": [],
    "physical": true,
    "unit_of_size": "cm",
    "height": "13",
    "width": "6",
    "length": "12",
    "unit_of_weight": "kg",
    "weight": "3.2",
    "hs_code": "3.2",
    "buyable": true,
    "images": [],
    "inventory_levels": [],
    "limit_quantity_per_customer": true,
    "country_of_origin": { … },
    "variant_countries": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Webhooks

Operations