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 CheckoutFormGroupName | 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": "UHQO7vyQIkuiZyVYny2gjQ==", "identifierGuid": "ee0e7450-90fc-4b22-a267-25589f2da08d", "name": "sample string 2", "formType": "sample string 3", "forms": [ { "$id": "2", "id": 1, "g_UID": "zwHYbh/HZkuykgRvhg0K2w==", "guid": "6ed801cf-c71f-4b66-b292-046f860d0adb", "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": "t/XEvU+oUUy0GZZ3a8R1gA==", "previousFormGuid": "bdc4f5b7-a84f-4c51-b419-96776bc47580", "nextForm": 1, "nextFormG_UID": "Z103czyXFEeJ1AWLX2kVgA==", "nextFormGuid": "73375d67-973c-4714-89d4-058b5f691580", "attributes": "sample string 10", "updated": "2025-10-04T23:58:41.7100508", "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": "5KxEKOQbdUyZ7btf5bNnIA==", "checkoutFormGuid": "2844ace4-1be4-4c75-99ed-bb5fe5b36720", "identifier": "bcSaL74YxUKqxK3Sp6o56g==", "identifierGuid": "2f9ac46d-18be-42c5-aac4-add2a7aa39ea", "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": "660p9i/Fq0GgEELNJy5mJg==", "valueGuid": "f629adeb-c52f-41ab-a010-42cd272e6626", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-04T23:58:41.7100508", "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": "2025-10-04T23:58:41.7100508", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "cFMFQNrEVU2SOO6nIJHMPQ==", "checkoutFormGuid": "40055370-c4da-4d55-9238-eea72091cc3d", "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 T�D[!X� 5 xl/workbook.xml � (� ��;�0D{$�`� DQ�JCKA��l%��6 �'%�������ӹ�|LocJ�R�c�Qh �G;�Z�Q�sm��]�6h��c�����Qi�B��}@�Q!&�/(��j�#DL��8��X�N&aK�����.fE,,i (���,鉒P�q��$�9?_/Y�э��[W_PK T�D[���� � [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 T�D[�,�3' ' _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="R91c78f89a63c40c0" /></Relationships>PK T�D[�� � � 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����� e4L1'��4|ߧ�O��G�a��8I�>[|�I?Z����8�)# IB�)����ŏ�>��%Q����>:�;�me�"S�����֣mjw���2�g�8�������-�� zK|� vK�>]d�]҅�t��īt>�W�|"Y��t��'�j��;���^�����:�O����:�Ox�� �|��M��&T)�����3[�PK T�D[J��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;q��E6l��\`�'�ؑmh9[=R�P�Jm����h~OO��|�Xm�Ɓ�ɇ���,FV;�۶�Sll֫ �D��)��bC ]�Ӓ�;1dn"�:��#Ɣ��O���y^q?g�-��/��蚦״u�4��������E`{�-�~J�_C�%*�gS��(B4B(Q.d�+`�nj!^ �^��\F��T9I��2z2/ѧKϝ��ڡBQң(�T�`������PK T�D[Ѓ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 T�D[}�.�1 ~ xl/sharedStrings.xml � (� ��]K�0��J�}�.�Ki;�lCp2p^ �؞��&�9�X��.D:����M�Żn�8T֤t�bJ��T�҇�*�S�^�R6�@J{@JY��Ih5������s,j��m���NKJw��:�%� ^7\��k�%��k%�Q��_ �PYⳛ�W��p�%�H�ʺS�P���ln����p+ 4g�G�]���C ��xG�qUD�g!")��HL&��J�2��݉R� ��]�����_��m�@��"[�� v��?�����F���-�#���lk��\�����v�X����4����e�PK- T�D[!X� 5 xl/workbook.xmlPK- T�D[���� � � [Content_Types].xmlPK- T�D[�,�3' ' U _rels/.relsPK- T�D[�� � � � xl/worksheets/sheet1.xmlPK- T�D[J��� P � xl/_rels/workbook.xml.relsPK- T�D[Ѓc'2 E . xl/styles.xmlPK- T�D[}�.�1 ~ � xl/sharedStrings.xmlPK � &
application/vnd.ms-excel
Sample:
PK T�D[��yy� 5 xl/workbook.xml � (� ����0��J}�(��SA�K�� �&�$(IE�R�n������ء1f 5jWؒ 蓼1� T�.fBv�� |���L��kӾjϒ(ʘ��4� 99���a��"tN z5n(R��|"�/͞g��`�u��-�~S|��"����ν+iL�-d����q�Dq�_���>`���/PK T�D[���� � [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 T�D[G;e' ' _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="Rbffadf71fc3c4d6e" /></Relationships>PK T�D[�� � � 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����� e4L1'��4|ߧ�O��G�a��8I�>[|�I?Z����8�)# IB�)����ŏ�>��%Q����>:�;�me�"S�����֣mjw���2�g�8�������-�� zK|� vK�>]d�]҅�t��īt>�W�|"Y��t��'�j��;���^�����:�O����:�Ox�� �|��M��&T)�����3[�PK T�D[�/0� P xl/_rels/workbook.xml.rels � (� ��Kn� @��f_�m[U�l��6�0Ɗ �&9[=R�P�H�#u�MV��==i���c��L#yCg[�3�tj�}����n�{EL�s iņL��3�A�D�܌6u��)�=��<�i�؊�%��p��?D�� q��iB� ӳ��`#���=�~J�~�<KT /��}S6��˂��X�S�:b�����NW�3^6%�8c��2FxT�ѧK/���M�:^w2�������PK T�D[Ѓ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 T�D[}�.�1 ~ xl/sharedStrings.xml � (� ��]K�0��J�}�.�Ki;�lCp2p^ �؞��&�9�X��.D:����M�Żn�8T֤t�bJ��T�҇�*�S�^�R6�@J{@JY��Ih5������s,j��m���NKJw��:�%� ^7\��k�%��k%�Q��_ �PYⳛ�W��p�%�H�ʺS�P���ln����p+ 4g�G�]���C ��xG�qUD�g!")��HL&��J�2��݉R� ��]�����_��m�@��"[�� v��?�����F���-�#���lk��\�����v�X����4����e�PK- T�D[��yy� 5 xl/workbook.xmlPK- T�D[���� � [Content_Types].xmlPK- T�D[G;e' ' V _rels/.relsPK- T�D[�� � � � xl/worksheets/sheet1.xmlPK- T�D[�/0� P � xl/_rels/workbook.xml.relsPK- T�D[Ѓc'2 E 0 xl/styles.xmlPK- T�D[}�.�1 ~ � xl/sharedStrings.xmlPK � (