29 NEXT
Search
K

Metadata Fields & Tags

Set up metadata fields and Tags to extend your data model

Metadata

Define custom metadata fields for use on the Admin API, Webhooks, Checkout Links, 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:
  • Orders
  • Customers
  • Attribution
  • Products
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.
Via the Admin API, you can now send or read values in your custom defined metadata fields, and view structured metadata on Webhooks and on data exports.

Tags

From the Settings > Tags page, you can add, edit, or delete Tags in your store. Tags are used to apply to Orders, Customers, or Support Tickets, to mark and segment each type of data for use in searches, reporting and analytics. Examples include the Support Tickets by Tag, and Orders by Tag reports.
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.