enrollment-packs

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://fluid-commerce.redocly.app/_mock/docs/apis/public/

Production API server

https://api.fluid.app/

Local development server

https://api.fluid.test/

Orders

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

Get enrollment pack by slug

Request

Path

slugstringrequired

Enrollment pack slug

Example: example-slug

Bodyapplication/json

metadataobject(RequestMetadata)required

metadata.fluid_shopstringrequired

Example: "myshop"

metadata.fluid_sessionstring(/\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/)required

Example: "fs_szwdDuRbqEe7AV7sXk7vVq"

metadata.fluid_localestring(/\A[a-z]{2}_[A-Z]{2}\z/)

Example: "en_US"

metadata.fluid_journeystring

metadata.attributionAttributionEmail (object) or AttributionUsername (object) or AttributionSharedGuid (object) or AttributionFluidRepId (object) or AttributionExternalId (object)(Attribution)

Any of:

curl -i -X POST \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/public/api/public/v2025-06/enrollment_packs/{slug}' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "fluid_shop": "myshop",
      "fluid_session": "fs_szwdDuRbqEe7AV7sXk7vVq",
      "fluid_locale": "en_US",
      "fluid_journey": "string",
      "attribution": {
        "email": "salesrep@example.com"
      }
    }
  }'

Responses

Enrollment pack retrieved successfully

Bodyapplication/json

statusnumberrequired

Example: 200

enrollment_packobjectrequired

enrollment_pack.slugstringrequired

enrollment_pack.enrollment_pack_idinteger

enrollment_pack.titlestringrequired

enrollment_pack.descriptionobjectrequired

enrollment_pack.description.idinteger

enrollment_pack.description.namestring

enrollment_pack.description.bodystring

enrollment_pack.description.record_typestring

enrollment_pack.description.record_idinteger

enrollment_pack.description.created_atstring

enrollment_pack.description.updated_atstring

enrollment_pack.description.localestring

enrollment_pack.enrollment_feestringrequired

enrollment_pack.additional_volumestring or null

enrollment_pack.tokenstringrequired

metadataobject(ResponseMetadata)required

metadata.fluid_shopstringrequired

metadata.fluid_sessionstringrequired

metadata.fluid_localestring or null(/\A[a-z]{2}_[A-Z]{2}\z/)

Example: "en_US"

metadata.request_uuidstring(uuid)required

metadata.timestampstringrequired

Response

application/json

{
  "status": 200,
  "enrollment_pack": {
    "slug": "string",
    "enrollment_pack_id": 0,
    "title": "string",
    "description": { … },
    "enrollment_fee": "string",
    "additional_volume": "string",
    "token": "string"
  },
  "metadata": {
    "fluid_shop": "string",
    "fluid_session": "string",
    "fluid_locale": "en_US",
    "request_uuid": "a699086b-c336-457e-9191-0c825d6efbc8",
    "timestamp": "string"
  }
}

events

Operations

lead

Operations

page

Operations

url

Operations

fingerprint

Operations

media

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

widgets

Operations