Item
- allowType: null | boolean
Auto Combo True if this item automatically create a combo, False if not
- alternateType: null | string
Id AlternateId for this item provided for customer integration
- alternateType: null | string
Kitchen Name Alternate name to be displayed on kitchen chits and kitchen displays
- askType: boolean
Name True if this Item's name will be prompted for, False if not
- askType: boolean
Price True if this Item's price will be prompted for, False if not
- availableType: null | stringFormat: date-time
End Date End date of this Item
- availableType: boolean
Select Dates True if this Item is available on select dates, False if not
- availableType: boolean
Select Days True if this Item is available on select days of the week, False if not
- availableType: null | stringFormat: date-time
Start Date Start date of this Item
- blinkType: boolean
In Kitchen True if this Item's name flashes on kitchen display, False if not
- brandType:
Allocations Properties: 3BrandAllocations for this Item
- clearsType: boolean
All Other Modifiers True if adding this modifier clears all other modifiers except required or deferred modifiers, False if not
- componentsType:Properties: 8
Item composite components for this Item
- costType: number | stringFormat: double
Cost of this Item
- customType:
Fields Properties: 3Dictionary of User Defined key value pair
- daysType: null | integer | stringFormat: uint8
Available Returns a byte describing the days this Item is available
- descriptionType: null | string
Description of this Item
- destinationType:
Availabilities Properties: 3Availability of the item against each destination
- discountType: null | integer | stringFormat: int32
Id Discount having an External ID and is a Loyalty Discount
- freeType: null | integer | stringFormat: int16
Modifier Substitution Limit Limits the number of modifiers that can be substituted without charge
- giftType: nullable
Card Item Type Returns one of the following: None CashOut Issue Reload
Possible values:
None= 0CashOut= 1Issue= 2Reload= 3
- idType: integer | stringFormat: int32
Signed 32-bit integers (commonly used integer type).
- includedType:
Modifiers Properties: 7Modifiers that are implied as being included in/on the item by default
- ingredientsType:Properties: 3
Items that are considered ingredients when calculating modifier prices
- isType: boolean
Active True if this Item is active, False if inactive
- isType: boolean
Exception Mod NO LONGER USED
- isType: boolean
Quantity Counted True if this Item quantity is counted, False if not
- itemType: null | array of integer | stringFormat: int32
Groups Item groups that the item belongs to
- kitchenType:
Background Color Properties: 4Color of the item background when displayed on the kitchen display
- kitchenType:
Color Properties: 4Color of the item background when displayed on the kitchen display
- modifierType:
Codes Pricing Properties: 3Price of the item(modifier) against each valid modifier code. Valid modifier codes are the ones that have charge type as "Modifier Code Pricing".
- modifierType:
Groups Properties: 3Modifier groups that are to be available when the item is ordered or modified
- modifierType:
Routing Returns one of the following: Follow parent item Route Separately Parent item also follows modifier Parent item only follows modifier
Possible values:
FollowParentItem= 0RouteSeparately= 1ParentItemAlsoFollowsModifier= 2ParentItemOnlyFollowsModifier= 3
- modifierType: null | integer | stringFormat: int32
Tier Id Modifier Tier Id for this Item, or 0 if null
- modifierType: integer | stringFormat: uint8
Weight Count towards the modifier group's min/max/free settings, when ordered as a modifier
- modifyType:
Panels Properties: 3Panels that are to be displayed in place of the 'Modify' system screen
- nameType: null | string
- nonType: boolean
Revenue Item True if this Item is a non-revenue Item, False if not
- pluType: null | string
Price look-up code of this Item
- prepaidType: nullable
Item Type Returns one of the following: Code Code on Receipt PIN on receipt
Possible values:
Code= 0CodeOnReceipt= 1PinOnReceipt= 2
- priceType: number | stringFormat: double
Price of this Item
- priceType: null | integer | stringFormat: int32
Level Id Price level that is to override the item price
- priceType:
Per Returns one of the following: Ounce Pound
Possible values:
Ounce= 0Pound= 1
- printerType: null | integer | stringFormat: int32
Group Id Printer group Id for this Item, or 0 if null
- restrictType: null | boolean
Combo Break True if this Item blocks the cashier from breaking a combo into individual items sold at discount, False if not
- revenueType: integer | stringFormat: int32
Center Id Maps to the Id of the RevenueCenter of this Item
- selectionType:
Panels Properties: 3Panels that are to be displayed when the item is ordered or selected
- simpleType: boolean
Combo Pricing 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.
- skusType: null | array of string
Product barcode identifiers used to order item via barcode scanner or 'Lookup Item' screen
- sortType: integer | stringFormat: uint8
Priority Sort priority of this Item
- tareType: null | integer | stringFormat: int32
Id Tare Id of this Item
- taxesType: null | array of integer | stringFormat: int32
Taxes that are to be applied to the item, in addition to those inherited via the revenue center
- typeType:
Returns one of the following: Normal Chicken Gift Card Loyalty item Pizza Composite Prepaid CompCard
Possible values:
Normal= 0Pizza= 1Chicken= 2GiftCard= 3Composite= 4LoyaltyItem= 5Prepaid= 6CompCard= 7
- unitType: null | string
Name Unit name for this Item
- unitType: integer | stringFormat: uint8
Precision Unit precision for this Item
- videoType: null | integer | stringFormat: int32
Group Id Video group Id for this Item, or 0 if null
