Skip to Content
ReferenceStorefrontv1.3.0 API Reference (Latest)ObjectsMenu

Menu

A navigation menu (link list) including its handle, title, and contained links.

Type Definition

type Menu {
  handle: String
  levels: Int
  links: [Link]
  title: String
}

Fields

FieldTypeDescription
handleStringUnique identifier (token) for this menu, used to reference the menu programmatically.
levelsIntThe total number of nested levels in this menu, representing the depth of the menu hierarchy.
links[Link]The list of top-level links in this menu. Each link may have its own child links, forming a hierarchical structure.
titleStringThe display name of the menu, typically shown as the menu’s title in navigation components.

Relationships

The Menu type represents a structured navigation menu that organizes links hierarchically. It contains a collection of Link objects through its links field, which may themselves contain nested child links to form a multi-level menu structure. The levels field indicates the depth of this hierarchy, while the handle provides a unique reference for programmatic menu retrieval.

Example

query {
  menu {
    handle
    levels
    title
    links {
      title
      url
    }
  }
}

Implements

This type does not implement any interfaces.