Delete a metafield definition

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

Admins

Operations

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

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

Dam

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

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Metafield Definitions

Operations

List metafield definitions

Request

Retrieve a list of metafield definitions for the authenticated company

Query

owner_resourcestring

Filter by resource type

Enum"Product""Variant"

Example: owner_resource=Product

pinnedboolean

Filter by pinned status

Example: pinned=true

search_querystring

Search in name, description, namespace, or key

Example: search_query=material

pageinteger

Page number for pagination

Default 1

per_pageinteger

Number of records per page

Default 20

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafield_definitions?owner_resource=Product&page=1&per_page=20&pinned=true&search_query=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Metafield definitions retrieved successfully

Bodyapplication/json

metafield_definitionsArray of objects(MetafieldDefinition)

metaobject

Response

application/json

{
  "metafield_definitions": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

Create a metafield definition

Request

Create a new metafield definition

Bodyapplication/json

metafield_definitionobjectrequired

metafield_definition.namespacestring<= 20 charactersrequired

Namespace for the metafield definition (alphanumeric and underscores only)

Example: "product_specs"

metafield_definition.keystring<= 30 charactersrequired

Key for the metafield definition (alphanumeric and underscores only)

Example: "material_type"

metafield_definition.namestring<= 100 charactersrequired

Display name for the metafield definition

Example: "Material Type"

metafield_definition.value_typestringrequired

Type of value this metafield will store

Enum"single_line_text_field""multi_line_text_field""number_integer""number_decimal""boolean""date""date_time""json""color""url"

Example: "single_line_text_field"

metafield_definition.owner_resourcestringrequired

Resource type that owns this metafield definition

Enum"Product""Variant"

Example: "Product"

metafield_definition.descriptionstring

Optional description of the metafield definition

Example: "The primary material used in manufacturing this product"

metafield_definition.categorystring

Optional category for organizing metafield definitions

Example: "Product Details"

metafield_definition.pinnedboolean

Whether this metafield definition should be pinned for easy access

Default false

Example: false

metafield_definition.positioninteger

Position for ordering metafield definitions

Example: 1

metafield_definition.validation_rulesobject

Optional validation rules for the metafield values

Example: {"min":1,"max":100,"choices":["small","medium","large"]}

curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafield_definitions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metafield_definition": {
      "namespace": "product_specs",
      "key": "material_type",
      "name": "Material Type",
      "value_type": "single_line_text_field",
      "owner_resource": "Product",
      "description": "The primary material used in manufacturing this product",
      "category": "Product Details",
      "pinned": false,
      "position": 1,
      "validation_rules": {
        "min": 1,
        "max": 100,
        "choices": [
          "small",
          "medium",
          "large"
        ]
      }
    }
  }'

Responses

Metafield definition created successfully

Bodyapplication/json

metafield_definitionobject(MetafieldDefinition)required

metafield_definition.idintegerrequired

metafield_definition.company_idintegerrequired

The ID of the company that owns this metafield definition.

Example: 1

metafield_definition.namespacestring<= 20 characters\A[a-zA-Z0-9_]+\zrequired

A container for related metafield definitions. Used to group definitions by app or functionality. Must be unique within company and owner_resource.

Example: "product_details"

metafield_definition.keystring<= 30 characters\A[a-zA-Z0-9_]+\zrequired

The unique identifier for the metafield definition within its namespace and owner_resource. Combined with namespace and owner_resource, this must be unique per company.

Example: "material_type"

metafield_definition.namestring<= 100 charactersrequired

Human-readable display name for the metafield definition, shown in admin interfaces and forms.

Example: "Material Type"

metafield_definition.descriptionstring or null

Detailed explanation of what this metafield definition represents, how it should be used, and any special instructions for content creators.

Example: "Specify the primary material composition of the product (e.g., cotton, polyester, silk). This will be displayed on the product detail page."

metafield_definition.value_typestringrequired

The data type that defines how metafield values should be validated, stored, and displayed. Determines which validation rules are available.

Example: "single_line_text_field"

metafield_definition.validation_rulesobject or null

JSON object containing validation constraints that will be applied to metafield values. Available rules depend on the value_type.

