MetafieldDefinition - admin-graphql - OBJECT

Version: 2024-07

Description:

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

Access Scopes

Fields

access: MetafieldAccess! - The access settings associated with the metafield definition.
constraints: MetafieldDefinitionConstraints - The constraints that determine what subtypes of resources a metafield definition applies to.
description: String - The description of the metafield definition.
id: ID! - A globally-unique ID.
key: String! - The unique identifier for the metafield definition within its namespace.
metafieldsCount: Int! - The count of the metafields that belong to the metafield definition.
name: String! - The human-readable name of the metafield definition.
namespace: String! - The container for a group of metafields that the metafield definition is associated with.
ownerType: MetafieldOwnerType! - 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! - The type of data that each of the metafields that belong to the metafield definition will store. Refer to the list of [supported types](https://shopify.dev/apps/metafields/types).
useAsCollectionCondition: Boolean! - Whether the metafield definition can be used as a collection condition.
validationStatus: MetafieldDefinitionValidationStatus! - The validation status for the metafields that belong to the metafield definition.
validations: MetafieldDefinitionValidation! - A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) 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.
visibleToStorefrontApi: Boolean! - Whether each of the metafields that belong to the metafield definition are visible from the Storefront API.

Connections

metafields: MetafieldConnection!

Related queries

metafieldDefinition Returns a metafield definition by identifier.
metafieldDefinitions Returns a list of metafield definitions.

Related mutations

metafieldDefinitionCreate Creates a metafield definition. Any metafields existing under the same owner type, namespace, and key will be checked against this definition and will have their type updated accordingly. For metafields that are not valid, they will remain unchanged but any attempts to update them must align with this definition.
metafieldDefinitionPin You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.
metafieldDefinitionUnpin You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.
metafieldDefinitionUpdate Updates a metafield definition.
standardMetafieldDefinitionEnable Activates the specified standard metafield definition from its template. Refer to the [list of standard metafield definition templates](https://shopify.dev/apps/metafields/definitions/standard-definitions).

Related Unions

Examples

Retrieve a count of a resource's metafields.

        Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query MetafieldsCount($metafieldDefinitionId: ID!) { metafieldDefinition(id: $metafieldDefinitionId) { id metafieldsCount } }\",\n \"variables\": {\n    \"metafieldDefinitionId\": \"gid://shopify/MetafieldDefinition/1071456166\"\n  }\n}'\n"
        Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query MetafieldsCount($metafieldDefinitionId: ID!) {\n      metafieldDefinition(id: $metafieldDefinitionId) {\n        id\n        metafieldsCount\n      }\n    }`,\n    \"variables\": {\n      \"metafieldDefinitionId\": \"gid://shopify/MetafieldDefinition/1071456166\"\n    },\n  },\n});\n"
        Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query MetafieldsCount($metafieldDefinitionId: ID!) {\n    metafieldDefinition(id: $metafieldDefinitionId) {\n      id\n      metafieldsCount\n    }\n  }\nQUERY\n\nvariables = {\n  \"metafieldDefinitionId\": \"gid://shopify/MetafieldDefinition/1071456166\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query MetafieldsCount($metafieldDefinitionId: ID!) {\n    metafieldDefinition(id: $metafieldDefinitionId) {\n      id\n      metafieldsCount\n    }\n  }\nQUERY;\n\n$variables = [\n  \"metafieldDefinitionId\" => \"gid://shopify/MetafieldDefinition/1071456166\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
        Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query MetafieldsCount($metafieldDefinitionId: ID!) {\n    metafieldDefinition(id: $metafieldDefinitionId) {\n      id\n      metafieldsCount\n    }\n  }`,\n  {\n    variables: {\n      \"metafieldDefinitionId\": \"gid://shopify/MetafieldDefinition/1071456166\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
        Graphql query: "query MetafieldsCount($metafieldDefinitionId: ID!) {\n  metafieldDefinition(id: $metafieldDefinitionId) {\n    id\n    metafieldsCount\n  }\n}"

input: {
  "metafieldDefinitionId": "gid://shopify/MetafieldDefinition/1071456166"
}

response: {
  "data": {
    "metafieldDefinition": {
      "id": "gid://shopify/MetafieldDefinition/1071456166",
      "metafieldsCount": 0
    }
  }
}

Retrieve metafield definition

        Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { metafieldDefinition(id: \\\"gid://shopify/MetafieldDefinition/1071456163\\\") { name } }\"\n}'\n"
        Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    metafieldDefinition(id: \"gid://shopify/MetafieldDefinition/1071456163\") {\n      name\n    }\n  }`,\n});\n"
        Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    metafieldDefinition(id: \"gid://shopify/MetafieldDefinition/1071456163\") {\n      name\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
        PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    metafieldDefinition(id: \"gid://shopify/MetafieldDefinition/1071456163\") {\n      name\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
        Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    metafieldDefinition(id: \"gid://shopify/MetafieldDefinition/1071456163\") {\n      name\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
        Graphql query: "query {\n  metafieldDefinition(id: \"gid://shopify/MetafieldDefinition/1071456163\") {\n    name\n  }\n}"

input: null

response: {
  "data": {
    "metafieldDefinition": {
      "name": "ingredients"
    }
  }
}