Metafields

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

Announcements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

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

Entities

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

MCC Codes

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Create a metafield for a resource

Request

Create a new metafield for a specific resource

Bodyapplication/json
resource_typestringrequired

Type of resource to create metafield for

Enum"customer""order""product""variant"
Example: "product"
resource_idintegerrequired

ID of the resource

Example: 123
namespacestringrequired

Namespace for the metafield (max 20 characters, alphanumeric and underscores only)

Example: "seo"
keystringrequired

Key for the metafield (max 30 characters, alphanumeric and underscores only)

Example: "title"
valuestring or integer or boolean or object or Array of arraysrequired

The value to store in the metafield

Example: "SEO Title"
One of:

The value to store in the metafield

string

The value to store in the metafield

value_typestringrequired

The type that defines how the value should be interpreted

Example: "single_line_text_field"
descriptionstring

Optional description of the metafield's purpose

Example: "Page title for SEO purposes"
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafields \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_type": "product",
    "resource_id": 123,
    "namespace": "seo",
    "key": "title",
    "value": "SEO Title",
    "value_type": "single_line_text_field",
    "description": "Page title for SEO purposes"
  }'

Responses

metafield created successfully

Bodyapplication/json
metafieldobject(EmbeddedMetafield)required
metafield.​namespacestringrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"
metafield.​keystringrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"
metafield.​valuestring or integer or object or boolean or numberrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"
metafield.​value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"
metafield.​descriptionstring or nullrequired

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"
metafield.​created_atstringrequired

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"
metafield.​updated_atstringrequired

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "metafield": {
    "namespace": "custom",
    "key": "material",
    "value": "cotton",
    "value_type": "single_line_text_field",
    "description": "The primary material used in this product",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a metafield for a resource

Request

Delete an existing metafield for a specific resource

Bodyapplication/json
resource_typestringrequired

Type of resource to delete metafield from

Enum"customer""order""product""variant"
Example: "product"
resource_idintegerrequired

ID of the resource

Example: 123
namespacestringrequired

Namespace of the metafield to delete

Example: "seo"
keystringrequired

Key of the metafield to delete

Example: "title"
curl -i -X DELETE \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafields \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_type": "product",
    "resource_id": 123,
    "namespace": "seo",
    "key": "title"
  }'

Responses

metafield deleted successfully

Bodyapplication/json
messagestringrequired
Example: "Metafield deleted successfully"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "message": "Metafield deleted successfully",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

List metafields for a resource

Request

Retrieve all metafields associated with a specific resource

Query
resource_typestringrequired

Type of resource to get metafields for

Enum"customer""order""product""variant"
Example: resource_type=product
resource_idintegerrequired

ID of the resource

pageinteger

Page number for pagination (default: 1)

per_pageinteger

Number of items per page (default: 25)

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafields?page=0&per_page=0&resource_id=0&resource_type=customer' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

metafields retrieved successfully

Bodyapplication/json
metafieldsArray of objects(EmbeddedMetafield)required
metafields[].​namespacestringrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"
metafields[].​keystringrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"
metafields[].​valuestring or integer or object or boolean or numberrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"
metafields[].​value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"
metafields[].​descriptionstring or nullrequired

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"
metafields[].​created_atstringrequired

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"
metafields[].​updated_atstringrequired

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
meta.​paginationobject
Response
application/json
{
  "metafields": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

Get a specific metafield

Request

Retrieve a specific metafield by namespace and key for a given resource

Query
resource_typestringrequired

Type of resource the metafield belongs to

Enum"customer""order""product""variant"
Example: resource_type=product
resource_idintegerrequired

ID of the resource

namespacestringrequired

Namespace of the metafield

Example: namespace=seo
keystringrequired

Key of the metafield

Example: key=title
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafields/show?key=string&namespace=string&resource_id=0&resource_type=customer' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json
metafieldobject(EmbeddedMetafield)required
metafield.​namespacestringrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"
metafield.​keystringrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"
metafield.​valuestring or integer or object or boolean or numberrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"
metafield.​value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"
metafield.​descriptionstring or nullrequired

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"
metafield.​created_atstringrequired

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"
metafield.​updated_atstringrequired

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "metafield": {
    "namespace": "custom",
    "key": "material",
    "value": "cotton",
    "value_type": "single_line_text_field",
    "description": "The primary material used in this product",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a metafield for a resource

Request

Update an existing metafield for a specific resource

Bodyapplication/json
resource_typestringrequired

Type of resource to update metafield for

Enum"customer""order""product""variant"
Example: "product"
resource_idintegerrequired

ID of the resource

Example: 123
namespacestringrequired

Namespace for the metafield (max 20 characters, alphanumeric and underscores only)

Example: "seo"
keystringrequired

Key for the metafield (max 30 characters, alphanumeric and underscores only)

Example: "title"
valuestring or integer or boolean or object or Array of arraysrequired

The updated value to store in the metafield

Example: "Updated SEO Title"
One of:

The updated value to store in the metafield

string

The updated value to store in the metafield

value_typestringrequired

The type that defines how the value should be interpreted

Example: "single_line_text_field"
descriptionstring

Optional description of the metafield's purpose

Example: "Updated page title for SEO purposes"
curl -i -X PATCH \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/metafields/update \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_type": "product",
    "resource_id": 123,
    "namespace": "seo",
    "key": "title",
    "value": "Updated SEO Title",
    "value_type": "single_line_text_field",
    "description": "Updated page title for SEO purposes"
  }'

Responses

metafield updated successfully

Bodyapplication/json
metafieldobject(EmbeddedMetafield)required
metafield.​namespacestringrequired

A container for related metafields. Commonly used to group metafields by app or functionality.

Example: "custom"
metafield.​keystringrequired

The unique identifier for the metafield within its namespace. Must be unique per namespace and owner.

Example: "material"
metafield.​valuestring or integer or object or boolean or numberrequired

The actual data stored in the metafield. Type depends on value_type.

Example: "cotton"
metafield.​value_typestringrequired

The data type that defines how the value should be interpreted and validated.

Example: "single_line_text_field"
metafield.​descriptionstring or nullrequired

Optional human-readable description explaining the purpose of this metafield.

Example: "The primary material used in this product"
metafield.​created_atstringrequired

Timestamp when the metafield was created.

Example: "2021-01-01T00:00:00Z"
metafield.​updated_atstringrequired

Timestamp when the metafield was last updated.

Example: "2021-01-01T00:00:00Z"
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "metafield": {
    "namespace": "custom",
    "key": "material",
    "value": "cotton",
    "value_type": "single_line_text_field",
    "description": "The primary material used in this product",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  },
  "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

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Search

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

Delete a media

Request

Path
idintegerrequired

Media ID

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

Responses

Media destroyed

Bodyapplication/json
string
Response
application/json
"string"