Enrollment Packs

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

List all enrollment packs

Request

Query
pageinteger

Page number

per_pageinteger

Items per page

sorted_bystring

Sort order

search_querystring

Search term

statusstring

Filter by status

with_country_idArray of integers

Filter by country IDs

languagestring

Language filter

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/enrollment_packs?language=string&page=0&per_page=0&search_query=string&sorted_by=string&status=string&with_country_id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

enrollment packs found

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

Create a new enrollment pack

Request

Bodyapplication/json
enrollment_packobjectrequired
enrollment_pack.​titlestringnon-emptyrequired
enrollment_pack.​descriptionobjectrequired
enrollment_pack.​description.​bodystringnon-emptyrequired
enrollment_pack.​activeboolean
enrollment_pack.​membership_after_one_monthboolean
enrollment_pack.​membership_optionalboolean
enrollment_pack.​enrollment_feenumber
enrollment_pack.​application_theme_template_idinteger
enrollment_pack.​country_idsArray of integers
enrollment_pack.​additional_volumeinteger
enrollment_pack.​member_enrollable_products_attributesArray of objects
enrollment_pack.​subscription_enrollable_products_attributesArray of objects
enrollment_pack.​images_attributesArray of objects
enrollment_pack.​enrollment_pack_agreementsArray of objects
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/enrollment_packs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrollment_pack": {
      "title": "string",
      "description": {
        "body": "string"
      },
      "active": true,
      "membership_after_one_month": true,
      "membership_optional": true,
      "enrollment_fee": 0,
      "application_theme_template_id": 0,
      "country_ids": [
        0
      ],
      "additional_volume": 0,
      "member_enrollable_products_attributes": [
        {
          "product_id": 0
        }
      ],
      "subscription_enrollable_products_attributes": [
        {
          "product_id": 0
        }
      ],
      "images_attributes": [
        {
          "image_url": "string",
          "position": 0
        }
      ],
      "enrollment_pack_agreements": [
        {
          "agreement_id": 0,
          "required": true
        }
      ]
    }
  }'

Responses

enrollment pack created

Bodyapplication/json
enrollment_packobject
metaobject
Response
application/json
{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "active": true,
    "description": { … },
    "enrollment_fee": "string",
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "additional_volume": 0,
    "application_theme_template_id": 0,
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Bulk update enrollment pack status

Request

Bodyapplication/json
idsArray of stringsrequired
statusstringrequired
Enum"active""draft"
curl -i -X PATCH \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/enrollment_packs/bulk_status_update \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "string"
    ],
    "status": "active"
  }'

Responses

enrollment packs updated

Bodyapplication/json
messagestring
updated_countinteger
idsArray of integers
metaobject
Response
application/json
{
  "message": "string",
  "updated_count": 0,
  "ids": [
    0
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieves a specific enrollment pack

Request

Path
idstringrequired

Enrollment pack ID

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

Responses

enrollment pack found

Bodyapplication/json
enrollment_packobject
metaobject
Response
application/json
{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "active": true,
    "description": { … },
    "enrollment_fee": "string",
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "additional_volume": 0,
    "application_theme_template_id": 0,
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete an enrollment pack

Request

Path
idstringrequired

Enrollment pack ID

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

Responses

enrollment pack deleted

Bodyapplication/json
messagestring
enrollment_packobject
metaobject
Response
application/json
{
  "message": "string",
  "enrollment_pack": {
    "id": 0
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update an enrollment pack

Request

Path
idstringrequired

Enrollment pack ID

Bodyapplication/json
idstringnon-emptyrequired
enrollment_packobjectrequired
enrollment_pack.​titlestringnon-empty
enrollment_pack.​descriptionobject
enrollment_pack.​activeboolean
enrollment_pack.​membership_after_one_monthboolean
enrollment_pack.​membership_optionalboolean
enrollment_pack.​enrollment_feenumber
enrollment_pack.​application_theme_template_idinteger
enrollment_pack.​country_idsArray of integers
enrollment_pack.​additional_volumeinteger
enrollment_pack.​member_enrollable_products_attributesArray of objects
enrollment_pack.​subscription_enrollable_products_attributesArray of objects
enrollment_pack.​images_attributesArray of objects
enrollment_pack.​enrollment_pack_agreementsArray of objects
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "enrollment_pack": {
      "title": "string",
      "description": {
        "body": "string"
      },
      "active": true,
      "membership_after_one_month": true,
      "membership_optional": true,
      "enrollment_fee": 0,
      "application_theme_template_id": 0,
      "country_ids": [
        0
      ],
      "additional_volume": 0,
      "member_enrollable_products_attributes": [
        {
          "id": 0,
          "product_id": 0,
          "_destroy": true
        }
      ],
      "subscription_enrollable_products_attributes": [
        {
          "id": 0,
          "product_id": 0,
          "_destroy": true
        }
      ],
      "images_attributes": [
        {
          "id": 0,
          "image_url": "string",
          "position": 0,
          "_destroy": true
        }
      ],
      "enrollment_pack_agreements": [
        {
          "id": 0,
          "agreement_id": 0,
          "required": true,
          "_destroy": true
        }
      ]
    }
  }'

Responses

enrollment pack updated

Bodyapplication/json
enrollment_packobject
metaobject
Response
application/json
{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "active": true,
    "description": { … },
    "enrollment_fee": "string",
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "additional_volume": 0,
    "application_theme_template_id": 0,
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

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