privateMetafield

query

deprecated

Code examples for QUERY: privateMetafield

Query Reference for QUERY: privateMetafield

"{\n  privateMetafield(id) {\n    # PrivateMetafield fields\n  }\n}"

Input Reference for QUERY: privateMetafield

Schema Reference for QUERY: privateMetafield

Display Examples for QUERY: privateMetafield

[
  {
    "example": {
      "type_name": "privatemetafield",
      "title": "Retrieve a private metafield by its ID",
      "description": "To retrieve a single private metafield, use the `privateMetafield` query.\nThe following example shows how to retrieve the private metafield owned by an `Order` resource.\n",
      "query_string": "query {\n  privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") {\n    id\n    key\n    namespace\n    value\n  }\n}",
      "response": {
        "data": {
          "privateMetafield": {
            "id": "gid://shopify/PrivateMetafield/1060470840",
            "key": "buyer",
            "namespace": "notes",
            "value": "Notes about this buyer"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/content/metafields/test/unit/graph_api/admin/private_metafield_test.rb",
      "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 { privateMetafield(id: \\\"gid://shopify/PrivateMetafield/1060470840\\\") { id key namespace value } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") {\n      id\n      key\n      namespace\n      value\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    privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") {\n      id\n      key\n      namespace\n      value\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    privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") {\n      id\n      key\n      namespace\n      value\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    privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") {\n      id\n      key\n      namespace\n      value\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]