POST v1/Menus/Exclusions

Menu exclusions to activate or deactivate items (SubMenu, MenuItem, SalesItem, ModifierGroup and Modifier) for each site. Menu changes will take effect after 5 mins due to menu caching.

URI template

v1/Menus/Exclusions

Request Information

URI Parameters

None.

Body Parameters

MenuExclusions

Name	Description	Type	Additional information
SiteId	Get or Set property for SiteId	integer	None.
ActivateList	Get or Set property for ActiveList	MenuList	None.
DeactivateList	Get or Set property for DeactivateList	MenuList	None.
SkipModifierGroupCheck	Get or Set property for SkipModifierGroupCheck	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteId": 1,
  "ActivateList": {
    "$id": "2",
    "SubMenuIds": [
      2,
      3
    ],
    "MenuItemIds": [
      4,
      5
    ],
    "SalesItemIds": [
      6,
      7
    ],
    "ModifierGroupIds": [
      8,
      9
    ],
    "ModifierIds": [
      10,
      11
    ],
    "QuickComboMenuItemIds": [
      12,
      13
    ]
  },
  "DeactivateList": {
    "$id": "3",
    "SubMenuIds": [
      14,
      15
    ],
    "MenuItemIds": [
      16,
      17
    ],
    "SalesItemIds": [
      18,
      19
    ],
    "ModifierGroupIds": [
      20,
      21
    ],
    "ModifierIds": [
      22,
      23
    ],
    "QuickComboMenuItemIds": [
      24,
      25
    ]
  },
  "SkipModifierGroupCheck": true
}

application/xml, text/xml

Sample:

<MenuExclusions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
  <ActivateList>
    <MenuItemIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>4</d3p1:long>
      <d3p1:long>5</d3p1:long>
    </MenuItemIds>
    <ModifierGroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>8</d3p1:long>
      <d3p1:long>9</d3p1:long>
    </ModifierGroupIds>
    <ModifierIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>10</d3p1:long>
      <d3p1:long>11</d3p1:long>
    </ModifierIds>
    <QuickComboMenuItemIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>12</d3p1:long>
      <d3p1:long>13</d3p1:long>
    </QuickComboMenuItemIds>
    <SalesItemIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>6</d3p1:long>
      <d3p1:long>7</d3p1:long>
    </SalesItemIds>
    <SubMenuIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>2</d3p1:long>
      <d3p1:long>3</d3p1:long>
    </SubMenuIds>
  </ActivateList>
  <DeactivateList>
    <MenuItemIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>16</d3p1:long>
      <d3p1:long>17</d3p1:long>
    </MenuItemIds>
    <ModifierGroupIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>20</d3p1:long>
      <d3p1:long>21</d3p1:long>
    </ModifierGroupIds>
    <ModifierIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>22</d3p1:long>
      <d3p1:long>23</d3p1:long>
    </ModifierIds>
    <QuickComboMenuItemIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>24</d3p1:long>
      <d3p1:long>25</d3p1:long>
    </QuickComboMenuItemIds>
    <SalesItemIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>18</d3p1:long>
      <d3p1:long>19</d3p1:long>
    </SalesItemIds>
    <SubMenuIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>14</d3p1:long>
      <d3p1:long>15</d3p1:long>
    </SubMenuIds>
  </DeactivateList>
  <SiteId>1</SiteId>
  <SkipModifierGroupCheck>true</SkipModifierGroupCheck>
</MenuExclusions>

Response Information

Resource Description

MenuExclusionsResponse

Name	Type	Additional information
Verbose	string	None.
Message	string	None.
ErrorCode	integer	None.
SuccessResult	MenuExclusionsResult	None.
FailedResult	FailedMenuExclusionsResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Verbose": "sample string 1",
  "Message": "sample string 2",
  "ErrorCode": 3,
  "SuccessResult": {
    "$id": "2",
    "SiteId": 4,
    "ActivatedList": {
      "$id": "3",
      "SubMenuIds": [
        5,
        6
      ],
      "MenuItemIds": [
        7,
        8
      ],
      "SalesItemIds": [
        9,
        10
      ],
      "ModifierGroupIds": [
        11,
        12
      ],
      "ModifierIds": [
        13,
        14
      ],
      "QuickComboMenuItemIds": [
        15,
        16
      ]
    },
    "DeactivatedList": {
      "$id": "4",
      "SubMenuIds": [
        17,
        18
      ],
      "MenuItemIds": [
        19,
        20
      ],
      "SalesItemIds": [
        21,
        22
      ],
      "ModifierGroupIds": [
        23,
        24
      ],
      "ModifierIds": [
        25,
        26
      ],
      "QuickComboMenuItemIds": [
        27,
        28
      ]
    }
  },
  "FailedResult": {
    "$id": "5",
    "SiteId": 29,
    "ActivatedList": {
      "$id": "6",
      "SubMenuIds": [
        30,
        31
      ],
      "MenuItemIds": [
        32,
        33
      ],
      "SalesItemIds": [
        34,
        35
      ],
      "ModifierGroupIds": [
        36,
        37
      ],
      "ModifierIds": [
        38,
        39
      ],
      "QuickComboMenuItemIds": [
        40,
        41
      ]
    },
    "DeactivatedList": {
      "$id": "7",
      "SubMenuIds": [
        42,
        43
      ],
      "MenuItemIds": [
        44,
        45
      ],
      "SalesItemIds": [
        46,
        47
      ],
      "ModifierGroupIds": [
        48,
        49
      ],
      "ModifierIds": [
        50,
        51
      ],
      "QuickComboMenuItemIds": [
        52,
        53
      ]
    }
  }
}

