API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

MetafieldSchema object

Version unstable

Metafield schemas allow merchants to configure a set of metafields that are surfaced and managed from admin resource pages.


appliesTo (MetafieldOwnerType!)

The resource type that the schema applies to.

configurableValidations (JSON)

The custom validations for the metafield schema.

createdAt (DateTime!)

The date and time when the metafield schema was created.

deleting (Boolean!)

The deletion status of the metafield schema.

description (String)

The description of a metafield schema.

id (ID!)

Globally unique identifier.

key (String!)

The key name for a metafield schema.

metafield (Metafield)

The metafield created under this schema.

metafieldSchemaTypeName (String!)

The associated metafield schema type.

name (String!)

The name of a metafield schema.

namespace (String!)

The namespace for a metafield schema.

type (MetafieldSchemaType!)

The associated metafield schema type object.

updatedAt (DateTime!)

The date and time when the metafield schema was updated.

Types that return MetafieldSchema

Mutations for MetafieldSchema


Creates a metafield schema.


Deletes a metafield schema and associated metafields.


Updates a metafield schema.