Skip to main content
Log inSign up
Anchor to MetafieldStorefrontVisibility

MetafieldStorefrontVisibility

object

By default, the Storefront API can't read metafields. To make specific metafields visible in the Storefront API, you need to create a MetafieldStorefrontVisibility record. A MetafieldStorefrontVisibility record is a list of the metafields, defined by the owner_type, namespace, and key, to make visible in the Storefront API.

Learn about [exposing metafields in the Storefront API] (https://shopify.dev/custom-storefronts/products-collections/metafields) for more details.

DateTime!non-null

The date and time when the metafield was set to visible in the Storefront API.

ID!non-null

A globally-unique ID.

String!non-null

The key of a metafield to make visible in the Storefront API.

The ID of the corresponding resource in the REST Admin API.

String!non-null

The namespace of a metafield to make visible in the Storefront API.

The owner type of a metafield to make visible in the Storefront API.

DateTime!non-null

The date and time when the MetafieldStorefrontVisilibty record was updated.


Was this section helpful?

Deprecated queries

query

List of the MetafieldStorefrontVisibility records.

query

Returns a MetafieldStorefrontVisibility record by ID. A MetafieldStorefrontVisibility record lists the metafields to make visible in the Storefront API.


Was this section helpful?

mutation

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.


Was this section helpful?


Was this section helpful?