GET
/
api
/
v2
/
storefront
/
menus
List all Menus
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/menus
{
  "data": [
    {
      "id": "1",
      "type": "menu",
      "attributes": {
        "name": "Main Menu",
        "location": "header",
        "locale": "en"
      },
      "relationships": {
        "menu_items": {
          "data": [
            {
              "id": "13",
              "type": "menu_item"
            },
            {
              "id": "19",
              "type": "menu_item"
            },
            {
              "id": "17",
              "type": "menu_item"
            },
            {
              "id": "21",
              "type": "menu_item"
            },
            {
              "id": "18",
              "type": "menu_item"
            },
            {
              "id": "29",
              "type": "menu_item"
            },
            {
              "id": "28",
              "type": "menu_item"
            },
            {
              "id": "35",
              "type": "menu_item"
            },
            {
              "id": "32",
              "type": "menu_item"
            },
            {
              "id": "31",
              "type": "menu_item"
            },
            {
              "id": "34",
              "type": "menu_item"
            },
            {
              "id": "30",
              "type": "menu_item"
            },
            {
              "id": "33",
              "type": "menu_item"
            },
            {
              "id": "16",
              "type": "menu_item"
            },
            {
              "id": "22",
              "type": "menu_item"
            },
            {
              "id": "23",
              "type": "menu_item"
            },
            {
              "id": "38",
              "type": "menu_item"
            },
            {
              "id": "37",
              "type": "menu_item"
            },
            {
              "id": "36",
              "type": "menu_item"
            },
            {
              "id": "24",
              "type": "menu_item"
            },
            {
              "id": "25",
              "type": "menu_item"
            },
            {
              "id": "20",
              "type": "menu_item"
            },
            {
              "id": "14",
              "type": "menu_item"
            },
            {
              "id": "40",
              "type": "menu_item"
            },
            {
              "id": "39",
              "type": "menu_item"
            },
            {
              "id": "27",
              "type": "menu_item"
            },
            {
              "id": "26",
              "type": "menu_item"
            },
            {
              "id": "1",
              "type": "menu_item"
            },
            {
              "id": "15",
              "type": "menu_item"
            }
          ]
        }
      }
    },
    {
      "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"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://localhost:3000/api/v2/storefront/menus",
    "next": "http://localhost:3000/api/v2/storefront/menus?page=1",
    "prev": "http://localhost:3000/api/v2/storefront/menus?page=1",
    "last": "http://localhost:3000/api/v2/storefront/menus?page=1",
    "first": "http://localhost:3000/api/v2/storefront/menus?page=1"
  }
}

Query Parameters

​
filter[location]
string

Fetch only resources with corresponding Location

Example:

"header"

​
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

Example:

"menu_items.linked_resource"

​
locale
string

Pass locale as value to fetch the resources with the matching locale for example ?locale=fr.

Example:

"en"

​
per_page
integer

Number of requested records per page when paginating collection

Response

200
application/vnd.api+json

200 Success - Returns an array of menu objects.

The response is of type object.