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": "jCM4AxXU40i3kraMuNPbpg==",
"identifierGuid": "0338238c-d415-48e3-b792-b68cb8d3dba6",
"name": "sample string 2",
"formType": "sample string 3",
"forms": [
{
"$id": "2",
"id": 1,
"g_UID": "RKTvzWo3ukOoxd1tKUupCw==",
"guid": "cdefa444-376a-43ba-a8c5-dd6d294ba90b",
"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": "wqOP+4oBJkq5HiaeCSxEHg==",
"previousFormGuid": "fb8fa3c2-018a-4a26-b91e-269e092c441e",
"nextForm": 1,
"nextFormG_UID": "hVPs4ljBFEm6gVuF56k+hg==",
"nextFormGuid": "e2ec5385-c158-4914-ba81-5b85e7a93e86",
"attributes": "sample string 10",
"updated": "2026-06-03T18:30:30.9473236",
"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": "ninxerPTYUaCCxEywFsgtQ==",
"checkoutFormGuid": "7af1299e-d3b3-4661-820b-1132c05b20b5",
"identifier": "4UeYrP1ZoUeZg7KTJg2MxA==",
"identifierGuid": "ac9847e1-59fd-47a1-9983-b293260d8cc4",
"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": "lulJdEo3p0uGj21q/GfW9A==",
"valueGuid": "7449e996-374a-4ba7-868f-6d6afc67d6f4",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:30:30.9473236",
"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:30.9473236",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "6sP2zMGDlki0+dsHgubkcA==",
"checkoutFormGuid": "ccf6c3ea-83c1-4896-b4f9-db0782e6e470",
"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 ϓ�\4�Y@� 5 xl/workbook.xml � (� ����0��&�C�p�S)��x����6Ж�5���H�yۙ��v�h]���#�_������5�';��v�:��$����ƶo�&@Ep���R
���X~pȟ^"ݯ(͕���@����~���՝Mk~Sl���"�k�h��dq�ϊƔ�RM�-��"*���y�'����`�]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
ϓ�\��P�' ' _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="R20c8d3e237eb43e2" /></Relationships>PK ϓ�\��� � � xl/worksheets/sheet1.xml � (� ��A�� ��
ý"��ug�i��uzh�V1:%$ٟ_$6�H&��Eax�^`ȟކ8Jmz5G1r�Uӏ�l�I��2?)�j:)-p�hV�����B���P�H����Z��ʺ��"ն}-ת>r�(�c���U�Me�~o����2{-��/a؝K
U?�2ozW}Z=в-�3^m��=���'�
�$��z�:ߚƞE��נ�mu����U��κMJ�S���_0���A0To��۹�RF�4�0�8��X5����V9���'��Hd1�\�a�}2��:?�x�ӌ ���>�}�A?����s�b���p��}6������ΩH3�3L���|��֕��\��~�U�ZϮi�I��3���8G�ɝ�������Hn�uH�[�KH�[b�@.�%]rM�[� �Hb�.$�E����m��A��|䚏�3_H,��2_H,�D���̇����=iRo��R��|yf�?PK ϓ�\�\�1� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;� &
ɦ�l�\��1���l�i��E��+�j��H]t��h~OO��|���ަ����55�$�F�v0]
砟춛�2� ��'q����5�^�8I��M�h�&b�::Ku��,MW�-p�$���!Z���V�'4�0�Xw�=b r���P�O�����H�ok8�R�T��E��L�S��:������*o2Yf+x�E�*�K��Kp��K�ey�ƪF�(�9/������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 ϓ�\���y3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{����Jہe����i���l���b��f{��'��p�����wբ7�N]� �1͍��P���2�0r�i�Z���8��e�G�U�7�wה:ހb��tP��*�Ci�u�p
�W-M�xF�#nz����^���/V�2�� ��^�ͩ/sz�ce�K1V1[���C�#wc�a�3�08��vOc1N�,I3���"�f�F��Uճ�יHE�f��T�B�؆�Q��rNe��o��
4X�ɝt�y�[|�5�� �����b]��q��T
���cuf��Ɵ��6��T~PK- ϓ�\4�Y@� 5 xl/workbook.xmlPK- ϓ�\���� � [Content_Types].xmlPK-
ϓ�\��P�' ' W _rels/.relsPK- ϓ�\��� � � � xl/worksheets/sheet1.xmlPK- ϓ�\�\�1� P � xl/_rels/workbook.xml.relsPK- ϓ�\Ѓc'2 E
2 xl/styles.xmlPK- ϓ�\���y3 ~ � xl/sharedStrings.xmlPK � ,
application/vnd.ms-excel
Sample:
PK ϓ�\X�"η 5 xl/workbook.xml � (� ����0��&�C��U�D��x�པ�m�-�����O ��mgv��)F����|l�0%�19c(5X�'?��v�+�$Ëy����˷م�+Ћh�Cm�+�D� �~EYa��B�����������l���o�X`�Ţ�JZ�((Y�{[�3%!7��H@�D�&�JoYFw�+����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
ϓ�\%M�/' ' _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="Rf149aa4d2e384873" /></Relationships>PK ϓ�\��� � � xl/worksheets/sheet1.xml � (� ��A�� ��
ý"��ug�i��uzh�V1:%$ٟ_$6�H&��Eax�^`ȟކ8Jmz5G1r�Uӏ�l�I��2?)�j:)-p�hV�����B���P�H����Z��ʺ��"ն}-ת>r�(�c���U�Me�~o����2{-��/a؝K
U?�2ozW}Z=в-�3^m��=���'�
�$��z�:ߚƞE��נ�mu����U��κMJ�S���_0���A0To��۹�RF�4�0�8��X5����V9���'��Hd1�\�a�}2��:?�x�ӌ ���>�}�A?����s�b���p��}6������ΩH3�3L���|��֕��\��~�U�ZϮi�I��3���8G�ɝ�������Hn�uH�[�KH�[b�@.�%]rM�[� �Hb�.$�E����m��A��|䚏�3_H,��2_H,�D���̇����=iRo��R��|yf�?PK ϓ�\��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8��P�n�t[z�㨉m�n�gc���V� �X��j4��'�|��6o�DN��l�(��U����1�6��'��D4��$��I�?R��Y��y���]�e�i��� �UY64,p�$�����֣�'��3�����p�1��0`���%�"S�l�v��|��⡮�Л��t�0�z}����5J���g�j����N!_z�,/�X�[.��D�4��ѫ�XPK ϓ�\Ѓ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 ϓ�\���y3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{����Jہe����i���l���b��f{��'��p�����wբ7�N]� �1͍��P���2�0r�i�Z���8��e�G�U�7�wה:ހb��tP��*�Ci�u�p
�W-M�xF�#nz����^���/V�2�� ��^�ͩ/sz�ce�K1V1[���C�#wc�a�3�08��vOc1N�,I3���"�f�F��Uճ�יHE�f��T�B�؆�Q��rNe��o��
4X�ɝt�y�[|�5�� �����b]��q��T
���cuf��Ɵ��6��T~PK- ϓ�\X�"η 5 xl/workbook.xmlPK- ϓ�\���� � [Content_Types].xmlPK-
ϓ�\%M�/' ' V _rels/.relsPK- ϓ�\��� � � � xl/worksheets/sheet1.xmlPK- ϓ�\��� P � xl/_rels/workbook.xml.relsPK- ϓ�\Ѓc'2 E
0 xl/styles.xmlPK- ϓ�\���y3 ~ � xl/sharedStrings.xmlPK � *