GET api/checkoutforms/{formType}/groups?relations={relations}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formType | string |
Required |
|
relations | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of CheckoutFormGroupName | Description | Type | Additional information |
---|---|---|---|
Identifier | Collection of byte |
None. |
|
IdentifierGuid | globally unique identifier |
None. |
|
Name | string |
String length: inclusive between 0 and 60 |
|
FormType | string |
String length: inclusive between 0 and 60 |
|
Forms | Collection of CheckoutForm |
None. |
|
Panels | Collection of CheckoutPanel |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "1", "identifier": "rmgwyUGaOECFM9jxr2jkWw==", "identifierGuid": "c93068ae-9a41-4038-8533-d8f1af68e45b", "name": "sample string 2", "formType": "sample string 3", "forms": [ { "$id": "2", "id": 1, "g_UID": "WQpgKZz8S0GQi3IHGqj5sA==", "guid": "29600a59-fc9c-414b-908b-72071aa8f9b0", "zoneID": 3, "storeID": 4, "name": "sample string 5", "formType": "sample string 6", "locationX": 1, "locationY": 1, "width": 1, "height": 1, "maximised": true, "resizable": true, "backgroundImage": "sample string 7", "backgroundColour": "sample string 8", "backgroundColourA": 1, "backgroundColourR": 1, "backgroundColourG": 1, "backgroundColourB": 1, "fontFamily": "sample string 9", "fontSize": 1.1, "fontStyle": 1, "previousForm": 1, "previousFormG_UID": "a84fkV8+f0OKvlNdWsaaYA==", "previousFormGuid": "911fce6b-3e5f-437f-8abe-535d5ac69a60", "nextForm": 1, "nextFormG_UID": "lTHhUjHTcUulyMb5e3QC1A==", "nextFormGuid": "52e13195-d331-4b71-a5c8-c6f97b7402d4", "attributes": "sample string 10", "updated": "2025-08-02T23:10:28.9728655", "positioning": 1, "contentPanel": "sample string 11", "selectionMode": 1, "maximumSelections": 1, "alteredInStore": true, "deleted": true, "blueprintID": 1, "preserveLayout": true, "mainCheckoutFormName": "sample string 13", "nextCheckoutForm": { "$ref": "2" }, "previousCheckoutForm": { "$ref": "2" }, "buttons": [ { "$id": "3", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "+NXffx/W3UCXN73+97PaYA==", "checkoutFormGuid": "7fdfd5f8-d61f-40dd-9737-bdfef7b3da60", "identifier": "CX+zSQCh1k60egu11HkAkA==", "identifierGuid": "49b37f09-a100-4ed6-b47a-0bb5d4790090", "name": "sample string 5", "plu": 1, "locationX": 1, "locationY": 1, "width": 1, "height": 1, "anchor": 1, "backgroundImage": "sample string 6", "backgroundImageID": 1, "backgroundImageUrl": "sample string 7", "topColour": 1, "textColour": 1, "bottomColour": 1, "borderColour": 1, "borderWidth": 1, "radius": 1, "gradientMode": 1, "dropShadow": true, "shadowWidth": 1, "highLightOnPush": true, "fontFamily": "sample string 8", "fontSize": 1.1, "fontStyle": 1, "textAlign": 1, "imageAlign": 1, "wordBreak": true, "verticalText": true, "buttonFunction": 1, "buttonValue": 1, "valueG_UID": "75+ex8nG80mHDPAV0UMzGQ==", "valueGuid": "c79e9fef-c6c9-49f3-870c-f015d1433319", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-08-02T23:10:28.9728655", "action": "sample string 12", "valueForm": { "$ref": "2" }, "image": { "$id": "4", "name": "sample string 3.sample string 4", "imageID": 2, "imageName": "sample string 3", "imageExtension": "sample string 4", "lastUpdate": "2025-08-02T23:10:28.9728655", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "pn1rUBSUsEqUFov9estccQ==", "checkoutFormGuid": "506b7da6-9414-4ab0-9416-8bfd7acb5c71", "panelType": "sample string 4", "name": "sample string 5", "locationX": 6, "locationY": 7, "width": 8, "height": 9, "anchor": 10, "fontFamily": "sample string 11", "fontSize": 12.1, "fontStyle": 13, "backgroundColour": 14, "textColour": 15, "attributes": "sample string 16" }, { "$ref": "5" } ] }, { "$ref": "2" } ], "panels": [ { "$ref": "5" }, { "$ref": "5" } ] }, { "$ref": "1" } ]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
text/csv
Sample:
Sample not available.
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK N�[AN� 5 xl/workbook.xml � (� ����0��&�C�� �H���/�����_(�ě����o'��k�{�r�-(��d����w�մ봕�'i_Lw�h���[��,:/�� ^h�0�.�X�X��qD/�%A(Z�w��s����9k��$l ��T`�EPD�ĂV����ۂ�(������\��Dq|K1iӆn� ���w�PK N�[���� � [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 N�[ Is�' ' _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="R1d602b88ca804fc1" /></Relationships>PK N�[#._�� � xl/worksheets/sheet1.xml � (� ��A�� �� ý"��ug����:=t�V1:�����/�l$��ً��<���=��8 �{9�!b�e�O�L�%�Ev��EwB`�IoT;c��t݉�ҁ܋Ɏ�R���]�C�m�Zle}�dP�)1T�N��~������{%��-aΥƪ�`�5��>�(���oJ*2���I�i�9�)_�Ώ&��c��n� 4����%O�E��ݤ�9���������zu�SߘζH3�(�a�y�!����y�W��G�]|�E��4�<���}���:? x�Ӕ% ����O?�Nj_|��R��$"����>[|v�y`g�4�S�SL���|�̶���L�Pn�V�[����I������0C��]�'����W��n��O�[�O�[���B �.���<����_��d��'�U:���m.� �~>r�G>���|>����|>�廃��77��O�P��F(w�/�l�PK N�[�� � P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8I����ݰ���=��&vd����G� XEWb�������4�����9��5�,�FZ5���)� l7�=N"� ��œ�b<��D��g�3����Y����.Bŀ���Lr�,����Qⳕ�M�L_�;z���0p�)yz E�@v�������ժm��F�wS��2�����&���>RȒUx_-����S�������ʼ��[&���Fo�b�PK N�[Ѓ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 N�[ny3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{�v�F'm�mNΧ!��5�$57�7ۃH�>�x���$]�����EitF#R�4��nj>��AB :�+� )Y�)�#�UcF�+αl@ d���X%�/�cgAT� 8��IιRSR�^;�vBI��k��+d�����d-����)?ѱ��e5V1[���C�#�1� ��Ёb׃���X,q8O1��i'A2��J�H�����q յ�3�>r2�[�9�0m��o�l�,٭D�Vr+�8�e[SyGl�-�� ;�fE��ݩ�0���i~����?PK- N�[AN� 5 xl/workbook.xmlPK- N�[���� � [Content_Types].xmlPK- N�[ Is�' ' V _rels/.relsPK- N�[#._�� � � xl/worksheets/sheet1.xmlPK- N�[�� � P � xl/_rels/workbook.xml.relsPK- N�[Ѓc'2 E 0 xl/styles.xmlPK- N�[ny3 ~ � xl/sharedStrings.xmlPK � *
application/vnd.ms-excel
Sample:
PK N�[��� 5 xl/workbook.xml � (� ����0��&�C���AR8q���{��6П�5���H�yۙ��v�l��3����/]�E�$�w�'cA��`��!J�"fd��� t �W�`�A텴��X�:� AM+Jq�q}< ĖfO �O2[��Dd ��K��")��� 7<p��s�+|�ȕ2���_hA�����������PK N�[���� � [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 N�[��' ' _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="R6db481e11a0b4c93" /></Relationships>PK N�[#._�� � xl/worksheets/sheet1.xml � (� ��A�� �� ý"��ug����:=t�V1:�����/�l$��ً��<���=��8 �{9�!b�e�O�L�%�Ev��EwB`�IoT;c��t݉�ҁ܋Ɏ�R���]�C�m�Zle}�dP�)1T�N��~������{%��-aΥƪ�`�5��>�(���oJ*2���I�i�9�)_�Ώ&��c��n� 4����%O�E��ݤ�9���������zu�SߘζH3�(�a�y�!����y�W��G�]|�E��4�<���}���:? x�Ӕ% ����O?�Nj_|��R��$"����>[|v�y`g�4�S�SL���|�̶���L�Pn�V�[����I������0C��]�'����W��n��O�[�O�[���B �.���<����_��d��'�U:���m.� �~>r�G>���|>����|>�廃��77��O�P��F(w�/�l�PK N�[�f��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�uLH��ݰa[z��=����.г��H\�H�J,�t5��ӓf>�?6��id/���l �L #��lW�)�w%춛=��D�9��bC }���{�0dn&�:��Ɣ��Ϩ���B�/p�d��L�!��4=:}���?����c�"���b ?��/a�%*�'S��T*���!�ʲ �o��y�����/d�4�!TŃ¢��L���s���K�ey��T�K�R�J*}�_���_l� PK N�[Ѓ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 N�[ny3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{�v�F'm�mNΧ!��5�$57�7ۃH�>�x���$]�����EitF#R�4��nj>��AB :�+� )Y�)�#�UcF�+αl@ d���X%�/�cgAT� 8��IιRSR�^;�vBI��k��+d�����d-����)?ѱ��e5V1[���C�#�1� ��Ёb׃���X,q8O1��i'A2��J�H�����q յ�3�>r2�[�9�0m��o�l�,٭D�Vr+�8�e[SyGl�-�� ;�fE��ݩ�0���i~����?PK- N�[��� 5 xl/workbook.xmlPK- N�[���� � [Content_Types].xmlPK- N�[��' ' V _rels/.relsPK- N�[#._�� � � xl/worksheets/sheet1.xmlPK- N�[�f��� P � xl/_rels/workbook.xml.relsPK- N�[Ѓc'2 E 0 xl/styles.xmlPK- N�[ny3 ~ � xl/sharedStrings.xmlPK � *