GET api/checkoutformgroups/{formType}?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": "Kc+nGto3V0OGMxDm0P3cLA==",
"identifierGuid": "1aa7cf29-37da-4357-8633-10e6d0fddc2c",
"name": "sample string 2",
"formType": "sample string 3",
"forms": [
{
"$id": "2",
"id": 1,
"g_UID": "HgYNJ7KMxUCUNiTMDUyrhg==",
"guid": "270d061e-8cb2-40c5-9436-24cc0d4cab86",
"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": "SCCC0W7cCUa1G9onQtYmmA==",
"previousFormGuid": "d1822048-dc6e-4609-b51b-da2742d62698",
"nextForm": 1,
"nextFormG_UID": "1BK4C6qB7UGjWZ+L8W26dw==",
"nextFormGuid": "0bb812d4-81aa-41ed-a359-9f8bf16dba77",
"attributes": "sample string 10",
"updated": "2026-06-03T18:30:38.8184236",
"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": "d3inK9ti90any0jAfB3sIw==",
"checkoutFormGuid": "2ba77877-62db-46f7-a7cb-48c07c1dec23",
"identifier": "SHYZhUBoVk+zV3H4kK8bQQ==",
"identifierGuid": "85197648-6840-4f56-b357-71f890af1b41",
"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": "BNbIRENG5keN0zhr75q+dg==",
"valueGuid": "44c8d604-4643-47e6-8dd3-386bef9abe76",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:30:38.8184236",
"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:38.8184236",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "10Ily4Dar0qaOFyx2iOH7A==",
"checkoutFormGuid": "cb2542d7-da80-4aaf-9a38-5cb1da2387ec",
"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 ӓ�\3^KѶ 5 xl/workbook.xml � (� ����0D�&�C�� F)��x��})[i�-ik��-H�yۙ�};|��o���G���]c��j�';��;i���{1+�X[��h;'ɕ9 (k|�FOW�?,?:��w�A+J�2�:�s����/2[��$l
��_`���%�! %�soK�R�
���M�"�M�_������8�~W_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
ӓ�\
=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="R73ec09d11afb4eee" /></Relationships>PK ӓ�\���X� � xl/worksheets/sheet1.xml � (� ��A�� ��
ý��ug����:=t�V1:�����/�l$��ً��<���=��8
�{9�1ղ�]�����";I��;!���7*��1�
B���X�@��d�Z���خ�!ٶ}-��>�b2(�8FJ��S��kx��?��^��qK�s���'XdMo�ϫJ�9|$��B�����{q�o�`N�Gʗ���!v,���M�S�F��a0����w���9���v_0���A0V�����
��ƌ1��r�6r|^��U9����� JӈaN0ci��O�^�g�0Ä�q��|���~�����q�SF���S��Nj_}��9K�4&)aw}t>wf��TE�� (7l�ϭG�����i{e���qv��'�-��'�[b�����(}"������BωW�|����D�J��*�O��6�wr?����u>�X��u>����A��Л���'M�RJ#��˗g��PK ӓ�\���Y� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8NL�TM�aö���Q۲]�gc���V���X��j4��'�|�lvo�L^ЇɚXQA#�0���STw-춛=�"���'HZ1��[S��E��:4���_DL���(F�UY���p�$�����R��+O����Z19?b���%�"Q�<=�Z��Z=�
WR �7S�<c����3�d��)�Z�U7�����}�t35�Ɋ�%�:�+vQ�W��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 ӓ�\ \N2 ~ xl/sharedStrings.xml � (� ��]K�0��J�}�~�6����
���y5Cr�ۤ����f���+/��r>�7���]K������ �)#��f_���2�Q�^%Zk��@J�e��Ih5X�����s�
t������>�nϱw 6 �ky�� m(�v0>�M)�~��a�.s_�*0^�\�}��#+�A��z/:�e�i{��8�a�=��б�����XL���:�����Ev9�f�,��&*��������B�.DNҿ��s*۶ }xCd+0�dw�s�[|�0b���
��b]��Evrͪ���:3��Oi~���*?PK- ӓ�\3^KѶ 5 xl/workbook.xmlPK- ӓ�\���� � � [Content_Types].xmlPK-
ӓ�\
=U' ' U _rels/.relsPK- ӓ�\���X� � � xl/worksheets/sheet1.xmlPK- ӓ�\���Y� P � xl/_rels/workbook.xml.relsPK- ӓ�\Ѓc'2 E
/ xl/styles.xmlPK- ӓ�\ \N2 ~ � xl/sharedStrings.xmlPK � (
application/vnd.ms-excel
Sample:
PK ӓ�\�J� � 5 xl/workbook.xml � (� ����0D�&�C��
D"N\�z���6Ж�5���H�yۙ�};�l��3���+lE��S���*p'3�;n��}1ù�1�[��,9����^턜]i���dz'�W��i}<R.͞ge0���I�b��2������m�%ѹ��Pb�G���,�%=��.,6�+����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
ӓ�\�\�#' ' _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="R5a57cea9335a41d5" /></Relationships>PK ӓ�\���X� � xl/worksheets/sheet1.xml � (� ��A�� ��
ý��ug����:=t�V1:�����/�l$��ً��<���=��8
�{9�1ղ�]�����";I��;!���7*��1�
B���X�@��d�Z���خ�!ٶ}-��>�b2(�8FJ��S��kx��?��^��qK�s���'XdMo�ϫJ�9|$��B�����{q�o�`N�Gʗ���!v,���M�S�F��a0����w���9���v_0���A0V�����
��ƌ1��r�6r|^��U9����� JӈaN0ci��O�^�g�0Ä�q��|���~�����q�SF���S��Nj_}��9K�4&)aw}t>wf��TE�� (7l�ϭG�����i{e���qv��'�-��'�[b�����(}"������BωW�|����D�J��*�O��6�wr?����u>�X��u>����A��Л���'M�RJ#��˗g��PK ӓ�\��l�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8NLJ��ݰa[z��=N�&�e�@�Ƃ#q�"A*�`��h~OO��|�Xoߦ��P���-��FV9=خ�S2w�ݬw4b��|dy�������z�0Γ��)����;�UY6<�p�d�����1��G�N�����p�=Q���Qj��%�"S�=�vy0X�Ų�F�J �7S��<R����g2RU�{�j-d�47��1�~N!_z�4/��DYV�*]7e��E�_���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 ӓ�\ \N2 ~ xl/sharedStrings.xml � (� ��]K�0��J�}�~�6����
���y5Cr�ۤ����f���+/��r>�7���]K������ �)#��f_���2�Q�^%Zk��@J�e��Ih5X�����s�
t������>�nϱw 6 �ky�� m(�v0>�M)�~��a�.s_�*0^�\�}��#+�A��z/:�e�i{��8�a�=��б�����XL���:�����Ev9�f�,��&*��������B�.DNҿ��s*۶ }xCd+0�dw�s�[|�0b���
��b]��Evrͪ���:3��Oi~���*?PK- ӓ�\�J� � 5 xl/workbook.xmlPK- ӓ�\���� � [Content_Types].xmlPK-
ӓ�\�\�#' ' V _rels/.relsPK- ӓ�\���X� � � xl/worksheets/sheet1.xmlPK- ӓ�\��l�� P � xl/_rels/workbook.xml.relsPK- ӓ�\Ѓc'2 E
0 xl/styles.xmlPK- ӓ�\ \N2 ~ � xl/sharedStrings.xmlPK � )