Example: {"choices":["cotton","polyester","silk","wool","linen","bamboo"],"max":50,"min":2}

metafield_definition.owner_resourcestringrequired

The type of resource (model class name) that metafields using this definition can be attached to. Must match the polymorphic owner_type.

Example: "Product"

metafield_definition.categorystring or null

Optional category for organizing metafield definitions in admin interfaces. Used for grouping related definitions together.

Example: "Product"

metafield_definition.pinnedboolean or null

Whether this definition should be prominently displayed or prioritized in admin interfaces and forms.

Default false

Example: false

metafield_definition.positioninteger or null

Sort order for displaying this definition relative to others in the same category and owner_resource. Lower numbers appear first.

Default 0

Example: 1

metafield_definition.created_atstring(date-time)required

Timestamp when the metafield definition was created.

Example: "2024-01-15T10:30:00Z"

metafield_definition.updated_atstring(date-time)required

Timestamp when the metafield definition was last updated.

Example: "2024-02-20T14:45:00Z"

metafield_definition.list_typebooleanrequired

Whether this definition is for list-type metafields that store arrays of values.

Example: false

metafield_definition.reference_typebooleanrequired

Whether this definition is for reference-type metafields that store references to other resources.

Example: false

metafield_definition.supported_validationsArray of arraysrequired

Array of validation rule names that are supported for this value_type.

Example: ["min","max","choices","regex"]

metafield_definition.validation_descriptionstringrequired

Human-readable description of what the value_type represents and its constraints.

Example: "Single line text up to 5000 characters"

metaobject

Response

application/json

