metafields - admin-graphql - QUERY

Version: unstable

Description:

A paginated list of metafields.

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 metafields by namespace.
• owner: ID! - Filter metafields to a specific owner. Recommend using the `metafields` connection from [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields) directly from the owner instead.
• reverse: Boolean - Reverse the order of the underlying list.

Returns

• edges: MetafieldEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: Metafield! A list of nodes that are contained in MetafieldEdge. 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 metafields belonging to a 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 { metafields(first: 2, owner: \\\"gid://shopify/Product/20995642\\\") { edges { node { namespace key value } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    metafields(first: 2, owner: \"gid://shopify/Product/20995642\") {\n      edges {\n        node {\n          namespace\n          key\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    metafields(first: 2, owner: \"gid://shopify/Product/20995642\") {\n      edges {\n        node {\n          namespace\n          key\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\n  query {\n    metafields(first: 2, owner: \"gid://shopify/Product/20995642\") {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\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    metafields(first: 2, owner: \"gid://shopify/Product/20995642\") {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  metafields(first: 2, owner: \"gid://shopify/Product/20995642\") {\n    edges {\n      node {\n        namespace\n        key\n        value\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "metafields": {
        "edges": [
          {
            "node": {
              "namespace": "my_fields",
              "key": "materials",
              "value": "95% Cotton/n 5% Spandex"
            }
          }
        ]
      }
    }
  }

  Retrieve metafields within a namespace

          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 { metafields(first: 2, owner: \\\"gid://shopify/Product/20995642\\\", namespace: \\\"my_fields\\\") { edges { node { namespace key value } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    metafields(first: 2, owner: \"gid://shopify/Product/20995642\", namespace: \"my_fields\") {\n      edges {\n        node {\n          namespace\n          key\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    metafields(first: 2, owner: \"gid://shopify/Product/20995642\", namespace: \"my_fields\") {\n      edges {\n        node {\n          namespace\n          key\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\n  query {\n    metafields(first: 2, owner: \"gid://shopify/Product/20995642\", namespace: \"my_fields\") {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\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    metafields(first: 2, owner: \"gid://shopify/Product/20995642\", namespace: \"my_fields\") {\n      edges {\n        node {\n          namespace\n          key\n          value\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  metafields(first: 2, owner: \"gid://shopify/Product/20995642\", namespace: \"my_fields\") {\n    edges {\n      node {\n        namespace\n        key\n        value\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "metafields": {
        "edges": [
          {
            "node": {
              "namespace": "my_fields",
              "key": "materials",
              "value": "95% Cotton\n5% Spandex"
            }
          },
          {
            "node": {
              "namespace": "my_fields",
              "key": "manufactured",
              "value": "Made in Canada"
            }
          }
        ]
      }
    }
  }