Skip to main content
Anchor to metafieldDefinitions

metafieldDefinitions

query

Returns a list of metafield definitions.

Anchor to Arguments

MetafieldDefinitionConnection arguments

•MetafieldDefinitionConnection!
Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to constraintStatusconstraintStatus
•MetafieldDefinitionConstraintStatus

Filter metafield definitions based on whether they are constrained.

Anchor to constraintSubtypeconstraintSubtype
•MetafieldDefinitionConstraintSubtypeIdentifier

Filter metafield definitions based on whether they apply to a given resource subtype.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to keykey
•String

Filter metafield definition by key.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to namespacenamespace
•String

Filter metafield definition by namespace.

Anchor to ownerTypeownerType
•MetafieldOwnerType!required

Filter the metafield definition by the specific owner type.

Anchor to pinnedStatuspinnedStatus
•MetafieldDefinitionPinnedStatusDefault:ANY

Filter the metafield definition by the pinned status.

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 default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time

Filter by the date and time when the metafield definition was created.

Example:

  • created_at:>2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
Anchor to reversereverse
•BooleanDefault:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MetafieldDefinitionSortKeysDefault:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[MetafieldDefinitionEdge!]!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
•[MetafieldDefinition!]!non-null

A list of nodes that are contained in MetafieldDefinitionEdge. 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?