{
  "metafield_definition": {
    "id": 0,
    "company_id": 1,
    "namespace": "product_details",
    "key": "material_type",
    "name": "Material Type",
    "description": "Specify the primary material composition of the product (e.g., cotton, polyester, silk). This will be displayed on the product detail page.",
    "value_type": "single_line_text_field",
    "validation_rules": { … },
    "owner_resource": "Product",
    "category": "Product",
    "pinned": false,
    "position": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-20T14:45:00Z",
    "list_type": false,
    "reference_type": false,
    "supported_validations": [ … ],
    "validation_description": "Single line text up to 5000 characters"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get a metafield definition

Request

Retrieve a single metafield definition by ID

Path

idintegerrequired

The ID of the metafield definition to retrieve

Example: 123

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

Responses

Metafield definition retrieved successfully

Bodyapplication/json

metafield_definitionobject(MetafieldDefinition)required

metafield_definition.idintegerrequired

metafield_definition.company_idintegerrequired

The ID of the company that owns this metafield definition.

Example: 1

metafield_definition.namespacestring<= 20 characters\A[a-zA-Z0-9_]+\zrequired

A container for related metafield definitions. Used to group definitions by app or functionality. Must be unique within company and owner_resource.

Example: "product_details"

metafield_definition.keystring<= 30 characters\A[a-zA-Z0-9_]+\zrequired

The unique identifier for the metafield definition within its namespace and owner_resource. Combined with namespace and owner_resource, this must be unique per company.

Example: "material_type"

metafield_definition.namestring<= 100 charactersrequired

Human-readable display name for the metafield definition, shown in admin interfaces and forms.

Example: "Material Type"

metafield_definition.descriptionstring or null

Detailed explanation of what this metafield definition represents, how it should be used, and any special instructions for content creators.

Example: "Specify the primary material composition of the product (e.g., cotton, polyester, silk). This will be displayed on the product detail page."

metafield_definition.value_typestringrequired

The data type that defines how metafield values should be validated, stored, and displayed. Determines which validation rules are available.

Example: "single_line_text_field"

metafield_definition.validation_rulesobject or null

JSON object containing validation constraints that will be applied to metafield values. Available rules depend on the value_type.

Example: {"choices":["cotton","polyester","silk","wool","linen","bamboo"],"max":50,"min":2}

metafield_definition.owner_resourcestringrequired

The type of resource (model class name) that metafields using this definition can be attached to. Must match the polymorphic owner_type.

Example: "Product"

metafield_definition.categorystring or null

Optional category for organizing metafield definitions in admin interfaces. Used for grouping related definitions together.

Example: "Product"

metafield_definition.pinnedboolean or null

Whether this definition should be prominently displayed or prioritized in admin interfaces and forms.

Default false

Example: false

metafield_definition.positioninteger or null

Sort order for displaying this definition relative to others in the same category and owner_resource. Lower numbers appear first.

Default 0

Example: 1

metafield_definition.created_atstring(date-time)required

Timestamp when the metafield definition was created.

Example: "2024-01-15T10:30:00Z"

metafield_definition.updated_atstring(date-time)required

Timestamp when the metafield definition was last updated.

Example: "2024-02-20T14:45:00Z"

metafield_definition.list_typebooleanrequired

Whether this definition is for list-type metafields that store arrays of values.

Example: false

metafield_definition.reference_typebooleanrequired

Whether this definition is for reference-type metafields that store references to other resources.

Example: false

metafield_definition.supported_validationsArray of arraysrequired

Array of validation rule names that are supported for this value_type.

Example: ["min","max","choices","regex"]

metafield_definition.validation_descriptionstringrequired

Human-readable description of what the value_type represents and its constraints.

Example: "Single line text up to 5000 characters"

metaobject

Response

application/json

{
  "metafield_definition": {
    "id": 0,
    "company_id": 1,
    "namespace": "product_details",
    "key": "material_type",
    "name": "Material Type",
    "description": "Specify the primary material composition of the product (e.g., cotton, polyester, silk). This will be displayed on the product detail page.",
    "value_type": "single_line_text_field",
    "validation_rules": { … },
    "owner_resource": "Product",
    "category": "Product",
    "pinned": false,
    "position": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-20T14:45:00Z",
    "list_type": false,
    "reference_type": false,
    "supported_validations": [ … ],
    "validation_description": "Single line text up to 5000 characters"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a metafield definition

Request

Update a metafield definition. Only name, description, category, pinned, and position can be updated.

Path

idintegerrequired

The ID of the metafield definition to update

Example: 123

Bodyapplication/json

metafield_definitionobjectrequired

metafield_definition.namestring<= 100 charactersrequired

Display name for the metafield definition

Example: "Updated Material Type"

metafield_definition.descriptionstringrequired

Description of the metafield definition

Example: "Updated description for the material type field"

metafield_definition.categorystring

Category for organizing metafield definitions

Example: "Updated Product Details"

metafield_definition.pinnedboolean

Whether this metafield definition should be pinned for easy access

Example: true

metafield_definition.positioninteger

Position for ordering metafield definitions

Example: 5

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafield_definitions/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metafield_definition": {
      "name": "Updated Material Type",
      "description": "Updated description for the material type field",
      "category": "Updated Product Details",
      "pinned": true,
      "position": 5
    }
  }'

Responses

Metafield definition updated successfully

Bodyapplication/json

metafield_definitionobject(MetafieldDefinition)required

metafield_definition.idintegerrequired

metafield_definition.company_idintegerrequired

The ID of the company that owns this metafield definition.

Example: 1

metafield_definition.namespacestring<= 20 characters\A[a-zA-Z0-9_]+\zrequired

A container for related metafield definitions. Used to group definitions by app or functionality. Must be unique within company and owner_resource.

Example: "product_details"

metafield_definition.keystring<= 30 characters\A[a-zA-Z0-9_]+\zrequired

The unique identifier for the metafield definition within its namespace and owner_resource. Combined with namespace and owner_resource, this must be unique per company.

Example: "material_type"

metafield_definition.namestring<= 100 charactersrequired

Human-readable display name for the metafield definition, shown in admin interfaces and forms.

Example: "Material Type"

metafield_definition.descriptionstring or null

Detailed explanation of what this metafield definition represents, how it should be used, and any special instructions for content creators.

Example: "Specify the primary material composition of the product (e.g., cotton, polyester, silk). This will be displayed on the product detail page."

metafield_definition.value_typestringrequired

The data type that defines how metafield values should be validated, stored, and displayed. Determines which validation rules are available.

Example: "single_line_text_field"

metafield_definition.validation_rulesobject or null

JSON object containing validation constraints that will be applied to metafield values. Available rules depend on the value_type.

Example: {"choices":["cotton","polyester","silk","wool","linen","bamboo"],"max":50,"min":2}

metafield_definition.owner_resourcestringrequired

The type of resource (model class name) that metafields using this definition can be attached to. Must match the polymorphic owner_type.

Example: "Product"

metafield_definition.categorystring or null

Optional category for organizing metafield definitions in admin interfaces. Used for grouping related definitions together.

Example: "Product"

metafield_definition.pinnedboolean or null

Whether this definition should be prominently displayed or prioritized in admin interfaces and forms.

Default false

Example: false

metafield_definition.positioninteger or null

Sort order for displaying this definition relative to others in the same category and owner_resource. Lower numbers appear first.

Default 0

Example: 1

metafield_definition.created_atstring(date-time)required

Timestamp when the metafield definition was created.

Example: "2024-01-15T10:30:00Z"

metafield_definition.updated_atstring(date-time)required

Timestamp when the metafield definition was last updated.

Example: "2024-02-20T14:45:00Z"

metafield_definition.list_typebooleanrequired

Whether this definition is for list-type metafields that store arrays of values.

Example: false

metafield_definition.reference_typebooleanrequired

Whether this definition is for reference-type metafields that store references to other resources.

Example: false

metafield_definition.supported_validationsArray of arraysrequired

Array of validation rule names that are supported for this value_type.

Example: ["min","max","choices","regex"]

metafield_definition.validation_descriptionstringrequired

Human-readable description of what the value_type represents and its constraints.

Example: "Single line text up to 5000 characters"

metaobject

Response

application/json

{
  "metafield_definition": {
    "id": 0,
    "company_id": 1,
    "namespace": "product_details",
    "key": "material_type",
    "name": "Material Type",
    "description": "Specify the primary material composition of the product (e.g., cotton, polyester, silk). This will be displayed on the product detail page.",
    "value_type": "single_line_text_field",
    "validation_rules": { … },
    "owner_resource": "Product",
    "category": "Product",
    "pinned": false,
    "position": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-02-20T14:45:00Z",
    "list_type": false,
    "reference_type": false,
    "supported_validations": [ … ],
    "validation_description": "Single line text up to 5000 characters"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a metafield definition

Request

Delete a metafield definition by ID

Path

idintegerrequired

The ID of the metafield definition to delete

Example: 123

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

Responses

Metafield definition deleted successfully

Bodyapplication/json

idintegerrequired

ID of the deleted metafield definition

metaobject

Response

application/json

{
  "id": 0,
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Get supported data types

Request

Retrieve a list of all supported data types for metafield definitions along with their descriptions and supported validations

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafield_definitions/supported_data_types \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Supported data types retrieved successfully

Bodyapplication/json

supported_data_typesArray of objectsrequired

supported_data_types[].value_typestringrequired

The value type identifier

Example: "single_line_text_field"

supported_data_types[].descriptionstringrequired

Human-readable description of the data type

Example: "Single line text field for short text values"

supported_data_types[].supported_validationsArray of objectsrequired

List of validation rules supported by this data type

supported_data_types[].supported_validations[].keystringrequired

The validation rule key

Example: "min"

supported_data_types[].supported_validations[].descriptionstring or nullrequired

Description of what this validation rule does

Example: "Minimum length for text fields"

metaobject

Response

application/json

{
  "supported_data_types": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

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

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Fluid Commerce APIs (1.0)

Admins

Agreements

ApplePay

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Callback Schemas

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

Dam

Domains

Drop Zones

Droplet Categories

Droplet Installations

Droplets

Enrollment Packs

Enrollments

Fantasy Points

File Resources

Fluid Pay

Form Elements

Forms

GlobalEmbeds

Impersonation

Inventory Levels

Labels

Metafield Definitions

List metafield definitions

Request

Responses

Was this helpful?

Create a metafield definition

RequestExpand all

Responses

Was this helpful?

Get a metafield definition

Request

Responses

Was this helpful?

Update a metafield definition

RequestExpand all

Responses

Was this helpful?

Delete a metafield definition

Request

Responses

Was this helpful?

Get supported data types

Request

Responses

Was this helpful?

Multi Factor Authentications

Multi-Factor Authentications

Notifications

Onboarding

Order Fulfillments

Orders

Payment

Payment Accounts

Request

Request