MetafieldDefinition
object

Choose a version:

Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to MetafieldDefinition.access access MetafieldAccess! non-null: The access settings associated with the metafield definition.
Anchor to MetafieldDefinition.description description String: The description of the metafield definition.
Anchor to MetafieldDefinition.id id ID! non-null: A globally-unique ID.
Anchor to MetafieldDefinition.key key String! non-null: The unique identifier for the metafield definition within its namespace.
Anchor to MetafieldDefinition.metafields metafields MetafieldConnection! non-null: The metafields that belong to the metafield definition.
Anchor to MetafieldDefinition.metafieldsCount metafieldsCount Int! non-null: The count of the metafields that belong to the metafield definition.
Anchor to MetafieldDefinition.name name String! non-null: The human-readable name of the metafield definition.
Anchor to MetafieldDefinition.namespace namespace String! non-null: The container for a group of metafields that the metafield definition is associated with.
Anchor to MetafieldDefinition.ownerType ownerType MetafieldOwnerType! non-null: The resource type that the metafield definition is attached to.
Anchor to MetafieldDefinition.pinnedPosition pinnedPosition Int: The position of the metafield definition in the pinned list.
Anchor to MetafieldDefinition.standardTemplate standardTemplate StandardMetafieldDefinitionTemplate: The standard metafield definition template associated with the metafield definition.
Anchor to MetafieldDefinition.type type MetafieldDefinitionType! non-null: The type of data that each of the metafields that belong to the metafield definition will store. Refer to the list of supported types.
Anchor to MetafieldDefinition.useAsCollectionCondition useAsCollectionCondition Boolean! non-null: Whether the metafield definition can be used as a collection condition.
Anchor to MetafieldDefinition.validations validations [MetafieldDefinitionValidation!]! non-null: A list of validation options for the metafields that belong to the metafield definition. For example, for a metafield definition with the type date, you can set a minimum date validation so that each of the metafields that belong to it can only store dates after the specified minimum.
Anchor to MetafieldDefinition.validationStatus validationStatus MetafieldDefinitionValidationStatus! non-null: The validation status for the metafields that belong to the metafield definition.

Was this section helpful?

Anchor to section titled 'Queries'

Queries

Anchor to metafieldDefinition metafieldDefinition query: Returns a metafield definition by identifier.
Anchor to metafieldDefinitions metafieldDefinitions query: Returns a list of metafield definitions.

Was this section helpful?

<?>

MetafieldDefinition Queries

MetafieldDefinition

Queried by

Anchor to section titled 'Mutations'

Mutations

Anchor to metafieldDefinitionCreate metafieldDefinitionCreate mutation: Creates a metafield definition. Any metafields existing under the same owner type, namespace, and key will be checked against this definition and will have their type updated accordingly. For metafields that are not valid, they will remain unchanged but any attempts to update them must align with this definition.
Anchor to metafieldDefinitionPin metafieldDefinitionPin mutation: You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.
Anchor to metafieldDefinitionUnpin metafieldDefinitionUnpin mutation: You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.
Anchor to metafieldDefinitionUpdate metafieldDefinitionUpdate mutation: Updates a metafield definition.
Anchor to standardMetafieldDefinitionEnable standardMetafieldDefinitionEnable mutation: Activates the specified standard metafield definition from its template.

Refer to the list of standard metafield definition templates.

Was this section helpful?

<~>

MetafieldDefinition Mutations

MetafieldDefinition

Mutated by

Anchor to section titled 'Implements'

Implements

Anchor to Node Node interface

Was this section helpful?

||-

MetafieldDefinition Implements

MetafieldDefinition

Implements

Node

MetafieldDefinitionobject

Fields and connections

Fields and connections from

Queries

Queried by

Mutations

Mutated by

Implements

Implements

MetafieldDefinition
object