Skip to main content

Menu Object

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

Fields​

Menu.id ● ID! non-null scalar miscellaneous​

The ID of the menu.

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

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

Menu.privateMetafield ● String scalar miscellaneous​

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

Tip: Use GraphQL aliases to fetch multiple keys.

Menu.privateMetafield.key ● String! non-null scalar miscellaneous​

Menu.privateMetafields ● Metadata scalar miscellaneous​

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

Menu.privateMetafields.keys ● [String!] list scalar miscellaneous​

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

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

Menu.metafield ● String scalar miscellaneous​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Menu.metafield.key ● String! non-null scalar miscellaneous​

Menu.metafields ● Metadata scalar miscellaneous​

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

Menu.metafields.keys ● [String!] list scalar miscellaneous​

Menu.name ● String! non-null scalar miscellaneous​

The name of the menu.

Menu.slug ● String! non-null scalar miscellaneous​

Slug of the menu.

Menu.items ● [MenuItem!] list object menu​

Menu items associated with this menu.

Interfaces​

Node interface miscellaneous​

An object with an ID

ObjectWithMetadata interface miscellaneous​

Returned By​

menu query

Member Of​

AssignNavigation object ● MenuCountableEdge object ● MenuCreate object ● MenuCreated object ● MenuDelete object ● MenuDeleted object ● MenuItem object ● MenuItemMove object ● MenuUpdate object ● MenuUpdated object