GET
/
api
/
v2
/
storefront
/
menus
/
{id}
Retrieve a Menu
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/menus/{id}
{
  "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

​
id
string
required

The ID of the menu you wish to retrieve.

Example:

"1"

Query Parameters

​
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"

Response

200
application/vnd.api+json

200 Success - Returns the menu object.

The response is of type object.