Menu Items
Return a list of Menu Items
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
Menu Items
Return a list of Menu Items
Returns a list of Menu Items
GET
/
api
/
v2
/
platform
/
menu_items
curl --request GET \
--url http://{defaultHost}/api/v2/platform/menu_items \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "2",
"type": "menu_item",
"attributes": {
"name": "Link no. 1 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 2,
"rgt": 3,
"depth": 1,
"created_at": "2022-11-08T19:34:23.401Z",
"updated_at": "2022-11-08T19:34:23.404Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "13",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "3",
"type": "menu_item",
"attributes": {
"name": "Link no. 2 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 4,
"rgt": 5,
"depth": 1,
"created_at": "2022-11-08T19:34:23.425Z",
"updated_at": "2022-11-08T19:34:23.428Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "14",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "4",
"type": "menu_item",
"attributes": {
"name": "Link no. 3 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 6,
"rgt": 7,
"depth": 1,
"created_at": "2022-11-08T19:34:23.446Z",
"updated_at": "2022-11-08T19:34:23.449Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "15",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "5",
"type": "menu_item",
"attributes": {
"name": "Link no. 4 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 8,
"rgt": 9,
"depth": 1,
"created_at": "2022-11-08T19:34:23.468Z",
"updated_at": "2022-11-08T19:34:23.471Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "16",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "6",
"type": "menu_item",
"attributes": {
"name": "Link no. 5 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 10,
"rgt": 11,
"depth": 1,
"created_at": "2022-11-08T19:34:23.491Z",
"updated_at": "2022-11-08T19:34:23.494Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "17",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "7",
"type": "menu_item",
"attributes": {
"name": "Link no. 6 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 12,
"rgt": 13,
"depth": 1,
"created_at": "2022-11-08T19:34:23.515Z",
"updated_at": "2022-11-08T19:34:23.518Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "18",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "8",
"type": "menu_item",
"attributes": {
"name": "Link no. 7 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 14,
"rgt": 15,
"depth": 1,
"created_at": "2022-11-08T19:34:23.535Z",
"updated_at": "2022-11-08T19:34:23.537Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "19",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "1",
"type": "menu_item",
"attributes": {
"name": "Neque a rem deserunt beatae.",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Container",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 1,
"rgt": 16,
"depth": 0,
"created_at": "2022-11-08T19:34:23.379Z",
"updated_at": "2022-11-08T19:34:23.545Z",
"link": null,
"is_container": true,
"is_root": true,
"is_child": false,
"is_leaf": false
},
"relationships": {
"icon": {
"data": null
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": null
},
"linked_resource": {
"data": null
},
"children": {
"data": [
{
"id": "2",
"type": "menu_item"
},
{
"id": "3",
"type": "menu_item"
},
{
"id": "4",
"type": "menu_item"
},
{
"id": "5",
"type": "menu_item"
},
{
"id": "6",
"type": "menu_item"
},
{
"id": "7",
"type": "menu_item"
},
{
"id": "8",
"type": "menu_item"
}
]
}
}
}
],
"meta": {
"count": 8,
"total_count": 8,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/menu_items?page=1&per_page=&include=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page="
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Response
200
application/vnd.api+json
Records returned
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/menu_items \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "2",
"type": "menu_item",
"attributes": {
"name": "Link no. 1 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 2,
"rgt": 3,
"depth": 1,
"created_at": "2022-11-08T19:34:23.401Z",
"updated_at": "2022-11-08T19:34:23.404Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "13",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "3",
"type": "menu_item",
"attributes": {
"name": "Link no. 2 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 4,
"rgt": 5,
"depth": 1,
"created_at": "2022-11-08T19:34:23.425Z",
"updated_at": "2022-11-08T19:34:23.428Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "14",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "4",
"type": "menu_item",
"attributes": {
"name": "Link no. 3 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 6,
"rgt": 7,
"depth": 1,
"created_at": "2022-11-08T19:34:23.446Z",
"updated_at": "2022-11-08T19:34:23.449Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "15",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "5",
"type": "menu_item",
"attributes": {
"name": "Link no. 4 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 8,
"rgt": 9,
"depth": 1,
"created_at": "2022-11-08T19:34:23.468Z",
"updated_at": "2022-11-08T19:34:23.471Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "16",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "6",
"type": "menu_item",
"attributes": {
"name": "Link no. 5 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 10,
"rgt": 11,
"depth": 1,
"created_at": "2022-11-08T19:34:23.491Z",
"updated_at": "2022-11-08T19:34:23.494Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "17",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "7",
"type": "menu_item",
"attributes": {
"name": "Link no. 6 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 12,
"rgt": 13,
"depth": 1,
"created_at": "2022-11-08T19:34:23.515Z",
"updated_at": "2022-11-08T19:34:23.518Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "18",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "8",
"type": "menu_item",
"attributes": {
"name": "Link no. 7 To Somewhere",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Link",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 14,
"rgt": 15,
"depth": 1,
"created_at": "2022-11-08T19:34:23.535Z",
"updated_at": "2022-11-08T19:34:23.537Z",
"link": null,
"is_container": false,
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"icon": {
"data": {
"id": "19",
"type": "icon"
}
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": {
"id": "1",
"type": "menu_item"
}
},
"linked_resource": {
"data": null
},
"children": {
"data": []
}
}
},
{
"id": "1",
"type": "menu_item",
"attributes": {
"name": "Neque a rem deserunt beatae.",
"subtitle": null,
"destination": null,
"new_window": false,
"item_type": "Container",
"linked_resource_type": "Spree::Linkable::Uri",
"code": null,
"lft": 1,
"rgt": 16,
"depth": 0,
"created_at": "2022-11-08T19:34:23.379Z",
"updated_at": "2022-11-08T19:34:23.545Z",
"link": null,
"is_container": true,
"is_root": true,
"is_child": false,
"is_leaf": false
},
"relationships": {
"icon": {
"data": null
},
"menu": {
"data": {
"id": "1",
"type": "menu"
}
},
"parent": {
"data": null
},
"linked_resource": {
"data": null
},
"children": {
"data": [
{
"id": "2",
"type": "menu_item"
},
{
"id": "3",
"type": "menu_item"
},
{
"id": "4",
"type": "menu_item"
},
{
"id": "5",
"type": "menu_item"
},
{
"id": "6",
"type": "menu_item"
},
{
"id": "7",
"type": "menu_item"
},
{
"id": "8",
"type": "menu_item"
}
]
}
}
}
],
"meta": {
"count": 8,
"total_count": 8,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/menu_items?page=1&per_page=&include=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/menu_items?filter%5Bname_eq%5D=&include=&page=1&per_page="
}
}