Skip to main content

menu Query

Look up a navigation menu by ID or name.

menu(
  channel: String
  id: ID
  name: String
  slug: String
): Menu
Details
type Menu implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  name: String!
  slug: String!
  items: [MenuItem!]
}

Arguments​

channel ● String​

Slug of a channel for which the data should be returned.

id ● ID​

ID of the menu.

name ● String​

The menu's name.

slug ● String​

The menu's slug.

Type​

Represents a single menu - an object that is used to help navigate through the store.