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

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

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

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

MCC Codes

Operations

Metafield Definitions

Operations

Metafields

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantCountries

Operations

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/swagger/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.​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", "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" } }

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Delete a media

Request

Path
idintegerrequired

Media ID

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

Responses

Media destroyed

Bodyapplication/json
string
Response
application/json
"string"