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://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

List products

Request

Query
status[]Array of strings

Filter by status. Supported values: 'active', 'draft', 'archived'. If no filter is sent, returns all products regardless of status.

availability[]Array of strings

Filter by availability. Supported values: 'All', 'in_stock', 'keep_selling'. If no filter is sent, returns all products regardless of availability.

country_code[]Array of strings

Filter by country codes. If no country code is selected it returns product in all country

category_titlestring

Filter by category title

category_idstring

Filter by category ID

category_ids[]Array of integers

Filter by category IDs

collection_idstring

Filter by collection ID

collection_ids[]Array of integers

Filter by collection IDs

bundleboolean

Filter by bundle

order_by[]Array of strings= 2 items

Sort results by specified field in specified direction.

search_querystring

Search the products by title

by_metadatastring(json)

Search JSON meta data

Default "{}"
pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/products?availability%5B%5D=string&bundle=true&by_metadata={}&category_id=string&category_ids%5B%5D=0&category_title=string&collection_id=string&collection_ids%5B%5D=0&country_code%5B%5D=string&order_by%5B%5D=string%2Cstring&page=1&per_page=10&search_query=string&status%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
productsArray of objects
metaobject
Response
application/json
{ "products": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": {} } }

Create a product

Request

Create a new product

Bodyapplication/json
productobjectrequired
product.​titlestringnon-emptyrequired
product.​image_urlstring
product.​skustring
product.​introductionstring
product.​feature_textstring
product.​descriptionstring
product.​statusstring
product.​commissionnumber
product.​publicboolean
product.​metadataobject
product.​publish_to_retail_storeboolean
product.​publish_to_rep_storeboolean
product.​publish_to_share_tabboolean
product.​show_reviewsboolean
product.​application_theme_template_idinteger
product.​tax_category_idinteger
product.​international_tax_typestring
product.​collection_idsArray of integers
product.​tag_idsArray of integers
product.​label_idinteger
product.​category_idinteger
product.​keep_sellingboolean
product.​option_attrsArray of strings
product.​no_indexboolean
product.​search_engine_optimizer_attributesobject
product.​images_attributesArray of objects
product.​product_subscription_plans_attributesArray of objects
product.​variants_attributesArray of objects
product.​bundleboolean
product.​product_bundles_attributesArray of objects
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "product": {
      "title": "string",
      "image_url": "string",
      "sku": "string",
      "introduction": "string",
      "feature_text": "string",
      "description": "string",
      "status": "string",
      "commission": 0,
      "public": true,
      "metadata": {},
      "publish_to_retail_store": true,
      "publish_to_rep_store": true,
      "publish_to_share_tab": true,
      "show_reviews": true,
      "application_theme_template_id": 0,
      "tax_category_id": 0,
      "international_tax_type": "string",
      "collection_ids": [
        0
      ],
      "tag_ids": [
        0
      ],
      "label_id": 0,
      "category_id": 0,
      "keep_selling": true,
      "option_attrs": [
        "string"
      ],
      "no_index": true,
      "search_engine_optimizer_attributes": {
        "title": "string",
        "description": "string",
        "image_url": "string",
        "image_path": "string",
        "block_crawler": true
      },
      "images_attributes": [
        {
          "position": 0,
          "image_url": "string"
        }
      ],
      "product_subscription_plans_attributes": [
        {
          "id": 0,
          "subscription_plan_id": 0,
          "default": true,
          "_destroy": true
        }
      ],
      "variants_attributes": [
        {
          "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,
          "images_attributes": [
            {
              "position": 0,
              "image_url": "string"
            }
          ],
          "inventory_levels_attributes": [
            {
              "warehouse_id": 0,
              "available": 0,
              "committed": 0,
              "on_hand": 0,
              "unavailable": 0
            }
          ],
          "variant_countries_attributes": [
            {
              "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
            }
          ]
        }
      ],
      "bundle": true,
      "product_bundles_attributes": [
        {
          "id": 0,
          "bundled_variant_id": 0,
          "quantity": 0,
          "_destroy": true
        }
      ]
    }
  }'

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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "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
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/products/{id}?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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "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
idstringnon-emptyrequired
productobjectrequired
product.​titlestringnon-emptyrequired
product.​image_urlstring
product.​skustring
product.​introductionstring
product.​feature_textstring
product.​descriptionstring
product.​statusstring
product.​commissionnumber
product.​publicboolean
product.​metadataobject
product.​publish_to_retail_storeboolean
product.​publish_to_rep_storeboolean
product.​publish_to_share_tabboolean
product.​show_reviewsboolean
product.​application_theme_template_idinteger
product.​tax_category_idinteger
product.​international_tax_typestring
product.​collection_idsArray of integers
product.​tag_idsArray of integers
product.​label_idinteger
product.​category_idinteger
product.​keep_sellingboolean
product.​option_attrsArray of strings
product.​no_indexboolean
product.​search_engine_optimizer_attributesobject
product.​images_attributesArray of objects
product.​product_subscription_plans_attributesArray of objects
product.​variants_attributesArray of objects
product.​bundleboolean
product.​product_bundles_attributesArray of objects
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/products/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "product": {
      "title": "string",
      "image_url": "string",
      "sku": "string",
      "introduction": "string",
      "feature_text": "string",
      "description": "string",
      "status": "string",
      "commission": 0,
      "public": true,
      "metadata": {},
      "publish_to_retail_store": true,
      "publish_to_rep_store": true,
      "publish_to_share_tab": true,
      "show_reviews": true,
      "application_theme_template_id": 0,
      "tax_category_id": 0,
      "international_tax_type": "string",
      "collection_ids": [
        0
      ],
      "tag_ids": [
        0
      ],
      "label_id": 0,
      "category_id": 0,
      "keep_selling": true,
      "option_attrs": [
        "string"
      ],
      "no_index": true,
      "search_engine_optimizer_attributes": {
        "id": 0,
        "title": "string",
        "description": "string",
        "image_url": "string",
        "image_path": "string",
        "block_crawler": true
      },
      "images_attributes": [
        {
          "id": 0,
          "position": 0,
          "image_url": "string",
          "_destroy": true
        }
      ],
      "product_subscription_plans_attributes": [
        {
          "id": 0,
          "subscription_plan_id": 0,
          "default": true,
          "_destroy": true
        }
      ],
      "variants_attributes": [
        {
          "id": 0,
          "option_attrs": [
            "string"
          ],
          "sku": "string",
          "is_master": true,
          "title": "string",
          "_destroy": true,
          "track_quantity": true,
          "bar_code": "string",
          "limit_subscription": true,
          "subscription_max_qty": 0,
          "customer_limit": 0,
          "keep_selling": true,
          "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
            }
          ]
        }
      ],
      "bundle": true,
      "product_bundles_attributes": [
        {
          "id": 0,
          "bundled_variant_id": 0,
          "quantity": 0,
          "_destroy": true
        }
      ]
    }
  }'

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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "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://fluid-commerce.redocly.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://fluid-commerce.redocly.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://fluid-commerce.redocly.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://fluid-commerce.redocly.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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "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://fluid-commerce.redocly.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://fluid-commerce.redocly.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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "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://fluid-commerce.redocly.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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "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://fluid-commerce.redocly.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://fluid-commerce.redocly.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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Remove metadata fields

