metafieldDefinition

query

Requires API client to have access to the resource type associated with the metafield definition.

Returns a metafield definition by identifier.

Arguments

Anchor to identifieridentifier • MetafieldDefinitionIdentifierInput: The identifier of the MetafieldDefinition to return.
Anchor to idid • IDDeprecated: The ID of the MetafieldDefinition to return. This field will be removed in a future version. Use the identifier input instead.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to MetafieldDefinitionMetafieldDefinition • MetafieldDefinition: 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?

Retrieve a count of a resource's metafields.
Retrieve metafield definition

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query MetafieldsCount($metafieldDefinitionId: ID!) {
6    metafieldDefinition(id: $metafieldDefinitionId) {
7      id
8      metafieldsCount
9    }
10  }`,
11  {
12    variables: {
13      "metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"
14    },
15  },
16);
17
18const 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-04/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

JSON

1{
2  "metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"
3}

Response

JSON

1{
2  "metafieldDefinition": {
3    "id": "gid://shopify/MetafieldDefinition/1071456166",
4    "metafieldsCount": 0
5  }
6}