metafieldStorefrontVisibilityDelete

mutationDeprecated

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

Deletes a MetafieldStorefrontVisibility record. All metafields that belongs to the specified record will no longer be visible in the Storefront API. This mutation will be removed in a future version. Use the metafieldDefinitionUpdate mutation with access.storefront set instead.

Arguments

Anchor to idid • ID!required: The ID of the MetafieldStorefrontVisibility record to delete.

Was this section helpful?

Anchor to MetafieldStorefrontVisibilityDeletePayload returnsMetafieldStorefrontVisibilityDeletePayload returns

Anchor to deletedMetafieldStorefrontVisibilityIddeletedMetafieldStorefrontVisibilityId • ID: The ID of the deleted MetafieldStorefrontVisibility record.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete a metafield storefront visibility
metafieldStorefrontVisibilityDelete reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation DeleteMetafieldStorefrontVisibility($id: ID!) {

metafieldStorefrontVisibilityDelete(id: $id) {

deletedMetafieldStorefrontVisibilityId

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/MetafieldStorefrontVisibility/24853765"

);

const data = await response.json();

mutation DeleteMetafieldStorefrontVisibility($id: ID!) {
  metafieldStorefrontVisibilityDelete(id: $id) {
    deletedMetafieldStorefrontVisibilityId
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation DeleteMetafieldStorefrontVisibility($id: ID!) { metafieldStorefrontVisibilityDelete(id: $id) { deletedMetafieldStorefrontVisibilityId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/MetafieldStorefrontVisibility/24853765"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation DeleteMetafieldStorefrontVisibility($id: ID!) {
    metafieldStorefrontVisibilityDelete(id: $id) {
      deletedMetafieldStorefrontVisibilityId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/MetafieldStorefrontVisibility/24853765"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteMetafieldStorefrontVisibility($id: ID!) {
      metafieldStorefrontVisibilityDelete(id: $id) {
        deletedMetafieldStorefrontVisibilityId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/MetafieldStorefrontVisibility/24853765"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation DeleteMetafieldStorefrontVisibility($id: ID!) {
    metafieldStorefrontVisibilityDelete(id: $id) {
      deletedMetafieldStorefrontVisibilityId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MetafieldStorefrontVisibility/24853765"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/MetafieldStorefrontVisibility/24853765"

}

Response

JSON

{

"metafieldStorefrontVisibilityDelete": {

"deletedMetafieldStorefrontVisibilityId": "gid://shopify/MetafieldStorefrontVisibility/24853765",

"userErrors": []

}