Menus Resource
URL Endpoints
| Endpoint | Supported Metods |
|---|---|
| /[store-handle]/api/v2/webstore/menus.json | GET |
| /[store-handle]/api/v2/webstore/menus/[menu-uuid or menu-name].json | GET, PUT, DELETE |
Data Structure
The menus in the menu resource are named collections of structured menus. They can go multiple levels deep, but please note that some of the templates only render the menus up to two levels of depth. The correct urls for the menu items will be generated when rendering the template, for example the url "tags:man,bikes" could become /store-name/shop/browse/man,bikes/1.
GET
/[store-handle]/api/v2/webstore/menu/navigation.json
/static/support/documentation/examples/menu.json
| Name | Path | Type | Description | Example |
|---|---|---|---|---|
| type | type | string (readonly) | Resource type. Must match the resource type used in the endpoint. | "orders", "products", "customers" |
| uuid | uuid | uuid | Resource identifier. Must be a valid hex representation. | "06429e75a8ea11de80c09314b8ee4e52" |
| revision | revision | timestamp (readonly) | Resource version. Uses the timestamp format, precision up to seconds. | 1253783394 |
| name | name | limited string | Menu name. By default templates expect "navigation" and "product" menu to be available. | "navigation", "product", "footer" |
| menu | menu | array with dictionaries | ||
| title | menu.0.title | string | Name as it would appear on the site. | "License Agreement", "Apple Website", "Bikes for Men" |
| target | menu.0.target | special string | Location the menu should point to. The targets can be of types page:[page resource url], url:[link], tags:[list of tags separated by comma]. If using tags or pages, make sure they exist. | "page:agreement", "url:http://www.apple.com", "tags:man,bikes" |
| submenus | menu.0.submenus | array with dictionaries | List with more menu resources. |