List company countries

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

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

List company countries

Request

List all countries configured for the company

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

Responses

Company countries retrieved successfully

Bodyapplication/json

company_countriesArray of objects(CompanyCountry)required

company_countries[].idintegerrequired

company_countries[].currencystringrequired

Example: "USD"

company_countries[].base_shippingnumber or string or null

Default "0.0"

Example: 0

company_countries[].defaultbooleanrequired

Example: false

company_countries[].pause_incomplete_enrollmentboolean or null

Example: false

company_countries[].handling_feenumber or null

Example: 5.99

company_countries[].updated_atstring(date-time)required

Example: "2021-01-01T00:00:00Z"

company_countries[].countryobject(Country)required

company_countries[].country.idintegerrequired

company_countries[].country.namestringrequired

Example: "United States"

company_countries[].country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

company_countries[].country.iso_namestringrequired

Example: "UNITED STATES"

company_countries[].country.iso3stringrequired

3-letter country code (ISO 3166-1 alpha-3)

Example: "USA"

company_countries[].country.currency_codestringrequired

Example: "USD"

company_countries[].country.currency_symbolstringrequired

Example: "$"

company_countries[].country.tax_enabledboolean or null

Example: true

company_countries[].tax_applyboolean or null

Example: false

company_countries[].tax_business_idstring or null

Example: "123456789"

company_countries[].tax_apply_discounted_ratesboolean or null

Example: false

company_countries[].tax_auto_send_invoiceboolean or null

Example: false

company_countries[].apply_shipping_taxboolean or null

Example: false

company_countries[].avalara_shipping_tax_codestring or null

Example: "FR030000"

company_countries[].customsstring or null

DDP = Delivery Duty Paid, DAP = Delivered at Place (customer pays VAT/customs on delivery)

Example: "DDP"

company_countries[].use_company_default_tax_settingsboolean or null

Example: true

company_countries[].use_company_avalara_tax_settingsboolean or null

Example: false

company_countries[].use_company_manual_tax_settingsboolean or null

Example: false

company_countries[].use_company_webhook_tax_settingsboolean or null

Example: false

company_countries[].use_custom_avalara_tax_settingsboolean or null

Example: false

company_countries[].custom_avalara_user_namestring or null

Example: "avalara_user"

company_countries[].custom_avalara_passwordstring or null

Example: "password123"

company_countries[].use_custom_avalara_product_tax_codeboolean or null

Example: false

company_countries[].tax_optionstring or null

Example: "avalara"

company_countries[].warehouseobject or null(Warehouse)

company_countries[].companyobject(Company)required

company_countries[].company.idintegerrequired

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "company_countries": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Create a company country

Request

Add a new country to the company configuration

Bodyapplication/json

company_countryobjectrequired

company_country.country_idintegerrequired

company_country.currencystring

company_country.warehouse_idinteger

company_country.handling_feenumber

company_country.defaultboolean

company_country.tax_business_idstring

company_country.use_company_default_tax_settingsboolean

company_country.use_company_avalara_tax_settingsboolean

company_country.use_custom_avalara_tax_settingsboolean

company_country.use_company_webhook_tax_settingsboolean

company_country.use_company_manual_tax_settingsboolean

company_country.custom_avalara_user_namestring

company_country.custom_avalara_passwordstring

company_country.use_custom_avalara_product_tax_codeboolean

company_country.tax_optionstring

curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/company_countries \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_country": {
      "country_id": 0,
      "currency": "string",
      "warehouse_id": 0,
      "handling_fee": 0,
      "default": true,
      "tax_business_id": "string",
      "use_company_default_tax_settings": true,
      "use_company_avalara_tax_settings": true,
      "use_custom_avalara_tax_settings": true,
      "use_company_webhook_tax_settings": true,
      "use_company_manual_tax_settings": true,
      "custom_avalara_user_name": "string",
      "custom_avalara_password": "string",
      "use_custom_avalara_product_tax_code": true,
      "tax_option": "string"
    }
  }'

Responses

No tax settings provided

Bodyapplication/json

company_countryobject(CompanyCountry)required

company_country.idintegerrequired

company_country.currencystringrequired

Example: "USD"

company_country.base_shippingnumber or string or null

Default "0.0"

Example: 0

company_country.defaultbooleanrequired

Example: false

company_country.pause_incomplete_enrollmentboolean or null

Example: false

company_country.handling_feenumber or null

Example: 5.99

company_country.updated_atstring(date-time)required

Example: "2021-01-01T00:00:00Z"

company_country.countryobject(Country)required

company_country.country.idintegerrequired

company_country.country.namestringrequired

