Standard Metafield Definition Template
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.
Anchor to FieldsFields
- Anchor to descriptiondescription•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.
- Anchor to namename•String!non-null
The human-readable name for the standard metafield definition.
- Anchor to namespacenamespace•String!non-null
The namespace owned by the definition after the definition has been activated.
- Anchor to ownerTypesowner•[Metafield
Types Owner Type!]! non-null The list of resource types that the standard metafield definition can be applied to.
- Anchor to typetype•Metafield
Definition Type! non-null The associated metafield definition type that the metafield stores.
- Anchor to validationsvalidations•[Metafield
Definition Validation!]! non-null The configured validations for the standard metafield definition.
- Anchor to visibleToStorefrontApivisible•Boolean!
To Storefront Api non-null Whether metafields for the definition are by default visible using the Storefront API.
Anchor to QueriesQueries
- •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.
- Anchor to constraintSubtypeconstraint•Metafield
Subtype Definition Constraint Subtype Identifier Filter standard metafield definitions based on whether they apply to a given resource subtype.
- Anchor to constraintStatusconstraint•Metafield
Status Definition Constraint Status Filter standard metafield definitions based on whether they are constrained.
- Anchor to excludeActivatedexclude•Boolean
Activated Default:false Filter standard metafield definitions that have already been activated.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments