Choose a version:

menuDelete

mutation

Requires write_online_store_navigation access scope.

Deletes a menu.

Anchor to Arguments

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?

Examples

Failing to delete the main menu

Description

Deleting the main menu returns an error

Query

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

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-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"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation DeleteMenu($id: ID!) {
  menuDelete(id: $id) {
    deletedMenuId
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/Menu/166235728"
}'

Response

{
  "menuDelete": {
    "deletedMenuId": null,
    "userErrors": [
      {
        "field": [
          "id"
        ],
        "message": "Default menu cannot be deleted."
      }
    ]
  }
}

Successfully deleting a menu

Description

Delete a menu by its ID

Query

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

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-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 } }",
 "variables": {
    "id": "gid://shopify/Menu/166235728"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation DeleteMenu($id: ID!) {
    menuDelete(id: $id) {
      deletedMenuId
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Menu/166235728"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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
    }
  }
QUERY

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

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

Node.js

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

Shopify CLI

shopify app execute \
--query \
'mutation DeleteMenu($id: ID!) {
  menuDelete(id: $id) {
    deletedMenuId
  }
}' \
--variables \
'{
  "id": "gid://shopify/Menu/166235728"
}'

Response

{
  "menuDelete": {
    "deletedMenuId": "gid://shopify/Menu/166235728"
  }
}

menuDelete reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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 json = await response.json();

return json.data;

}

GQL

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-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"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Node.js

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"
    },
  },
});

Ruby

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)

Shopify CLI

shopify app execute \
--query \
'mutation DeleteMenu($id: ID!) {
  menuDelete(id: $id) {
    deletedMenuId
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/Menu/166235728"
}'

Input variables

JSON

{

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

}

Response

JSON

{

"menuDelete": {

"deletedMenuId": null,

"userErrors": [

{

"field": [

"id"

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

}

]

}