GetItems

This call is to retrieve an array of Item objects for the location.

Request Parameters

ItemIds Array of int — Depending on the ItemId(-s) passed in request the response will return the details of that(those) item(-s)

Response Parameters

AllowAutoCombo bool? — True if this item automatically create a combo, False if not
AlternateId string — AlternateId for this item provided for customer integration
AlternateKitchenName string — Alternate name to be displayed on kitchen chits and kitchen displays
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
AvailableEndDate DateTime? — End date of this Item
AvailableSelectDates bool — True if this Item is available on select dates, False if not
AvailableSelectDays bool — True if this Item is available on select days of the week, False if not
AvailableStartDate DateTime? — Start date of this Item
BlinkInKitchen bool — True if this Item's name flashes on kitchen display, False if not
BrandAllocations Array of ItemBrandAllocation — BrandAllocations for this Item
ItemBrandAllocation 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 Brand allocation (used to distribute revenue across brands)
ClearsAllOtherModifiers bool — True if adding this modifier clears all other modifiers except required or deferred modifiers, False if not
Components Array of ItemCompositeComponent — Item composite components for this Item
ItemCompositeComponent Properties
- Id int — Unique Id of this ItemCompositeComponent within the Item
- ItemGroupId int? — Maps to the Id of the ItemGroup that defines valid items for this component
- Items Array of ItemCompositeComponentItem — Items that can be selected for this component
  ItemCompositeComponentItem Properties
  - Id int — Unique Id of this ItemCompositeComponentItem within the component
  - IsDefault bool — True if this is the default Item for the component, False if not
  - ItemId int — Maps to the Id of the Item that may be selected for this component
  - OverridePrice bool — True if the Price field overrides the Item's price, False if not
  - Price decimal? — Override price for this Item within the component (used when OverridePrice is True)
- Name string — Name of this ItemCompositeComponent
- OverridePrice bool — True if the Price field overrides the component default price, False if not
- Panels Array of ItemCompositeComponentPanel — Panels to display when selecting items for this component
  ItemCompositeComponentPanel Properties
  - Id int — Unique Id of this ItemCompositeComponentPanel within the component
  - PanelId int — Maps to the Id of the Panel displayed when selecting items for this component
  - ScreenId int? — Maps to the Id of the Screen this panel is displayed on
- Price decimal? — Override price for this component (used when OverridePrice is True)
- RollupPrice bool — True if pricing rolls up to the parent composite item, False if not
Cost decimal — Cost of this Item
CustomFields Array of CustomFields — Dictionary of User Defined key value pair.(Save of this field from API is in future scope)
CustomField Properties
- Id int — Unique Id of this CustomField
- FieldName string — Name of this CustomField
- Value string — Value of this CustomField
DaysAvailable byte? — Returns a byte describing the days this Item is available:
- 0 = None
- 1 = Sunday
- 2 = Monday
- 4 = Tuesday
- 8 = Wednesday
- 16 = Thursday
- 32 = Friday
- 64 = Saturday
If multiple days are selected, binary addition is used in determining this value.
Description string — Description of this Item
DestinationAvailabilities Array of ItemDestinationAvailability — Availability of the item against each destination
ItemDestinationAvailability Properties
- Id int — Unique Id of this ItemDestinationAvailability within the Item
- DestinationId int — Maps to the Id of the Destination this availability applies to
- IsAvailable bool — True if the Item is available at this Destination, False if not
DiscountId int? — Discount having an External ID and is a Loyalty Discount
FreeModifierSubstitutionLimit short? — Limits the number of modifiers that can be substituted without charge
GiftCardItemType GiftCardItemType? — Returns one of the following:
- None
- CashOut
- Issue
- Reload
Id int — Unique Id of this Item
Ingredients Array of ItemIngredient — Items that are considered ingredients when calculating modifier prices
ItemIngredient Properties
- Id int — Unique Id of this ItemIngredient
- ItemId int — Maps to the Id of the Item that is an ingredient
- Position short — Position of this ingredient within the Item
IsActive bool — True if this Item is active, False if inactive
IsExceptionMod bool — NO LONGER USED
IsQuantityCounted bool — True if this Item quantity is counted, False if not
KitchenBackgroundColor Color — Color of the item background when displayed on the kitchen display
KitchenColor Color — Color of the item text when displayed on kitchen display
IncludedModifiers Array of ItemIncludedModifier — Modifiers that are implied as being included in/on the item by default
ItemIncludedModifier Properties
- AutomaticallyAdd bool — True if this modifier is automatically added when the Item is ordered, False if not
- Id int — Unique Id of this ItemIncludedModifier
- IsIncluded bool — True if this modifier is included with the Item by default, False if not
- ItemId int — Maps to the Id of the Item that is the included modifier
- ModifierGroupId int — Maps to the Id of the ModifierGroup this included modifier belongs to
- Position short — Position of this included modifier within the ModifierGroup
- PrintInKitchen bool — True if this included modifier prints in kitchen, False if not
ItemGroups IdList — Item groups that the item belongs to
ModifierCodesPricing Array of ItemModifierCodePricing — Price of the item(modifier) against each valid modifier code. Valid modifier codes are the ones that have charge type as "Modifier Code Pricing".
ItemModifierCodePricing Properties
- Id int — Unique Id of this ItemModifierCodePricing within the Item
- ModifierCodeId int — Maps to the Id of the ModifierCode this pricing applies to
- Price decimal — Price for this Item when the specified ModifierCode is applied
ModifierGroups Array of ItemModifierGroup — Modifier groups that are to be available when the item is ordered or modified
ItemModifierGroup Properties
- Id int — Unique Id of this ItemModifierGroup
- ModifierGroupId int — Maps to the Id of the ModifierGroup available for this Item
- Position short — Position of this ModifierGroup within the Item
ModifierRouting ModifierRoutingOptions — Returns one of the following:
- Follow parent item
- Route Separately
- Parent item also follows modifier
- Parent item only follows modifier
ModifierTierId int? — Modifier Tier Id for this Item, or 0 if null
ModifierWeight byte — Count towards the modifier group's min/max/free settings, when ordered as a modifier
ModifyPanels Array of ItemModifyPanel — Panels that are to be displayed in place of the 'Modify' system screen
ItemModifyPanel Properties
- Id int — Unique Id of this ItemModifyPanel
- PanelId int — Maps to the Id of the Panel displayed in place of the Modify system screen
- ScreenId int? — Maps to the Id of the Screen this modify panel is displayed on
Name string — Name of this Item
NonRevenueItem bool — True if this Item is a non-revenue Item, False if not
Plu string — Price look-up code of this Item
PrepaidItemType PrepaidItemType? — Returns one of the following:
- Code
- Code on Receipt
- PIN on receipt
Price decimal — Price of this Item
PriceLevelId int? — Price level that is to override the item price
PricePer PricePer — Returns one of the following:
- Ounce
- Pound
PrinterGroupId int? — Printer group Id for this Item, or 0 if null
RevenueCenterId int — Maps to the Id of the RevenueCenter of this Item
RestrictComboBreak bool? — True if this Item blocks the cashier from breaking a combo into individual items sold at discount, False if not
SelectionPanels Array of ItemSelectionPanel — Panels that are to be displayed when the item is ordered or selected
ItemSelectionPanel Properties
- Id int — Unique Id of this ItemSelectionPanel
- PanelId int — Maps to the Id of the Panel displayed when the Item is ordered or selected
- ScreenId int? — Maps to the Id of the Screen this selection panel is displayed on
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.
Skus List<string> — Product barcode identifiers used to order item via barcode scanner or 'Lookup Item' screen
SortPriority byte — Sort priority of this Item
TareId int? — Tare Id of this Item
Taxes IdList — Taxes that are to be applied to the item, in addition to those inherited via the revenue center
Type ItemType — Returns one of the following:
- Normal
- Chicken
- Gift Card
- Loyalty item
- Pizza
- Composite
- Prepaid
- CompCard
UnitName string — Unit name for this Item
UnitPrecision byte — Unit precision for this Item
VideoGroupId int? — Video group Id for this Item, or 0 if null

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope for GetItems request. No parameters required.

