metafieldStorefrontVisibilityCreate mutation

Makes a Metafield with a specific namespace and key visible to the storefront API.

On this page

Interactive example

This is an example mutation query.

mutation metafieldStorefrontVisibilityCreate($input: MetafieldStorefrontVisibilityInput!) { metafieldStorefrontVisibilityCreate(input: $input) { 
  1. <font style="color:#1F61A0;">metafieldStorefrontVisibility</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"namespace"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"key"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  5. <font style="color:#8B2BB9;">"ownerType"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
} }

Arguments

Argument Description
input
(
[MetafieldStorefrontVisibilityInput!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldstorefrontvisibilityinput)

) REQUIRED		 Specifies the input fields for the visibility.

MetafieldStorefrontVisibilityInput fields

  • key ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
    The key of the metafield to be visible to the storefront api.
  • namespace ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
    The namespace of the metafield to be visible to the storefront api.
  • ownerType ([MetafieldOwnerType!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldownertype)) REQUIRED
    The core resource ( e.g.: Product ) that owns this metafield.

Return fields

  • metafieldStorefrontVisibility ([MetafieldStorefrontVisibility](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldstorefrontvisibility))
    The metafield storefront visibility that was created.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.