Deletes a file resource

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://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 - 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

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Returns a list of file resources

Request

Query

paginationobject

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

Responses

returns list of file resources

Bodyapplication/json

file_resourcesArray of objects(FileResource)

metaobject

Response

application/json

{
  "file_resources": [
    { … }
  ],
  "meta": {
    "total_count": 0,
    "total_pages": 0,
    "current_page": 0,
    "request_id": "string",
    "timestamp": "string"
  }
}

Creates a file resource

Request

Bodyapplication/json

file_resourceobject(FileResource)required

file_resource.idintegerrequired

file_resource.urlstringrequired

file_resource.preview_image_urlstring or null

file_resource.filenamestringrequired

file_resource.alt_textstring or null

file_resource.handlestring or null

file_resource.content_typestringrequired

file_resource.content_sizeintegerrequired

file_resource.contentstring or null

file_resource.relateable_idinteger or null

file_resource.relateable_typestring or null

file_resource.metadataobject or null

Default "{}"

file_resource.created_atstring(date-time)required

file_resource.updated_atstring(date-time)required

file_resource.versionstring or null

Example: "1"

file_resource.non_binarybooleanrequired

Example: true

file_resource.references_countobjectrequired

Example: {"ApplicationThemeTemplate":2}

curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/file_resources \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "file_resource": {
      "id": 0,
      "url": "string",
      "preview_image_url": "string",
      "filename": "string",
      "alt_text": "string",
      "handle": "string",
      "content_type": "string",
      "content_size": 0,
      "content": "string",
      "relateable_id": 0,
      "relateable_type": "string",
      "metadata": "{}",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "version": "1",
      "non_binary": true,
      "references_count": {
        "ApplicationThemeTemplate": 2
      }
    }
  }'

Responses

file resource created

Bodyapplication/json

file_resourceobject(FileResource)

metaobject

Response

application/json

{
  "file_resource": {
    "id": 0,
    "url": "string",
    "preview_image_url": "string",
    "filename": "string",
    "alt_text": "string",
    "handle": "string",
    "content_type": "string",
    "content_size": 0,
    "content": "string",
    "relateable_id": 0,
    "relateable_type": "string",
    "metadata": "{}",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "version": "1",
    "non_binary": true,
    "references_count": { … }
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Shows a file resource

Request

Path

idintegerrequired

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

Responses

returns a single file resource

Bodyapplication/json

file_resourceobject(FileResource)

metaobject

Response

application/json

{
  "file_resource": {
    "id": 0,
    "url": "string",
    "preview_image_url": "string",
    "filename": "string",
    "alt_text": "string",
    "handle": "string",
    "content_type": "string",
    "content_size": 0,
    "content": "string",
    "relateable_id": 0,
    "relateable_type": "string",
    "metadata": "{}",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "version": "1",
    "non_binary": true,
    "references_count": { … }
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Updates a file resource

Request

Path

idintegerrequired

Bodyapplication/json

file_resourceobject(FileResource)required

file_resource.idintegerrequired

file_resource.urlstringrequired

file_resource.preview_image_urlstring or null

file_resource.filenamestringrequired

file_resource.alt_textstring or null

file_resource.handlestring or null

file_resource.content_typestringrequired

file_resource.content_sizeintegerrequired

file_resource.contentstring or null

file_resource.relateable_idinteger or null

file_resource.relateable_typestring or null

file_resource.metadataobject or null

Default "{}"

file_resource.created_atstring(date-time)required

file_resource.updated_atstring(date-time)required

file_resource.versionstring or null

Example: "1"

file_resource.non_binarybooleanrequired

Example: true

file_resource.references_countobjectrequired

Example: {"ApplicationThemeTemplate":2}

curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/file_resources/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "file_resource": {
      "id": 0,
      "url": "string",
      "preview_image_url": "string",
      "filename": "string",
      "alt_text": "string",
      "handle": "string",
      "content_type": "string",
      "content_size": 0,
      "content": "string",
      "relateable_id": 0,
      "relateable_type": "string",
      "metadata": "{}",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "version": "1",
      "non_binary": true,
      "references_count": {
        "ApplicationThemeTemplate": 2
      }
    }
  }'

Responses

file resource updated

Bodyapplication/json

file_resourceobject(FileResource)

metaobject

Response

application/json

{
  "file_resource": {
    "id": 0,
    "url": "string",
    "preview_image_url": "string",
    "filename": "string",
    "alt_text": "string",
    "handle": "string",
    "content_type": "string",
    "content_size": 0,
    "content": "string",
    "relateable_id": 0,
    "relateable_type": "string",
    "metadata": "{}",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "version": "1",
    "non_binary": true,
    "references_count": { … }
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Deletes a file resource

Request

Path

idintegerrequired

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

Responses

file resource deleted

Bodyapplication/json

idinteger

metaobject

Response

application/json

{
  "id": 0,
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Creates multiple file resources

Request

Bodyapplication/json

file_resourcesobjectrequired

curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/file_resources/bulk_create \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "file_resources": {}
  }'

Responses

file resources created

Bodyapplication/json

file_resourcesArray of objects(FileResource)

metaobject

Response

application/json

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

Deletes multiple file resources

Request

Bodyapplication/json

idsArray of integersrequired

curl -i -X DELETE \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/file_resources/bulk_destroy \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      0
    ]
  }'

Responses

file resources deleted

Bodyapplication/json

idsArray of integers

metaobject

Response

application/json

{
  "ids": [
    0
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "destroyed_count": 0
  }
}

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

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations

Fluid Commerce APIs (1.0)

Admins

Agreements

ApplePay

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Carts

Commerce Orders

Companies

Company Custom Catch Ups

Company Discounts

Company Mobile Widgets

Company Pages

Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Company Webhook Events

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

Domains

Drop Zones

Droplet Categories

Droplet Installations

Droplets

Enrollment Packs

Enrollments

Fantasy Points

File Resources

Returns a list of file resources

RequestExpand all

Responses

Was this helpful?

Creates a file resource

RequestExpand all

Responses

Was this helpful?

Shows a file resource

Request

Responses

Was this helpful?

Updates a file resource

RequestExpand all

Responses

Was this helpful?

Deletes a file resource

Request

Responses

Was this helpful?

Creates multiple file resources

Request

Responses

Was this helpful?

Deletes multiple file resources

Request

Responses

Was this helpful?

Fluid Pay

Form Elements

Forms

GlobalEmbeds

Inventory Levels

Labels

Multi Factor Authentications

Multi-Factor Authentications

Notifications

Onboarding

Order Fulfillments

Orders

Payment

Payment Accounts

Request

Request

Request