Choose a version:

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

MetafieldDefinition

•

MetafieldDefinition

Metafield definitions enable you to define additional validation constraints for metafields, and enable the merchant to edit metafield values in context.

access• MetafieldAccess! non-null: The access settings associated with the metafield definition.
capabilities• MetafieldCapabilities! non-null: The capabilities of the metafield definition.
constraints• MetafieldDefinitionConstraints: The constraints that determine what subtypes of resources a metafield definition applies to.
createdAt• DateTime! non-null: The date and time when the metafield definition was created.
description• String: The description of the metafield definition.
id• ID! non-null: A globally-unique ID.
key• String! non-null: The unique identifier for the metafield definition within its namespace.
metafields • MetafieldConnection! non-null: The metafields that belong to the metafield definition.
metafieldsCount• Int! non-null: The count of the metafields that belong to the metafield definition.
name• String! non-null: The human-readable name of the metafield definition.
namespace• String! non-null: The container for a group of metafields that the metafield definition is associated with.
ownerType• MetafieldOwnerType! non-null: The resource type that the metafield definition is attached to.
pinnedPosition• Int: The position of the metafield definition in the pinned list.
standardTemplate• StandardMetafieldDefinitionTemplate: The standard metafield definition template associated with the metafield definition.
type• MetafieldDefinitionType! non-null: The type of data that each of the metafields that belong to the metafield definition will store. Refer to the list of supported types.
updatedAt• DateTime! non-null: The date and time when the metafield definition was updated.
useAsCollectionCondition• Boolean! non-null: Whether the metafield definition can be used as a collection condition.
validations• [MetafieldDefinitionValidation!]! non-null: A list of validation options for the metafields that belong to the metafield definition. For example, for a metafield definition with the type date, you can set a minimum date validation so that each of the metafields that belong to it can only store dates after the specified minimum.
validationStatus• MetafieldDefinitionValidationStatus! non-null: The validation status for the metafields that belong to the metafield definition.

Was this section helpful?

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

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query MetafieldsCount($metafieldDefinitionId: ID!) {

metafieldDefinition(id: $metafieldDefinitionId) {

metafieldsCount

}

}`,

{

variables: {

"metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"

);

const data = await response.json();

query MetafieldsCount($metafieldDefinitionId: ID!) {
  metafieldDefinition(id: $metafieldDefinitionId) {
    id
    metafieldsCount
  }
}

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

{

"metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"

}

Response

JSON

{

"metafieldDefinition": {

"id": "gid://shopify/MetafieldDefinition/1071456166",

"metafieldsCount": 0

}