privateMetafields - admin-graphql - QUERY

Version: unstable

Description:

Returns a list of private metafields associated to a resource.

Access Scopes

Arguments

• after: String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• before: String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
• first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
• namespace: String - Filter the private metafields by namespace.
• owner: ID! - Retrieve the private metafields of a certain resource, specified by the resource ID.
• reverse: Boolean - Reverse the order of the underlying list.

Returns

• edges: PrivateMetafieldEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: PrivateMetafield! A list of nodes that are contained in PrivateMetafieldEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
• pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples

• Retrieve a list of private metafields

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { privateMetafields(owner: \\\"gid://shopify/Order/148977776\\\", first: 2) { edges { node { id key namespace value } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    privateMetafields(owner: \"gid://shopify/Order/148977776\", first: 2) {\n      edges {\n        node {\n          id\n          key\n          namespace\n          value\n        }\n      }\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    privateMetafields(owner: \"gid://shopify/Order/148977776\", first: 2) {\n      edges {\n        node {\n          id\n          key\n          namespace\n          value\n        }\n      }\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([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    privateMetafields(owner: \"gid://shopify/Order/148977776\", first: 2) {\n      edges {\n        node {\n          id\n          key\n          namespace\n          value\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  privateMetafields(owner: \"gid://shopify/Order/148977776\", first: 2) {\n    edges {\n      node {\n        id\n        key\n        namespace\n        value\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "privateMetafields": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/PrivateMetafield/1060470842",
              "key": "buyer",
              "namespace": "notes",
              "value": "Notes about this buyer"
            }
          },
          {
            "node": {
              "id": "gid://shopify/PrivateMetafield/1060470843",
              "key": "reviews",
              "namespace": "feedback",
              "value": "Feedback about the order"
            }
          }
        ]
      }
    }
  }

  Retrieve a list of private metafields from the Shop resource

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { shop { name privateMetafields(first: 2) { edges { node { id key namespace value } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    shop {\n      name\n      privateMetafields(first: 2) {\n        edges {\n          node {\n            id\n            key\n            namespace\n            value\n          }\n        }\n      }\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    shop {\n      name\n      privateMetafields(first: 2) {\n        edges {\n          node {\n            id\n            key\n            namespace\n            value\n          }\n        }\n      }\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([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    shop {\n      name\n      privateMetafields(first: 2) {\n        edges {\n          node {\n            id\n            key\n            namespace\n            value\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  shop {\n    name\n    privateMetafields(first: 2) {\n      edges {\n        node {\n          id\n          key\n          namespace\n          value\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shop": {
        "name": "John Smith Test Store",
        "privateMetafields": {
          "edges": [
            {
              "node": {
                "id": "gid://shopify/PrivateMetafield/769645494",
                "key": "test_key",
                "namespace": "nested_namespace",
                "value": "this is a test value"
              }
            },
            {
              "node": {
                "id": "gid://shopify/PrivateMetafield/1060470841",
                "key": "fantastic_app",
                "namespace": "private_keys",
                "value": "TA432RZ"
              }
            }
          ]
        }
      }
    }
  }