Lists all 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

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 - Warehouses

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Lists all enrollment packs

Request

Query

filterrific[by_status]string

Filter by status (active/draft)

pageinteger

Page number for pagination

per_pageinteger

Number of items per page

Headers

Authorizationstringrequired

Bearer token for authentication

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs?filterrific%5Bby_status%5D=string&page=0&per_page=0' \
  -H 'Authorization: string'

Responses

enrollment packs found

Bodyapplication/json

enrollment_packsArray of objects

metaobject

Response

application/json

{
  "enrollment_packs": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Creates a new enrollment pack

Request

Headers

Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json

enrollment_packobjectrequired

enrollment_pack.titlestringrequired

enrollment_pack.tokenstring

enrollment_pack.descriptionobjectrequired

enrollment_pack.description.bodystring

enrollment_pack.country_idsArray of integersrequired

enrollment_pack.enrollment_feestringrequired

enrollment_pack.membership_after_one_monthbooleanrequired

enrollment_pack.membership_optionalbooleanrequired

enrollment_pack.statusstringrequired

enrollment_pack.member_enrollable_products_attributesArray of objectsrequired

enrollment_pack.member_enrollable_products_attributes[].product_idintegerrequired

enrollment_pack.subscription_enrollable_products_attributesArray of objects

curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrollment_pack": {
      "title": "string",
      "token": "string",
      "description": {
        "body": "string"
      },
      "country_ids": [
        0
      ],
      "enrollment_fee": "string",
      "membership_after_one_month": true,
      "membership_optional": true,
      "status": "string",
      "member_enrollable_products_attributes": [
        {
          "product_id": 0
        }
      ],
      "subscription_enrollable_products_attributes": [
        {
          "product_id": 0
        }
      ]
    }
  }'

Responses

enrollment pack created

Bodyapplication/json

enrollment_packobject

metaobject

Response

application/json

{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "description": { … },
    "active": true,
    "enrollment_fee": "string",
    "additional_volume": 0,
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ],
    "subscription_enrollable_products": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Updates agreements for an enrollment pack

Request

Path

idstringrequired

Headers

Authorizationstringrequired

Bodyapplication/json

enrollment_pack_agreementsArray of objectsrequired

enrollment_pack_agreements[].agreement_idintegerrequired

enrollment_pack_agreements[].requiredbooleanrequired

enrollment_pack_agreements[].enabledbooleanrequired

curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}/update_agreements' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrollment_pack_agreements": [
      {
        "agreement_id": 0,
        "required": true,
        "enabled": true
      }
    ]
  }'

Responses

agreements updated

Bodyapplication/json

enrollment_packobjectrequired

enrollment_pack.enrollment_pack_idintegerrequired

enrollment_pack.tokenstring

enrollment_pack.titlestringrequired

enrollment_pack.descriptionobjectrequired

enrollment_pack.description.idinteger

enrollment_pack.description.namestring

enrollment_pack.description.bodystring

enrollment_pack.description.localestring

enrollment_pack.description.record_typestring

enrollment_pack.description.record_idinteger

enrollment_pack.description.created_atstring(date-time)

enrollment_pack.description.updated_atstring(date-time)

enrollment_pack.activebooleanrequired

enrollment_pack.enrollment_feestringrequired

enrollment_pack.additional_volumeinteger or null

enrollment_pack.membership_after_one_monthbooleanrequired

enrollment_pack.membership_optionalbooleanrequired

enrollment_pack.statusstringrequired

enrollment_pack.country_idsArray of integersrequired

enrollment_pack.member_enrollable_productsArray of objectsrequired

enrollment_pack.member_enrollable_products[].idinteger

enrollment_pack.member_enrollable_products[].product_idinteger

enrollment_pack.subscription_enrollable_productsArray of objectsrequired

enrollment_pack.subscription_enrollable_products[].idinteger

enrollment_pack.subscription_enrollable_products[].product_idinteger

enrollment_pack.imagesArray of objectsrequired

enrollment_pack.images[].idinteger

enrollment_pack.images[].image_urlstring

enrollment_pack.images[].positioninteger

enrollment_pack.enrollment_pack_agreementsArray of objectsrequired

enrollment_pack.enrollment_pack_agreements[].idintegerrequired

enrollment_pack.enrollment_pack_agreements[].agreement_idintegerrequired

enrollment_pack.enrollment_pack_agreements[].requiredbooleanrequired

metaobject

Response

application/json

{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "description": { … },
    "active": true,
    "enrollment_fee": "string",
    "additional_volume": 0,
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Updates status for multiple enrollment packs

Request

Headers

Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json

enrollment_pack_idsArray of stringsrequired

Array of enrollment pack IDs to update

statusstringrequired

Status to set for all enrollment packs

Enum"active""draft"

curl -i -X PATCH \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/bulk_status_update \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrollment_pack_ids": [
      "string"
    ],
    "status": "active"
  }'

Responses

enrollment packs updated

Bodyapplication/json

messagestring

updated_countinteger

enrollment_pack_idsArray of integers

metaobject

Response

application/json

{
  "message": "string",
  "updated_count": 0,
  "enrollment_pack_ids": [
    0
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Creates a product association in an enrollment pack

Request

Path

idstringrequired

Enrollment pack ID

Headers

Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json

product_idintegerrequired

ID of the product to associate

typestringrequired

Type of the product association

Enum"membership_product""subscription_product"

Example: "membership_product"

membership_after_one_monthboolean

For subscription products only - whether to grant membership after one month

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}/product' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": 0,
    "type": "membership_product",
    "membership_after_one_month": true
  }'

