Menus
Retrieve a Menu
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Products
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Menus
Retrieve a Menu
Returns the dertails of a specified menu.
GET
/
api
/
v2
/
storefront
/
menus
/
{id}
id
string
*
id
Required
string
The ID of the menu you wish to retrieve.
Add Example Value
include
string
include
string
Pass menu_items as an include value to fetch the Menu Items associated with each Menu. If you need to fetch the Menu Item Linked Resource, you can pass menu_items.linked_resource, additionally, you can pass menu_items.icon to fetch the associated Icon for each menu Item
Add Example Value
{
"data": {
"id": "2",
"type": "menu",
"attributes": {
"name": "Footer Menu",
"location": "footer",
"locale": "en"
},
"relationships": {
"menu_items": {
"data": [
{
"id": "46",
"type": "menu_item"
},
{
"id": "45",
"type": "menu_item"
},
{
"id": "44",
"type": "menu_item"
},
{
"id": "47",
"type": "menu_item"
},
{
"id": "48",
"type": "menu_item"
},
{
"id": "41",
"type": "menu_item"
},
{
"id": "49",
"type": "menu_item"
},
{
"id": "50",
"type": "menu_item"
},
{
"id": "51",
"type": "menu_item"
},
{
"id": "52",
"type": "menu_item"
},
{
"id": "42",
"type": "menu_item"
},
{
"id": "53",
"type": "menu_item"
},
{
"id": "54",
"type": "menu_item"
},
{
"id": "56",
"type": "menu_item"
},
{
"id": "55",
"type": "menu_item"
},
{
"id": "43",
"type": "menu_item"
},
{
"id": "2",
"type": "menu_item"
}
]
}
}
}
}Path Parameters
The ID of the menu you wish to retrieve.
Query Parameters
Pass menu_items as an include value to fetch the Menu Items associated with each Menu. If you need to fetch the Menu Item Linked Resource, you can pass menu_items.linked_resource, additionally, you can pass menu_items.icon to fetch the associated Icon for each menu Item
Response
200 - application/vnd.api+json
Was this page helpful?
{
"data": {
"id": "2",
"type": "menu",
"attributes": {
"name": "Footer Menu",
"location": "footer",
"locale": "en"
},
"relationships": {
"menu_items": {
"data": [
{
"id": "46",
"type": "menu_item"
},
{
"id": "45",
"type": "menu_item"
},
{
"id": "44",
"type": "menu_item"
},
{
"id": "47",
"type": "menu_item"
},
{
"id": "48",
"type": "menu_item"
},
{
"id": "41",
"type": "menu_item"
},
{
"id": "49",
"type": "menu_item"
},
{
"id": "50",
"type": "menu_item"
},
{
"id": "51",
"type": "menu_item"
},
{
"id": "52",
"type": "menu_item"
},
{
"id": "42",
"type": "menu_item"
},
{
"id": "53",
"type": "menu_item"
},
{
"id": "54",
"type": "menu_item"
},
{
"id": "56",
"type": "menu_item"
},
{
"id": "55",
"type": "menu_item"
},
{
"id": "43",
"type": "menu_item"
},
{
"id": "2",
"type": "menu_item"
}
]
}
}
}
}