GET api/possetting/{section}/{keyName}?relations={relations}&storeID={storeID}

Get a POS setting by section and keyname

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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

Sample:
{
  "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-04-03T06:27:07.3014421",
  "updatedBy": "sample string 5",
  "terminalG_UID": "dyDEcANSqkqWeShiHRV1rg==",
  "terminalGuid": "70c42077-5203-4aaa-9679-28621d1575ae",
  "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": "1GQ9wgEm702N8dPCD/de9A==",
    "terminalGuid": "c23d64d4-2601-4def-8df1-d3c20ff75ef4",
    "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": "Yk9bBvB5qEmDggH2J66N3A==",
      "guid": "065b4f62-79f0-49a8-8382-01f627ae8ddc",
      "name": "sample string 3",
      "description": "sample string 4",
      "terminalNumber": 1,
      "posKey": "qpUYgpC5x0SOF5wtWvp0lA==",
      "linkedPOSKey": "821895aa-b990-44c7-8e17-9c2d5afa7494",
      "location": 1,
      "zoneID": 1,
      "currentMachineID": 1,
      "storeID": 1,
      "deleted": true,
      "updated": "2026-04-03T06:27:07.3014421",
      "currentMachine": {
        "$ref": "2"
      },
      "currentLane": {
        "$id": "5",
        "identifier": "np/0dFUnHk6UIn8PUyPLjg==",
        "identifierGuid": "74f49f9e-2755-4e1e-9422-7f0f5323cb8e",
        "name": "sample string 1",
        "storeID": 2,
        "machineID": 3,
        "scaleID": "sample string 4",
        "lastPingLocal": "2026-04-03T06:27:07.3014421",
        "lastSaleLocal": "2026-04-03T06:27:07.3014421",
        "status": 0,
        "statusDate": "2026-04-03T06:27:07.3014421",
        "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:

Sample not available.

text/xml

Sample:

Sample not available.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PKc3�\S��S�5xl/workbook.xml �(���=�0��J�C�4!ڢ��ҵCw�D�%����@�VO~�ϟ�gm�F�|�\aK:xo
�\;�w�U���J�A��}/Z�u���<K��Y���� ��+��3�s��ӊ� ��B���S�����b���o�GؾQ ��5x�$:���	%��y�I��*�/٭�ҝ��8�nW_PKc3�\����	�[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
c3�\I>e�''_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="R63af290225c44396" /></Relationships>PKc3�\��A��xl/worksheets/sheet1.xml �(���_w�@ſ
���ΰ�9j�m�&���m���*FNUr��~��("�i|I0��ܹ�/�.�S�i���	�IV�l����c9{�ݗ��:���$)����|���������<Yƅ�=$+{o��˸��{?���Ir�M�ɪ�Q��ϓE\�G��p����V�'�Z�r�-��ӕ;LS[}�z'OfCwg�1��?T�m����kg�*�������t芊�;�E���ܙ&��qQ�d��$����%Ui&٢�~:�t��,���u:-�C�x E���<e����j�V�;�u<����h�� 8�v��ϕ;���@x@+�4p\�vz��)!Hj�q}�Ӈ'꣝>:Q�wz}����ѣ��T��P ��Aԁ'�����
62�. ��u��I_���@j���P���?�	4�0�Z�H���� ��A�CM
��T�H�J�zv�1�Ssu�I�DO��
�:2=�(�9t2ҁ�� 
e�s�Y�&�
<���=��:�'�����{���&��<-�P�Ё]��Xg��,�:�B�E�?��D�2�Q��yK𷓬{�q�y�v�궭���ˢ�v�v�>����hwī.m�u��6q�%�6�K�6q�%T�x�%�6q�%�6q�%t�x�%L�x�8FL�� �ՏBl�� ���B��f��!��0��+�s�1q�;�6��-�w�����A��?����A��cfbc�o7�~�b�s�+"��bb��a����{o�ҤQ]$ �z� �A�Buu�Ni�;RڹH;�I��1��AHO?0���#�}b�d7}f��k!��� �I7]D�&}e�F��4�;��o�8� ��B��� ��_]�gcfJM��0|���n�_dY���x���PKc3�\?����Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞8�7AM�aö�Sg�DM��v���G�
XE�Tb�����OO�|���o�(^؇���,�V�v�]�h�*�n�;)���s�

�1�R��D!s3�41�OS�;9�>RDz�s%���L�?���3f����ib��W珡g� ��;�
�����"KTOm��(�R�Za}�@ț��x9�z}��
QQa(/QkuS��<��ѧ�^:-�K5���{*ѴX�ꋚ����PKc3�\Ѓc'2E
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��PKc3�\�@���xl/sharedStrings.xml �(��V�n�0�G��\�cӤ��N��F�:&e�	���i-;�Π ��'�8�v�>)��_yf<�ѱ�ٮi�,!t96�n/��i�h�2Fal�A���d$�4�*cs%eq�8� G�fPŤ��H�'_:����y���:9"�40+����4JJ~�0=����$.2"��#GNFNm��d	Z�c�8�gux���v�堙,UU��{X7IDY��wE�$$-���-�P�]~��C=�%�,~fM��,�?�V�j5e�+K[M*{���%geѤ�N��:zÄ l�*4_�B�3���l���hjg\>�4:�L�2�KB̵� �Z
^	�=eY��"�K��	����߼���d�(Z�,�L�狩��w&�}�!�}��Kݍ@y���T�������^7t���
��%�kqG.|7������!d
�hh��������U��–4��_�g���ި����e���
vx�jr ��蠢��L��F;�M��}�ѳҨ�}LW��_pP�����!?Y�d��;KH�B������LNO�a?4�?:q#��bk���(�'�{"�n���K� 	,?t=+H �I�YI�n�F}H�CZ���5hd#�l�b���n[*cJ�ku�q�\��	a�+ſ����[�6<x��[�|x�z��+�߸��q�៹N�3��;�O��
��PK-c3�\S��S�5xl/workbook.xmlPK-c3�\����	��[Content_Types].xmlPK-
c3�\I>e�''U_rels/.relsPK-c3�\��A���xl/worksheets/sheet1.xmlPK-c3�\?����P�xl/_rels/workbook.xml.relsPK-c3�\Ѓc'2E
�xl/styles.xmlPK-c3�\�@���V
xl/sharedStrings.xmlPK�Y

application/vnd.ms-excel

Sample:
PKc3�\��qܶ5xl/workbook.xml �(�����0��&�C��X���x��}��6П�5��$޼���~;�d��3����]IE6g̷�����7NA�ҽ��{�bmڷBO�+s8B�F{!��+�����1�qE)��V�!���)q��Vw6	[C�7U,��bQD�’���Źw%=S�r�Gz��͚�
G��wX����PKc3�\����	�[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
c3�\U�''_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="R96fe7e998f8a4089" /></Relationships>PKc3�\��A��xl/worksheets/sheet1.xml �(���_w�@ſ
���ΰ�9j�m�&���m���*FNUr��~��("�i|I0��ܹ�/�.�S�i���	�IV�l����c9{�ݗ��:���$)����|���������<Yƅ�=$+{o��˸��{?���Ir�M�ɪ�Q��ϓE\�G��p����V�'�Z�r�-��ӕ;LS[}�z'OfCwg�1��?T�m����kg�*�������t芊�;�E���ܙ&��qQ�d��$����%Ui&٢�~:�t��,���u:-�C�x E���<e����j�V�;�u<����h�� 8�v��ϕ;���@x@+�4p\�vz��)!Hj�q}�Ӈ'꣝>:Q�wz}����ѣ��T��P ��Aԁ'�����
62�. ��u��I_���@j���P���?�	4�0�Z�H���� ��A�CM
��T�H�J�zv�1�Ssu�I�DO��
�:2=�(�9t2ҁ�� 
e�s�Y�&�
<���=��:�'�����{���&��<-�P�Ё]��Xg��,�:�B�E�?��D�2�Q��yK𷓬{�q�y�v�궭���ˢ�v�v�>����hwī.m�u��6q�%�6�K�6q�%T�x�%�6q�%�6q�%t�x�%L�x�8FL�� �ՏBl�� ���B��f��!��0��+�s�1q�;�6��-�w�����A��?����A��cfbc�o7�~�b�s�+"��bb��a����{o�ҤQ]$ �z� �A�Buu�Ni�;RڹH;�I��1��AHO?0���#�}b�d7}f��k!��� �I7]D�&}e�F��4�;��o�8� ��B��� ��_]�gcfJM��0|���n�_dY���x���PKc3�\:U��Pxl/_rels/workbook.xml.rels �(���An� E��f_cS��*$�l�Ms�c�Hڜ���W(j�֑��&+43��������m�	C��P%t�w��%���Y�v8��oD;̑�'.J�)�O�FmqR��3�<1>L*�2�tV��z��,��f��y���1�ƭ��	]�L_}8D����U�1I�iE�}TE�y�$�P���{d5�-C �fj1�G��^�z!�Z�|`���\	qS�v/)�M/���eN53Uc��bGqɉ^���PKc3�\Ѓc'2E
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��PKc3�\�@���xl/sharedStrings.xml �(��V�n�0�G��\�cӤ��N��F�:&e�	���i-;�Π ��'�8�v�>)��_yf<�ѱ�ٮi�,!t96�n/��i�h�2Fal�A���d$�4�*cs%eq�8� G�fPŤ��H�'_:����y���:9"�40+����4JJ~�0=����$.2"��#GNFNm��d	Z�c�8�gux���v�堙,UU��{X7IDY��wE�$$-���-�P�]~��C=�%�,~fM��,�?�V�j5e�+K[M*{���%geѤ�N��:zÄ l�*4_�B�3���l���hjg\>�4:�L�2�KB̵� �Z
^	�=eY��"�K��	����߼���d�(Z�,�L�狩��w&�}�!�}��Kݍ@y���T�������^7t���
��%�kqG.|7������!d
�hh��������U��–4��_�g���ި����e���
vx�jr ��蠢��L��F;�M��}�ѳҨ�}LW��_pP�����!?Y�d��;KH�B������LNO�a?4�?:q#��bk���(�'�{"�n���K� 	,?t=+H �I�YI�n�F}H�CZ���5hd#�l�b���n[*cJ�ku�q�\��	a�+ſ����[�6<x��[�|x�z��+�߸��q�៹N�3��;�O��
��PK-c3�\��qܶ5xl/workbook.xmlPK-c3�\����	��[Content_Types].xmlPK-
c3�\U�''U_rels/.relsPK-c3�\��A���xl/worksheets/sheet1.xmlPK-c3�\:U��P�xl/_rels/workbook.xml.relsPK-c3�\Ѓc'2E
�xl/styles.xmlPK-c3�\�@���W
xl/sharedStrings.xmlPK�Z