Anchor to metafieldDefinitionmetafield
metafield Definition
query
Requires API client to have access to the resource type associated with the metafield definition.
Returns a metafield definition by identifier.
Anchor to Arguments
Arguments
- •ID!required
The ID of the MetafieldDefinition to return.
Was this section helpful?
Anchor to Possible returnsPossible returns
- Anchor to MetafieldDefinitionMetafield•
Definition Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context.
Was this section helpful?
Examples
1const { admin } = await authenticate.admin(request);23const response = await admin.graphql(4 `#graphql5 query MetafieldsCount($metafieldDefinitionId: ID!) {6 metafieldDefinition(id: $metafieldDefinitionId) {7 id8 metafieldsCount9 }10 }`,11 {12 variables: {13 "metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"14 },15 },16);1718const data = await response.json();19
query MetafieldsCount($metafieldDefinitionId: ID!) {
metafieldDefinition(id: $metafieldDefinitionId) {
id
metafieldsCount
}
}
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 MetafieldsCount($metafieldDefinitionId: ID!) { metafieldDefinition(id: $metafieldDefinitionId) { id metafieldsCount } }",
"variables": {
"metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
query MetafieldsCount($metafieldDefinitionId: ID!) {
metafieldDefinition(id: $metafieldDefinitionId) {
id
metafieldsCount
}
}`,
{
variables: {
"metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `query MetafieldsCount($metafieldDefinitionId: ID!) {
metafieldDefinition(id: $metafieldDefinitionId) {
id
metafieldsCount
}
}`,
"variables": {
"metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"
},
},
});
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 MetafieldsCount($metafieldDefinitionId: ID!) {
metafieldDefinition(id: $metafieldDefinitionId) {
id
metafieldsCount
}
}
QUERY
variables = {
"metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"
}
response = client.query(query: query, variables: variables)
Input variables
JSON1{2 "metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"3}
Response
JSON1{2 "metafieldDefinition": {3 "id": "gid://shopify/MetafieldDefinition/1071456166",4 "metafieldsCount": 05 }6}