Skip to main content
Anchor to MetaobjectConnection

MetaobjectConnection

connection

An auto-generated type for paginating through multiple Metaobjects.

Anchor to Fields with this connectionFields with this connection

Anchor to MetaobjectDefinition.metaobjectsMetaobjectDefinition.metaobjects
•OBJECT

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.

Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to metaobjectsmetaobjects
•query

Returns a paginated list of Metaobject entries for a specific type. Metaobjects are custom data structures that extend Shopify's data model with merchant or app-specific data types.

Filter results using the query parameter with a search syntax for metaobject fields. Use fields.{key}:{value} to filter by field values, supporting any field previously marked as filterable. The sortKey parameter accepts id, type, updated_at, or display_name to control result ordering.

Learn more about querying metaobjects by field value.

Arguments

Anchor to typetype
•String!
required

The type of the metaobjects to query.

Anchor to sortKeysortKey
•String

The key of a field to sort with. Supports "id", "type", "updated_at", and "display_name".

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 queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to display_name
•string
Anchor to fields.{key}
•mixed

Filters metaobject entries by field value. Format: fields.{key}:{value}. Only fields marked as filterable in the metaobject definition can be used. Learn more about querying metaobjects by field value.

Example:

  • fields.color:blue
  • fields.on_sale:true
Anchor to handle
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to updated_at
•time
Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[MetaobjectEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[Metaobject!]!
non-null

A list of nodes that are contained in MetaobjectEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?