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": "mFOU1qt0gUC+Gx6MQ7E2vQ==",
"identifierGuid": "d6945398-74ab-4081-be1b-1e8c43b136bd",
"name": "sample string 2",
"formType": "sample string 3",
"forms": [
{
"$id": "2",
"id": 1,
"g_UID": "Ue54tKGdrEGa7yVdRtyu+Q==",
"guid": "b478ee51-9da1-41ac-9aef-255d46dcaef9",
"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": "yvtjBdhmeUmK8egV9gn7TQ==",
"previousFormGuid": "0563fbca-66d8-4979-8af1-e815f609fb4d",
"nextForm": 1,
"nextFormG_UID": "/WItQWY950mn1uhcb4+xJA==",
"nextFormGuid": "412d62fd-3d66-49e7-a7d6-e85c6f8fb124",
"attributes": "sample string 10",
"updated": "2026-04-03T06:14:53.4772425",
"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": "lEC3j99nQk+gfdx2+Qi/ZQ==",
"checkoutFormGuid": "8fb74094-67df-4f42-a07d-dc76f908bf65",
"identifier": "xww2eUm3f0KIB5DXno0svA==",
"identifierGuid": "79360cc7-b749-427f-8807-90d79e8d2cbc",
"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": "sl8rn8wSY0Ce7ZzzCHrQwg==",
"valueGuid": "9f2b5fb2-12cc-4063-9eed-9cf3087ad0c2",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-03T06:14:53.4772425",
"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:14:53.4772425",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "3"
}
],
"panels": [
{
"$id": "5",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "8JpeTp8wLkOxCmD3s1cziA==",
"checkoutFormGuid": "4e5e9af0-309f-432e-b10a-60f7b3573388",
"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 �1�\k���� 5 xl/workbook.xml � (� ����0��&�C�����p��Ճ�[�H����[J ��mgv��a�������Ʉ�7X��jB� A�p�L� �5�I�'�B�:;�5�H.����ģ�&H�^i������ ��V�����x@�-�
�e2�����"�)�a�EV�p
�x�e�66����U�}u���,@�xg�0F���PK �1�\���� � [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
�1�\Mc�' ' _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="Rdf52ce905aa84801" /></Relationships>PK �1�\�L��� � xl/worksheets/sheet1.xml � (� ��O�� ��
ý�ɨ;�M����=[��JH��Hl��L�ً��</��!{zpJ�r�! 0b�e�O�L�)�OEv��UwB`�IoT;c��t݉�ҁ܋Ɏ�R���]�C�m�Zle}�dP�q��*c��]���\�j�U�0�Rc�O�Ț�V�W�hs�L6%� ����ߵ��䷔�s�[�C�X�������h��`~��W��:c7�;���v_0���A0Vo����
xD#�NI���m��k�[�쇋^|���a�`�I��>]|z��1��FI��}���>_|~��(�SF��4��?��ŏ�~��c��4")aw}t>wf��TE�� (7l�ϭg�����i{e���qv��'�-��'�[b�����(}�_d�]҅�t��D�t>���D�J��*�O��6�wr?������|>����|>�廃��w7��O�P��F(w�/�l�PK �1�\8���� P xl/_rels/workbook.xml.rels � (� ��;n�0@�"p�E����%K�4�m�6bK�����:�H�B�H�C�L �?��ۏefodݤUi��Hu������˧����f�Ä'�XXQ���{�̹�FZ�K�!:R�E��ځ��@<C,��p�d������SG;ݝR�0���F"� �@��k��KH�@��7�o�b+��I敔���Ԝ?��n^�y$�E�ʲ-$a����2��Կz.;��HM U)�E�y��E�����PK �1�\Ѓ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 �1�\S"�3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{�v��Jہe����i���l�����ӛ�A�S�|����sN���UG���4:�)]�F�}N7� ��Ѝ茆� )��#�UcN[��kαnA d�핝�J8_�=�ނh�p��0�r%���6�v~턒A���/�W�"s�m�ɝ�qWd�H��r��X�
�l�o��9��Zh����(vsp�}���*�����2U��iTUAi��UO��;Q���������r��9��:��CdK�`e��$��h;��+��,[��;b�U����5+[�_��ՙ��J��|�?P� PK- �1�\k���� 5 xl/workbook.xmlPK- �1�\���� � � [Content_Types].xmlPK-
�1�\Mc�' ' U _rels/.relsPK- �1�\�L��� � � xl/worksheets/sheet1.xmlPK- �1�\8���� P � xl/_rels/workbook.xml.relsPK- �1�\Ѓc'2 E
/ xl/styles.xmlPK- �1�\S"�3 ~ � xl/sharedStrings.xmlPK � )
application/vnd.ms-excel
Sample:
PK �1�\ߞ7� 5 xl/workbook.xml � (� ����0��&�C�pѐ&��ū�l�������J ��mgv��)'�_��/�ѣ ����+ B7��p��̼��k���O�R��۽5��,�iĨ� �r���X�y�>DQ�+J�2�>+�fESHr6����`
�o�L��")fPS���Yrn}�Ϝ�B��]��*�Nb�˾�;{������PK �1�\���� � [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
�1�\a\\B' ' _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="R32fb2c91a4a94913" /></Relationships>PK �1�\�L��� � xl/worksheets/sheet1.xml � (� ��O�� ��
ý�ɨ;�M����=[��JH��Hl��L�ً��</��!{zpJ�r�! 0b�e�O�L�)�OEv��UwB`�IoT;c��t݉�ҁ܋Ɏ�R���]�C�m�Zle}�dP�q��*c��]���\�j�U�0�Rc�O�Ț�V�W�hs�L6%� ����ߵ��䷔�s�[�C�X�������h��`~��W��:c7�;���v_0���A0Vo����
xD#�NI���m��k�[�쇋^|���a�`�I��>]|z��1��FI��}���>_|~��(�SF��4��?��ŏ�~��c��4")aw}t>wf��TE�� (7l�ϭg�����i{e���qv��'�-��'�[b�����(}�_d�]҅�t��D�t>���D�J��*�O��6�wr?������|>����|>�廃��w7��O�P��F(w�/�l�PK �1�\�ؚ�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�i����ݰa[z�3��&vd�@�Ƃ#q�"A*�`��h~OO��|���ަ��P��w-�� FN{\��)��5춛=�*�h�9���b6����-M*~&�;ƇI�����JUO|%D�Ò�Lv8���7f����i"�� �W��%`zJ-��"����T`O�¾!�t���F i���t)�z}��ՄBU��Z
��Tƪ@��B���iY^�U]Y�X!�u%Q�5~��/PK �1�\Ѓ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 �1�\S"�3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{�v��Jہe����i���l�����ӛ�A�S�|����sN���UG���4:�)]�F�}N7� ��Ѝ茆� )��#�UcN[��kαnA d�핝�J8_�=�ނh�p��0�r%���6�v~턒A���/�W�"s�m�ɝ�qWd�H��r��X�
�l�o��9��Zh����(vsp�}���*�����2U��iTUAi��UO��;Q���������r��9��:��CdK�`e��$��h;��+��,[��;b�U����5+[�_��ՙ��J��|�?P� PK- �1�\ߞ7� 5 xl/workbook.xmlPK- �1�\���� � � [Content_Types].xmlPK-
�1�\a\\B' ' T _rels/.relsPK- �1�\�L��� � � xl/worksheets/sheet1.xmlPK- �1�\�ؚ�� P � xl/_rels/workbook.xml.relsPK- �1�\Ѓc'2 E
. xl/styles.xmlPK- �1�\S"�3 ~ � xl/sharedStrings.xmlPK � (