Skip to content
Last update: March 19, 2024

Menus query

This query is used to retrieve a collection of menus based on the provided criteria.

Arguments

Arguments Description
storeId String! The Id of the store for which to retrieve menus.
cultureName String A language to retrieve data in.
keyword String A keyword used to filter menus based on their content.

Possible returns

Possible return Description
MenuLinkListType A list of menu links.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
query {
  menus(
    storeId:"B2B-store"
    cultureName:"en-US"
  )
  {
    name
    outerId
    items{
      url
      title
      outerId
      priority
      associatedObjectId
      associatedObjectName
      associatedObjectType
    }
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
{
  "data": {
    "menus": [
      {
        "name": "catalog-menu",
        "outerId": null,
        "items": [
          {
            "url": "/bolts",
            "title": "Bolts",
            "outerId": null,
            "priority": 20,
            "associatedObjectId": null,
            "associatedObjectName": null,
            "associatedObjectType": null
          },
          {
            "url": "/printers",
            "title": "Printers",
            "outerId": null,
            "priority": 10,
            "associatedObjectId": null,
            "associatedObjectName": null,
            "associatedObjectType": null
          }
        ]
      },
      {
        "name": "Bolts",
        "outerId": null,
        "items": [
          {
            "url": "/bolts/freight-car-bolts",
            "title": "Freight car bolts",
            "outerId": null,
            "priority": 30,
            "associatedObjectId": null,
            "associatedObjectName": null,
            "associatedObjectType": null
          },
          {
            "url": "/bolts/carriage-bolts",
            "title": "Carriage bolts",
            "outerId": null,
            "priority": 20,
            "associatedObjectId": null,
            "associatedObjectName": null,
            "associatedObjectType": null
          },
          {
            "url": "/bolts/eyebolts",
            "title": "Eyebolts",
            "outerId": null,
            "priority": 10,
            "associatedObjectId": null,
            "associatedObjectName": null,
            "associatedObjectType": null
          },
          {
            "url": "/bolts/flange-bolts",
            "title": "Flange Bolts",
            "outerId": null,
            "priority": 0,
            "associatedObjectId": null,
            "associatedObjectName": null,
            "associatedObjectType": null
          }
        ]
      },
    ]
  }
}