GetItems

​

Retrieve the menu Items for this location.

Note: We recommend using Settings2.svc GetItems for more detailed item information.

Request Parameters
  • accessToken string — Your access token (passed in SOAP body, not headers).
  • locationToken string — Your location token (passed in SOAP body, not headers).
Response Parameters

  • Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.

  • ResultCode int — Returns one of the following:

    • 0 — Success
    • 1 — Unknown Error
    • 3 — Server Unavailable
    • 4 — Access Denied

  • Items Array of Item — Array of Item objects for this location.

    Item Properties

    • Active bool — True if this Item is active, False if inactive

    • AskName bool — True if this Item's name will be prompted for, False if not

    • AskPrice bool — True if this Item's price will be prompted for, False if not

    • AvailableFriday bool — True if this Item is available on Fridays, False if not

    • AvailableMonday bool — True if this Item is available on Mondays, False if not

    • AvailableSaturday bool — True if this Item is available on Saturdays, False if not

    • AvailableSelectDates bool — True if this Item is available only on select dates, False if not

    • AvailableSelectDays bool — True if this Item is available only on select days, False if not

    • AvailableSunday bool — True if this Item is available on Sundays, False if not

    • AvailableThursday bool — True if this Item is available on Thursdays, False if not

    • AvailableTuesday bool — True if this Item is available on Tuesdays, False if not

    • AvailableWednesday bool — True if this Item is available on Wednesdays, False if not

    • BrandAllocations Array of BrandAllocation — Brand allocations for this Item

      BrandAllocation Properties
      • BrandId int — Maps to the Id of the Brand for this allocation
      • Id int — Unique Id of this BrandAllocation
      • Weight decimal — Weight of this BrandAllocation

    • Components Array of ItemCompositeComponent — Composite components for this Item (used for combo/composite items)

      ItemCompositeComponent Properties

      • Id int — Unique Id of this ItemCompositeComponent

      • ItemGroupId int? — Maps to the Id of the ItemGroup for this component, if applicable

      • Items Array of ItemCompositeComponentItem — Items available for this component

        ItemCompositeComponentItem Properties
        • Id int — Unique Id of this ItemCompositeComponentItem
        • IsDefault bool — True if this is the default item for this component, False if not
        • ItemId int — Maps to the Id of the Item for this component
        • OverridePrice bool — True if this component overrides the item price, False if not
        • Price decimal? — Override price for this component, if applicable

      • Name string — Name of this ItemCompositeComponent

      • OverridePrice bool — True if this component overrides the price, False if not

      • Price decimal? — Override price for this component, if applicable

      • RollupPrice bool — True if the component price rolls up to the parent item, False if not

    • Cost decimal — Cost of this Item

    • CreatedTime DateTime — Date and time this Item was created

    • DatesAvailable DateRange — Date range during which this Item is available (applies when AvailableSelectDates is True)

    • DestinationAvailabilities Array of ItemDestinationAvailability — Destination-specific availability settings for this Item

      ItemDestinationAvailability Properties
      • DestinationId int — Maps to the Id of the Destination
      • Id int — Unique Id of this ItemDestinationAvailability
      • IsAvailable bool — True if this Item is available at this Destination, False if not

    • GiftCardItemType byte — Returns one of the following: 0=None, 1=CashOut, 2=Issue, 3=Reload

    • Id int — Unique Id of this Item

    • IncludedModifiers Array of ItemIncludedModifier — Modifiers that are included with this Item by default

      ItemIncludedModifier Properties
      • AutomaticallyAdd bool — True if this modifier is automatically added, False if not
      • IsIncluded bool — True if this modifier is included with the item, False if not
      • ItemId int — Maps to the Id of the modifier Item
      • ModifierGroupId int — Maps to the Id of the ModifierGroup this modifier belongs to
      • Position short — Position of this modifier within its ModifierGroup
      • PrintInKitchen bool — True if this modifier prints in the kitchen, False if not

    • IngredientItemIds Array of int — Ids of Items used as ingredients for this Item

    • IsCombo bool — True if this Item is a combo, False if not

    • IsDeleted bool — True if this Item has been deleted, False if not

    • IsGiftCard bool — True if this Item is a gift card, False if not

    • IsQuantityCounted bool — True if the quantity of this Item is tracked, False if not

    • ItemType byte — Returns one of the following: 0=Normal, 1=Chicken, 2=Gift Card, 3=Loyalty item, 4=Pizza, 5=Composite, 6=Prepaid, 7=CompCard

    • KitchenName string — Kitchen display name for this Item

    • LastEditedTime DateTime — Date and time this Item was last edited

    • ModifierCodesPricing Array of ItemModifierCodePricing — Modifier code pricing tiers for this Item

      ItemModifierCodePricing Properties
      • Id int — Unique Id of this ItemModifierCodePricing
      • ModifierCodeId int — Maps to the Id of the ModifierCode
      • Price decimal — Price for this modifier code pricing tier

    • ModifierGroupIds Array of int — Ids of the ModifierGroups associated with this Item

    • ModifierTierId int — Maps to the Id of the ModifierTier for this Item

    • ModifierWeight byte — Modifier weight for this Item

    • Name string — Name of this Item

    • NonRevenueItem bool — True if this Item does not generate revenue, False if not

    • PLU string — PLU (Price Look Up) code for this Item

    • Price decimal — Price of this Item

    • PriceLevel byte — Price level of this Item

    • PricePer byte — Unit pricing method for this Item

    • PrinterGroupId int — Maps to the Id of the PrinterGroup for this Item

    • RevenueCenterId int — Maps to the Id of the RevenueCenter for this Item

    • SimpleComboPricing bool — True if pricing needs to be set for the entire combo as well, False if not. Note that any price set for the entire combo will add on to the pricing set for combo component items. This flag is used with a True value usually when brand sets the combo component price to 0 and wants to maintain price for the entire combo only.

    • SortPriority byte — Sort priority for display ordering of this Item

    • TareId int — Maps to the Id of the Tare weight for this Item

    • TaxIds Array of int — Ids of the Taxes associated with this Item

    • UnitName string — Unit of measure name for this Item (e.g. "Each", "oz")

    • UnitPrecision byte — Decimal precision for unit quantities of this Item

    • VideoGroupId int — Maps to the Id of the VideoGroup for this Item

