Reps
/
List all reps

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

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

List all reps

Request

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

Responses

reps found

Bodyapplication/json
repsArray of objects(UserCompany)required
reps[].​idintegerrequired
reps[].​activeboolean or null
Default true
reps[].​external_idstring or null
reps[].​usernamestring or null
reps[].​first_namestringrequired
reps[].​last_namestringrequired
reps[].​created_atstring(date-time)required
reps[].​image_urlstring or null
reps[].​rolesstring or null
Default "user"
reps[].​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
reps[].​computed_full_namestring or null
reps[].​computed_emailstring or null
reps[].​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
{
  "reps": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

Create a rep

Request

Bodyapplication/json
repobjectrequired
rep.​first_namenull or string
rep.​last_namenull or string
rep.​emailnull or stringrequired
rep.​phonenull or string
rep.​activenull or boolean
rep.​external_idnull or string
rep.​usernamenull or string
rep.​share_guidnull or string
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v2/reps \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rep": {
      "first_name": null,
      "last_name": null,
      "email": null,
      "phone": null,
      "active": null,
      "external_id": null,
      "username": null,
      "share_guid": null
    }
  }'

Responses

rep created with custom share_guid

Bodyapplication/json
repobject(UserCompany)required
rep.​idintegerrequired
rep.​activeboolean or null
Default true
rep.​external_idstring or null
rep.​usernamestring or null
rep.​first_namestringrequired
rep.​last_namestringrequired
rep.​created_atstring(date-time)required
rep.​image_urlstring or null
rep.​rolesstring or null
Default "user"
rep.​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
rep.​computed_full_namestring or null
rep.​computed_emailstring or null
rep.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "rep": {
    "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",
    "roles": "user",
    "share_guid": "string",
    "computed_full_name": "string",
    "computed_email": "string",
    "phone": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieve a rep

Request

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

Responses

rep found

Bodyapplication/json
repobject(UserCompany)required
rep.​idintegerrequired
rep.​activeboolean or null
Default true
rep.​external_idstring or null
rep.​usernamestring or null
rep.​first_namestringrequired
rep.​last_namestringrequired
rep.​created_atstring(date-time)required
rep.​image_urlstring or null
rep.​rolesstring or null
Default "user"
rep.​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
rep.​computed_full_namestring or null
rep.​computed_emailstring or null
rep.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "rep": {
    "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",
    "roles": "user",
    "share_guid": "string",
    "computed_full_name": "string",
    "computed_email": "string",
    "phone": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a rep

Request

Path
idintegerrequired
Bodyapplication/json
idintegerrequired
repobjectrequired
rep.​first_namenull or string
rep.​last_namenull or string
rep.​emailnull or string
rep.​phonenull or string
rep.​activenull or boolean
rep.​external_idnull or string
rep.​usernamenull or string
rep.​share_guidnull or string
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/v2/reps/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "rep": {
      "first_name": null,
      "last_name": null,
      "email": null,
      "phone": null,
      "active": null,
      "external_id": null,
      "username": null,
      "share_guid": null
    }
  }'

Responses

rep updated with empty string fields filtered

Bodyapplication/json
repobject(UserCompany)required
rep.​idintegerrequired
rep.​activeboolean or null
Default true
rep.​external_idstring or null
rep.​usernamestring or null
rep.​first_namestringrequired
rep.​last_namestringrequired
rep.​created_atstring(date-time)required
rep.​image_urlstring or null
rep.​rolesstring or null
Default "user"
rep.​share_guidstring>= 2 characters\A[a-z0-9\-_]+\zrequired
rep.​computed_full_namestring or null
rep.​computed_emailstring or null
rep.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "rep": {
    "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",
    "roles": "user",
    "share_guid": "string",
    "computed_full_name": "string",
    "computed_email": "string",
    "phone": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a rep

Request

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

Responses

rep 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"
  }
}

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