Domains
/
Verify domain

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

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company 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

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Lists domains

Request

Query
search_querystring

Search by domain name or target

pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/domains?page=1&per_page=10&search_query=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
domainsArray of objects
metaobject
Response
application/json
{
  "domains": [
    { … }
  ],
  "meta": {
    "total_count": 20,
    "total_pages": 2,
    "current_page": 1,
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-11T08:04:10Z"
  }
}

Create domain

Request

Create a new domain

Bodyapplication/json
hostnamestringrequired
Example: "newdomain.com"
redirection_domain_idinteger
Example: 101
primaryboolean
Example: false
wildcard_subdomainboolean
Example: false
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/domains \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "hostname": "newdomain.com",
    "redirection_domain_id": 101,
    "primary": false,
    "wildcard_subdomain": false
  }'

Responses

created

Bodyapplication/json
domainobject
metaobject
Response
application/json
{
  "domain": {
    "id": 101,
    "hostname": "example.com",
    "created_at": "2024-04-20T12:34:56.000Z",
    "updated_at": "2024-08-20T12:34:56.000Z",
    "apex_domain": "example1.com",
    "certificate_domain_id": 101,
    "company_id": 101,
    "dns_config": {},
    "primary": false,
    "redirection_domain_id": 101,
    "redirection_domain_hostname": "example2.com",
    "verification_status": "pending_cname",
    "wildcard_subdomain": false,
    "dns_fluid_verified": "no",
    "cert_created": true,
    "connected": false,
    "verifying_cname": false,
    "payment_account": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Retrieves a domain

Request

Path
idintegerrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/domains/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
domainobject
metaobject
Response
application/json
{
  "domain": {
    "id": 101,
    "hostname": "example.com",
    "created_at": "2024-04-20T12:34:56.000Z",
    "updated_at": "2024-08-20T12:34:56.000Z",
    "apex_domain": "example1.com",
    "certificate_domain_id": 101,
    "company_id": 101,
    "dns_config": {},
    "primary": false,
    "redirection_domain_id": 101,
    "redirection_domain_hostname": "example2.com",
    "verification_status": "pending_cname",
    "wildcard_subdomain": false,
    "dns_fluid_verified": "no",
    "cert_created": true,
    "connected": false,
    "verifying_cname": false,
    "payment_account": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Updates a domain

Request

Path
idintegerrequired
Bodyapplication/json
hostnamestring
Example: "updateddomain.com"
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/domains/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "hostname": "updateddomain.com"
  }'

Responses

successful

Bodyapplication/json
domainobject
metaobject
Response
application/json
{
  "domain": {
    "id": 101,
    "hostname": "example.com",
    "created_at": "2024-04-20T12:34:56.000Z",
    "updated_at": "2024-08-20T12:34:56.000Z",
    "apex_domain": "example1.com",
    "certificate_domain_id": 101,
    "company_id": 101,
    "dns_config": {},
    "primary": false,
    "redirection_domain_id": 101,
    "redirection_domain_hostname": "example2.com",
    "verification_status": "pending_cname",
    "wildcard_subdomain": false,
    "dns_fluid_verified": "no",
    "cert_created": true,
    "connected": false,
    "verifying_cname": false,
    "payment_account": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Deletes a domain

Request

Path
idintegerrequired
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/domains/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
domainobject
metaobject
Response
application/json
{
  "domain": {
    "id": 101,
    "hostname": "example.com",
    "created_at": "2024-04-20T12:34:56.000Z",
    "updated_at": "2024-08-20T12:34:56.000Z",
    "apex_domain": "example1.com",
    "certificate_domain_id": 101,
    "company_id": 101,
    "dns_config": {},
    "primary": false,
    "redirection_domain_id": 101,
    "redirection_domain_hostname": "example2.com",
    "verification_status": "pending_cname",
    "wildcard_subdomain": false,
    "dns_fluid_verified": "no",
    "cert_created": true,
    "connected": false,
    "verifying_cname": false,
    "payment_account": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Verify domain

Request

Path
idintegerrequired

Domain ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/domains/{id}/verify_domain' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
domainobject
metaobject
Response
application/json
{
  "domain": {
    "id": 101,
    "hostname": "example.com",
    "created_at": "2024-04-20T12:34:56.000Z",
    "updated_at": "2024-08-20T12:34:56.000Z",
    "apex_domain": "example1.com",
    "certificate_domain_id": 101,
    "company_id": 101,
    "dns_config": {},
    "primary": false,
    "redirection_domain_id": 101,
    "redirection_domain_hostname": "example2.com",
    "verification_status": "pending_cname",
    "wildcard_subdomain": false,
    "dns_fluid_verified": "no",
    "cert_created": true,
    "connected": false,
    "verifying_cname": false,
    "payment_account": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Confirm CNAME for domain

Request

Path
idintegerrequired

Domain ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/domains/{id}/confirm_cname_for_domain' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
domainobject
metaobject
Response
application/json
{
  "domain": {
    "id": 101,
    "hostname": "example.com",
    "created_at": "2024-04-20T12:34:56.000Z",
    "updated_at": "2024-08-20T12:34:56.000Z",
    "apex_domain": "example1.com",
    "certificate_domain_id": 101,
    "company_id": 101,
    "dns_config": {},
    "primary": false,
    "redirection_domain_id": 101,
    "redirection_domain_hostname": "example2.com",
    "verification_status": "pending_cname",
    "wildcard_subdomain": false,
    "dns_fluid_verified": "no",
    "cert_created": true,
    "connected": false,
    "verifying_cname": false,
    "payment_account": { … }
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

Bodyapplication/json
droplet_categoriesArray of objects(DropletCategory)
metaobject
Response
application/json
{
  "droplet_categories": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}