metafieldDefinitions

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.
Anchor to created_at • time: Filter by the date and time when the metafield definition was created.
Anchor to id • id: Filter by id range.
Anchor to key • string: Filter by the metafield definition key field.
Anchor to namespace • string: Filter by the metafield definition namespace field.
Anchor to owner_type • string: Filter by the metafield definition ownerType field.
Anchor to type • string: Filter by the metafield definition type field.
Anchor to updated_at • time: Filter by the date and time when the metafield definition was last updated.

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

sortKey

•

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?

Retrieve metafield definitions

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

metafieldDefinitions(first: 250, ownerType: PRODUCT) {

edges {

node {

name

}

}`,

);

const data = await response.json();

query {
  metafieldDefinitions(first: 250, ownerType: PRODUCT) {
    edges {
      node {
        name
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { metafieldDefinitions(first: 250, ownerType: PRODUCT) { edges { node { name } } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    metafieldDefinitions(first: 250, ownerType: PRODUCT) {
      edges {
        node {
          name
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    metafieldDefinitions(first: 250, ownerType: PRODUCT) {
      edges {
        node {
          name
        }
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    metafieldDefinitions(first: 250, ownerType: PRODUCT) {
      edges {
        node {
          name
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"metafieldDefinitions": {

"edges": [

{

"node": {

"name": "legacy definition"

}

{

"node": {

"name": "Non-standard rating"

}

{

"node": {

"name": "date of creation"

}

{

"node": {

"name": "Custom ID"

}

{

"node": {

"name": "create"

}

{

"node": {

"name": "amenity"

}

{

"node": {

"name": "youbube video"