Skip to main content
Anchor to StandardMetafieldDefinitionTemplate

StandardMetafieldDefinitionTemplate

object

Standard metafield definition templates provide preset configurations to create metafield definitions. Each template has a specific namespace and key that we've reserved to have specific meanings for common use cases.

Refer to the list of standard metafield definitions.

String

The description of the standard metafield definition.

ID!
non-null

A globally-unique ID.

String!
non-null

The key owned by the definition after the definition has been activated.

String!
non-null

The human-readable name for the standard metafield definition.

String!
non-null

The namespace owned by the definition after the definition has been activated.

[MetafieldOwnerType!]!
non-null

The list of resource types that the standard metafield definition can be applied to.

MetafieldDefinitionType!
non-null

The associated metafield definition type that the metafield stores.

[MetafieldDefinitionValidation!]!
non-null

The configured validations for the standard metafield definition.

Anchor to visibleToStorefrontApivisibleToStorefrontApi
Boolean!
non-null

Whether metafields for the definition are by default visible using the Storefront API.


Was this section helpful?

query

Retrieves preset metafield definition templates for common use cases. Each template provides a reserved namespace and key combination for specific purposes like product subtitles, care guides, or ISBN numbers. Use these templates to create standardized metafields across your store. Filter templates by constraint status or exclude those you've already activated.

See the list of standard metafield definitions for available templates.

Arguments

MetafieldDefinitionConstraintSubtypeIdentifier

Filter standard metafield definitions based on whether they apply to a given resource subtype.

MetafieldDefinitionConstraintStatus

Filter standard metafield definitions based on whether they are constrained.

Boolean
Default:false

Filter standard metafield definitions that have already been activated.

Int

The first n elements from the paginated list.

String

The elements that come after the specified cursor.

Int

The last n elements from the paginated list.

String

The elements that come before the specified cursor.

Boolean
Default:false

Reverse the order of the underlying list.



Was this section helpful?

interface

Was this section helpful?