Skip to main content
Anchor to Menu

Menu

object

Requires read_online_store_navigation access scope.

Navigation menus that organize links into logical structures to guide customers through a store. Menus serve as the backbone of store navigation, making it easy for customers to find products, pages, and other content through organized hierarchical links.

For example, a merchant might create a main navigation menu with top-level categories like "Products," "About Us," and "Contact," where each category can contain nested menu items linking to specific collections, pages, or external resources.

Use the Menu object to:

  • Build and customize store navigation structures
  • Organize hierarchical menu systems with nested items
  • Work with default menus that can't be deleted
  • Access menu items for building navigation

Menus can be designated as default navigation elements (like main menu or footer), which can't be deleted and have restricted handle updates. The handle provides a unique identifier that themes can reference, while the items collection enables nested navigation structures.

Each menu contains menu items that can link to various resource types. This flexibility lets merchants create navigation experiences that guide customers through their store.

Anchor to FieldsFields

Anchor to handlehandle
•String!
non-null

The menu's handle.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to isDefaultisDefault
•Boolean!
non-null

Whether the menu is a default. The handle for default menus can't be updated and default menus can't be deleted.

Anchor to itemsitems
•[MenuItem!]!
non-null

A list of items on the menu sorted by position.

Arguments

Anchor to limitlimit
•Int

The number of menu items to be returned.

Anchor to titletitle
•String!
non-null

The menu's title.

Anchor to translationstranslations
•[Translation!]!
non-null

The published translations associated with the resource.

Arguments

Anchor to localelocale
•String!
required

Filters translations locale.

Anchor to marketIdmarketId
•ID

Filters translations by market ID. Use this argument to retrieve content specific to a market.

Was this section helpful?

Anchor to QueriesQueries

Anchor to menumenu
•query

Returns a Menu resource by ID.

Arguments

Anchor to idid
•ID!
required

The ID of the Menu to return.

Anchor to menusmenus
•query

Retrieves navigation menus. Menus organize content into hierarchical navigation structures that merchants can display in the online store (for example, in headers, footers, and sidebars) and customer accounts.

Each Menu contains a handle for identification, a title for display, and a collection of MenuItem objects that can be nested up to 3 levels deep. Default menus have protected handles that can't be modified.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MenuSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to title
•string
Was this section helpful?

Anchor to MutationsMutations

Anchor to menuCreatemenuCreate
•mutation

Creates a navigation Menu for the online store. Menus organize links that help customers navigate to collections, products, pages, blogs, and custom URLs.

Each menu requires a unique handle for identification and can contain multiple MenuItem objects with nested sub-items up to three levels deep.

Arguments

Anchor to titletitle
•String!
required

The menu's title.

Anchor to handlehandle
•String!
required

The menu's handle.

Anchor to itemsitems
•[MenuItemCreateInput!]!
required

List of the menu's items.

Anchor to menuUpdatemenuUpdate
•mutation

Updates a Menu for display on the storefront. Modifies the menu's title and navigation structure, including nested MenuItem objects. You can update the handle for non-default menus.

The items argument accepts a list of menu items with their nested structure. Each item can include nested items to create multi-level navigation hierarchies. Default menus have restricted updates—you can't change their handles.

Arguments

Anchor to idid
•ID!
required

ID of the menu to be updated.

Anchor to titletitle
•String!
required

The menu's title.

Anchor to handlehandle
•String

The menu's handle.

Anchor to itemsitems
•[MenuItemUpdateInput!]!
required

List of the menu's items.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?