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
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company 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

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

List products

Request

Query
statusstring

Filter by status (defaults to 'active')

Enum"active""draft""archived""all"
availabilitystring

Filter by availability (defaults to 'all')

country_codestring

Filter by country code (defaults to company's default country)

category_titlestring

Filter by category title

category_idstring

Filter by category ID

collection_idstring

Filter by collection ID

bundleboolean

Filter by bundle

order_bystring

Sort results by specified field

search_querystring

Search the products by title

by_metadatastring(json)

Search JSON meta data

Default "{}"
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products?availability=string&bundle=true&by_metadata={}&category_id=string&category_title=string&collection_id=string&country_code=string&order_by=string&search_query=string&status=active' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
productsArray of objects
metaobject
Response
application/json
{ "products": [ {} ], "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Create a product

Request

Create a new product

Bodyapplication/json
productobjectrequired
product.​skustringrequired

Product SKU

Example: "PROD-123"
product.​titlestringrequired

Product title

Example: "Premium Coffee Maker"
product.​image_urlstringrequired

URL of the product image

Example: "https://example.com/images/coffee-maker.jpg"
product.​pricenumber or stringrequired

Product price

Example: 299.99
product.​shippingnumber or stringrequired

Shipping cost

Example: 15
product.​descriptionstring

Product description

Example: "Professional grade coffee maker with built-in grinder"
product.​statusstring

Product status

Enum"active""draft""archived"
Example: "active"
product.​commissionnumber or string

Commission rate

Example: 10
product.​publicboolean

Product visibility

Example: true
product.​metadataobject

Custom metadata key-value pairs

Example: {"brand":"CoffeePro","warranty_months":24,"features":["built-in-grinder","timer","auto-shutoff"]}
product.​product_bundles_attributesArray of objects
country_codestringrequired

Two-letter ISO country code

Example: "US"
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "product": {
      "sku": "PROD-123",
      "title": "Premium Coffee Maker",
      "image_url": "https://example.com/images/coffee-maker.jpg",
      "price": 299.99,
      "shipping": 15,
      "description": "Professional grade coffee maker with built-in grinder",
      "status": "active",
      "commission": 10,
      "public": true,
      "metadata": {
        "brand": "CoffeePro",
        "warranty_months": 24,
        "features": [
          "built-in-grinder",
          "timer",
          "auto-shutoff"
        ]
      },
      "product_bundles_attributes": [
        {
          "id": 1,
          "bundled_variant_id": 1,
          "quantity": 1,
          "_destroy": false
        }
      ]
    },
    "country_code": "US"
  }'

Responses

success

Bodyapplication/json
productobject
metaobject
Response
application/json
{ "product": { "id": 0, "sku": "string", "title": "string", "description": "string", "image_url": "string", "status": "string", "price": "string", "commission": "string", "public": true, "slug": "string", "category_id": "string", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "upc": "string", "hs_code": "string", "compressed_image_url": "string", "image_path": "string", "external_url": "string", "display_price": "string", "subscription_price": "string", "tax_inclusive_price": "string", "tax_inclusive_wholesale": "string", "tax_inclusive_subscription_price": "string", "tax_inclusive_wholesale_subscription_price": "string", "currency_code": "string", "tax_category_id": 0, "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "last_synced_at": "string", "metadata": {}, "product_bundles": [], "category": "string", "collections": [], "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Show a product

Request

Path
idintegerrequired

Product's Id or slug

Query
langstring

Determines language to be used to display translations, if applicable.

  • If not specified, the company's default language is used.
  • This is the 2 letter ISO language code. Examples: 'en', 'es', 'fr'
  • It can be upper case or lower case
country_codestring

The country code for specifying the country. The currency and pricing will change depending on the country selected.

  • If not specified, the company's default country is used.
  • This is the 2 letter ISO country code. Examples: 'us', 'ca', 'es', 'fr'
  • It can be upper case or lower case
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{id}?country_code=string&lang=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
productobject
metaobject
Response
application/json
{ "product": { "id": 0, "sku": "string", "title": "string", "description": "string", "image_url": "string", "status": "string", "price": "string", "commission": "string", "public": true, "slug": "string", "category_id": "string", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "upc": "string", "hs_code": "string", "compressed_image_url": "string", "image_path": "string", "external_url": "string", "display_price": "string", "subscription_price": "string", "tax_inclusive_price": "string", "tax_inclusive_wholesale": "string", "tax_inclusive_subscription_price": "string", "tax_inclusive_wholesale_subscription_price": "string", "currency_code": "string", "tax_category_id": 0, "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "last_synced_at": "string", "metadata": {}, "product_bundles": [], "category": "string", "collections": [], "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Update a product

Request

Update an existing product

Path
idintegerrequired

Product's Id

Bodyapplication/json
productobjectrequired
product.​skustringrequired

Product SKU

Example: "PROD-123"
product.​titlestringrequired

Product title

Example: "Premium Coffee Maker"
product.​descriptionstring

Product description

Example: "Professional grade coffee maker with built-in grinder"
product.​image_urlstringrequired

URL of the product image

Example: "https://example.com/images/coffee-maker.jpg"
product.​statusstring

Product status

Enum"active""draft""archived"
Example: "active"
product.​pricenumber or stringrequired

Product price

Example: 299.99
product.​shippingnumber or stringrequired

Shipping cost

Example: 15
product.​commissionnumber or string

Commission rate

Example: 10
product.​publicboolean

Product visibility

Example: true
product.​metadataobject

A JSON object that can store any custom data structure.

Example: {"brand":"CoffeePro","warranty_months":24,"features":["built-in-grinder","timer","auto-shutoff"]}
product.​product_bundles_attributesArray of objects
country_codestringrequired

Two-letter ISO country code

Example: "US"
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "product": {
      "sku": "PROD-123",
      "title": "Premium Coffee Maker",
      "description": "Professional grade coffee maker with built-in grinder",
      "image_url": "https://example.com/images/coffee-maker.jpg",
      "status": "active",
      "price": 299.99,
      "shipping": 15,
      "commission": 10,
      "public": true,
      "metadata": {
        "brand": "CoffeePro",
        "warranty_months": 24,
        "features": [
          "built-in-grinder",
          "timer",
          "auto-shutoff"
        ]
      },
      "product_bundles_attributes": [
        {
          "id": 1,
          "bundled_variant_id": 1,
          "quantity": 1,
          "_destroy": false
        }
      ]
    },
    "country_code": "US"
  }'

Responses

success

Bodyapplication/json
productobject
metaobject
Response
application/json
{ "product": { "id": 0, "sku": "string", "title": "string", "description": "string", "image_url": "string", "status": "string", "price": "string", "commission": "string", "public": true, "slug": "string", "category_id": "string", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "upc": "string", "hs_code": "string", "compressed_image_url": "string", "image_path": "string", "external_url": "string", "display_price": "string", "subscription_price": "string", "tax_inclusive_price": "string", "tax_inclusive_wholesale": "string", "tax_inclusive_subscription_price": "string", "tax_inclusive_wholesale_subscription_price": "string", "currency_code": "string", "tax_category_id": 0, "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "last_synced_at": "string", "metadata": {}, "product_bundles": [], "category": "string", "collections": [], "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Delete a product

Request

Path
idintegerrequired

Product's Id or slug

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

Responses

success

Bodyapplication/json
idinteger

Product ID

metaobject
Response
application/json
{ "id": 0, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Add product to collection

Request

Add a Product to a Collection

Path
idintegerrequired

Product's Id or slug

Query
collection_idstringrequired

Collection's Id

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{id}/add_to_collection?collection_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
messagestring
Example: "Product (1373) added to Collection (2402)"
metaobject
Response
application/json
{ "message": "Product (1373) added to Collection (2402)", "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Remove product from collection

Request

Remove a Product from a Collection

Path
idintegerrequired

Product's Id or slug

Query
collection_idstringrequired

Collection's Id

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{id}/remove_from_collection?collection_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
messagestring
Example: "Product (1373) removed from Collection (2402)"
metaobject
Response
application/json
{ "message": "Product (1373) removed from Collection (2402)", "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Duplicate a product

Request

Create a duplicate copy of an existing product

Path
idintegerrequired

Product's Id or slug

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

Responses

success

Bodyapplication/json
productobject
metaobject
Response
application/json
{ "product": { "id": 0, "sku": "string", "title": "string", "description": "string", "image_url": "string", "status": "string", "price": "string", "commission": "string", "public": true, "slug": "string", "category_id": "string", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "upc": "string", "hs_code": "string", "compressed_image_url": "string", "image_path": "string", "external_url": "string", "display_price": "string", "subscription_price": "string", "tax_inclusive_price": "string", "tax_inclusive_wholesale": "string", "tax_inclusive_subscription_price": "string", "tax_inclusive_wholesale_subscription_price": "string", "currency_code": "string", "tax_category_id": 0, "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "last_synced_at": "string", "metadata": {}, "product_bundles": [], "category": "string", "collections": [], "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Send product to top

Request

Change the priority attribute of a product to the highest priority. This will move the product to the top of the default order in the index API

Path
idintegerrequired

Product's Id or slug

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

Responses

success

Bodyapplication/json
messagestring
Example: "priority set to 1000"
metaobject
Response
application/json
{ "message": "priority set to 1000", "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Find product by external shop ID

Request

Find or optionally sync a product using external shop ID. Currently, support is limited to Shopify Integrations only.

Path
product_idstringrequired

External ID of the product

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{product_id}/find_by_shop_id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
productobject
metaobject
Response
application/json
{ "product": { "id": 0, "sku": "string", "title": "string", "description": "string", "image_url": "string", "status": "string", "price": "string", "commission": "string", "public": true, "slug": "string", "category_id": "string", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "upc": "string", "hs_code": "string", "compressed_image_url": "string", "image_path": "string", "external_url": "string", "display_price": "string", "subscription_price": "string", "tax_inclusive_price": "string", "tax_inclusive_wholesale": "string", "tax_inclusive_subscription_price": "string", "tax_inclusive_wholesale_subscription_price": "string", "currency_code": "string", "tax_category_id": 0, "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "last_synced_at": "string", "metadata": {}, "product_bundles": [], "category": "string", "collections": [], "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Update product by shop ID

Request

Update a product using external shop ID. Currently, support is limited to Shopify Integrations only.

Path
product_idstringrequired

External ID of the product

Bodyapplication/json
productobjectrequired
product.​skustring

Product SKU

product.​titlestring

Product title

product.​image_urlstring

URL of the product image

product.​pricenumber or string

Product price

product.​shippingnumber or string

Shipping cost

product.​country_codestring

Two-letter ISO country code

product.​descriptionstring

Product description

product.​statusstring

Product status

Enum"active""draft""archived"
product.​commissionnumber or string

Commission rate

product.​publicboolean

Product visibility

product.​metadataobject

Custom metadata key-value pairs

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{product_id}/shop_update' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "product": {
      "sku": "string",
      "title": "string",
      "image_url": "string",
      "price": 0,
      "shipping": 0,
      "country_code": "string",
      "description": "string",
      "status": "active",
      "commission": 0,
      "public": true,
      "metadata": {}
    }
  }'

Responses

success

Bodyapplication/json
productobject
metaobject
Response
application/json
{ "product": { "id": 0, "sku": "string", "title": "string", "description": "string", "image_url": "string", "status": "string", "price": "string", "commission": "string", "public": true, "slug": "string", "category_id": "string", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "upc": "string", "hs_code": "string", "compressed_image_url": "string", "image_path": "string", "external_url": "string", "display_price": "string", "subscription_price": "string", "tax_inclusive_price": "string", "tax_inclusive_wholesale": "string", "tax_inclusive_subscription_price": "string", "tax_inclusive_wholesale_subscription_price": "string", "currency_code": "string", "tax_category_id": 0, "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "last_synced_at": "string", "metadata": {}, "product_bundles": [], "category": "string", "collections": [], "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Search products by external ID

Request

Search for products using an external ID. Searches through variant_countries, variants, and products in that order.

Query
external_idstringrequired

External ID to search for

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/search_by_external_id?external_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
productsArray of objects
metaobject
Response
application/json
{ "products": [ {} ], "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Append metadata field

Request

Path
idintegerrequired

Product's Id or SKU

Bodyapplication/json
metadaobject

A JSON object that can store any custom data structure.

Example: {"brand":"CoffeePro","warranty_months":24,"features":["built-in-grinder","timer","auto-shutoff"]}
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/products/{id}/append_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metada": {
      "brand": "CoffeePro",
      "warranty_months": 24,
      "features": [
        "built-in-grinder",
        "timer",
        "auto-shutoff"
      ]
    }
  }'

Responses

success

Bodyapplication/json
productobject
metaobject
Response
application/json
{ "product": { "id": 0, "sku": "string", "title": "string", "description": "string", "image_url": "string", "status": "string", "price": "string", "commission": "string", "public": true, "slug": "string", "category_id": "string", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "upc": "string", "hs_code": "string", "compressed_image_url": "string", "image_path": "string", "external_url": "string", "display_price": "string", "subscription_price": "string", "tax_inclusive_price": "string", "tax_inclusive_wholesale": "string", "tax_inclusive_subscription_price": "string", "tax_inclusive_wholesale_subscription_price": "string", "currency_code": "string", "tax_category_id": 0, "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "last_synced_at": "string", "metadata": {}, "product_bundles": [], "category": "string", "collections": [], "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/droplet_categories \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns a list of droplet categories

Bodyapplication/json
droplet_categoriesArray of objects(DropletCategory)
metaobject
Response
application/json
{ "droplet_categories": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }