| Name | Description | Type | Additional information |
|---|---|---|---|
| SalesItemId |
The sales item id |
integer |
None. |
| POSItemId |
The POS id for this sales item |
integer |
None. |
| ExternalReferenceId |
Id that is uniquely defined for each Sales Item by the company |
integer |
None. |
| Name |
The internal name of the sales item |
string |
None. |
| DisplayName |
The name that is to be displayed to the customer |
string |
None. |
| Description |
A short description of the Sales Item |
string |
None. |
| CategoryName |
The Category Name used in the API to denote categorically similar items. |
string |
None. |
| GroupDetailName |
The Sales Group detail name |
string |
None. |
| ShortDescription |
Details on the optional pricing grid during order entry |
string |
None. |
| Price |
The price for this sales item |
decimal number |
None. |
| PriceChanges |
PriceChanges is null when there is no Changes info during the current business day otherwise it will display Prices for this sales item as they change during the current (as indicated by promise datetime) business day. |
PriceInterval |
None. |
| ItemOptionSetId |
/deprecated The item option set id |
integer |
None. |
| BaseImageName |
A url that is to be displayed for the this sales item |
string |
None. |
| ModifierGroups |
List of valid ModifierGroup for this SalesItem |
Collection of integer |
None. |
| DefaultOptions |
The list of DefaultOption for this sales item |
Collection of DefaultOption |
None. |
| IsVisible |
Should the customer be able to view this salesitem |
boolean |
None. |
| CanBeOrderedAsIs |
Can this item be ordered without additional selection of modifiers |
boolean |
None. |
| IncludedModifierCount |
The number of modifiers that come with the sales item |
integer |
None. |
| DiscountPrice |
The discount price. This is the price of the item after the discount was applied. Only applicable when there is Goal-Price comp applied |
decimal number |
None. |
| FreeModifierCount |
Number of the free modifiers that is configurated for the discount that was applied. Only applicable when there is Goal-Price comp applied |
integer |
None. |
| DiscountName |
Name of the goal price comp Only applicable when there is Goal-Price comp applied |
string |
None. |
| CaloricValue |
Caloric value of the Sales Item |
integer |
None. |
| IsAvailable |
Is the Sales Item available for sale at this moment, default is true |
boolean |
None. |
| CustomFields |
CustomFields |
Collection of CustomField |
None. |