MenuItemManager Web Service

MenuItemManager

Click here for a complete list of operations.

AddNewMenuItem

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /KMWare.ZMA.Food.MenuItemMgmt.Host/MenuItemManager.asmx HTTP/1.1
Host: ssa.fp360.us
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://KMWare.ZMA.Food.MenuItemMgmt.ServiceContracts/AddNewMenuItem"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddNewMenuItem xmlns="http://KMWare.ZMA.Food.MenuItemMgmt.ServiceContracts">
      <AddNewMenuItemRequest xmlns="http://KMWare.ZMA.Food.MenuItemMgmt.DataTypes">
        <OrganizationUnitId>short</OrganizationUnitId>
        <MenuItemCategoryCode>string</MenuItemCategoryCode>
        <MenuItemSubCategoryCode>string</MenuItemSubCategoryCode>
        <MenuTypeCode>string</MenuTypeCode>
        <MenuItemCode>string</MenuItemCode>
        <MenuItemName>string</MenuItemName>
        <Description>string</Description>
        <ServingSizeCode>string</ServingSizeCode>
        <MaintainInventory>string</MaintainInventory>
        <IsCombo>string</IsCombo>
        <MaxDiscountType>string</MaxDiscountType>
        <MaxDiscountValue>decimal</MaxDiscountValue>
        <MenuItemImage>base64Binary</MenuItemImage>
        <CustomField1>string</CustomField1>
        <UpdateId>string</UpdateId>
        <UpdateDate>dateTime</UpdateDate>
        <ExpiryDate>dateTime</ExpiryDate>
        <MenuItemPricing>
          <MenuItemPricing>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <FoodStandId>short</FoodStandId>
            <PriceByFoodStand>string</PriceByFoodStand>
            <Price>decimal</Price>
            <Description>string</Description>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
          </MenuItemPricing>
          <MenuItemPricing>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <FoodStandId>short</FoodStandId>
            <PriceByFoodStand>string</PriceByFoodStand>
            <Price>decimal</Price>
            <Description>string</Description>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
          </MenuItemPricing>
        </MenuItemPricing>
        <MenuItemComboMeal>
          <MenuItemComboMeal>
            <menuItemCategoryCode>string</menuItemCategoryCode>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <MenuItemComboMealCode>string</MenuItemComboMealCode>
            <MenuItemType>string</MenuItemType>
            <ChoiceName>string</ChoiceName>
            <Quantity>decimal</Quantity>
            <AdditionalPrice>decimal</AdditionalPrice>
            <CustomField1>string</CustomField1>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <CustomField2>string</CustomField2>
            <CustomField3>string</CustomField3>
            <CustomField4>string</CustomField4>
            <SequenceNo>int</SequenceNo>
            <MenuItemCategoryCode>string</MenuItemCategoryCode>
            <MenuItemName>string</MenuItemName>
            <MenuItemDescription>string</MenuItemDescription>
            <PrintInKitchen>string</PrintInKitchen>
          </MenuItemComboMeal>
          <MenuItemComboMeal>
            <menuItemCategoryCode>string</menuItemCategoryCode>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <MenuItemComboMealCode>string</MenuItemComboMealCode>
            <MenuItemType>string</MenuItemType>
            <ChoiceName>string</ChoiceName>
            <Quantity>decimal</Quantity>
            <AdditionalPrice>decimal</AdditionalPrice>
            <CustomField1>string</CustomField1>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <CustomField2>string</CustomField2>
            <CustomField3>string</CustomField3>
            <CustomField4>string</CustomField4>
            <SequenceNo>int</SequenceNo>
            <MenuItemCategoryCode>string</MenuItemCategoryCode>
            <MenuItemName>string</MenuItemName>
            <MenuItemDescription>string</MenuItemDescription>
            <PrintInKitchen>string</PrintInKitchen>
          </MenuItemComboMeal>
        </MenuItemComboMeal>
        <MenuItemCondiment>
          <MenuItemCondiment>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <MenuItemCondimentsCode>string</MenuItemCondimentsCode>
            <Quantity>decimal</Quantity>
            <Price>decimal</Price>
            <Description>string</Description>
            <CustomField1>string</CustomField1>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <MenuItemName>string</MenuItemName>
            <MenuItemDescription>string</MenuItemDescription>
            <PrintInKitchen>string</PrintInKitchen>
          </MenuItemCondiment>
          <MenuItemCondiment>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <MenuItemCondimentsCode>string</MenuItemCondimentsCode>
            <Quantity>decimal</Quantity>
            <Price>decimal</Price>
            <Description>string</Description>
            <CustomField1>string</CustomField1>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <MenuItemName>string</MenuItemName>
            <MenuItemDescription>string</MenuItemDescription>
            <PrintInKitchen>string</PrintInKitchen>
          </MenuItemCondiment>
        </MenuItemCondiment>
        <MenuItemAvailability>
          <MenuItemAvailability>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <IsAvailable>string</IsAvailable>
            <AvailableTime>string</AvailableTime>
            <AvailableByPeriod>string</AvailableByPeriod>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Description>string</Description>
            <CustomField1>string</CustomField1>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
          </MenuItemAvailability>
          <MenuItemAvailability>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <IsAvailable>string</IsAvailable>
            <AvailableTime>string</AvailableTime>
            <AvailableByPeriod>string</AvailableByPeriod>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <Description>string</Description>
            <CustomField1>string</CustomField1>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
          </MenuItemAvailability>
        </MenuItemAvailability>
        <MenuItemTaxing>
          <MenuItemTaxing>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <ServingFee>decimal</ServingFee>
            <ServingTypeCode>string</ServingTypeCode>
            <Description>string</Description>
            <TaxGroupCode>string</TaxGroupCode>
            <Taxable>string</Taxable>
            <TaxIncluded>string</TaxIncluded>
            <TaxExempted>string</TaxExempted>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
          </MenuItemTaxing>
          <MenuItemTaxing>
            <OrganizationUnitId>short</OrganizationUnitId>
            <MenuItemCode>string</MenuItemCode>
            <ServingFee>decimal</ServingFee>
            <ServingTypeCode>string</ServingTypeCode>
            <Description>string</Description>
            <TaxGroupCode>string</TaxGroupCode>
            <Taxable>string</Taxable>
            <TaxIncluded>string</TaxIncluded>
            <TaxExempted>string</TaxExempted>
            <UpdateId>string</UpdateId>
            <UpdateDate>dateTime</UpdateDate>
            <ExpiryDate>dateTime</ExpiryDate>
          </MenuItemTaxing>
        </MenuItemTaxing>
        <IsAvailable>string</IsAvailable>
        <Price>decimal</Price>
        <TaxGroupCode>string</TaxGroupCode>
        <Taxable>string</Taxable>
        <TaxIncluded>string</TaxIncluded>
        <TaxExempted>string</TaxExempted>
        <RuleYN>string</RuleYN>
        <RuleApplied>string</RuleApplied>
        <ServingTypeCode>string</ServingTypeCode>
        <SKUCode>string</SKUCode>
        <PriceLabelCode>string</PriceLabelCode>
        <SequenceNumber>int</SequenceNumber>
        <Color>string</Color>
        <ItemColor>string</ItemColor>
        <PrintInKitchen>string</PrintInKitchen>
        <IsAccountBasedOnLocation>string</IsAccountBasedOnLocation>
        <CustomField4>string</CustomField4>
        <CustomField5>string</CustomField5>
        <CustomField6>string</CustomField6>
        <CustomField2>string</CustomField2>
        <CustomField3>string</CustomField3>
        <MenuItemAccountGroup>
          <MenuItemAccountGroup>
            <ItemNumber>string</ItemNumber>
            <AccountGroupCode>string</AccountGroupCode>
            <EventTypeCode>string</EventTypeCode>
            <ModuleCode>string</ModuleCode>
            <CustomField1>string</CustomField1>
            <CustomField2>string</CustomField2>
            <OrganizationUnitId>short</OrganizationUnitId>
            <ExpiryDate>dateTime</ExpiryDate>
            <UpdateDate>dateTime</UpdateDate>
            <UpdateId>string</UpdateId>
            <AccountGroupDescription>string</AccountGroupDescription>
            <EventTypeDescription>string</EventTypeDescription>
            <CustomField3>string</CustomField3>
            <CustomField4>string</CustomField4>
            <CustomField5>string</CustomField5>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
          </MenuItemAccountGroup>
          <MenuItemAccountGroup>
            <ItemNumber>string</ItemNumber>
            <AccountGroupCode>string</AccountGroupCode>
            <EventTypeCode>string</EventTypeCode>
            <ModuleCode>string</ModuleCode>
            <CustomField1>string</CustomField1>
            <CustomField2>string</CustomField2>
            <OrganizationUnitId>short</OrganizationUnitId>
            <ExpiryDate>dateTime</ExpiryDate>
            <UpdateDate>dateTime</UpdateDate>
            <UpdateId>string</UpdateId>
            <AccountGroupDescription>string</AccountGroupDescription>
            <EventTypeDescription>string</EventTypeDescription>
            <CustomField3>string</CustomField3>
            <CustomField4>string</CustomField4>
            <CustomField5>string</CustomField5>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
          </MenuItemAccountGroup>
        </MenuItemAccountGroup>
        <ShowInPackageTicket>string</ShowInPackageTicket>
      </AddNewMenuItemRequest>
    </AddNewMenuItem>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddNewMenuItemResponse xmlns="http://KMWare.ZMA.Food.MenuItemMgmt.ServiceContracts">
      <AddNewMenuItemResult>string</AddNewMenuItemResult>
      <newMenuItemCode>string</newMenuItemCode>
    </AddNewMenuItemResponse>
  </soap:Body>
</soap:Envelope>