Admins

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

List all admins

Request

Query
paginationobject
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v2/admins?active=true&page=0&per_page=100&search_query=string&sorted_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

admins found

Bodyapplication/json
adminsArray of objects(UserCompany)required
admins[].​idintegerrequired
admins[].​activeboolean or null
Default true
admins[].​external_idstring or null
admins[].​usernamestring or null
admins[].​first_namestringrequired
admins[].​last_namestringrequired
admins[].​created_atstring(date-time)required
admins[].​image_urlstring or null
admins[].​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
admins[].​countryobject or null
admins[].​languageobject or null
admins[].​rolesArray of arrays or null or null
admins[].​computed_full_namestring or null
admins[].​computed_emailstring or null
admins[].​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
meta.​paginationobject
Response
application/json
{
  "admins": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

Create an admin

Request

Bodyapplication/json
adminobjectrequired
admin.​first_namestring
admin.​last_namestring
admin.​emailstringrequired
admin.​phonestring
admin.​activeboolean
admin.​external_idstring
admin.​usernamestring
admin.​rolesArray of arrays
admin.​admin_rolesArray of integers
admin.​language_codestring
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v2/admins \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "admin": {
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string",
      "active": true,
      "external_id": "string",
      "username": "string",
      "roles": [],
      "admin_roles": [
        0
      ],
      "language_code": "string"
    }
  }'

Responses

admin created

Bodyapplication/json
adminobject(UserCompany)required
admin.​idintegerrequired
admin.​activeboolean or null
Default true
admin.​external_idstring or null
admin.​usernamestring or null
admin.​first_namestringrequired
admin.​last_namestringrequired
admin.​created_atstring(date-time)required
admin.​image_urlstring or null
admin.​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
admin.​countryobject or null
admin.​languageobject or null
admin.​rolesArray of arrays or null or null
admin.​computed_full_namestring or null
admin.​computed_emailstring or null
admin.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "admin": {
    "id": 0,
    "active": true,
    "external_id": "string",
    "username": "string",
    "first_name": "string",
    "last_name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "image_url": "string",
    "share_guid": "string",
    "country": {},
    "language": {},
    "roles": [],
    "computed_full_name": "string",
    "computed_email": "string",
    "phone": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieve an admin

Request

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

Responses

admin found

Bodyapplication/json
adminobject(UserCompany)required
admin.​idintegerrequired
admin.​activeboolean or null
Default true
admin.​external_idstring or null
admin.​usernamestring or null
admin.​first_namestringrequired
admin.​last_namestringrequired
admin.​created_atstring(date-time)required
admin.​image_urlstring or null
admin.​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
admin.​countryobject or null
admin.​languageobject or null
admin.​rolesArray of arrays or null or null
admin.​computed_full_namestring or null
admin.​computed_emailstring or null
admin.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "admin": {
    "id": 0,
    "active": true,
    "external_id": "string",
    "username": "string",
    "first_name": "string",
    "last_name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "image_url": "string",
    "share_guid": "string",
    "country": {},
    "language": {},
    "roles": [],
    "computed_full_name": "string",
    "computed_email": "string",
    "phone": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update an admin

Request

Path
idintegerrequired
Bodyapplication/json
idintegerrequired
adminobjectrequired
admin.​first_namestring
admin.​last_namestring
admin.​emailstring
admin.​phonestring
admin.​activeboolean
admin.​external_idstring
admin.​usernamestring
admin.​rolesArray of arrays
admin.​admin_rolesArray of integers
admin.​language_codestring
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v2/admins/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "admin": {
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string",
      "active": true,
      "external_id": "string",
      "username": "string",
      "roles": [],
      "admin_roles": [
        0
      ],
      "language_code": "string"
    }
  }'

Responses

admin updated

Bodyapplication/json
adminobject(UserCompany)required
admin.​idintegerrequired
admin.​activeboolean or null
Default true
admin.​external_idstring or null
admin.​usernamestring or null
admin.​first_namestringrequired
admin.​last_namestringrequired
admin.​created_atstring(date-time)required
admin.​image_urlstring or null
admin.​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
admin.​countryobject or null
admin.​languageobject or null
admin.​rolesArray of arrays or null or null
admin.​computed_full_namestring or null
admin.​computed_emailstring or null
admin.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "admin": {
    "id": 0,
    "active": true,
    "external_id": "string",
    "username": "string",
    "first_name": "string",
    "last_name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "image_url": "string",
    "share_guid": "string",
    "country": {},
    "language": {},
    "roles": [],
    "computed_full_name": "string",
    "computed_email": "string",
    "phone": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete an admin

Request

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

Responses

admin deleted

Bodyapplication/json
idintegerrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "id": 0,
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

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

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

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

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations