Retrieves All Menu Items

Returns a list of all active menus all their menu items

GET /menu/items

Retrieves All Menu Items

cURL

curl --request GET \
  --url https://cdn.xm.fabric.inc/api/menu/items \
  --header 'x-site-context: <x-site-context>'

200

{
  "status_code": 200,
  "status": "List of active menus",
  "data": {
    "MenuList": [
      {
        "id": "61110b8d3e136500082f5d42",
        "label": "Gifts + Holiday",
        "order": 1,
        "isActive": true,
        "channel": [
          12
        ],
        "path": "/c/gifts",
        "params": [
          {
            "_id": "61110bba873a390008d3a2fe",
            "kind": "context",
            "value": "gifts"
          }
        ],
        "children": [
          {
            "id": "61110bcb3e136500082f5d48",
            "label": "Gifts by Price",
            "order": 1,
            "isActive": true,
            "channel": [
              12
            ],
            "path": "/c/gifts/gifts-by-price",
            "params": [
              {
                "_id": "61110bdd873a390008d3a303",
                "kind": "context",
                "value": "gifts_gifts-by-price"
              }
            ],
            "children": [
              {
                "id": "61110bf93e136500082f5d4d",
                "label": "Gifts Under $250",
                "order": 1,
                "isActive": true,
                "channel": [
                  12
                ],
                "path": "/c/gifts/gifts-by-price/gifts-under-250",
                "params": [
                  {
                    "kind": "context",
                    "value": "gifts_gifts-by-price_gifts-under-250"
                  }
                ],
                "children": []
              },
              {
                "id": "61110c1a3e136500082f5d52",
                "label": "Gifts Under $500",
                "order": 2,
                "isActive": false,
                "channel": [
                  12
                ],
                "path": "/c/gifts/gifts-by-price/gifts-under-500",
                "params": [
                  {
                    "kind": "context",
                    "value": "gifts_gifts-by-price_gifts-under-500"
                  }
                ],
                "children": []
              }
            ]
          },
          {
            "id": "61110c3e3e136500082f5d56",
            "label": "Dining + Entertainment",
            "order": 3,
            "isActive": true,
            "channel": [
              12
            ],
            "path": "/",
            "params": [],
            "children": [
              {
                "id": "61110c513e136500082f5d5b",
                "label": "All Dining + Entertainment",
                "order": 1,
                "isActive": true,
                "channel": [
                  12
                ],
                "path": "/content/shop/dining-entertaining",
                "params": [
                  {
                    "kind": "",
                    "value": ""
                  }
                ],
                "children": []
              }
            ]
          }
        ]
      }
    ]
  }
}

Headers

x-site-context · string · required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Response

200

application/json

Successful operation

200 response object

status_code · integer

The response status code

status · string

Status message

data · object

The data object holding the list of menus and menu items

Show child attributes