Example: "United States"

company_country.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

company_country.country.iso_namestringrequired

Example: "UNITED STATES"

company_country.country.iso3stringrequired

3-letter country code (ISO 3166-1 alpha-3)

Example: "USA"

company_country.country.currency_codestringrequired

Example: "USD"

company_country.country.currency_symbolstringrequired

Example: "$"

company_country.country.tax_enabledboolean or null

Example: true

company_country.tax_applyboolean or null

Example: false

company_country.tax_business_idstring or null

Example: "123456789"

company_country.tax_apply_discounted_ratesboolean or null

Example: false

company_country.tax_auto_send_invoiceboolean or null

Example: false

company_country.apply_shipping_taxboolean or null

Example: false

company_country.avalara_shipping_tax_codestring or null

Example: "FR030000"

company_country.customsstring or null

DDP = Delivery Duty Paid, DAP = Delivered at Place (customer pays VAT/customs on delivery)

Example: "DDP"

company_country.use_company_default_tax_settingsboolean or null

Example: true

company_country.use_company_avalara_tax_settingsboolean or null

Example: false

company_country.use_company_manual_tax_settingsboolean or null

Example: false

company_country.use_company_webhook_tax_settingsboolean or null

Example: false

company_country.use_custom_avalara_tax_settingsboolean or null

Example: false

company_country.custom_avalara_user_namestring or null

Example: "avalara_user"

company_country.custom_avalara_passwordstring or null

Example: "password123"

company_country.use_custom_avalara_product_tax_codeboolean or null

Example: false

company_country.tax_optionstring or null

Example: "avalara"

company_country.warehouseobject or null(Warehouse)

company_country.companyobject(Company)required

company_country.company.idintegerrequired

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "company_country": {
    "id": 0,
    "currency": "USD",
    "base_shipping": 0,
    "default": false,
    "pause_incomplete_enrollment": false,
    "handling_fee": 5.99,
    "updated_at": "2021-01-01T00:00:00Z",
    "country": { … },
    "tax_apply": false,
    "tax_business_id": "123456789",
    "tax_apply_discounted_rates": false,
    "tax_auto_send_invoice": false,
    "apply_shipping_tax": false,
    "avalara_shipping_tax_code": "FR030000",
    "customs": "DDP",
    "use_company_default_tax_settings": true,
    "use_company_avalara_tax_settings": false,
    "use_company_manual_tax_settings": false,
    "use_company_webhook_tax_settings": false,
    "use_custom_avalara_tax_settings": false,
    "custom_avalara_user_name": "avalara_user",
    "custom_avalara_password": "password123",
    "use_custom_avalara_product_tax_code": false,
    "tax_option": "avalara",
    "warehouse": { … },
    "company": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a company country

Request

Update an existing country configuration for the company

Path

idintegerrequired

Company country ID

Bodyapplication/json

idintegerrequired

company_countryobjectrequired

company_country.currencystring

company_country.warehouse_idinteger

company_country.handling_feenumber

company_country.defaultboolean

company_country.tax_business_idstring

company_country.use_company_default_tax_settingsboolean

company_country.use_company_avalara_tax_settingsboolean

company_country.use_custom_avalara_tax_settingsboolean

company_country.use_company_webhook_tax_settingsboolean

company_country.use_company_manual_tax_settingsboolean

company_country.custom_avalara_user_namestring

company_country.custom_avalara_passwordstring

company_country.use_custom_avalara_product_tax_codeboolean

company_country.tax_optionstring

curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/company_countries/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "company_country": {
      "currency": "string",
      "warehouse_id": 0,
      "handling_fee": 0,
      "default": true,
      "tax_business_id": "string",
      "use_company_default_tax_settings": true,
      "use_company_avalara_tax_settings": true,
      "use_custom_avalara_tax_settings": true,
      "use_company_webhook_tax_settings": true,
      "use_company_manual_tax_settings": true,
      "custom_avalara_user_name": "string",
      "custom_avalara_password": "string",
      "use_custom_avalara_product_tax_code": true,
      "tax_option": "string"
    }
  }'

Responses

Company country updated successfully

Bodyapplication/json

company_countryobject(CompanyCountry)required

company_country.idintegerrequired

company_country.currencystringrequired

Example: "USD"

company_country.base_shippingnumber or string or null

Default "0.0"

Example: 0

company_country.defaultbooleanrequired

Example: false

company_country.pause_incomplete_enrollmentboolean or null

Example: false

company_country.handling_feenumber or null

Example: 5.99

company_country.updated_atstring(date-time)required

Example: "2021-01-01T00:00:00Z"