Responses

text/xml; charset=utf-8

post/GetItems

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetItems' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/settings/v2/ISettingsWebService2/GetItems"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetItems/>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings2_GetItemsResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <Settings2_GetItemsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Items>
          <Item>
            <AllowAutoCombo i:nil="true"/>
            <AlternateId>BURG</AlternateId>
            <AlternateKitchenName>Burger</AlternateKitchenName>
            <AskName>false</AskName>
            <AskPrice>false</AskPrice>
            <AvailableEndDate i:nil="true"/>
            <AvailableSelectDates>false</AvailableSelectDates>
            <AvailableSelectDays>false</AvailableSelectDays>
            <AvailableStartDate i:nil="true"/>
            <BlinkInKitchen>false</BlinkInKitchen>
            <BrandAllocations/>
            <ClearsAllOtherModifiers>false</ClearsAllOtherModifiers>
            <Components/>
            <Cost>2.50</Cost>
            <CustomFields/>
            <DaysAvailable i:nil="true"/>
            <Description>Classic Burger</Description>
            <DestinationAvailabilities>
              <ItemDestinationAvailability>
                <DestinationId>1</DestinationId>
                <Id>1</Id>
                <IsAvailable>true</IsAvailable>
              </ItemDestinationAvailability>
            </DestinationAvailabilities>
            <DiscountId i:nil="true"/>
            <FreeModifierSubstitutionLimit i:nil="true"/>
            <GiftCardItemType i:nil="true"/>
            <Id>1</Id>
            <IncludedModifiers/>
            <Ingredients/>
            <IsActive>true</IsActive>
            <IsExceptionMod>false</IsExceptionMod>
            <IsQuantityCounted>false</IsQuantityCounted>
            <ItemGroups/>
            <KitchenBackgroundColor>0</KitchenBackgroundColor>
            <KitchenColor>16777215</KitchenColor>
            <ModifierCodesPricing>
              <ItemModifierCodePricing>
                <Id>1</Id>
                <ModifierCodeId>1</ModifierCodeId>
                <Price>0.50</Price>
              </ItemModifierCodePricing>
            </ModifierCodesPricing>
            <ModifierGroups/>
            <ModifierRouting>0</ModifierRouting>
            <ModifierTierId i:nil="true"/>
            <ModifierWeight>0</ModifierWeight>
            <ModifyPanels/>
            <Name>Classic Burger</Name>
            <NonRevenueItem>false</NonRevenueItem>
            <Plu>001</Plu>
            <PrepaidItemType i:nil="true"/>
            <Price>9.99</Price>
            <PriceLevelId i:nil="true"/>
            <PricePer>0</PricePer>
            <PrinterGroupId i:nil="true"/>
            <RestrictComboBreak i:nil="true"/>
            <RevenueCenterId>1</RevenueCenterId>
            <SelectionPanels/>
            <SimpleComboPricing>false</SimpleComboPricing>
            <Skus/>
            <SortPriority>0</SortPriority>
            <TareId i:nil="true"/>
            <Taxes/>
            <Type>0</Type>
            <UnitName/>
            <UnitPrecision>0</UnitPrecision>
            <VideoGroupId i:nil="true"/>
          </Item>
        </Items>
      </Settings2_GetItemsResult>
    </Settings2_GetItemsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Item objects.