GET api/possetting/{section}/{keyName}?relations={relations}&storeID={storeID}
Get a POS setting by section and keyname
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| section |
Section under which this setting belongs |
string |
Required |
| keyName |
unique key/name used to identify this setting |
string |
Required |
| relations |
Load any related fields such as header details, terminal, machineGroup and store name |
boolean |
Default value is False |
| storeID |
Only get values for this setting that belong to this store |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
POSSettingSplitBy| 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. |
Response Formats
application/json, text/json
{
"splitBy": 0,
"children": [
{
"$ref": "1"
},
{
"$ref": "1"
}
],
"storeID": 1,
"machineID": 1,
"machineName": "sample string 1",
"section": "sample string 2",
"keyName": "sample string 3",
"value": "sample string 4",
"updated": "2026-06-03T18:33:15.1943404",
"updatedBy": "sample string 5",
"terminalG_UID": "5HulLunigUKsBelVjtqflw==",
"terminalGuid": "2ea57be4-e2e9-4281-ac05-e9558eda9f97",
"zoneID": 1,
"softwareUpdatedBy": 0,
"storeName": "sample string 6",
"machine": {
"$id": "2",
"id": 1,
"storeScaleID": 2,
"scaleID": "sample string 3",
"scaleName": "sample string 4",
"description": "sample string 5",
"scaleLocation": 1,
"zoneID": 1,
"storeID": 1,
"scaleType": 1,
"checkFrequency": 1,
"testWeight": 1.1,
"terminalG_UID": "UhgzrWA1j0SS+5b6g4cW7Q==",
"terminalGuid": "ad331852-3560-448f-92fb-96fa838716ed",
"storeName": "sample string 6",
"zoneName": "sample string 7",
"scaleLocationName": "sample string 8",
"settingsZone": {
"$id": "3",
"id": 1,
"storeID": 2,
"name": "sample string 3",
"machines": [
{
"$ref": "2"
},
{
"$ref": "2"
}
]
},
"terminal": {
"$id": "4",
"id": 1,
"g_UID": "BXVsSl/4YUGp/stfcejdWA==",
"guid": "4a6c7505-f85f-4161-a9fe-cb5f71e8dd58",
"name": "sample string 3",
"description": "sample string 4",
"terminalNumber": 1,
"posKey": "PDORXPBHz0KMqvlnZwL4Cw==",
"linkedPOSKey": "5c91333c-47f0-42cf-8caa-f9676702f80b",
"location": 1,
"zoneID": 1,
"currentMachineID": 1,
"storeID": 1,
"deleted": true,
"updated": "2026-06-03T18:33:15.1943404",
"currentMachine": {
"$ref": "2"
},
"currentLane": {
"$id": "5",
"identifier": "MezeS0WkOEuyp34ffIv0sg==",
"identifierGuid": "4bdeec31-a445-4b38-b2a7-7e1f7c8bf4b2",
"name": "sample string 1",
"storeID": 2,
"machineID": 3,
"scaleID": "sample string 4",
"lastPingLocal": "2026-06-03T18:33:15.1943404",
"lastSaleLocal": "2026-06-03T18:33:15.1943404",
"status": 0,
"statusDate": "2026-06-03T18:33:15.1943404",
"statusName": "None",
"storeName": "sample string 5",
"machineName": "sample string 6",
"zoneName": "sample string 7"
}
}
},
"terminalName": "sample string 7",
"terminal": {
"$ref": "4"
},
"machineGroupName": "sample string 8",
"header": {
"$id": "6",
"type": 0,
"possibleValues": "sample string 1",
"defaultValue": "sample string 2",
"description": "sample string 3",
"section": "sample string 4",
"subSection": "sample string 5",
"keyName": "sample string 6",
"scope": 0
},
"possibleValues": "sample string 9",
"type": 0,
"defaultValue": "sample string 10",
"description": "sample string 11",
"subSection": "sample string 12",
"scope": 0,
"ingressId": "sample string 13"
}
application/xml
Sample not available.
text/xml
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK '��\����� 5 xl/workbook.xml � (� ����0��&�C��R)��x���"
�'m
>��o�vfg�6k;>��GNʕ���$ĵH�Nڀ
�^[�}��Etߋݾ%(O����B+7��J�����iEI.������!`vQc�����!�b�_D��P�{�Qtn]��l)�p/��%iBSJ/E�㝽��~�_PK '��\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
'��\Z��' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Ref7fc79e7b29410c" /></Relationships>PK '��\��C� � xl/worksheets/sheet1.xml � (� ��ow�0ƿ
���ܐ��G�q�v�nk��c��3��uA�r���Q��sI��$��˿��y��"��c<�:�z�͓���},/��r2�d��bǥc�uq���eY>��~1[�iTx�C���Y�F������b����l�����猅~���>�X&����?���<����ծT%kw2�'��v�N/��ΦS�:�dTѷI�)���T~gٟ퇫��e�����3��㪼�6�qr�,�K��̲UQ�:i���u��o��I��r���g�E��w���Q�t���N�JF�q}P�g>W�:�����F���zY�e���L0&�Z����և'�U�W'�u��'�M�7��{�)��f�`M`؉#�}�ం���C���@>h�h��6&�� R M����&�p�@�1ù�F1#���©�&�ЦP�m�D(5g��ob��� B�D�=*�ie*4Qs�ҁ�
E8�5Y�m%���Hm���@/x�E'���!��d���i!�TLv��&�\�Z��"��Vh�����+��@
oȼ�"W���;ɪc�<*��(�6N^ݶ��WS{YT��=�
{�>M���jk�U��.�O�.q�'�.�O�.q�'d�x�'�.q�'T����K���K�'C�~ ��GA�~"��gA�^r�� koy��@������Hr��@��w���A �ݟ���E ��)�yk�o�~��v����@���X��G�!J�F]� 5�-��]j���8E*�
��
�1����z��@PO?���#�}"�h5}&��kA��B �I7}D�&}%4�o���N ��[A��r�� wr�W��ٔX�B�e��K�O7�/�����x�����PK '��\
.am� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�$NP�nذ-��q&5�#�z6�+` R���F�{z�����f�6O�}�m�e9�Ƶ��8��v��I�4�q $�����rOi0�:dnA�:��)�=]�9�)���5���p^�?D�u��gN3����:brо���O)�K`Y�yl�עT%��e]U@���B<O~���+��x梨�������c�}���i]^�u�$S�Jq�JuQ�W��PK '��\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK '��\���l� � xl/sharedStrings.xml � (� �V]o�0}����x ��Tj�vњ��&��6nk`3�t˦����d �7|������_Y�=㘒�n�=]���H|�2]�����H� ��s�IW�G�Z��̲x��q��@$��,CB���9��5��R���|+C��ZL"Fz?Ե��L�L��C1�������UB;x��i��HP�i��x�I;q�2PBA,�T���4YDi���y�$-�����^}TK=�V"~�M�Et)~"����j�K[ M.{�%�5�E���^��:zO9Nj�c�J�M�ę��h��)���:�b�r�QL�,3�b��L�����F�7\@fNh��p�0�7��o���o<G���s�@����Ĕ��UHn��E�w����p��)ȗʤ�fw�N7�v��n�k���F��R��,�o���w�@q�3 � .Á�wQw ~�
j��ofSm�����v����Ŝ-v8�fr �V�~I-�b��oh�*�m��{R�ѱ�(�}L��b ��ě=� \|�Z�1�HH\�oe���T
�}˕:����g����w���G���݉�� ɣ�u��s��{F�,��Y.��_��
�ɡ�����4�el�f�֬z-e0i�gu�q�\���q������Q���G��>p��4�i��N�PU�j��{�A����>�'K����PK- '��\����� 5 xl/workbook.xmlPK- '��\���� � [Content_Types].xmlPK-
'��\Z��' ' V _rels/.relsPK- '��\��C� � � xl/worksheets/sheet1.xmlPK- '��\
.am� P � xl/_rels/workbook.xml.relsPK- '��\Ѓc'2 E
� xl/styles.xmlPK- '��\���l� � V
xl/sharedStrings.xmlPK � [
application/vnd.ms-excel
PK '��\��s� 5 xl/workbook.xml � (� ����0D�&�C�����N\�z��bhK��|�o�vfg����kcz�Q�v�-��~�s�@�dF��3V���}1�u���4o�ڳs��� ^�]i���hZ'�V��iy<fO��r6���I�b�)`�EPD�V����ۂƔ�\��#N��f���BcMw��l�]~PK '��\���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
'��\7�c' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Rae96740e9096433b" /></Relationships>PK '��\��C� � xl/worksheets/sheet1.xml � (� ��ow�0ƿ
���ܐ��G�q�v�nk��c��3��uA�r���Q��sI��$��˿��y��"��c<�:�z�͓���},/��r2�d��bǥc�uq���eY>��~1[�iTx�C���Y�F������b����l�����猅~���>�X&����?���<����ծT%kw2�'��v�N/��ΦS�:�dTѷI�)���T~gٟ퇫��e�����3��㪼�6�qr�,�K��̲UQ�:i���u��o��I��r���g�E��w���Q�t���N�JF�q}P�g>W�:�����F���zY�e���L0&�Z����և'�U�W'�u��'�M�7��{�)��f�`M`؉#�}�ం���C���@>h�h��6&�� R M����&�p�@�1ù�F1#���©�&�ЦP�m�D(5g��ob��� B�D�=*�ie*4Qs�ҁ�
E8�5Y�m%���Hm���@/x�E'���!��d���i!�TLv��&�\�Z��"��Vh�����+��@
oȼ�"W���;ɪc�<*��(�6N^ݶ��WS{YT��=�
{�>M���jk�U��.�O�.q�'�.�O�.q�'d�x�'�.q�'T����K���K�'C�~ ��GA�~"��gA�^r�� koy��@������Hr��@��w���A �ݟ���E ��)�yk�o�~��v����@���X��G�!J�F]� 5�-��]j���8E*�
��
�1����z��@PO?���#�}"�h5}&��kA��B �I7}D�&}%4�o���N ��[A��r�� wr�W��ٔX�B�e��K�O7�/�����x�����PK '��\P��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞� NH��ݰa[z��=N�&vd�@�Ƃ#q�"A*�`��h~OO��|�Xoߦ�����-� FV9=خ�S4w5l7���D�9��bC}���z�0dn&�:�� cJ}�gTG�BT�/p�d��L�!:cE�N�&��0u�z�l�����O)�KȳD��[���P?Tu)�5ʜ����B<�~���L%E��R��Z��T�GO�9�t�Ӳ�P;4��(D)�RV/j��/6_PK '��\Ѓc'2 E
xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK '��\���l� � xl/sharedStrings.xml � (� �V]o�0}����x ��Tj�vњ��&��6nk`3�t˦����d �7|������_Y�=㘒�n�=]���H|�2]�����H� ��s�IW�G�Z��̲x��q��@$��,CB���9��5��R���|+C��ZL"Fz?Ե��L�L��C1�������UB;x��i��HP�i��x�I;q�2PBA,�T���4YDi���y�$-�����^}TK=�V"~�M�Et)~"����j�K[ M.{�%�5�E���^��:zO9Nj�c�J�M�ę��h��)���:�b�r�QL�,3�b��L�����F�7\@fNh��p�0�7��o���o<G���s�@����Ĕ��UHn��E�w����p��)ȗʤ�fw�N7�v��n�k���F��R��,�o���w�@q�3 � .Á�wQw ~�
j��ofSm�����v����Ŝ-v8�fr �V�~I-�b��oh�*�m��{R�ѱ�(�}L��b ��ě=� \|�Z�1�HH\�oe���T
�}˕:����g����w���G���݉�� ɣ�u��s��{F�,��Y.��_��
�ɡ�����4�el�f�֬z-e0i�gu�q�\���q������Q���G��>p��4�i��N�PU�j��{�A����>�'K����PK- '��\��s� 5 xl/workbook.xmlPK- '��\���� � [Content_Types].xmlPK-
'��\7�c' ' V _rels/.relsPK- '��\��C� � � xl/worksheets/sheet1.xmlPK- '��\P��� P � xl/_rels/workbook.xml.relsPK- '��\Ѓc'2 E
� xl/styles.xmlPK- '��\���l� � U
xl/sharedStrings.xmlPK � Z