company_country.countryobject(Country)required

company_country.country.idintegerrequired

company_country.country.namestringrequired

Example: "United States"

company_country.country.isostringrequired

2-letter country code (ISO 3166-1 alpha-2)

Example: "US"

company_country.country.iso_namestringrequired

Example: "UNITED STATES"

company_country.country.iso3stringrequired

3-letter country code (ISO 3166-1 alpha-3)

Example: "USA"

company_country.country.currency_codestringrequired

Example: "USD"

company_country.country.currency_symbolstringrequired

Example: "$"

company_country.country.tax_enabledboolean or null

Example: true

company_country.tax_applyboolean or null

Example: false

company_country.tax_business_idstring or null

Example: "123456789"

company_country.tax_apply_discounted_ratesboolean or null

Example: false

company_country.tax_auto_send_invoiceboolean or null

Example: false

company_country.apply_shipping_taxboolean or null

Example: false

company_country.avalara_shipping_tax_codestring or null

Example: "FR030000"

company_country.customsstring or null

DDP = Delivery Duty Paid, DAP = Delivered at Place (customer pays VAT/customs on delivery)

Example: "DDP"

company_country.use_company_default_tax_settingsboolean or null

Example: true

company_country.use_company_avalara_tax_settingsboolean or null

Example: false

company_country.use_company_manual_tax_settingsboolean or null

Example: false

company_country.use_company_webhook_tax_settingsboolean or null

Example: false

company_country.use_custom_avalara_tax_settingsboolean or null

Example: false

company_country.custom_avalara_user_namestring or null

Example: "avalara_user"

company_country.custom_avalara_passwordstring or null

Example: "password123"

company_country.use_custom_avalara_product_tax_codeboolean or null

Example: false

company_country.tax_optionstring or null

Example: "avalara"

company_country.warehouseobject or null(Warehouse)

company_country.companyobject(Company)required

company_country.company.idintegerrequired

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "company_country": {
    "id": 0,
    "currency": "USD",
    "base_shipping": 0,
    "default": false,
    "pause_incomplete_enrollment": false,
    "handling_fee": 5.99,
    "updated_at": "2021-01-01T00:00:00Z",
    "country": { … },
    "tax_apply": false,
    "tax_business_id": "123456789",
    "tax_apply_discounted_rates": false,
    "tax_auto_send_invoice": false,
    "apply_shipping_tax": false,
    "avalara_shipping_tax_code": "FR030000",
    "customs": "DDP",
    "use_company_default_tax_settings": true,
    "use_company_avalara_tax_settings": false,
    "use_company_manual_tax_settings": false,
    "use_company_webhook_tax_settings": false,
    "use_custom_avalara_tax_settings": false,
    "custom_avalara_user_name": "avalara_user",
    "custom_avalara_password": "password123",
    "use_custom_avalara_product_tax_code": false,
    "tax_option": "avalara",
    "warehouse": { … },
    "company": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a company country

Request

Remove a country from the company configuration

Path

idintegerrequired

Company country ID

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

Responses

Company country deleted successfully

Bodyapplication/json

successbooleanrequired

Example: true

messagestringrequired

Example: "Company country deleted successfully"

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

Response

application/json

{
  "success": true,
  "message": "Company country deleted successfully",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get valid tax options for the company country

Request

Get valid tax options for the company country

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

Responses

Company country tax options retrieved successfully

Bodyapplication/json

tax_optionsArray of stringsrequired

metaobject

Response

application/json

{
  "tax_options": [
    "string"
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Company Settings - Languages

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

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations

Fluid Commerce APIs (1.0)

Admins

Agreements

ApplePay

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Carts

Commerce Orders

Companies

Company Custom Catch Ups

Company Discounts

Company Mobile Widgets

Company Pages

Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

List company countries

Request

Responses

Was this helpful?

Create a company country

RequestExpand all

Responses

Was this helpful?

Update a company country

RequestExpand all

Responses

Was this helpful?

Delete a company country

Request

Responses

Was this helpful?

Get valid tax options for the company country

Request

Responses

Was this helpful?

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Company Webhook Events

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

Domains

Drop Zones

Droplet Categories

Droplet Installations

Droplets

Enrollment Packs

Enrollments

Fantasy Points

File Resources

Fluid Pay

Form Elements

Forms

GlobalEmbeds

Inventory Levels

Labels

Multi Factor Authentications

Multi-Factor Authentications

Notifications

Onboarding

Order Fulfillments

Orders

Payment

Payment Accounts

Payment Integrations

Payments

Paypal

Products

Prompts

Public Companies

Public Drop Zones

Ranks

Request

Request