Skip to main content
Version: 3.x

Menu

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

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!]
}

Fields

Menu.id ● ID! non-null scalar

The ID of the menu.

Menu.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires staff permissions to access.

Menu.privateMetafield ● String scalar

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
Menu.privateMetafield.key ● String! non-null scalar

Menu.privateMetafields ● Metadata scalar

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
Menu.privateMetafields.keys ● [String!] list scalar

Menu.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Menu.metafield ● String scalar

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
Menu.metafield.key ● String! non-null scalar

Menu.metafields ● Metadata scalar

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
Menu.metafields.keys ● [String!] list scalar

Menu.name ● String! non-null scalar

The name of the menu.

Menu.slug ● String! non-null scalar

Slug of the menu.

Menu.items ● [MenuItem!] list object

Menu items associated with this menu.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned by

menu query

Member of

MenuCountableEdge object ● MenuItem object


Was this page helpful?