Skip to main content
Anchor to metaobjectDefinitionByType

metaobjectDefinitionByType

query

Requires read_metaobject_definitions access scope.

Retrieves a MetaobjectDefinition by its type. The type serves as a unique identifier that distinguishes one metaobject definition from another.

•String!
required

The type of the metaobject definition to return.


Was this section helpful?

Anchor to MetaobjectDefinitionMetaobjectDefinition
•MetaobjectDefinition

Defines the structure and configuration for a custom data type in Shopify. Each definition specifies the fields, validation rules, and capabilities that apply to all Metaobject entries created from it.

The definition includes field definitions that determine what data to store, access controls for the Shopify admin and Storefront APIs, and capabilities such as publishability and translatability. You can track which App or StaffMember created the definition and optionally base it on a StandardMetaobjectDefinitionTemplate.

•MetaobjectAccess!
non-null

Access configuration for the metaobject definition.

•MetaobjectCapabilities!
non-null

The capabilities of the metaobject definition.

•App!
non-null

The app used to create the metaobject definition.

•StaffMember

The staff member who created the metaobject definition.

•String

The administrative description.

•String

The key of a field to reference as the display name for each object.

•[MetaobjectFieldDefinition!]!
non-null

The fields defined for this object type.

•Boolean!
non-null

Whether this metaobject definition has field whose type can visually represent a metaobject with the thumbnailField.

•ID!
non-null

A globally-unique ID.

•MetaobjectConnection!
non-null

A paginated connection to the metaobjects associated with the definition.

Arguments

•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.


•Int!
non-null

The count of metaobjects created for the definition.

•String!
non-null

The human-readable name.

•StandardMetaobjectDefinitionTemplate

The standard metaobject template associated with the definition.

•String!
non-null

The type of the object definition. Defines the namespace of associated metafields.


Was this section helpful?