Skip to main content

MenuItem

Represents a single item of the related menu. Can store categories, collection or pages.

type MenuItem 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!
  menu: Menu!
  parent: MenuItem
  category: Category
  collection: Collection
  page: Page
  level: Int!
  children: [MenuItem!]
  url: String
  translation(languageCode: LanguageCodeEnum!): MenuItemTranslation
}

Fields​

MenuItem.id ● ID! non-null scalar​

MenuItem.privateMetadata ● [MetadataItem!]! non-null object​

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

MenuItem.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
This API is currently in Feature Preview and can be subject to changes at later point.
MenuItem.privateMetafield.key ● String! non-null scalar​

MenuItem.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
This API is currently in Feature Preview and can be subject to changes at later point.
MenuItem.privateMetafields.keys ● [String!] list scalar​

MenuItem.metadata ● [MetadataItem!]! non-null object​

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

MenuItem.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
MenuItem.metafield.key ● String! non-null scalar​

MenuItem.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
This API is currently in Feature Preview and can be subject to changes at later point.
MenuItem.metafields.keys ● [String!] list scalar​

MenuItem.name ● String! non-null scalar​

MenuItem.menu ● Menu! non-null object​

MenuItem.parent ● MenuItem object​

MenuItem.category ● Category object​

MenuItem.collection ● Collection object​

A collection associated with this menu item.

Requires one of the following permissions to include the unpublished items: MANAGE_ORDERSMANAGE_DISCOUNTSMANAGE_PRODUCTS

MenuItem.page ● Page object​

A page associated with this menu item.

Requires MANAGE_PAGESpermission.

MenuItem.level ● Int! non-null scalar​

MenuItem.children ● [MenuItem!] list object​

MenuItem.url ● String scalar​

URL to the menu item.

MenuItem.translation ● MenuItemTranslation object​

Returns translated menu item fields for the given language code.

MenuItem.translation.languageCode ● LanguageCodeEnum! non-null enum​

A language code to return the translation for menu item.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Returned by​

menuItem query

Member of​

Menu object ● MenuItem object ● MenuItemCountableEdge object

Was this page helpful?