menuDelete - admin-graphql - MUTATION

Version: 2025-01

Description:

Deletes a menu.

Access Scopes

`write_online_store_navigation` access scope.

Arguments

• id: ID! - The ID of the menu to be deleted.

Returns

• deletedMenuId: ID The ID of the deleted menu.
• userErrors: MenuDeleteUserError! The list of errors that occurred from executing the mutation.

Examples

• Failing to delete the main menu

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DeleteMenu($id: ID!) { menuDelete(id: $id) { deletedMenuId userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Menu/166235728\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DeleteMenu($id: ID!) {\n      menuDelete(id: $id) {\n        deletedMenuId\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Menu/166235728\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation DeleteMenu($id: ID!) {\n    menuDelete(id: $id) {\n      deletedMenuId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Menu/166235728\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation DeleteMenu($id: ID!) {\n    menuDelete(id: $id) {\n      deletedMenuId\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Menu/166235728\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation DeleteMenu($id: ID!) {\n    menuDelete(id: $id) {\n      deletedMenuId\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Menu/166235728\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DeleteMenu($id: ID!) {\n  menuDelete(id: $id) {\n    deletedMenuId\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

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

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

  Successfully deleting a menu

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation DeleteMenu($id: ID!) { menuDelete(id: $id) { deletedMenuId } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Menu/166235728\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation DeleteMenu($id: ID!) {\n      menuDelete(id: $id) {\n        deletedMenuId\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Menu/166235728\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation DeleteMenu($id: ID!) {\n    menuDelete(id: $id) {\n      deletedMenuId\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Menu/166235728\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation DeleteMenu($id: ID!) {\n    menuDelete(id: $id) {\n      deletedMenuId\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Menu/166235728\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation DeleteMenu($id: ID!) {\n    menuDelete(id: $id) {\n      deletedMenuId\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Menu/166235728\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation DeleteMenu($id: ID!) {\n  menuDelete(id: $id) {\n    deletedMenuId\n  }\n}"
        

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

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