metafieldDefinition
query

Choose a version:

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

Returns a metafield definition by identifier.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the MetafieldDefinition to return.

Was this section helpful?

Anchor to section titled 'MetafieldDefinition possible returns'

MetafieldDefinition possible returns

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

Code examples for QUERY: metafieldDefinition

Query Reference for QUERY: metafieldDefinition

"{\n  metafieldDefinition(id) {\n    # MetafieldDefinition fields\n  }\n}"

Input Reference for QUERY: metafieldDefinition

Schema Reference for QUERY: metafieldDefinition

Display Examples for QUERY: metafieldDefinition

[
  {
    "example": {
      "type_name": "metafielddefinition",
      "title": "Retrieve metafield definition",
      "description": "To retrieve a single metafield definition, use the `metafieldDefinition` query with its ID.\nThe following example shows how to retrive the metafield definition for a newly created metafield\ndefinition.\n",
      "query_string": "query {\n  metafieldDefinition(id: \"gid://shopify/MetafieldDefinition/1071456143\") {\n    name\n  }\n}",
      "response": {
        "data": {
          "metafieldDefinition": {
            "name": "Ingredients"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/platform/admin/test/unit/graph_api/admin/query_root_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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/1071456143\\\") { name } }\"\n}'\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/1071456143\") {\n      name\n    }\n  }`,\n);\n\nconst data = await response.json();\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/1071456143\") {\n      name\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    metafieldDefinition(id: \"gid://shopify/MetafieldDefinition/1071456143\") {\n      name\n    }\n  }`,\n});\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/1071456143\") {\n      name\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]

metafieldDefinitionquery

Arguments

MetafieldDefinition possible returns

metafieldDefinition
query