menuDelete

mutation

Requires write_online_store_navigation access scope.

Deletes a menu.

Arguments

Anchor to idid • ID!required: The ID of the menu to be deleted.

Was this section helpful?

Anchor to MenuDeletePayload returnsMenuDeletePayload returns

Anchor to deletedMenuIddeletedMenuId • ID: The ID of the deleted menu.
Anchor to userErrorsuserErrors • [MenuDeleteUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Failing to delete the main menu
Successfully deleting a menu
menuDelete reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation DeleteMenu($id: ID!) {

menuDelete(id: $id) {

deletedMenuId

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/Menu/166235728"

);

const data = await response.json();

mutation DeleteMenu($id: ID!) {
  menuDelete(id: $id) {
    deletedMenuId
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation DeleteMenu($id: ID!) { menuDelete(id: $id) { deletedMenuId userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Menu/166235728"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation DeleteMenu($id: ID!) {
    menuDelete(id: $id) {
      deletedMenuId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Menu/166235728"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation DeleteMenu($id: ID!) {
      menuDelete(id: $id) {
        deletedMenuId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Menu/166235728"
    },
  },
});

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 DeleteMenu($id: ID!) {
    menuDelete(id: $id) {
      deletedMenuId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Menu/166235728"
}

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

Input variables

JSON

{

"id": "gid://shopify/Menu/166235728"

}

Response

JSON

{

"menuDelete": {

"deletedMenuId": null,

"userErrors": [

{

"field": [

"id"

"message": "Default menu cannot be deleted."

}

]

}