Skip to content

Metafield definition types

View as Markdown

A Metafield definition type is one of the data types a Metafield definition can use - single_line_text_field, number_decimal, json, metaobject_reference, and so on. This is a read-only reference resource: you list the types to discover the valid values for a definition’s type.

Each type also reports its allowedValidations - the validation types you may attach to a definition of that type. This is the authoritative source for type/validation compatibility (see Type compatibility).

PropertyTypeRequiredDescription
idstring-The metafield definition type identifier (e.g. number_decimal).
descriptionstring-A human-readable description of the metafield definition type.
examplestring | null-An example value for a metafield of this type.
allowedValidationsstring[]-The validation types that can be applied to a metafield definition of this type. Submitting any other validation is rejected. Types that allow none return an empty array.

All requests require an OAuth 2.0 bearer token:

Authorization: Bearer <token>

This resource is read-only - it has no create, update or delete operations.