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 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": "Vrkhlx9sHUCkg5os8fkVOg==",
"identifierGuid": "9721b956-6c1f-401d-a483-9a2cf1f9153a",
"name": "sample string 2",
"formType": "sample string 3",
"forms": [
{
"$id": "2",
"id": 1,
"g_UID": "WfiXf3sYZ0qt3IyaF62mgQ==",
"guid": "7f97f859-187b-4a67-addc-8c9a17ada681",
"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": "wsW7SmBXnU2uiI8orCE+Rw==",
"previousFormGuid": "4abbc5c2-5760-4d9d-ae88-8f28ac213e47",
"nextForm": 1,
"nextFormG_UID": "OWWkDsMF5EWnOXhJseCBhA==",
"nextFormGuid": "0ea46539-05c3-45e4-a739-7849b1e08184",
"attributes": "sample string 10",
"updated": "2026-04-03T06:20:24.4171411",
"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": "Iws5Szco30i4zoY0OfhRiw==",
"checkoutFormGuid": "4b390b23-2837-48df-b8ce-863439f8518b",
"identifier": "VXzEcIbRX0eHxtBRiHoK3w==",
"identifierGuid": "70c47c55-d186-475f-87c6-d051887a0adf",
"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": "u8eUbUSPoUiydykLZRhNZg==",
"valueGuid": "6d94c7bb-8f44-48a1-b277-290b65184d66",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-03T06:20:24.4171411",
"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:24.4171411",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "kBWBVmRv60GnE1iNZcB04Q==",
"checkoutFormGuid": "56811590-6f64-41eb-a713-588d65c074e1",
"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�\��0d� 5 xl/workbook.xml � (� ����0��&�C�� �D��x��Эm�?ik��-%�x�3;��4�q�`̄>j־v-!ؚ?
P�_�w�8EC��E�r�ތo:�k�U��L�4�i=�h���u@� A�JQ�qw>!Ԭ͞�d4�����"��&������
Z��@1J�8���2��3~+�!�9+���>`
�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�\ë�X' ' _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="Rff0d3c0eee754683" /></Relationships>PK �2�\e#��� � xl/worksheets/sheet1.xml � (� ��A�� ��
�^Aщ���Դ����lG�*`���E�:;2�6{Q������m���KՉ1���!�c%�n<d�O1|��I�W�r���G��l�>�RUˇRy��G3�9��t����*��i�F��GH��f*�vG/����:J^�v C)5����L�y�@�&��xWP�Z�g�'��
�$��x�;����E\�ɿKP�<��������j�I�u*�+�C7oC�f�SW�ִ�F$��� f ��:)-�_���*?X�`� �8��A�bL�d��u~�Ч>�I�,x��ŧ���W�EK(�qF��-~t��gfg4�'�������K]��v�T�[Ϧ��I��S�ʜs?E��]�����g�n��K�[�K�[�p�p%� ����lj6�\�mҹD�I��&�K��6w|?��#����|.����|.�仃l�w7�5O���K{��g6�PK �2�\�y�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�I��TM�a�m��=�DM��v)=�����ĂMW��==i���c�}��>��6�gZ�Lo�N�*�n�{TL���Ҋ
t1N+�pT!s��!�GS�[>)}T-�B�%�s�2��2��������iD� ����!F`�[�
����<KT`;��~I��|�)7r!��Z��ï�w>�)���(I#I�w��G�}���i^����QȪ�tUHYPyU�7��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�\Hf�4 ~ xl/sharedStrings.xml � (� ��]K�0��J�}���p���6'�����l�ړ��כ�B�~\yy����I�|�
y��5�XH iKe��߯�%�)Ec
dt �d�����V���k/9GY��l�+��p���D�5��
��pεP�i{��ژ�ި��O�W�<u�u ƩJA�r���D�ʦW�X��l�o���p'4��݀4��brGO�l�eT�0*1]L�DIJ��$�Mĸ�n�w>r�-O~9��M��7D����F�{��w�F�c[[zGl�-��";�fE
����T}3���i~����? PK- �2�\��0d� 5 xl/workbook.xmlPK- �2�\���� � � [Content_Types].xmlPK-
�2�\ë�X' ' U _rels/.relsPK- �2�\e#��� � � xl/worksheets/sheet1.xmlPK- �2�\�y�� P � xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
/ xl/styles.xmlPK- �2�\Hf�4 ~ � xl/sharedStrings.xmlPK � *
application/vnd.ms-excel
Sample:
PK �2�\�{!:� 5 xl/workbook.xml � (� ����0��&�C���B)��x���V�O�||K $���~;t�v괞�G��U�ƣ��"��#H�.ڀ
;��d>H�"�s�C����I�$�03/�r�0o�X�X`���7�dB��|B��͞e0�����"�)a�ETH1 5n�gE�>�8��V"�4ɋ�L�2/�[q��`0J���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="R12e87e40943145ac" /></Relationships>PK �2�\e#��� � xl/worksheets/sheet1.xml � (� ��A�� ��
�^Aщ���Դ����lG�*`���E�:;2�6{Q������m���KՉ1���!�c%�n<d�O1|��I�W�r���G��l�>�RUˇRy��G3�9��t����*��i�F��GH��f*�vG/����:J^�v C)5����L�y�@�&��xWP�Z�g�'��
�$��x�;����E\�ɿKP�<��������j�I�u*�+�C7oC�f�SW�ִ�F$��� f ��:)-�_���*?X�`� �8��A�bL�d��u~�Ч>�I�,x��ŧ���W�EK(�qF��-~t��gfg4�'�������K]��v�T�[Ϧ��I��S�ʜs?E��]�����g�n��K�[�K�[�p�p%� ����lj6�\�mҹD�I��&�K��6w|?��#����|.����|.�仃l�w7�5O���K{��g6�PK �2�\��>� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�_�i7ݰ-���'Q;�]�gc���V� �X��j4��'�|�lvo��^��њD�##�M��9�v�́&q���Y\1��!��s/��'v!;ںCL]��'�giZq�f�-�/��h�%�<�d�`�j��D�]O������ �H��Z8����&-��Ɋ*�����|�L����L���aWt"��̀��sp��k�uy���J�L(ʱ,�W5~��/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�\Hf�4 ~ xl/sharedStrings.xml � (� ��]K�0��J�}���p���6'�����l�ړ��כ�B�~\yy����I�|�
y��5�XH iKe��߯�%�)Ec
dt �d�����V���k/9GY��l�+��p���D�5��
��pεP�i{��ژ�ި��O�W�<u�u ƩJA�r���D�ʦW�X��l�o���p'4��݀4��brGO�l�eT�0*1]L�DIJ��$�Mĸ�n�w>r�-O~9��M��7D����F�{��w�F�c[[zGl�-��";�fE
����T}3���i~����? PK- �2�\�{!:� 5 xl/workbook.xmlPK- �2�\���� � [Content_Types].xmlPK-
�2�\)*�' ' V _rels/.relsPK- �2�\e#��� � � xl/worksheets/sheet1.xmlPK- �2�\��>� P � xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
/ xl/styles.xmlPK- �2�\Hf�4 ~ � xl/sharedStrings.xmlPK � *