Headers
  • SOAPAction
    Type: string
    required
Body
required
application/json

SOAP envelope containing the GetItems request with accessToken and locationToken in body.

Responses
  • text/xml; charset=utf-8
Request Example for post/GetItems
cURL
curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetItems' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetItems"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetItems>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetItems>
    </soapenv:Body>
  </soapenv:Envelope>'

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetItemsResponse xmlns="http://tempuri.org/">
      <Settings_GetItemsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Items>
          <Item>
            <Active>true</Active>
            <AskName>false</AskName>
            <AskPrice>false</AskPrice>
            <AvailableFriday>true</AvailableFriday>
            <AvailableMonday>true</AvailableMonday>
            <AvailableSaturday>true</AvailableSaturday>
            <AvailableSelectDates>false</AvailableSelectDates>
            <AvailableSelectDays>false</AvailableSelectDays>
            <AvailableSunday>true</AvailableSunday>
            <AvailableThursday>true</AvailableThursday>
            <AvailableTuesday>true</AvailableTuesday>
            <AvailableWednesday>true</AvailableWednesday>
            <BrandAllocations>
              <BrandAllocation>
                <BrandId>1</BrandId>
                <Id>1</Id>
                <Weight>1.00</Weight>
              </BrandAllocation>
            </BrandAllocations>
            <Components>
              <ItemCompositeComponent>
                <Id>1</Id>
                <ItemGroupId>5</ItemGroupId>
                <Items>
                  <ItemCompositeComponentItem>
                    <Id>1</Id>
                    <IsDefault>true</IsDefault>
                    <ItemId>102</ItemId>
                    <OverridePrice>false</OverridePrice>
                    <Price i:nil="true"/>
                  </ItemCompositeComponentItem>
                </Items>
                <Name>Side Choice</Name>
                <OverridePrice>false</OverridePrice>
                <Price i:nil="true"/>
                <RollupPrice>true</RollupPrice>
              </ItemCompositeComponent>
            </Components>
            <Cost>3.50</Cost>
            <CreatedTime>2023-01-15T10:30:00</CreatedTime>
            <DatesAvailable>
              <_end>2025-12-31T23:59:59</_end>
              <_start>2023-01-01T00:00:00</_start>
            </DatesAvailable>
            <DestinationAvailabilities>
              <ItemDestinationAvailability>
                <DestinationId>1</DestinationId>
                <Id>1</Id>
                <IsAvailable>true</IsAvailable>
              </ItemDestinationAvailability>
            </DestinationAvailabilities>
            <GiftCardItemType>0</GiftCardItemType>
            <Id>101</Id>
            <IncludedModifiers>
              <ItemIncludedModifier>
                <AutomaticallyAdd>true</AutomaticallyAdd>
                <IsIncluded>true</IsIncluded>
                <ItemId>201</ItemId>
                <ModifierGroupId>1</ModifierGroupId>
                <Position>1</Position>
                <PrintInKitchen>true</PrintInKitchen>
              </ItemIncludedModifier>
            </IncludedModifiers>
            <IngredientItemIds>
              <int>301</int>
              <int>302</int>
            </IngredientItemIds>
            <IsCombo>false</IsCombo>
            <IsGiftCard>false</IsGiftCard>
            <IsQuantityCounted>true</IsQuantityCounted>
            <ItemType>0</ItemType>
            <KitchenName>Burger</KitchenName>
            <LastEditedTime>2023-06-01T14:00:00</LastEditedTime>
            <ModifierCodesPricing>
              <ItemModifierCodePricing>
                <Id>1</Id>
                <ModifierCodeId>1</ModifierCodeId>
                <Price>0.50</Price>
              </ItemModifierCodePricing>
            </ModifierCodesPricing>
            <ModifierGroupIds>
              <int>1</int>
              <int>2</int>
            </ModifierGroupIds>
            <ModifierTierId>0</ModifierTierId>
            <ModifierWeight>1</ModifierWeight>
            <Name>Classic Burger</Name>
            <NonRevenueItem>false</NonRevenueItem>
            <PLU>1001</PLU>
            <Price>9.99</Price>
            <PriceLevel>0</PriceLevel>
            <PricePer>0</PricePer>
            <PrinterGroupId>1</PrinterGroupId>
            <RevenueCenterId>1</RevenueCenterId>
            <SortPriority>1</SortPriority>
            <TareId>0</TareId>
            <TaxIds>
              <int>1</int>
            </TaxIds>
            <UnitName>Each</UnitName>
            <UnitPrecision>0</UnitPrecision>
            <VideoGroupId>1</VideoGroupId>
          </Item>
        </Items>
      </Settings_GetItemsResult>
    </Settings_GetItemsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Item objects.

Copyright © 2026 PAR Technology Corporation. All rights reserved.
PAR Technology Corporation 8383 Seneca Turnpike, Suite 3 New Hartford, New York 13413 (315) 738-0600 legal@partech.com. PAR Tech is a leading global provider of software, systems, and service solutions to the restaurant and retail industries. You may learn about its product offerings here.
Before using this application, please read the Limited License Agreement and the PAR Tech Terms of Use. In addition, the sample applications of PAR Technology are licensed under the terms of the O'Saasy License.