stack

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

AdminTypes.StandardMetafieldDefinitionTemplate interface

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](https://shopify.dev/apps/metafields/definitions/standard-definitions).

Signature:

export interface StandardMetafieldDefinitionTemplate extends Node 

Extends: Node

Properties

Property Modifiers Type Description
description?   Maybe<Scalars[‘String’][‘output’]> (Optional) The description of the standard metafield definition.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
key   Scalars[‘String’][‘output’] The key owned by the definition after the definition has been activated.
name   Scalars[‘String’][‘output’] The human-readable name for the standard metafield definition.
namespace   Scalars[‘String’][‘output’] The namespace owned by the definition after the definition has been activated.
ownerTypes   Array<MetafieldOwnerType | `${MetafieldOwnerType}`> The list of resource types that the standard metafield definition can be applied to.
type   MetafieldDefinitionType The associated [metafield definition type](https://shopify.dev/apps/metafields/definitions/types) that the metafield stores.
validations   Array<MetafieldDefinitionValidation> The configured validations for the standard metafield definition.
visibleToStorefrontApi   Scalars[‘Boolean’][‘output’] Whether metafields for the definition are by default visible using the Storefront API.