metafieldStorefrontVisibilityCreate - admin-graphql - MUTATION

Version: 2024-01

Description:

Creates a `MetafieldStorefrontVisibility` record to make all metafields that belong to the specified resource and have the established `namespace` and `key` combination visible in the Storefront API.

Access Scopes

API client to have access to the owner type and namespace.

Arguments

• input: MetafieldStorefrontVisibilityInput! - Specifies the input fields for a `MetafieldStorefrontVisibility` record.

Returns

• metafieldStorefrontVisibility: MetafieldStorefrontVisibility The `MetafieldStorefrontVisibility` that was created.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Create a metafield storefront visibility

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation CreateMetafieldStorefrontVisibility($input: MetafieldStorefrontVisibilityInput!) { metafieldStorefrontVisibilityCreate(input: $input) { metafieldStorefrontVisibility { namespace key } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"namespace\": \"bakery\",\n      \"key\": \"ingredients\",\n      \"ownerType\": \"PRODUCT\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation CreateMetafieldStorefrontVisibility($input: MetafieldStorefrontVisibilityInput!) {\n      metafieldStorefrontVisibilityCreate(input: $input) {\n        metafieldStorefrontVisibility {\n          namespace\n          key\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"namespace\": \"bakery\",\n        \"key\": \"ingredients\",\n        \"ownerType\": \"PRODUCT\"\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  mutation CreateMetafieldStorefrontVisibility($input: MetafieldStorefrontVisibilityInput!) {\n    metafieldStorefrontVisibilityCreate(input: $input) {\n      metafieldStorefrontVisibility {\n        namespace\n        key\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"namespace\": \"bakery\",\n    \"key\": \"ingredients\",\n    \"ownerType\": \"PRODUCT\"\n  }\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  mutation CreateMetafieldStorefrontVisibility($input: MetafieldStorefrontVisibilityInput!) {\n    metafieldStorefrontVisibilityCreate(input: $input) {\n      metafieldStorefrontVisibility {\n        namespace\n        key\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"namespace\" => \"bakery\",\n    \"key\" => \"ingredients\",\n    \"ownerType\" => \"PRODUCT\",\n  ],\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  mutation CreateMetafieldStorefrontVisibility($input: MetafieldStorefrontVisibilityInput!) {\n    metafieldStorefrontVisibilityCreate(input: $input) {\n      metafieldStorefrontVisibility {\n        namespace\n        key\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"namespace\": \"bakery\",\n        \"key\": \"ingredients\",\n        \"ownerType\": \"PRODUCT\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation CreateMetafieldStorefrontVisibility($input: MetafieldStorefrontVisibilityInput!) {\n  metafieldStorefrontVisibilityCreate(input: $input) {\n    metafieldStorefrontVisibility {\n      namespace\n      key\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "input": {
      "namespace": "bakery",
      "key": "ingredients",
      "ownerType": "PRODUCT"
    }
  }

  response: {
    "data": {
      "metafieldStorefrontVisibilityCreate": {
        "metafieldStorefrontVisibility": {
          "namespace": "bakery",
          "key": "ingredients"
        },
        "userErrors": []
      }
    }
  }