POST toastSupportAPI/dataUpload/menu

The Data Upload Menu method. This request includes the store’s menu Major Groups, Minor Groups and Menu Items. Clients should make this request upon enabling changes to the store’s menu. It is also recommended that an initial menu upload be made when the store becomes “live” prior to any redeem promotion requests.

Request Information

URI Parameters

None.

Body Parameters

The Data Upload Menu request context.

ToastDataUploadMenuRequest

Name	Description	Type	Additional information
menuItems	A collection of MenuItem objects.	Collection of ToastMenuItem	Required
menuMajorGroups	A collection of MenuMajorGroups objects.	Collection of MenuMajorGroup	Required
menuMinorGroups	A collection of MenuMinorGroups objects.	Collection of MenuMinorGroup	Required

Request Formats

application/json, text/json

Sample:

{
  "menuItems": [
    {
      "itemGuid": "8e1ee33c-05b8-420a-ba9c-b5798780f3b5",
      "itemId": 1,
      "itemName": "sample string 2",
      "minorGroupId": 3,
      "majorGroupId": 4
    },
    {
      "itemGuid": "8e1ee33c-05b8-420a-ba9c-b5798780f3b5",
      "itemId": 1,
      "itemName": "sample string 2",
      "minorGroupId": 3,
      "majorGroupId": 4
    }
  ],
  "menuMajorGroups": [
    {
      "majorGroupid": 1,
      "name": "sample string 2"
    },
    {
      "majorGroupid": 1,
      "name": "sample string 2"
    }
  ],
  "menuMinorGroups": [
    {
      "minorGroupid": 1,
      "name": "sample string 2"
    },
    {
      "minorGroupid": 1,
      "name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ToastDataUploadMenuRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <MenuItems>
    <ToastMenuItem>
      <ItemGuid>8e1ee33c-05b8-420a-ba9c-b5798780f3b5</ItemGuid>
      <ItemId>1</ItemId>
      <ItemName>sample string 2</ItemName>
      <MajorGroupId>4</MajorGroupId>
      <MinorGroupId>3</MinorGroupId>
    </ToastMenuItem>
    <ToastMenuItem>
      <ItemGuid>8e1ee33c-05b8-420a-ba9c-b5798780f3b5</ItemGuid>
      <ItemId>1</ItemId>
      <ItemName>sample string 2</ItemName>
      <MajorGroupId>4</MajorGroupId>
      <MinorGroupId>3</MinorGroupId>
    </ToastMenuItem>
  </MenuItems>
  <MenuMajorGroups>
    <MenuMajorGroup>
      <MajorGroupId>1</MajorGroupId>
      <Name>sample string 2</Name>
    </MenuMajorGroup>
    <MenuMajorGroup>
      <MajorGroupId>1</MajorGroupId>
      <Name>sample string 2</Name>
    </MenuMajorGroup>
  </MenuMajorGroups>
  <MenuMinorGroups>
    <MenuMinorGroup>
      <MinorGroupId>1</MinorGroupId>
      <Name>sample string 2</Name>
    </MenuMinorGroup>
    <MenuMinorGroup>
      <MinorGroupId>1</MinorGroupId>
      <Name>sample string 2</Name>
    </MenuMinorGroup>
  </MenuMinorGroups>
</ToastDataUploadMenuRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ToastDataUploadMenuRequest'.

Response Information

Resource Description

The Data Upload Menu response object.

DataUploadMenuResponse

Name	Description	Type	Additional information
Result	The Result Object.	Result	None.
ItemCount	The number of items uploaded.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "statusCode": 1,
    "description": "sample string 2",
    "exceptionTrackingMoniker": "sample string 3"
  },
  "ItemCount": 1
}

application/xml, text/xml

Sample:

<DataUploadMenuResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <ItemCount>1</ItemCount>
  <Result>
    <Description>sample string 2</Description>
    <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
    <StatusCode>1</StatusCode>
  </Result>
</DataUploadMenuResponse>