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 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": "0c5PIj8Bx0qtE4bxBZN3bw==", "identifierGuid": "224fced1-013f-4ac7-ad13-86f10593776f", "name": "sample string 2", "formType": "sample string 3", "forms": [ { "$id": "2", "id": 1, "g_UID": "uu5t8VbHKE6/6tsJTMJvFA==", "guid": "f16deeba-c756-4e28-bfea-db094cc26f14", "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": "i5X+nXA260GLE1eDNktAUw==", "previousFormGuid": "9dfe958b-3670-41eb-8b13-5783364b4053", "nextForm": 1, "nextFormG_UID": "Ldi+7eWNOUOq4hFSSzEutw==", "nextFormGuid": "edbed82d-8de5-4339-aae2-11524b312eb7", "attributes": "sample string 10", "updated": "2025-10-04T23:57:27.4607853", "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": "WxKjH/mwm0a1J0ccGrVKCA==", "checkoutFormGuid": "1fa3125b-b0f9-469b-b527-471c1ab54a08", "identifier": "rG00Xos1vUaxavthH1rs0w==", "identifierGuid": "5e346dac-358b-46bd-b16a-fb611f5aecd3", "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": "6L0mQ0/I10yQiI43OyynFQ==", "valueGuid": "4326bde8-c84f-4cd7-9088-8e373b2ca715", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-04T23:57:27.4607853", "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:57:27.4607853", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "dw4NDba3LUS3u98S5P7Sog==", "checkoutFormGuid": "0d0d0e77-b7b6-442d-b7bb-df12e4fed2a2", "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 -�D[��Kg� 5 xl/workbook.xml � (� ����0��&�C��`�D��x��})[�H����[J ��mgv�۩'�_��/�ѣ �o���U�.QC8X�&��b��ɬ�cg�[���X�q��� R�@�?��<�$b��Ҡm�;B��C��L�Zw6 [B�7Ug�v�1���D�$;���%%�Ri���p�<�V������PK -�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 -�D[���T' ' _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="Re51c33eea4a84e52" /></Relationships>PK -�D[�l<� � xl/worksheets/sheet1.xml � (� ��A�� �� ý"��ug����:=�g��U� I���M6�I;{Q������q G�t/�� �@L�l�i�Ãi?%��NR��N,>��ag�~���;1V:�{1ٱV��2��vH�m_������!%��ةt��5<W��Zz�Dո%�ù�X�,������%�>�MI @E���8�wm0����u�|kr:yp�&��@#��0���U���M�]���v_0���A0Vo���� bF�4L1O9�A9�Z��V9�%]�I�c�0N f�q�,yr��<i�iʒ�G��t����%_�<�8�ID8 ��y���5�;;�I�2�����|�̶���L�Pn�V�[϶��I������0C�9�/>�o��>�[� �����D��@V�b]�"/�Vv>�Wv>���|"]��^msy����Տ���'�~>��Ox~w��zwS;�� UJi�rw��� PK -�D[�r~� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8iH��ݰa[z��=��&vd�@�Ƃ#q�"�+�`��h~OO��|���ަ�������FV:5�^�)�v�͞F�i"�a,�� ��8�9�Є�p3����OS�{>�<bO|Q�����f��y���փ�G'O����:�(;��) �)~ U����������T�e��x)�z}癌�X�H�\.�R7�1�I=G�.�;��LM˦-�qY��]���_l� PK -�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 -�D[�x�2 ~ xl/sharedStrings.xml � (� ��]K�0��J�}�~�mJہe����JCr��������f���+/��r>�7��%oУv�� �)+��v_Ї�*�S�^X%Zg��@Je��Ih�X����s� ��u`�R���~ϱ�A(l �iy�Sn���H7X֦�V�P}��B��/oX�k }�}��#+�A��z'��*ܴ;t?rí�О��z0�����i,�餖��(N�:�9��J�h>����2�ͦ����Z�!r��-g��S����"[��^Kv��?'���V�g��#��Tl됝\���������S������OPK- -�D[��Kg� 5 xl/workbook.xmlPK- -�D[���� � � [Content_Types].xmlPK- -�D[���T' ' U _rels/.relsPK- -�D[�l<� � � xl/worksheets/sheet1.xmlPK- -�D[�r~� P � xl/_rels/workbook.xml.relsPK- -�D[Ѓc'2 E . xl/styles.xmlPK- -�D[�x�2 ~ � xl/sharedStrings.xmlPK � '
application/vnd.ms-excel
Sample:
PK -�D[wBU� 5 xl/workbook.xml � (� ����0��&�C����iH��ū�.������Ƿ@ ��mgv����ι����*�X��+Bb���xrl� .��O�A�к�m�&RŕE��F�}�+�V��� �qE�-n�����a����Vw6YC�7��~�(d���" ��&k|�(T:��c���^(c�,��;���w�PK -�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 -�D[�' ' _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="Rdffc076fa5244ee3" /></Relationships>PK -�D[�l<� � xl/worksheets/sheet1.xml � (� ��A�� �� ý"��ug����:=�g��U� I���M6�I;{Q������q G�t/�� �@L�l�i�Ãi?%��NR��N,>��ag�~���;1V:�{1ٱV��2��vH�m_������!%��ةt��5<W��Zz�Dո%�ù�X�,������%�>�MI @E���8�wm0����u�|kr:yp�&��@#��0���U���M�]���v_0���A0Vo���� bF�4L1O9�A9�Z��V9�%]�I�c�0N f�q�,yr��<i�iʒ�G��t����%_�<�8�ID8 ��y���5�;;�I�2�����|�̶���L�Pn�V�[϶��I������0C�9�/>�o��>�[� �����D��@V�b]�"/�Vv>�Wv>���|"]��^msy����Տ���'�~>��Ox~w��zwS;�� UJi�rw��� PK -�D[��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;���`� �n)p��G$vdZ��E��+ԢRk�.�a5��ӓf>�?6��i$t~���<c@�(���p퓀�vs�Q�8��a�$�_C¼�ԫ'�3;���ֺI�����R�d��`��.e�=��3��h�vP���<� ��u'�# G�:5��<��<�T Ϻ��j�\���B �S��:������%_�T��T�h�Cez�P�/�:��D +Q-�2/�U×+uS�w��PK -�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 -�D[�x�2 ~ xl/sharedStrings.xml � (� ��]K�0��J�}�~�mJہe����JCr��������f���+/��r>�7��%oУv�� �)+��v_Ї�*�S�^X%Zg��@Je��Ih�X����s� ��u`�R���~ϱ�A(l �iy�Sn���H7X֦�V�P}��B��/oX�k }�}��#+�A��z'��*ܴ;t?rí�О��z0�����i,�餖��(N�:�9��J�h>����2�ͦ����Z�!r��-g��S����"[��^Kv��?'���V�g��#��Tl됝\���������S������OPK- -�D[wBU� 5 xl/workbook.xmlPK- -�D[���� � [Content_Types].xmlPK- -�D[�' ' V _rels/.relsPK- -�D[�l<� � � xl/worksheets/sheet1.xmlPK- -�D[��� P � xl/_rels/workbook.xml.relsPK- -�D[Ѓc'2 E 1 xl/styles.xmlPK- -�D[�x�2 ~ � xl/sharedStrings.xmlPK � *