| Name | Description | Type | Additional information |
|---|---|---|---|
| SplitBy |
What parameter this checkout setting has been split by |
CheckoutSettingSplitByLevel |
None. |
| Children |
List of all checkout settings split by one level lower than the current level; null if this is the lowest level in which case this setting applies to all children You can limit the depth returned by providing during retrieval |
Collection of POSSettingSplitBy |
Relation. This field may not always be loaded or used for updates. |
| StoreID | integer |
None. |
|
| MachineID | integer |
None. |
|
| MachineName |
ScaleDescription.ScaleID or ScaleDescription.ScaleName |
string |
String length: inclusive between 0 and 60 |
| Section |
Section under which this setting is saved |
string |
String length: inclusive between 0 and 60 |
| KeyName |
KeyName under which this setting is saved. Combo of Section + KeyName is unique per setting |
string |
String length: inclusive between 0 and 60 |
| Value | string |
None. |
|
| Updated |
Date-time that this setting was last updated |
date |
None. |
| UpdatedBy |
User or operator that updated this setting |
string |
String length: inclusive between 0 and 60 |
| TerminalG_UID |
Guid of the terminal that this setting applies to |
Collection of byte |
None. |
| TerminalGuid |
Guid of the terminal that this setting applies to |
globally unique identifier |
None. |
| ZoneID |
Zone ID that this setting applies to |
integer |
None. |
| SoftwareUpdatedBy |
The software that last updated this settings value |
CheckoutSettingSoftwareUpdatedBy |
None. |
| StoreName |
Name of the store this setting/value belongs. Only populated if relations is true |
string |
Relation. This field may not always be loaded or used for updates. |
| Machine | Machine |
Relation. This field may not always be loaded or used for updates. |
|
| TerminalName |
Details about the terminal. Only populated if relations is true |
string |
Relation. This field may not always be loaded or used for updates. |
| Terminal |
Details about the terminal. Only populated if relations is true |
Terminal |
Relation. This field may not always be loaded or used for updates. |
| MachineGroupName |
Details about the machine group. Only populated if relations is true |
string |
Relation. This field may not always be loaded or used for updates. |
| Header |
Provides extra details about this setting such as scope, possible values, description and subsection. There is only one header per section and keyname. |
POSSettingHeader |
Relation. This field may not always be loaded or used for updates. |
| PossibleValues | string |
Relation. This field may not always be loaded or used for updates. |
|
| Type | CheckoutSettingType |
Relation. This field may not always be loaded or used for updates. |
|
| DefaultValue | string |
Relation. This field may not always be loaded or used for updates. |
|
| Description | string |
Relation. This field may not always be loaded or used for updates. |
|
| SubSection | string |
Relation. This field may not always be loaded or used for updates. |
|
| Scope | CheckoutSettingScope |
Relation. This field may not always be loaded or used for updates. |
|
| IngressId |
ID of the Ingress entry (Redis Stream message ID) |
string |
None. |