getMenusByMarker

Getting pages included in the menu by marker

Menus.getMenusByMarker(marker)

const value = await Menus.getMenusByMarker('my-marker')

Schema

This method retrieves a single menu object based on its marker (marker) from the API. It returns a Promise that resolves to a single menu object as a object with included pages.

Example return:

{
  "id": 1,
  "identifier": "menu",
  "localizeInfos": {
    "title": "menu"
  },
  "pages": [
    {
      "id": null,
      "pageUrl": null,
      "localizeInfos": {},
      "attributeValues": {},
      "parentId": null,
      "position": 1
    }
  ]
}

Schema

id: number
The unique identifier of the menu.
example: 1

identifier: string
The menu identifier.
example: "main_menu"

localizeInfos: ILocalizeInfo
The menu data, taking into account localization.
example:

{
  "title": "menu"
}

pages: IMenusPages[]
Array of menu pages.
example:

[
  {
    "id": null,
    "pageUrl": null,
    "localizeInfos": {},
    "attributeValues": {},
    "parentId": null,
    "position": 1
  }
]

---