GET api/store/{storeID}/machine/{machine}/checkoutsetting/{section}/{keyName}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| storeID | integer |
Required |
|
| machine | string |
Required |
|
| section | string |
Required |
|
| keyName | string |
Required |
Body Parameters
None.
Response Information
Resource Description
CheckoutSetting| Name | Description | Type | Additional information |
|---|---|---|---|
| StoreID | integer |
None. |
|
| MachineID | integer |
None. |
|
| 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. |
|
| 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. |
Response Formats
application/json, text/json
Sample:
{
"storeID": 1,
"machineID": 1,
"machineName": "sample string 1",
"section": "sample string 2",
"keyName": "sample string 3",
"value": "sample string 4",
"updated": "2026-04-03T06:26:10.842674",
"updatedBy": "sample string 5",
"terminalG_UID": "f38+qzEd9Umd2KkMMSSJPg==",
"terminalGuid": "ab3e7f7f-1d31-49f5-9dd8-a90c3124893e",
"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": "0IMSiSxG60Gae+IAQf41oQ==",
"terminalGuid": "891283d0-462c-41eb-9a7b-e20041fe35a1",
"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": "Iq0saqKWdUG0cSrbuhKf9g==",
"guid": "6a2cad22-96a2-4175-b471-2adbba129ff6",
"name": "sample string 3",
"description": "sample string 4",
"terminalNumber": 1,
"posKey": "5rNFg4fmVUSWRPfEhg9bCQ==",
"linkedPOSKey": "8345b3e6-e687-4455-9644-f7c4860f5b09",
"location": 1,
"zoneID": 1,
"currentMachineID": 1,
"storeID": 1,
"deleted": true,
"updated": "2026-04-03T06:26:10.842674",
"currentMachine": {
"$ref": "2"
},
"currentLane": {
"$id": "5",
"identifier": "+FsIsj0ciEKIcbnBnFNSeg==",
"identifierGuid": "b2085bf8-1c3d-4288-8871-b9c19c53527a",
"name": "sample string 1",
"storeID": 2,
"machineID": 3,
"scaleID": "sample string 4",
"lastPingLocal": "2026-04-03T06:26:10.842674",
"lastSaleLocal": "2026-04-03T06:26:10.842674",
"status": 0,
"statusDate": "2026-04-03T06:26:10.842674",
"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, text/xml
Sample:
<CheckoutSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager"> <KeyName>sample string 3</KeyName> <MachineID>1</MachineID> <Section>sample string 2</Section> <SoftwareUpdatedBy>POS</SoftwareUpdatedBy> <StoreID>1</StoreID> <TerminalG_UID>f38+qzEd9Umd2KkMMSSJPg==</TerminalG_UID> <TerminalGuid>ab3e7f7f-1d31-49f5-9dd8-a90c3124893e</TerminalGuid> <UpdatedBy>sample string 5</UpdatedBy> <Value>sample string 4</Value> <ZoneID>1</ZoneID> </CheckoutSetting>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK E3�\�X�(� 5 xl/workbook.xml � (� ����0D�J��(� BT `b�ڡ�LA�����R�n��������i�H>jҮ�
��c�T�.fFv��
|����0H���o�ڳ,I
fq/�vBΎn�Xn���^MJ�Դ=���f���2{��$l��Ta�ETD�v���������J��^f�5����yI������PK E3�\���� � [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
E3�\��38' ' _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="R42830e33fd8f46e0" /></Relationships>PK E3�\O� �U � xl/worksheets/sheet1.xml � (� ���r�0E�ὠ]I elwڦiҦI��I�Hm35&$��W�`�Ec^l0���+dFo��K�%$[�]��īi6KV�c����Q���h���E���W�I>ve�t���t�Q�eO��\�gy��4��<�Ƨ��9�W���~/��U,����V��Z�SG�j
�r[*���;�S}3{'��c��<����Q�%�88v6w�;��lN.fc�U�߁Ϫ�orgϣ�ey�����qQ�d��fˢ�t�dc�����{����������E���۟�QouX�p��i %��Ḟ�z��/�L0:P*��zQ��@���r�>���@}X�ý=���ZQ���j�8����P����A ��q=�&8lW���Bezϑ)֓ �E�ك&|p�>�1����a������A@�'P�ME 2�w�Mah� !�S(p��5�d*�=�Bx�d��R9�Th��$J��Rj��z�D�@��"��>Ś�>� =%�!S�̿�A�=qh�&�ȇVh�����C0�<�cE������M���4*��(��N^]6�7G��aQmXf*���2a#�e����]�ć.�m�K�6�K�6q�%d���%�6q�%�6q�%T���%t��bq��ziA��_-��ʂ_�-1�Ƃg�Yb�!�~� �����Ӓ6��!��[��/B�}� {w}��vK�Kk�e)�?r�v#}:� �O-�ә!}�t8Oa��H
��]?�T#-��"���!�|9�ݥEN��Ղ�v_Y���-iҍ!M�fA����4�!���"�8�ӂw�,q�ނwu�z�T���?����.�ϲ���jCܽrN�PK E3�\��(� P xl/_rels/workbook.xml.rels � (� ��KN�0��b͞8q�hP�nذ-����<�Ďl��Xp$��U$H%l����'�|�lvo��^��`MCY��QV�k�ڻ5��=F��ٳ�b|C}�=�^���O�;�u�1u��:�\�i�ݒA�Lv8��Ѷ��`�i� ���uG���A�����痐%�J�Q7��EVeȤ,s�C�����|8��^��BF��nQ��֫�n*�K�\���iY^�B`]�EQH��z����~PK E3�\Ѓ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 E3�\>`-� xl/sharedStrings.xml � (� �U�n�@}G�,?���U��6-D4��[�@m�����5��A�;k7I��7�9s�����w�*��xB�T�tSU�`%d=U�5_U�@$B)%0UK�r>�p.iJ�T������iD21eRdk��P�7 "K
�4=#C QL"��;R��$?��2D2��Y((��|b��Ĩ�'x��&!��-ʠI���,� ��K�J���GH@�_�M�X������NuOI���U\Hc�1�Ww���m[�R�2�q=��1Z�]v�嬁5�;�y�J�n+o�*�9ĨHE���1K�q�Ūg�!��(�f���5��<��L����a���az�*��2����[�D+��8֬ȱ47�GZE��;�����j���p8�g ����W��2U�7�^��j̮����ɞ���E�}0��hoC1ڪ�Y<�����ʢZ�p��㚁�>�;����z#*D�zB��R�����|�t
G�6�S�3�;�L�������jG�;R�W@�~`پ����Xs-Xi�4�gӵbpF蹬��y�t��V�:��Z
����I��?���/i)ׯ���|��NQ?�8,n�z� ��+���8n�/�>����}���l��O�q��I�P�>q|����d�8O��}2�}�PK- E3�\�X�(� 5 xl/workbook.xmlPK- E3�\���� � � [Content_Types].xmlPK-
E3�\��38' ' U _rels/.relsPK- E3�\O� �U � � xl/worksheets/sheet1.xmlPK- E3�\��(� P h xl/_rels/workbook.xml.relsPK- E3�\Ѓc'2 E
� xl/styles.xmlPK- E3�\>`-� '
xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK E3�\�X��� 5 xl/workbook.xml � (� ����0��&�C���(*)��x���b�O�||K $���~;l2nx3���/]�E�$ķ�cA�]o��!J�"��e�i�
t 9�q0� ��BZ��?,o�������Ը��bs����'���l"���o�%�v��\A�8Fɹu�0r�����J;�Wz:f�3�����w�PK E3�\���� � [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
E3�\%�!�' ' _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="R99670d199dfd40d9" /></Relationships>PK E3�\O� �U � xl/worksheets/sheet1.xml � (� ���r�0E�ὠ]I elwڦiҦI��I�Hm35&$��W�`�Ec^l0���+dFo��K�%$[�]��īi6KV�c����Q���h���E���W�I>ve�t���t�Q�eO��\�gy��4��<�Ƨ��9�W���~/��U,����V��Z�SG�j
�r[*���;�S}3{'��c��<����Q�%�88v6w�;��lN.fc�U�߁Ϫ�orgϣ�ey�����qQ�d��fˢ�t�dc�����{����������E���۟�QouX�p��i %��Ḟ�z��/�L0:P*��zQ��@���r�>���@}X�ý=���ZQ���j�8����P����A ��q=�&8lW���Bezϑ)֓ �E�ك&|p�>�1����a������A@�'P�ME 2�w�Mah� !�S(p��5�d*�=�Bx�d��R9�Th��$J��Rj��z�D�@��"��>Ś�>� =%�!S�̿�A�=qh�&�ȇVh�����C0�<�cE������M���4*��(��N^]6�7G��aQmXf*���2a#�e����]�ć.�m�K�6�K�6q�%d���%�6q�%�6q�%T���%t��bq��ziA��_-��ʂ_�-1�Ƃg�Yb�!�~� �����Ӓ6��!��[��/B�}� {w}��vK�Kk�e)�?r�v#}:� �O-�ә!}�t8Oa��H
��]?�T#-��"���!�|9�ݥEN��Ղ�v_Y���-iҍ!M�fA����4�!���"�8�ӂw�,q�ނwu�z�T���?����.�ϲ���jCܽrN�PK E3�\��� P xl/_rels/workbook.xml.rels � (� ��AN�0E�b͞؉BҠ�ݰa[z��=��&�e�@�Ƃ#q,*A*�`ӕ5짧���o��^(��Y e!��UN�v�pJ��
����&L�F4��,?�Q�I�?p��c�<���]�1�2ܣ:�@���aɀk&۟=����~T���i&�� �W��%`{% ?Q��GYd*�'-aGU� -TӉ��\�����b:O�.�B��Nk�Jt��Qn*c0�~N!oz鴌jX*�B�F��j.s�W�b�PK E3�\Ѓ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 E3�\>`-� xl/sharedStrings.xml � (� �U�n�@}G�,?���U��6-D4��[�@m�����5��A�;k7I��7�9s�����w�*��xB�T�tSU�`%d=U�5_U�@$B)%0UK�r>�p.iJ�T������iD21eRdk��P�7 "K
�4=#C QL"��;R��$?��2D2��Y((��|b��Ĩ�'x��&!��-ʠI���,� ��K�J���GH@�_�M�X������NuOI���U\Hc�1�Ww���m[�R�2�q=��1Z�]v�嬁5�;�y�J�n+o�*�9ĨHE���1K�q�Ūg�!��(�f���5��<��L����a���az�*��2����[�D+��8֬ȱ47�GZE��;�����j���p8�g ����W��2U�7�^��j̮����ɞ���E�}0��hoC1ڪ�Y<�����ʢZ�p��㚁�>�;����z#*D�zB��R�����|�t
G�6�S�3�;�L�������jG�;R�W@�~`پ����Xs-Xi�4�gӵbpF蹬��y�t��V�:��Z
����I��?���/i)ׯ���|��NQ?�8,n�z� ��+���8n�/�>����}���l��O�q��I�P�>q|����d�8O��}2�}�PK- E3�\�X��� 5 xl/workbook.xmlPK- E3�\���� � [Content_Types].xmlPK-
E3�\%�!�' ' V _rels/.relsPK- E3�\O� �U � � xl/worksheets/sheet1.xmlPK- E3�\��� P i xl/_rels/workbook.xml.relsPK- E3�\Ѓc'2 E
� xl/styles.xmlPK- E3�\>`-� (
xl/sharedStrings.xmlPK � �