MetaobjectFieldDefinition - admin-graphql - OBJECT

Version: unstable

Description:

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

Access Scopes

Fields

  • description: String - The administrative description.
  • key: String! - A key name used to identify the field within the metaobject composition.
  • name: String! - The human-readable name.
  • required: Boolean! - Required status of the field within the metaobject composition.
  • type: MetafieldDefinitionType! - The type of data that the field stores.
  • validations: 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.
  • visibleToStorefrontApi: Boolean! - Whether this field is visible within the Storefront API.

Connections

Related queries

Related mutations

Related Unions

Examples