GET api/checkoutformgroups?relations={relations}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| relations | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of CheckoutFormGroup| Name | 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": "5X/zeYl/+02P4IJ8PalqHw==",
"identifierGuid": "79f37fe5-7f89-4dfb-8fe0-827c3da96a1f",
"name": "sample string 2",
"formType": "sample string 3",
"forms": [
{
"$id": "2",
"id": 1,
"g_UID": "z/YZ/P8KG0eBxMhpHVrilQ==",
"guid": "fc19f6cf-0aff-471b-81c4-c8691d5ae295",
"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": "AaIinm1aiEy+45mn2uI5TA==",
"previousFormGuid": "9e22a201-5a6d-4c88-bee3-99a7dae2394c",
"nextForm": 1,
"nextFormG_UID": "9uAGgHzwFEi5i0POcB5A2A==",
"nextFormGuid": "8006e0f6-f07c-4814-b98b-43ce701e40d8",
"attributes": "sample string 10",
"updated": "2026-04-03T06:20:25.0422412",
"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": "JNrCRE7MF0iBKEZgpoEQQw==",
"checkoutFormGuid": "44c2da24-cc4e-4817-8128-4660a6811043",
"identifier": "EOJ3OQBpx0e2F6ujF8c6lw==",
"identifierGuid": "3977e210-6900-47c7-b617-aba317c73a97",
"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": "vjBuvB7uQ0egfUv9PJTpFw==",
"valueGuid": "bc6e30be-ee1e-4743-a07d-4bfd3c94e917",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-03T06:20:25.0422412",
"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": "2026-04-03T06:20:25.0422412",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "HDTbMFjPvkSkAxAEcv/U/Q==",
"checkoutFormGuid": "30db341c-cf58-44be-a403-100472ffd4fd",
"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 �2�\���߷ 5 xl/workbook.xml � (� ���� D�M��(��iz��k�S\Q� ���*F��zۙ�};|r�:ף�l(}�U�cIH�
�'7��w��F�Y�q]�%4N�
�HrJ/�� �v6(=���a�уh��fXQFh���!�4{h�B����]LD��M��/�BV�p#��(9���F���p/��m�d��e��;���w�PK �2�\���� � [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
�2�\?��' ' _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="R79fb883e9ea7476e" /></Relationships>PK �2�\ �� � xl/worksheets/sheet1.xml � (� ��A�� ��
�^Aщ���Դ�����*�fU&����uvd���E!<�/҇סg.U'�bχ��������n���!O'!_T˹�Nf����CHU-J�#�X#�Pjӕ$����^T����!��R��T��T��Z�(yY�%���Pv#�Ӻ3���ɛ>�]A @yj���ԛ6����e���3�[9pa'�)A͛���_b�λC��&�֩D��ݼu��O]�[�"^��R�'�%�ꤴ���U.~������0���:Ytr��z,��i�1����O?釋�>�<�P�8 ����~����g����8L"�`z�G�S�G�/u��RL@�aS}n=���m�N�s���gw!�\�_]"�%�.An�o.Ao��%@&ؚ.��'ڤs �I��&�K$�t.�7�\�A��|䚏|��%��\b��%��\��w��Conjk^4.!4��.��l�PK �2�\ڰQ�� P xl/_rels/workbook.xml.rels � (� ��Mn� F��f_�mp�(N6�d���?�
HӜ���W(J�֑��&+4���������<�W�a���<c@�(�G�7p��C
��z����FFHzbBC�nEiP�2d֡I���Y�T��:���GZ0VQ�d�-�.�C�]7*|��4������c#���=�~�@�G�%*��n`_ֹ`���k��wS�2a����2E-*�����\=�w��G�}���i/�lӌ
%*�E+�j��_l� PK �2�\Ѓ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 �2�\r�3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{��ӵ���6'�����l���b��f{��'��p����wբ7�N]� �1].����U�a�<Ӝ�FC�p-��9�B�vn��(uu�9b:�A�*�Ci�uw
�W-M�xF����ڇ� F���=T_ ��e���K!��ԗ9=ұ��%�wL����M�����1�2
���E��DZ���4p�"�G\<G��8ʒ��r6����8��B�6D�����/�T�m���
Y�+kr+���r�4;�%Ã#��Tdk9�&U�����:3��Oi~�O�*?PK- �2�\���߷ 5 xl/workbook.xmlPK- �2�\���� � [Content_Types].xmlPK-
�2�\?��' ' V _rels/.relsPK- �2�\ �� � � xl/worksheets/sheet1.xmlPK- �2�\ڰQ�� P � xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
1 xl/styles.xmlPK- �2�\r�3 ~ � xl/sharedStrings.xmlPK � +
application/vnd.ms-excel
Sample:
PK �2�\�6�� 5 xl/workbook.xml � (� ����0D�&�C��HR8q����B�������Ϸ@ ��mgv�����W�܋|�`C�k�b+�B��@8�m�I�
�$��9)u����mdy��� Q;�]i����DP��+ʀ��9�s���),2[��$l
��_`���5m!%�s5=S�+���(��d�we^^�5�6��l��|PK �2�\���� � [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
�2�\��7`' ' _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="R92f4c465867949de" /></Relationships>PK �2�\ �� � xl/worksheets/sheet1.xml � (� ��A�� ��
�^Aщ���Դ�����*�fU&����uvd���E!<�/҇סg.U'�bχ��������n���!O'!_T˹�Nf����CHU-J�#�X#�Pjӕ$����^T����!��R��T��T��Z�(yY�%���Pv#�Ӻ3���ɛ>�]A @yj���ԛ6����e���3�[9pa'�)A͛���_b�λC��&�֩D��ݼu��O]�[�"^��R�'�%�ꤴ���U.~������0���:Ytr��z,��i�1����O?釋�>�<�P�8 ����~����g����8L"�`z�G�S�G�/u��RL@�aS}n=���m�N�s���gw!�\�_]"�%�.An�o.Ao��%@&ؚ.��'ڤs �I��&�K$�t.�7�\�A��|䚏|��%��\b��%��\��w��Conjk^4.!4��.��l�PK �2�\�N��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8qSנ�ݰ��v<N�&�e����G�
XE�Tb�������4����M#9c���
TE m��`�N�<�n�{e��|$y��������q��pm�&�r:�e{�RV���9n��p���3fh�ٵ� m�L_]8�19��aj��5TE����ZH�gJ0Q�B��e������d��WXrU �ꅪ�*�ˀ�%�|�Ӽ<SSK�(
r�k�X]���_l� PK �2�\Ѓ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 �2�\r�3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{��ӵ���6'�����l���b��f{��'��p����wբ7�N]� �1].����U�a�<Ӝ�FC�p-��9�B�vn��(uu�9b:�A�*�Ci�uw
�W-M�xF����ڇ� F���=T_ ��e���K!��ԗ9=ұ��%�wL����M�����1�2
���E��DZ���4p�"�G\<G��8ʒ��r6����8��B�6D�����/�T�m���
Y�+kr+���r�4;�%Ã#��Tdk9�&U�����:3��Oi~�O�*?PK- �2�\�6�� 5 xl/workbook.xmlPK- �2�\���� � [Content_Types].xmlPK-
�2�\��7`' ' V _rels/.relsPK- �2�\ �� � � xl/worksheets/sheet1.xmlPK- �2�\�N��� P � xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
0 xl/styles.xmlPK- �2�\r�3 ~ � xl/sharedStrings.xmlPK � *