Request

Remove specific metadata fields from a product

Path
idintegerrequired

Product's Id or slug

Bodyapplication/json
productobjectrequired
product.​metadataArray of stringsrequired

Array of metadata field keys to remove

Example: ["brand","warranty_months"]
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/products/{id}/remove_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "product": {
      "metadata": [
        "brand",
        "warranty_months"
      ]
    }
  }'

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", "active": true, "introduction": "string", "feature_text": "string", "stripped": "string", "review_count": 0, "show_reviews": true, "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, "tax_category": {}, "international_tax_type": "string", "in_stock": true, "keep_selling": true, "track_quantity": true, "no_index": true, "publish_to_retail_store": true, "publish_to_rep_store": true, "publish_to_share_tab": true, "affiliate_commission": "string", "integration_id": "string", "external_id": "string", "application_theme_template_id": "string", "last_synced_at": "string", "updated_at": "string", "option_attrs": [], "metadata": {}, "product_subscription_plans": [], "product_bundles": [], "collections": [], "tags": [], "label": {}, "search_engine_optimizer": {}, "category": {}, "images": [], "options": [], "variants": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Get tax categories

Request

Get the tax categories

Query
parent_idinteger

Children of this Category id

searchstring

Search Keyword

Example: search=Tangible personal property
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/products/tax_categories?parent_id=0&search=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

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

Get international tax types

Request

Get international tax types

Query
searchstring

Search Keyword

Example: search=pharmaceuticals
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/products/international_tax_types?search=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

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

Retrieve product options

Request

Returns all available product options with their values for the authenticated company

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

Responses

returns a list of product options available

Bodyapplication/json
optionsArray of objects(Option)required
options[].​idintegerrequired
options[].​titlestringrequired
options[].​positioninteger or null
Default 1
options[].​presentationstringrequired
options[].​external_idstring or null
options[].​created_atstring(date-time)required
options[].​updated_atstring(date-time)required
options[].​option_valuesArray of objects(OptionValue)required
options[].​option_values[].​idintegerrequired
options[].​option_values[].​titlestringrequired
options[].​option_values[].​positioninteger or null
Default 1
options[].​option_values[].​presentationstring or null
options[].​option_values[].​created_atstring(date-time)required
options[].​option_values[].​updated_atstring(date-time)required
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "options": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

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

Webhooks

Operations