Metadata Definitions

Fluid

Updated July 23, 2025 15:37

Introduction

The Metadata Definitions section in your admin portal allows you to add custom data fields to specific parts of your store, creating standardized information structures that help organize and enhance your business data. These custom metafield definitions enable you to capture additional product details, customer information, order specifications, and variant attributes that go beyond the standard data fields. By creating structured metadata definitions, you can ensure consistency across your store while providing richer, more detailed information for your products, customers, orders, and variants.

Accessing Metadata Definitions

Log in to your Admin portal
Navigate to Settings in your dashboard
In the left navigation sidebar, locate the "Commerce" section
Select "Metadata Definitions" from the menu options

Settings Overview

Main Interface

The Metadata Definitions page provides a centralized hub for managing all custom data structures across your store. The interface is organized into clear sections for easy navigation and management.

Header Section:

Page title and description explaining the purpose of metadata definitions
"View Metadata Definition Documentation" link for comprehensive technical guidance
Descriptive text explaining how metafield definitions standardize custom information
Visual preview illustration showing metadata management concepts

Metadata Definition Categories

Overview

The system organizes metadata definitions into logical categories based on where the custom data will be applied. Each category allows you to create specific metafield definitions tailored to different areas of your store.

Category Selection Interface

Choose a category to manage metafield definitions for that specific area of your store. The interface displays the number of existing definitions for each category, helping you track your custom data structures.

Product Metadata

Purpose: Add custom fields to your product listings to capture specialized product information

Current Status: 12 definitions configured

Common Use Cases:

Technical specifications (dimensions, weight, materials)
Care instructions and usage guidelines
Manufacturer details and warranty information
Custom product attributes specific to your industry
SEO-related metadata for better search optimization
Product certification and compliance information

Example Definitions:

Single line text fields for model numbers or SKU variants
Multi-line text areas for detailed product descriptions
Number fields for technical specifications
Date fields for release dates or expiration information
JSON fields for complex structured data
Rating fields for internal product scoring

Variant Metadata

Purpose: Extend product variants with additional custom information

Current Status: 1 definition configured

Common Use Cases:

Size-specific information (fit guides, measurements)
Color-specific details (hex codes, material differences)
Variant-specific pricing or availability information
Regional variations and localization data
Inventory tracking enhancements
Supplier-specific information per variant

Benefits:

Granular control over variant-specific data
Enhanced inventory management capabilities
Improved customer experience through detailed variant information

Orders Metadata

Purpose: Capture additional information related to customer orders

Current Status: 0 definitions configured

Potential Applications:

Custom order instructions or special requests
Delivery preferences and scheduling information
Gift message and packaging options
Internal order processing notes
Shipping method preferences
Customer service interaction history

Setup Recommendations:

Create fields for frequently requested order customizations
Add tracking fields for internal workflow management
Include customer communication preferences

Customers Metadata

Purpose: Store additional customer information beyond standard profile data

Current Status: 0 definitions configured

Common Applications:

Customer preferences and interests
Purchase history analysis and segmentation
Loyalty program information
Communication preferences and consent tracking
Custom customer service notes
Account management and relationship data

Privacy Considerations:

Ensure compliance with data protection regulations
Implement appropriate access controls for sensitive information
Consider data retention policies for customer metadata

Product Metadata Management

Detailed View Interface

When you select "Product Metadata," you access a comprehensive management interface showing all existing metafield definitions for products.

Navigation Elements:

Breadcrumb navigation showing: Metadata > Product Metadata
Filter tabs: "All" and "Pinned" for organizing definitions
Search functionality for finding specific definitions
Sort and view options for customizing the display

Definition Table Structure

Column Headers:

Definition Name: The identifier for your custom field
Type: The data format (Single Line Text, Multi Line Text, JSON, etc.)
Namespace: The organized grouping system (custom.fieldname)
Used In: Shows how many products currently use this definition
Pinned: Allows you to mark frequently used definitions for quick access

Available Field Types

Text Fields:

Single Line Text Field: For short text entries like model numbers, brief descriptions
Multi Line Text Field: For longer content like detailed descriptions, instructions
Rich Text Field: For formatted content with styling options

Numeric Fields:

Number Decimal: For precise measurements, prices, specifications
Rating: For scoring systems or quality assessments

Date and Time Fields:

Date: For specific dates like release dates, expiration dates
Date Time: For precise timestamps including time information

Structured Data:

JSON: For complex, structured data that requires flexibility
Color: For color values and hex codes

Namespace Organization

All custom metadata fields are organized under the "custom" namespace with descriptive identifiers:

custom.singleline - Single line text fields
custom.multiline - Multi-line text areas
custom.rating - Rating and scoring fields
custom.json - JSON structured data
custom.datetime - Date and time fields

Best Practices

Planning Your Metadata Structure

Data Consistency:

Plan your metadata schema before creating definitions
Use consistent naming conventions across all definitions
Document the purpose and expected values for each field
Consider future scalability when designing field structures

Field Type Selection:

Choose appropriate field types for your data requirements
Consider validation needs and user input methods
Plan for data export and integration requirements
Think about how the data will be displayed to customers

Organization and Management:

Definition Naming:

Use descriptive, clear names for easy identification
Follow consistent naming patterns across categories
Avoid special characters that might cause technical issues
Include version information for fields that may evolve

Usage Tracking:

Monitor which definitions are actively used
Remove unused definitions to maintain system cleanliness
Pin frequently used definitions for quick access
Regular audits of metadata usage and effectiveness

Data Quality Management:

Validation and Standards:

Establish data entry standards for consistency
Train team members on proper metadata usage
Implement validation rules where possible
Regular quality checks on metadata content

Performance Considerations:

Avoid creating excessive metadata fields that aren't necessary
Consider the impact on page load times and database performance
Plan for search and filtering capabilities based on metadata
Optimize metadata for SEO and customer experience

Working with Metadata Definitions

Creating New Definitions

When creating new metadata definitions:

Choose the appropriate category (Product, Variant, Order, Customer)
Select the correct field type for your data requirements
Provide a clear, descriptive name
Configure any validation rules or constraints
Test the definition with sample data before full implementation

Editing Existing Definitions

Modification Guidelines:

Changes to existing definitions may affect current data
Test modifications in a staging environment first
Consider backward compatibility with existing data
Document changes for team awareness

Usage Monitoring

Analytics and Reporting:

Track which definitions are most frequently used
Monitor data completion rates across products
Analyze the impact of metadata on customer engagement
Regular reviews of metadata effectiveness

Troubleshooting

Common Issues

Definition Not Appearing:

Verify the definition is created in the correct category
Check that user permissions allow access to metadata management
Ensure the definition is not filtered out by current view settings

Data Not Saving:

Confirm field type matches the data being entered
Check for validation rules that might be preventing saves
Verify character limits for text fields
Ensure required fields are completed

Performance Issues:

Review the number of active metadata definitions
Check for overly complex JSON structures
Monitor database performance impact
Consider archiving unused definitions

Getting Help

For assistance with metadata definitions:

Consult the "View Metadata Definition Documentation" link for detailed technical information
Contact your system administrator for permission-related issues
Reach out to technical support for complex metadata structure questions
Review existing successful metadata implementations for guidance