Anchor to MetaobjectFieldDefinitionMetaobject
objectMetaobject
Defines a field for a MetaobjectDefinition with properties such as the field's data type and validations.
Anchor to FieldsFields
- Anchor to capabilitiescapabilities•Metaobject
Field Definition Capabilities! non-null Capabilities available for this metaobject field definition.
- Anchor to descriptiondescription•String
The administrative description.
- •String!non-null
A key name used to identify the field within the metaobject composition.
- Anchor to namename•String!non-null
The human-readable name.
- Anchor to requiredrequired•Boolean!non-null
Required status of the field within the metaobject composition.
- Anchor to typetype•Metafield
Definition Type! non-null The type of data that the field stores.
- Anchor to validationsvalidations•[Metafield
Definition Validation!]! non-null A list of validation options for the field. For example, a field with the type
datecan set a minimum date requirement.- Anchor to visibleToStorefrontApivisible•Boolean!
To Storefront Api non-null Whether this field is visible within the Storefront API.
Was this section helpful?