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

Fields​

id ● ID!​

The ID of the menu.

privateMetadata ● [MetadataItem!]!​

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

privateMetafield ● String​

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

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

privateMetafields ● Metadata​

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

keys ● [String!]​

metadata ● [MetadataItem!]!​

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

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

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

keys ● [String!]​

name ● String!​

The name of the menu.

slug ● String!​

Slug of the menu.

items ● [MenuItem!]​

Menu items associated with this menu.

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

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