The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.
For APIs that authenticate with User tokens, see the Rep APIs documentation.
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/v1/collections?page=1&per_page=10&public=all&search_query=string&sorted_by=created_at_desc&status=all' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "collections": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": { … } } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/company/v1/collections \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "collection": { "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, "application_theme_template_id": 1, "slug": "my-favourite", "custom_slug": false, "feature_attributes": { "_destroy": false, "position": 1 }, "product_collections_attributes": [ { "product_id": 1, "_destroy": false } ], "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 } } }'
{ "collection": { "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, "slug": "summer-collection", "custom_slug": false, "created_at": "string", "featured_date": "string", "featured": true, "application_theme_template": { … }, "search_engine_optimizer": { … }, "product_collections": [ … ] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/v1/collections/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "collection": { "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, "slug": "summer-collection", "custom_slug": false, "created_at": "string", "featured_date": "string", "featured": true, "application_theme_template": { … }, "search_engine_optimizer": { … }, "product_collections": [ … ] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
For fine-grained control over product associations. Use 'id' field to update existing associations.
curl -i -X PATCH \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/v1/collections/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "collection": { "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, "public": false, "active": true, "application_theme_template_id": 2, "slug": "updated-favourite", "custom_slug": false, "feature_attributes": { "_destroy": true, "position": 2 }, "product_collections_attributes": [ { "id": 5, "product_id": 4, "_destroy": true } ], "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 } } }'
{ "collection": { "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, "slug": "summer-collection", "custom_slug": false, "created_at": "string", "featured_date": "string", "featured": true, "application_theme_template": { … }, "search_engine_optimizer": { … }, "product_collections": [ … ] }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/v1/collections/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "message": "Collection deleted successfully", "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/v1/collections/{id_or_slug}'
OK
{ "status": "success", "data": { "collection": { … } } }
Social Media