> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/menu/models.md).

# Models

## The MenuItemDetail object

```json
{"openapi":"3.0.3","info":{"title":"Menu API","version":"1.0.0"},"components":{"schemas":{"MenuItemDetail":{"type":"object","properties":{"label":{"type":"string","description":"Display text for the menu item"},"url":{"type":"string","description":"Navigation URL (can be absolute or relative path)"},"level":{"type":"integer","description":"Depth level in the menu hierarchy (0-based, excluding root node)"},"pk":{"type":"string","format":"uuid","description":"Unique identifier for the menu item (UUID)"},"sort_order":{"type":"integer","description":"Ordering position within the same level (used for sorting siblings)"},"path":{"type":"string","description":"Materialized path for efficient tree traversal"},"parent_pk":{"type":"string","format":"uuid","nullable":true,"description":"Parent menu item's UUID (null for top-level items)"},"parent":{"type":"object","nullable":true,"description":"Parent menu item object (null for top-level items, populated by SetParentMenuModifier)"},"generator_name":{"type":"string","description":"Name of the generator that created this menu item"},"extra_context":{"type":"object","description":"Additional context data for the menu item","properties":{"attributes":{"type":"object","description":"Custom EAV attributes associated with this menu item","additionalProperties":true},"numchild":{"type":"integer","description":"Number of direct children under this menu item"}}},"selected":{"type":"boolean","description":"Indicates if this menu item is in the current navigation path (set by SetSelectedMenuModifier)"}},"required":["label","url","level","pk","sort_order","path","parent_pk","parent","generator_name","extra_context"]}}}}
```

## The MenuResponse object

```json
{"openapi":"3.0.3","info":{"title":"Menu API","version":"1.0.0"},"components":{"schemas":{"MenuResponse":{"type":"object","properties":{"menu":{"type":"array","items":{"$ref":"#/components/schemas/MenuItemDetail"},"description":"Array of menu items in the generated menu structure"}},"required":["menu"]},"MenuItemDetail":{"type":"object","properties":{"label":{"type":"string","description":"Display text for the menu item"},"url":{"type":"string","description":"Navigation URL (can be absolute or relative path)"},"level":{"type":"integer","description":"Depth level in the menu hierarchy (0-based, excluding root node)"},"pk":{"type":"string","format":"uuid","description":"Unique identifier for the menu item (UUID)"},"sort_order":{"type":"integer","description":"Ordering position within the same level (used for sorting siblings)"},"path":{"type":"string","description":"Materialized path for efficient tree traversal"},"parent_pk":{"type":"string","format":"uuid","nullable":true,"description":"Parent menu item's UUID (null for top-level items)"},"parent":{"type":"object","nullable":true,"description":"Parent menu item object (null for top-level items, populated by SetParentMenuModifier)"},"generator_name":{"type":"string","description":"Name of the generator that created this menu item"},"extra_context":{"type":"object","description":"Additional context data for the menu item","properties":{"attributes":{"type":"object","description":"Custom EAV attributes associated with this menu item","additionalProperties":true},"numchild":{"type":"integer","description":"Number of direct children under this menu item"}}},"selected":{"type":"boolean","description":"Indicates if this menu item is in the current navigation path (set by SetSelectedMenuModifier)"}},"required":["label","url","level","pk","sort_order","path","parent_pk","parent","generator_name","extra_context"]}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Menu API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"errors":{"type":"object","description":"Validation errors keyed by field name","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/menu/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.