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": "/hUohNvXRE271j9UeoEmag==",
"identifierGuid": "842815fe-d7db-4d44-bbd6-3f547a81266a",
"name": "sample string 2",
"formType": "sample string 3",
"forms": [
{
"$id": "2",
"id": 1,
"g_UID": "RVa21N0t+0KkreqoZrGw4g==",
"guid": "d4b65645-2ddd-42fb-a4ad-eaa866b1b0e2",
"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": "PoJCmunYnEq1L1qJ3Eyokw==",
"previousFormGuid": "9a42823e-d8e9-4a9c-b52f-5a89dc4ca893",
"nextForm": 1,
"nextFormG_UID": "BezjWbwiw0+U6RBnPDdo0g==",
"nextFormGuid": "59e3ec05-22bc-4fc3-94e9-10673c3768d2",
"attributes": "sample string 10",
"updated": "2026-06-03T18:30:31.5098428",
"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": "LwjN35Gdi0idY+ydJ+kSyg==",
"checkoutFormGuid": "dfcd082f-9d91-488b-9d63-ec9d27e912ca",
"identifier": "Wg3/0Gu5pUyaGZxz55beGg==",
"identifierGuid": "d0ff0d5a-b96b-4ca5-9a19-9c73e796de1a",
"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": "jRXl7wgERUGlf4Ok5Wk3FA==",
"valueGuid": "efe5158d-0408-4145-a57f-83a4e5693714",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:30:31.5098428",
"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-06-03T18:30:31.5098428",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "zBKCxdHOykquvgLMPOEHBQ==",
"checkoutFormGuid": "c58212cc-ced1-4aca-aebe-02cc3ce10705",
"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 ϓ�\Qw ŷ 5 xl/workbook.xml � (� ����0��&�C�`��QR8q���{)�4П�5��$���~;l2nh��G����>[P�E�������3N��{Q�uR`m�[�4M�u8� ����V�?,o����A�+Jq��:as����/2[��$t
��[`���
K�y�@�ޖp�
�G�4�
�IvI�,M�������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
ϓ�\V�F�' ' _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="Rd74c18878f4a4220" /></Relationships>PK ϓ�\gm�n� � xl/worksheets/sheet1.xml � (� ��A�� ��
�^Aʼn���Դ����lG�*`���E�:;2�6{Q������m���KՉ1���!�c%�n<d�O>��$�j9������Zw���C�<q�k�Jm��D�tߋ�4�Q���#$y_j3�j����j�SK%/k������n�yZw���z y��g�+(O-���z���o!^�η:��e�v��Լ)O��!���;��lRh3���������|����ukZ�#QJ��IAuRZ���U.�`�k�0��!
Y�(}�'K�\�^���4����y������|yqB1�, 1����h�G�|��c��$� ��.�`�l_�2O����æ��z6MeO��2W��):�مxq |K|v��ػ�%���%
�W��.��N&�عD��s ��s�dc�x�����#W?�O?�������%�~.���A�~��Mm͓�e!��������� PK ϓ�\�d(� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�
����ݰa[z�'Q;�]�gc���V� �X��j4��'�|�lvo�H^0��; ��A��\'��]
��f��Jy"��I^qQB���@i�=N*~F�;ևI�����JU��dLаd�5��3���4>z}�Х?��Շc���
& ?�H/aUd*�'#a_��4X3.ʊ��Bo��y�����/d���Fl�Q�[��T�W�s
��K�ey��m-¬�y[W5z��/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 ϓ�\V��3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{���"m�mN��̚�5�&57�7ۃH�>�x���$]��
y���NلХ�J3���J� -Ec4dt �d�����V����8Dz�V 3h�Tƶ���9v����
'���BiJJ�k�׆��Z��P|�B��o$h�*6�.O����M��X�-�����0t?rÝ��\����zp��I&�y�\�C�(
�j-D2
�X�{P�]>c�#'����s
�4P:���6�����*t����Cm�G�lk�w�Vۂ���kV�P��ޝ�C�7�������PK- ϓ�\Qw ŷ 5 xl/workbook.xmlPK- ϓ�\���� � [Content_Types].xmlPK-
ϓ�\V�F�' ' V _rels/.relsPK- ϓ�\gm�n� � � xl/worksheets/sheet1.xmlPK- ϓ�\�d(� P � xl/_rels/workbook.xml.relsPK- ϓ�\Ѓc'2 E
0 xl/styles.xmlPK- ϓ�\V��3 ~ � xl/sharedStrings.xmlPK � *
application/vnd.ms-excel
Sample:
PK ϓ�\�߅Ÿ 5 xl/workbook.xml � (� ��=�0��J�C�4��0�t��=S"H��T��
A u�`������ M_#��m3S�ι1c�6(n8������K�bض��
����1�.����Dm;9Z���a�� �pjXP�KM����|��)a�Azc}w6 [B�7�ض�\AA+�8%����Ɣ�L��qiR7���+�n�
���v�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
ϓ�\3LsQ' ' _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="R7839ed0cae48490d" /></Relationships>PK ϓ�\gm�n� � xl/worksheets/sheet1.xml � (� ��A�� ��
�^Aʼn���Դ����lG�*`���E�:;2�6{Q������m���KՉ1���!�c%�n<d�O>��$�j9������Zw���C�<q�k�Jm��D�tߋ�4�Q���#$y_j3�j����j�SK%/k������n�yZw���z y��g�+(O-���z���o!^�η:��e�v��Լ)O��!���;��lRh3���������|����ukZ�#QJ��IAuRZ���U.�`�k�0��!
Y�(}�'K�\�^���4����y������|yqB1�, 1����h�G�|��c��$� ��.�`�l_�2O����æ��z6MeO��2W��):�مxq |K|v��ػ�%���%
�W��.��N&�عD��s ��s�dc�x�����#W?�O?�������%�~.���A�~��Mm͓�e!��������� PK ϓ�\A���� P xl/_rels/workbook.xml.rels � (� ���n!�_�̽�h�q�ҋW��0,wah���G�+�ؤŤ�^<L&�×/a>�?�۷q g�����b@�)�{�5pJ�A�v��� Sވ��"�O\l��4=Q��Q��O����0ʔ���I����[�P2�I� �C���
��:���`���1Z�� C����V��TW�
d���⭪�9�^��л��t0�z}ׅL���h���s-�*ce@��B��ҩljR(\�&f2��Fo�b�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 ϓ�\V��3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{���"m�mN��̚�5�&57�7ۃH�>�x���$]��
y���NلХ�J3���J� -Ec4dt �d�����V����8Dz�V 3h�Tƶ���9v����
'���BiJJ�k�׆��Z��P|�B��o$h�*6�.O����M��X�-�����0t?rÝ��\����zp��I&�y�\�C�(
�j-D2
�X�{P�]>c�#'����s
�4P:���6�����*t����Cm�G�lk�w�Vۂ���kV�P��ޝ�C�7�������PK- ϓ�\�߅Ÿ 5 xl/workbook.xmlPK- ϓ�\���� � [Content_Types].xmlPK-
ϓ�\3LsQ' ' W _rels/.relsPK- ϓ�\gm�n� � � xl/worksheets/sheet1.xmlPK- ϓ�\A���� P � xl/_rels/workbook.xml.relsPK- ϓ�\Ѓc'2 E
1 xl/styles.xmlPK- ϓ�\V��3 ~ � xl/sharedStrings.xmlPK � +