Categories
/
Get category

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 Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

List categories

Request

Query
pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 25
publicstring

Filter by public status

Default "true"
Enum"all""true""false"
statusstring

Filter by status

Default "true"
Enum"all""true""false"
sorted_bystring

Sorting criteria for categories, e.g., 'created_at_asc', 'created_at_desc', 'title_asc', 'title_desc'

Default "created_at_desc"
search_querystring

Search keyword

Example: search_query=summer
parent_idinteger

Filter by parent category ID

source_typestring

Filter by source type

Default "product"
include_childrenboolean

Include child categories in response

Default false
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/categories?include_children=false&page=1&parent_id=0&per_page=25&public=all&search_query=string&sorted_by=created_at_desc&source_type=product&status=all' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

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

Create category

Request

Bodyapplication/json
categoryobjectrequired
category.​titlestringrequired
Example: "Summer Collection"
category.​descriptionstring
Example: "Our latest summer styles"
category.​image_urlstring
Example: "https://example.com/image.jpg"
category.​image_pathstring
Example: "/images/summer.jpg"
category.​positioninteger
Example: 1
category.​parent_idinteger
Example: null
category.​publicboolean
Example: true
category.​activeboolean
Example: true
category.​source_typestring
Example: "product"
category.​application_theme_template_idinteger
Example: 1
category.​slugstring
Example: "summer-collection"
category.​feature_attributesobject
category.​product_idsArray of integers
category.​search_engine_optimizer_attributesobject
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/categories \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": {
      "title": "Summer Collection",
      "description": "Our latest summer styles",
      "image_url": "https://example.com/image.jpg",
      "image_path": "/images/summer.jpg",
      "position": 1,
      "parent_id": null,
      "public": true,
      "active": true,
      "source_type": "product",
      "application_theme_template_id": 1,
      "slug": "summer-collection",
      "feature_attributes": {
        "_destroy": false,
        "position": 1
      },
      "product_ids": [
        0
      ],
      "search_engine_optimizer_attributes": {
        "title": "SEO Title",
        "description": "SEO Description",
        "image_url": "https://example.com/seo-image.jpg",
        "image_path": "/images/seo.jpg",
        "block_crawler": false
      }
    }
  }'

Responses

category created

Bodyapplication/json
categoryobject
metaobject
Response
application/json
{
  "category": {
    "id": 1,
    "title": "Summer Collection",
    "description": "Our latest summer styles",
    "image_url": "https://example.com/image.jpg",
    "image_path": "/images/summer.jpg",
    "position": 1,
    "public": true,
    "active": true,
    "source_type": "product",
    "parent_id": null,
    "has_children": false,
    "slug": "summer-collection",
    "created_at": "string",
    "updated_at": "string",
    "include_children": false,
    "parent_name": null,
    "sub_categories": [ … ],
    "application_theme_template": { … },
    "search_engine_optimizer": { … },
    "products": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get category

Request

Path
idstringrequired

Category ID

Query
include_childrenboolean

Include child categories in response

Default false
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/categories/{id}?include_children=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
categoryobject
metaobject
Response
application/json
{
  "category": {
    "id": 1,
    "title": "Summer Collection",
    "description": "Our latest summer styles",
    "image_url": "https://example.com/image.jpg",
    "image_path": "/images/summer.jpg",
    "position": 1,
    "public": true,
    "active": true,
    "source_type": "product",
    "parent_id": null,
    "has_children": false,
    "slug": "summer-collection",
    "created_at": "string",
    "updated_at": "string",
    "include_children": false,
    "parent_name": null,
    "sub_categories": [ … ],
    "application_theme_template": { … },
    "search_engine_optimizer": { … },
    "products": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update category

Request

Path
idintegerrequired

Category ID

Example: 1
Bodyapplication/json
categoryobjectrequired
category.​titlestringrequired
Example: "Updated Summer Collection"
category.​descriptionstring
Example: "Our updated summer styles"
category.​image_urlstring
Example: "https://example.com/updated-image.jpg"
category.​image_pathstring
Example: "/images/updated-summer.jpg"
category.​positioninteger
Example: 2
category.​parent_idinteger
Example: null
category.​publicboolean
Example: false
category.​activeboolean
Example: true
category.​source_typestring
Example: "product"
category.​application_theme_template_idinteger
Example: 2
category.​slugstring
Example: "updated-summer-collection"
category.​feature_attributesobject
category.​product_idsArray of integers
category.​search_engine_optimizer_attributesobject
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/v1/categories/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "category": {
      "title": "Updated Summer Collection",
      "description": "Our updated summer styles",
      "image_url": "https://example.com/updated-image.jpg",
      "image_path": "/images/updated-summer.jpg",
      "position": 2,
      "parent_id": null,
      "public": false,
      "active": true,
      "source_type": "product",
      "application_theme_template_id": 2,
      "slug": "updated-summer-collection",
      "feature_attributes": {
        "_destroy": true,
        "position": 2
      },
      "product_ids": [
        0
      ],
      "search_engine_optimizer_attributes": {
        "id": 3,
        "title": "Updated SEO Title",
        "description": "Updated SEO Description",
        "image_url": "https://example.com/updated-seo-image.jpg",
        "image_path": "/images/updated-seo.jpg",
        "block_crawler": true
      }
    }
  }'

Responses

category updated

Bodyapplication/json
categoryobject
metaobject
Response
application/json
{
  "category": {
    "id": 1,
    "title": "Summer Collection",
    "description": "Our latest summer styles",
    "image_url": "https://example.com/image.jpg",
    "image_path": "/images/summer.jpg",
    "position": 1,
    "public": true,
    "active": true,
    "source_type": "product",
    "parent_id": null,
    "has_children": false,
    "slug": "summer-collection",
    "created_at": "string",
    "updated_at": "string",
    "include_children": false,
    "parent_name": null,
    "sub_categories": [ … ],
    "application_theme_template": { … },
    "search_engine_optimizer": { … },
    "products": [ … ]
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete category

Request

Path
idstringrequired

Category ID

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

Responses

category deleted

Bodyapplication/json
messagestring
Example: "category deleted successfully"
metaobject
Response
application/json
{
  "message": "category deleted successfully",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Collections

Operations

Companies

Operations

Company Admins

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

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

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

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations