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.
curl -i -X GET \ https://docs.fluid.app/_mock/docs/apis/company.api/api/settings/company_countries \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Company countries retrieved successfully
2-letter country code (ISO 3166-1 alpha-2)
Whether this country's prices are inclusive of tax
The display name of the tax included in the price (e.g., VAT, GST)
3-letter country code (ISO 3166-1 alpha-3)
DDP = Delivery Duty Paid, DAP = Delivered at Place (customer pays VAT/customs on delivery)
Gaiyo Shomen is a company overview document required for certain business transactions in Japan. When enabled, this setting mandates that companies provide this document during enrollment flows. Only applicable for Japan country configurations.
{ "company_countries": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/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", "require_gaiyo_shomen_in_enrollment": true, "settlement_currency": "string", "entity_id": 0, "entity_legally_registered": true } }'
No tax settings provided
Whether this country's prices are inclusive of tax
The display name of the tax included in the price (e.g., VAT, GST)
3-letter country code (ISO 3166-1 alpha-3)
DDP = Delivery Duty Paid, DAP = Delivered at Place (customer pays VAT/customs on delivery)
Gaiyo Shomen is a company overview document required for certain business transactions in Japan. When enabled, this setting mandates that companies provide this document during enrollment flows. Only applicable for Japan country configurations.
{ "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", "settlement_currency": "USD", "entity_legally_registered": false, "country": { … }, "entity": { … }, "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", "require_gaiyo_shomen_in_enrollment": false, "warehouse": { … }, "company": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X PUT \ 'https://docs.fluid.app/_mock/docs/apis/company.api/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", "require_gaiyo_shomen_in_enrollment": true, "settlement_currency": "string", "entity_id": 0, "entity_legally_registered": true } }'
Company country updated successfully
Whether this country's prices are inclusive of tax
The display name of the tax included in the price (e.g., VAT, GST)
3-letter country code (ISO 3166-1 alpha-3)
DDP = Delivery Duty Paid, DAP = Delivered at Place (customer pays VAT/customs on delivery)
Gaiyo Shomen is a company overview document required for certain business transactions in Japan. When enabled, this setting mandates that companies provide this document during enrollment flows. Only applicable for Japan country configurations.
{ "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", "settlement_currency": "USD", "entity_legally_registered": false, "country": { … }, "entity": { … }, "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", "require_gaiyo_shomen_in_enrollment": false, "warehouse": { … }, "company": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/settings/company_countries/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "success": true, "message": "Company country deleted successfully", "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/settings/company_countries/tax_options?country_id=0' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "tax_options": [ "string" ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
Social Media