Skip to main content
Anchor to metaobjectByHandle

metaobjectByHandle

query

Requires read_metaobjects access scope.

Retrieves a Metaobject by its handle and type. Handles are unique identifiers within a metaobject type.

Anchor to Arguments

Arguments

Anchor to handlehandle
•MetaobjectHandleInput!
required

The identifier of the metaobject to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to MetaobjectMetaobject
•Metaobject

An instance of custom structured data defined by a MetaobjectDefinition. Metaobjects store reusable data that extends beyond Shopify's standard resources, such as product highlights, size charts, or custom content sections.

Each metaobject includes fields that match the field types and validation rules specified in its definition, which also determines the metaobject's capabilities, such as storefront visibility, publishing and translation support. Metafields can reference metaobjects to connect custom data with Product objects, Collection objects, and other Shopify resources.

Anchor to capabilitiescapabilities
•MetaobjectCapabilityData!
non-null

Metaobject capabilities for this Metaobject.

Anchor to createdAtcreatedAt
•DateTime!
non-null

When the object was created.

Anchor to createdBycreatedBy
•App!
non-null

The app used to create the object.

Anchor to createdByAppcreatedByApp
•App!
non-null

The app used to create the object.

Anchor to createdByStaffcreatedByStaff
•StaffMember

The staff member who created the metaobject.

Anchor to definitiondefinition
•MetaobjectDefinition!
non-null

The MetaobjectDefinition that models this object type.

Anchor to displayNamedisplayName
•String!
non-null

The preferred display name field value of the metaobject.

Anchor to fieldfield
•MetaobjectField

The field for an object key, or null if the key has no field definition.

Arguments

Anchor to keykey
•String!
required

The metaobject key to access.

Anchor to fieldsfields
•[MetaobjectField!]!
non-null

All ordered fields of the metaobject with their definitions and values.

Anchor to handlehandle
•String!
non-null

The unique handle of the object, useful as a custom ID.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to referencedByreferencedBy
•MetafieldRelationConnection!
non-null

List of back references metafields that belong to the resource.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to thumbnailFieldthumbnailField
•MetaobjectField

The recommended field to visually represent this metaobject. May be a file reference or color field.

Anchor to typetype
•String!
non-null

The type of the metaobject.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

When the object was last updated.

Anchor to staffMemberstaffMember
•StaffMember
Deprecated
Was this section helpful?