application/xml, text/xml

Sample:

<MenuExclusionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response">
  <ErrorCode>3</ErrorCode>
  <FailedResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
    <d2p1:ActivatedList>
      <d2p1:MenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>32</d4p1:long>
        <d4p1:long>33</d4p1:long>
      </d2p1:MenuItemIds>
      <d2p1:ModifierGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>36</d4p1:long>
        <d4p1:long>37</d4p1:long>
      </d2p1:ModifierGroupIds>
      <d2p1:ModifierIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>38</d4p1:long>
        <d4p1:long>39</d4p1:long>
      </d2p1:ModifierIds>
      <d2p1:QuickComboMenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>40</d4p1:long>
        <d4p1:long>41</d4p1:long>
      </d2p1:QuickComboMenuItemIds>
      <d2p1:SalesItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>34</d4p1:long>
        <d4p1:long>35</d4p1:long>
      </d2p1:SalesItemIds>
      <d2p1:SubMenuIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>30</d4p1:long>
        <d4p1:long>31</d4p1:long>
      </d2p1:SubMenuIds>
    </d2p1:ActivatedList>
    <d2p1:DeactivatedList>
      <d2p1:MenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>44</d4p1:long>
        <d4p1:long>45</d4p1:long>
      </d2p1:MenuItemIds>
      <d2p1:ModifierGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>48</d4p1:long>
        <d4p1:long>49</d4p1:long>
      </d2p1:ModifierGroupIds>
      <d2p1:ModifierIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>50</d4p1:long>
        <d4p1:long>51</d4p1:long>
      </d2p1:ModifierIds>
      <d2p1:QuickComboMenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>52</d4p1:long>
        <d4p1:long>53</d4p1:long>
      </d2p1:QuickComboMenuItemIds>
      <d2p1:SalesItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>46</d4p1:long>
        <d4p1:long>47</d4p1:long>
      </d2p1:SalesItemIds>
      <d2p1:SubMenuIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>42</d4p1:long>
        <d4p1:long>43</d4p1:long>
      </d2p1:SubMenuIds>
    </d2p1:DeactivatedList>
    <d2p1:SiteId>29</d2p1:SiteId>
  </FailedResult>
  <Message>sample string 2</Message>
  <SuccessResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
    <d2p1:ActivatedList>
      <d2p1:MenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>7</d4p1:long>
        <d4p1:long>8</d4p1:long>
      </d2p1:MenuItemIds>
      <d2p1:ModifierGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>11</d4p1:long>
        <d4p1:long>12</d4p1:long>
      </d2p1:ModifierGroupIds>
      <d2p1:ModifierIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>13</d4p1:long>
        <d4p1:long>14</d4p1:long>
      </d2p1:ModifierIds>
      <d2p1:QuickComboMenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>15</d4p1:long>
        <d4p1:long>16</d4p1:long>
      </d2p1:QuickComboMenuItemIds>
      <d2p1:SalesItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>9</d4p1:long>
        <d4p1:long>10</d4p1:long>
      </d2p1:SalesItemIds>
      <d2p1:SubMenuIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>5</d4p1:long>
        <d4p1:long>6</d4p1:long>
      </d2p1:SubMenuIds>
    </d2p1:ActivatedList>
    <d2p1:DeactivatedList>
      <d2p1:MenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>19</d4p1:long>
        <d4p1:long>20</d4p1:long>
      </d2p1:MenuItemIds>
      <d2p1:ModifierGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>23</d4p1:long>
        <d4p1:long>24</d4p1:long>
      </d2p1:ModifierGroupIds>
      <d2p1:ModifierIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>25</d4p1:long>
        <d4p1:long>26</d4p1:long>
      </d2p1:ModifierIds>
      <d2p1:QuickComboMenuItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>27</d4p1:long>
        <d4p1:long>28</d4p1:long>
      </d2p1:QuickComboMenuItemIds>
      <d2p1:SalesItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>21</d4p1:long>
        <d4p1:long>22</d4p1:long>
      </d2p1:SalesItemIds>
      <d2p1:SubMenuIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>17</d4p1:long>
        <d4p1:long>18</d4p1:long>
      </d2p1:SubMenuIds>
    </d2p1:DeactivatedList>
    <d2p1:SiteId>4</d2p1:SiteId>
  </SuccessResult>
  <Verbose>sample string 1</Verbose>
</MenuExclusionsResponse>