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

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

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

Retrieves a list of variant countries of variant

Request

Query
variant_ids[]Array of integersrequired
Example: variant_ids[]=1
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v1/variants/variant_countries?variant_ids%5B%5D=1'

Responses

List of variant countries retrieved successfully

Bodyapplication/json
variant_countriesArray of objects
metaobject
Response
application/json
{ "variant_countries": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2024-12-11T08:00:00Z" } }

Bulk Update Variant Countries

Request

Bodyapplication/json
variant_countriesArray of objects or objects or (object or objects) or objectsrequired
Any of:
variant_countries[].​variant_country_idstring or nullrequired
Default null
variant_countries[].​variant_country_external_idstring or null
Default null
variant_countries[].​variant_idstring or null
Default null
variant_countries[].​variant_external_idstring or null
Default null
variant_countries[].​currency_codestringrequired
variant_countries[].​country_codestring or null
variant_countries[].​skustring or null
variant_countries[].​pricenumber or string(float)
variant_countries[].​wholesalenumber or string(float)
variant_countries[].​cvinteger
variant_countries[].​qvinteger
variant_countries[].​pc_cvinteger
variant_countries[].​pc_qvinteger
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/v1/variants/variant_countries/bulk_update \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "variant_countries": [
      {
        "variant_country_id": null,
        "variant_country_external_id": null,
        "variant_id": null,
        "variant_external_id": null,
        "currency_code": "string",
        "country_code": "string",
        "sku": "string",
        "price": 0,
        "wholesale": 0,
        "cv": 0,
        "qv": 0,
        "pc_cv": 0,
        "pc_qv": 0
      }
    ]
  }'

Responses

Bulk Update Successful

Bodyapplication/json
variant_countriesArray of objects
metaobject
Response
application/json
{ "variant_countries": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2024-12-11T08:00:00Z" } }

Create a new variant country

Request

Path
variant_idintegerrequired

Variant ID

Example: 1
Bodyapplication/json
variant_countryobjectrequired
variant_country.​activebooleanrequired
variant_country.​country_idintegerrequired
variant_country.​pricenumberrequired
variant_country.​subscription_pricenumber
variant_country.​wholesalenumber
variant_country.​wholesale_subscription_pricenumber
variant_country.​compare_pricenumber
variant_country.​cvinteger
variant_country.​qvinteger
variant_country.​pc_cvinteger
variant_country.​pc_qvinteger
variant_country.​cost_of_goods_soldnumber
variant_country.​shippingnumber
variant_country.​taxnumber
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/v1/variants/{variant_id}/variant_countries' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "variant_country": {
      "active": true,
      "country_id": 0,
      "price": 0,
      "subscription_price": 0,
      "wholesale": 0,
      "wholesale_subscription_price": 0,
      "compare_price": 0,
      "cv": 0,
      "qv": 0,
      "pc_cv": 0,
      "pc_qv": 0,
      "cost_of_goods_sold": 0,
      "shipping": 0,
      "tax": 0
    }
  }'

Responses

Variant country created successfully

Bodyapplication/json
variant_countryobject(VariantCountry)required
variant_country.​idintegerrequired
variant_country.​variant_idintegerrequired
variant_country.​activeboolean or null
Default true
variant_country.​currency_codestring or null
variant_country.​pricenumber or string or null[ 0 .. 99999999 ]
Default "0.0"
variant_country.​shippingnumber or string or null
Default "0.0"
variant_country.​shipping_timestring or null
variant_country.​subscription_pricenumber or string or null
Default "0.0"
variant_country.​wholesalenumber or string or null
Default "0.0"
variant_country.​wholesale_subscription_pricenumber or string or null
Default "0.0"
variant_country.​cost_of_goods_soldnumber or string or null
Default "0.0"
variant_country.​compare_pricenumber or string or null
Default "0.0"
variant_country.​pointsinteger>= 0required
Default 0
variant_country.​country_codestringrequired
variant_country.​display_pricestringrequired
variant_country.​display_subscription_pricestringrequired
variant_country.​display_wholesalestringrequired
variant_country.​display_wholesale_subscription_pricestringrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "variant_country": { "id": 0, "variant_id": 0, "active": true, "currency_code": "string", "price": "0.0", "shipping": "0.0", "shipping_time": "string", "subscription_price": "0.0", "wholesale": "0.0", "wholesale_subscription_price": "0.0", "cost_of_goods_sold": "0.0", "compare_price": "0.0", "points": 0, "country_code": "string", "display_price": "string", "display_subscription_price": "string", "display_wholesale": "string", "display_wholesale_subscription_price": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

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

session

Operations

settings

Operations

url

Operations

widgets

Operations