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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query {
6    metafieldDefinitions(first: 250, ownerType: PRODUCT) {
7      edges {
8        node {
9          name
10        }
11      }
12    }
13  }`,
14);
15
16const data = await response.json();
17

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/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

1{
2  "metafieldDefinitions": {
3    "edges": [
4      {
5        "node": {
6          "name": "legacy definition"
7        }
8      },
9      {
10        "node": {
11          "name": "Non-standard rating"
12        }
13      },
14      {
15        "node": {
16          "name": "date of creation"
17        }
18      },
19      {
20        "node": {
21          "name": "Custom ID"
22        }
23      },
24      {
25        "node": {
26          "name": "create"
27        }
28      },
29      {
30        "node": {
31          "name": "amenity"
32        }
33      },
34      {
35        "node": {
36          "name": "youbube video"
37        }
38      },
39      {
40        "node": {
41          "name": "Swatch List"
42        }
43      },
44      {
45        "node": {
46          "name": "Spiceness metaobject reference"
47        }
48      },
49      {
50        "node": {
51          "name": "model"
52        }
53      },
54      {
55        "node": {
56          "name": "Competitor cost"
57        }
58      },
59      {
60        "node": {
61          "name": "Season"
62        }
63      },
64      {
65        "node": {
66          "name": "Year released"
67        }
68      },
69      {
70        "node": {
71          "name": "youtubee video"
72        }
73      },
74      {
75        "node": {
76          "name": "date of creation"
77        }
78      },
79      {
80        "node": {
81          "name": "youtube video"
82        }
83      },
84      {
85        "node": {
86          "name": "Spiceness metaobject reference"
87        }
88      },
89      {
90        "node": {
91          "name": "nutrition field"
92        }
93      },
94      {
95        "node": {
96          "name": "Materials"
97        }
98      },
99      {
100        "node": {
101          "name": "Taxonomy materials"
102        }
103      },
104      {
105        "node": {
106          "name": "Recyclable"
107        }
108      },
109      {
110        "node": {
111          "name": "Looksbooks List"
112        }
113      },
114      {
115        "node": {
116          "name": "geographical availability"
117        }
118      },
119      {
120        "node": {
121          "name": "Color List"
122        }
123      },
124      {
125        "node": {
126          "name": "Exporters"
127        }
128      },
129      {
130        "node": {
131          "name": "Looksbooks List"
132        }
133      },
134      {
135        "node": {
136          "name": "youtubbe video"
137        }
138      },
139      {
140        "node": {
141          "name": "Ingredients"
142        }
143      }
144    ]
145  }
146}