29 NEXT
  • Welcome to 29 Next Docs
  • About 29 Next
  • Changelog
  • Start Here
    • 🌟Get Started on 29 Next
      • General Settings & Branding
      • Link Domains
      • Invite Team Members
      • Add Locations & Languages
      • Checkout Settings & Policies
      • Customer Storefront Accounts
      • Fulfillment Settings
      • Support & Notifications
      • Add Payment Providers
    • ⚡Developer Docs
  • BUILD A STORE
    • 📦Products Catalogue
      • Add Products
      • Inventory
      • Product Variants
      • Gift Cards
      • Upsells & SEO Settings
      • Create Categories
      • Google Merchant XML Feed
      • Tax Settings
    • 🛒Storefront
      • Customer Accounts
      • Support Content
      • Custom Pages
      • Blogs
      • Storefront Redirects
    • 🪄Technical Settings
      • Metadata Fields & Tags
      • Configure Webhooks
      • Storefront API & Events
  • Manage Orders
    • 📥Orders
      • Create Orders
      • Order Management
      • Edit Orders
      • Refund Items & Orders
      • Create & Manage Returns
      • Order Statuses
      • Open Carts
      • Test Orders
    • 👥Customers Guide
      • Customer Carts
      • Checkout Links
    • 🔃Subscriptions Guide
      • Subscription Settings
      • Managing Subscriptions
      • Account Updater
      • Decline Salvage
      • Subscription Statuses
    • 📞Support Guide
  • Features
    • 🛍️Offers Guide
      • Create and Manage Offers
      • Product Ranges
      • Coupons
      • Shareable Coupon Links
      • Marketing Attribution
    • 💳Payments Guide
      • 3DS2 Payments
      • PayPal
      • Apple Pay
      • Google Pay
      • Stripe APMs
      • Authorize & Capture Payments
      • Disputes Guide
      • Block Lists
      • Payment Failure Cascading
      • Transaction Response Codes
    • 🚚Fulfillment Guide
      • Fulfillment Statuses
      • Location-Based Routing
      • Advanced Settings
  • Apps
    • 3PL Central
    • Avalara AvaTax
    • Campaigns App
    • Delivery Tracking
    • Everflow
    • Meta Pixel
    • Gorgias
    • Klaviyo
    • MaxMind minFraud
    • Chargeback360
    • TaxJar
    • ShipStation
    • Shop Sync
  • Analytics
    • Dashboards
    • Orders Reports
    • Customers Reports
    • Disputes Reports
    • Gift Card Reports
    • Fulfillment Reports
    • Transactions Reports
    • Support Ticket Reports
    • Subscription Reports
    • Tax Reports
    • Partner Marketing Reports
Powered by GitBook
On this page
  • Metadata
  • Tags

Was this helpful?

  1. BUILD A STORE
  2. Technical Settings

Metadata Fields & Tags

Set up metadata fields and Tags to extend your data model

PreviousTechnical SettingsNextConfigure Webhooks

Last updated 6 months ago

Was this helpful?

Metadata

Define custom metadata fields for use on the , , , and manual data exports.

From the Metadata Settings view, choose Add Metadata Definition to define custom fields and attach them to objects in your store's database.

First, define a Name for your custom metadata definition. Then, choose the Object it should be associated to from the displayed options:

  • Order

  • Customer

  • Attribution

  • Product

  • Dispute

Define a Metadata Key to use to pass custom values, and define the metadata Type:

  • Text

  • Integer

  • Decimal

  • Rich Text

  • Multi Text

  • File

  • Boolean

Exports & Search

Select the options to add the metadata field as a column to data Exports, and enable the metadata field in reports and list view search Filters.

Validation

Depending on the metadata Type selected, you may be prompted to optionally input field validation parameters.

Choose Save Changes.

Metadata Validation restricts field input globally, including on the Admin API. Ensure your configured validation settings accommodate all of your expected scenarios, or you may experience unexpected input validation errors.

Tags

Optionally, you can create new tags by free-typing a new Tag in the Tags section of a Customer Detail, or Order Detail view, or within a Support Ticket's Tags field.

Via the , you can now send or read values in your custom defined metadata fields, and view structured metadata on Webhooks and on data exports.

From the Settings > Tags page, you can add, edit, or delete Tags in your store. Tags are used to apply to , , or , to mark and segment each type of data for use in searches, reporting and analytics. Examples include the , and reports.

🪄
Admin API
Admin API
Webhooks
Orders by Tag
Support Tickets
Support Tickets by Tag
Orders
Customers
Checkout Links