metafieldStorefrontVisibilities - admin-graphql - QUERY

Version: 2024-07

Description:

List of the `MetafieldStorefrontVisibility` records.

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 visible metafields by namespace.
• reverse: Boolean - Reverse the order of the underlying list.

Returns

• edges: MetafieldStorefrontVisibilityEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
• nodes: MetafieldStorefrontVisibility! A list of nodes that are contained in MetafieldStorefrontVisibilityEdge. 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 `MetafieldStorefrontVisibility` records

          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 MetafieldStorefrontVisibilities($first: Int!) { metafieldStorefrontVisibilities(first: $first) { edges { node { namespace key } } } }\",\n \"variables\": {\n    \"first\": 2\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query MetafieldStorefrontVisibilities($first: Int!) {\n      metafieldStorefrontVisibilities(first: $first) {\n        edges {\n          node {\n            namespace\n            key\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"first\": 2\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 MetafieldStorefrontVisibilities($first: Int!) {\n    metafieldStorefrontVisibilities(first: $first) {\n      edges {\n        node {\n          namespace\n          key\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"first\": 2\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 MetafieldStorefrontVisibilities($first: Int!) {\n    metafieldStorefrontVisibilities(first: $first) {\n      edges {\n        node {\n          namespace\n          key\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"first\" => 2,\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 MetafieldStorefrontVisibilities($first: Int!) {\n    metafieldStorefrontVisibilities(first: $first) {\n      edges {\n        node {\n          namespace\n          key\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"first\": 2\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query MetafieldStorefrontVisibilities($first: Int!) {\n  metafieldStorefrontVisibilities(first: $first) {\n    edges {\n      node {\n        namespace\n        key\n      }\n    }\n  }\n}"
        

  input: {
    "first": 2
  }

  response: {
    "data": {
      "metafieldStorefrontVisibilities": {
        "edges": [
          {
            "node": {
              "namespace": "bakery",
              "key": "ingredients"
            }
          },
          {
            "node": {
              "namespace": "bakery",
              "key": "utensils"
            }
          }
        ]
      }
    }
  }

  Retrieve a list of `MetafieldStorefrontVisibility` records filtered by namespace

          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 MetafieldStorefrontVisibilitiesByNamespace($first: Int!, $namespace: String!) { metafieldStorefrontVisibilities(first: $first, namespace: $namespace) { edges { node { namespace key } } } }\",\n \"variables\": {\n    \"first\": 1,\n    \"namespace\": \"bakery\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query MetafieldStorefrontVisibilitiesByNamespace($first: Int!, $namespace: String!) {\n      metafieldStorefrontVisibilities(first: $first, namespace: $namespace) {\n        edges {\n          node {\n            namespace\n            key\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"first\": 1,\n      \"namespace\": \"bakery\"\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 MetafieldStorefrontVisibilitiesByNamespace($first: Int!, $namespace: String!) {\n    metafieldStorefrontVisibilities(first: $first, namespace: $namespace) {\n      edges {\n        node {\n          namespace\n          key\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"first\": 1,\n  \"namespace\": \"bakery\"\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 MetafieldStorefrontVisibilitiesByNamespace($first: Int!, $namespace: String!) {\n    metafieldStorefrontVisibilities(first: $first, namespace: $namespace) {\n      edges {\n        node {\n          namespace\n          key\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"first\" => 1,\n  \"namespace\" => \"bakery\",\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 MetafieldStorefrontVisibilitiesByNamespace($first: Int!, $namespace: String!) {\n    metafieldStorefrontVisibilities(first: $first, namespace: $namespace) {\n      edges {\n        node {\n          namespace\n          key\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"first\": 1,\n      \"namespace\": \"bakery\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query MetafieldStorefrontVisibilitiesByNamespace($first: Int!, $namespace: String!) {\n  metafieldStorefrontVisibilities(first: $first, namespace: $namespace) {\n    edges {\n      node {\n        namespace\n        key\n      }\n    }\n  }\n}"
        

  input: {
    "first": 1,
    "namespace": "bakery"
  }

  response: {
    "data": {
      "metafieldStorefrontVisibilities": {
        "edges": [
          {
            "node": {
              "namespace": "bakery",
              "key": "ingredients"
            }
          }
        ]
      }
    }
  }