Responses

subscription product association created with membership_after_one_month

Bodyapplication/json

enrollment_packobject

metaobject

Response

application/json

{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "description": { … },
    "active": true,
    "enrollment_fee": "string",
    "additional_volume": 0,
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Deletes an enroll product from an enrollment pack

Request

Path

idstringrequired

Enrollment pack ID

enroll_product_idstringrequired

Enroll product ID

Headers

Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json

typestringrequired

Type of enroll product

Enum"membership_product""subscription_product"

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}/product/{enroll_product_id}' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "membership_product"
  }'

Responses

enroll product deleted

Bodyapplication/json

enrollment_packobject

metaobject

Response

application/json

{
  "enrollment_pack": {
    "id": 0,
    "deleted_product_id": 0
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Retrieves a specific enrollment pack

Request

Path

idstringrequired

Enrollment pack ID

Headers

Authorizationstringrequired

Bearer token for authentication

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}' \
  -H 'Authorization: string'

Responses

enrollment pack found

Bodyapplication/json

enrollment_packobject

metaobject

Response

application/json

{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "description": { … },
    "active": true,
    "enrollment_fee": "string",
    "additional_volume": 0,
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Deletes an enrollment pack

Request

Path

idstringrequired

Enrollment pack ID

Headers

Authorizationstringrequired

Bearer token for authentication

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}' \
  -H 'Authorization: string'

Responses

enrollment pack deleted

Bodyapplication/json

messagestring

enrollment_packobject

metaobject

Response

application/json

{
  "message": "string",
  "enrollment_pack": {
    "id": 0
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Updates an enrollment pack

Request

Path

idstringrequired

Enrollment pack ID

Headers

Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json

enrollment_packobjectrequired

enrollment_pack.tokenstring

enrollment_pack.titlestring

enrollment_pack.descriptionobject

enrollment_pack.enrollment_fee_enabledboolean

enrollment_pack.activeboolean

enrollment_pack.membership_after_one_monthboolean

enrollment_pack.membership_optionalboolean

enrollment_pack.enrollment_feestring

enrollment_pack.country_idsArray of integers

curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrollment_pack": {
      "token": "string",
      "title": "string",
      "description": {
        "body": "string"
      },
      "enrollment_fee_enabled": true,
      "active": true,
      "membership_after_one_month": true,
      "membership_optional": true,
      "enrollment_fee": "string",
      "country_ids": [
        0
      ]
    }
  }'

Responses

enrollment pack updated

Bodyapplication/json

enrollment_packobject

metaobject

Response

application/json

{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "description": { … },
    "active": true,
    "enrollment_fee": "string",
    "additional_volume": 0,
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "country_ids": [ … ],
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Adds images to an enrollment pack

Request

Path

idstringrequired

Enrollment pack ID

Headers

Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json

images_attributesArray of objectsrequired

images_attributes[].image_urlstringrequired

images_attributes[].positionintegerrequired

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}/images' \
  -H 'Authorization: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "images_attributes": [
      {
        "image_url": "string",
        "position": 0
      }
    ]
  }'

Responses

images added

Bodyapplication/json

enrollment_packobject

metaobject

Response

application/json

{
  "enrollment_pack": {
    "enrollment_pack_id": 0,
    "token": "string",
    "title": "string",
    "description": { … },
    "active": true,
    "enrollment_fee": "string",
    "additional_volume": 0,
    "country_ids": [ … ],
    "membership_after_one_month": true,
    "membership_optional": true,
    "status": "string",
    "member_enrollable_products": [ … ],
    "subscription_enrollable_products": [ … ],
    "images": [ … ],
    "enrollment_pack_agreements": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Deletes an image from an enrollment pack

Request

Path

idstringrequired

Enrollment pack ID

image_idstringrequired

Image ID

Headers

Authorizationstringrequired

Bearer token for authentication

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/enrollment_packs/{id}/images/{image_id}' \
  -H 'Authorization: string'

Responses

image deleted

Bodyapplication/json

enrollment_packobject

metaobject

Response

application/json

{
  "enrollment_pack": {
    "id": 0,
    "image_id": 0
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

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

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

Fluid Commerce APIs (1.0)

Agreements

ApplePay

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Carts

Company Custom Catch Ups

Company Discounts

Company Droplets

Company Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

Domains

Drop Zones

Droplets

Enrollment Packs

Lists all enrollment packs

Request

Responses

Was this helpful?

Creates a new enrollment pack

RequestExpand all

Responses

Was this helpful?

Updates agreements for an enrollment pack

RequestExpand all

Responses

Was this helpful?

Updates status for multiple enrollment packs

Request

Responses

Was this helpful?

Creates a product association in an enrollment pack

Request

Responses

Was this helpful?

Deletes an enroll product from an enrollment pack

Request

Responses

Was this helpful?

Retrieves a specific enrollment pack

Request

Responses

Was this helpful?

Deletes an enrollment pack

Request

Responses

Was this helpful?

Updates an enrollment pack

RequestExpand all

Responses

Was this helpful?

Adds images to an enrollment pack

RequestExpand all

Responses

Was this helpful?

Deletes an image from an enrollment pack

Request

Responses

Was this helpful?

Enrollments

Fantasy Points

Fluid Pay

GlobalEmbeds

Inventory Levels

Multi-Factor Authentications

Notifications

Order Fulfillments

Request

Request

Request

Request