stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > MetaobjectFieldDefinition

AdminTypes.MetaobjectFieldDefinition interface

Defines a field for a MetaobjectDefinition with properties such as the field’s data type and validations.

Signature:

export interface MetaobjectFieldDefinition 

Properties

Property Modifiers Type Description
description?   Maybe<Scalars[‘String’][‘output’]> (Optional) The administrative description.
key   Scalars[‘String’][‘output’] A key name used to identify the field within the metaobject composition.
name   Scalars[‘String’][‘output’] The human-readable name.
required   Scalars[‘Boolean’][‘output’] Required status of the field within the metaobject composition.
type   MetafieldDefinitionType The type of data that the field stores.
validations   Array<MetafieldDefinitionValidation> A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for the field. For example, a field with the type date can set a minimum date requirement.