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 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": "GLYbkNkcAE2GrUMoBfVqzg==", "identifierGuid": "901bb618-1cd9-4d00-86ad-432805f56ace", "name": "sample string 2", "formType": "sample string 3", "forms": [ { "$id": "2", "id": 1, "g_UID": "kw5/GlgnFUehyd6c/QaFvg==", "guid": "1a7f0e93-2758-4715-a1c9-de9cfd0685be", "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": "Eny2MpDHY0SDrp7bN5Y7/A==", "previousFormGuid": "32b67c12-c790-4463-83ae-9edb37963bfc", "nextForm": 1, "nextFormG_UID": "79LCMK76/0KklDSuS2Yjow==", "nextFormGuid": "30c2d2ef-faae-42ff-a494-34ae4b6623a3", "attributes": "sample string 10", "updated": "2025-08-02T23:12:22.4355606", "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": "J5H+kthZQEeARzkwA3+gxA==", "checkoutFormGuid": "92fe9127-59d8-4740-8047-3930037fa0c4", "identifier": "ERIESUDcPE219uB326BVVQ==", "identifierGuid": "49041211-dc40-4d3c-b5f6-e077dba05555", "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": "gbBnV00uUU2v2VuD22e0+Q==", "valueGuid": "5767b081-2e4d-4d51-afd9-5b83db67b4f9", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-08-02T23:12:22.4355606", "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-08-02T23:12:22.4355606", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "by8R8zadVkWdh0+OEpxPrw==", "checkoutFormGuid": "f3112f6f-9d36-4556-9d87-4f8e129c4faf", "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 ��[g�� 5 xl/workbook.xml � (� ����0D�&�C��T AR8q����Zi�-ik��H�yۙ�};b��Zۓ��/\I�Ƃ1/;��OvD3�Z�4�Y��m�$�V�5���I�1�e�����J���G���1�aEiP�V�!bi�P8�(gc�����!���_DEh,i (�έ))��j�Y�K˹LH9�tg�0����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 ��[Q��' ' _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="R8754f3b2eae3442b" /></Relationships>PK ��[|s��� � xl/worksheets/sheet1.xml � (� ��A�� �� ý"�ug����:=t�V1:�����/�l$��ً��<���=��8 �{9�!b�e�O�L�%�Ev��EwB`�IoT;c��t݉�ҁ܋Ɏ�R���]�C�m�Zle}�dP�1Rb���Jw�^�s�����JT�[�8�K�U?�"kz[}^=P���#ޔTd��~�s�?R�̝MC�".��?hD[�K���~��I�9���������zu�SߘζH�bSJ��CP����2���ُ?��$ fq�)���}�,>��O�Bb��I£�}���>[|v�y��'�$�`����W�vvN��8�������l[��Ȕ<�m���h�ڝ�=<m�̱3t�݅x� |K|������%���%J�`�`�t�5]�9�*�O�U:�HV�|"]�� �������#�|��|>����|>���^�;�:zsS;�� UJi�rw���PK ��[f�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;�*6��Ɠ�H��6m9��W�E�6H]t�j4��'�|^?���q`�b�Y`���Ωy�a�Y�i0)OĮ�"�+.j�R��9���hb�'r���0�������ɴ�K!�<�p�d��D�!���v�#�����p�Qv4�����-�"S��X �emV�FJT�(I50�0��.�_��|&c�BY٪��*�>T�3��!�|�Ӽ<S�,"�Jɕ�J����|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 ��[� ��2 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{���J'm�mN��̒�5�$5I����� ҩO>����9')�Eo`�4�� �1͍��X�LJU�c�<ӂ�FC�p-��9�B�v%n��(u��1��U̇���,0� �Z��qF�#nz����^���/VȪ�Ս ��A�-�� z�ce�K1V1[����G��p�4��~p�<���<N��,ɣ��y4q��t����0�����Z�9J��'��S����:� Vrr+�Nv��a�����Ynj�5��]���bz�.���s������OPK- ��[g�� 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[Q��' ' U _rels/.relsPK- ��[|s��� � � xl/worksheets/sheet1.xmlPK- ��[f�� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E / xl/styles.xmlPK- ��[� ��2 ~ � xl/sharedStrings.xmlPK � (
application/vnd.ms-excel
Sample:
PK ��[A�䐷 5 xl/workbook.xml � (� ����0D�&�C��(�N\�z��bhK��|o�vfg����kcz�Q�v�-��~�s�@�dF�a���i_�t�l�2�[���E �8��F;!GGW�?,7Z�� D���@jZ���S�����l���o�/��bQD�V��Ź�=Sbs�G�m�Y�� ��qLw��l�]~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="Rac9cff2f8f294dab" /></Relationships>PK ��[|s��� � xl/worksheets/sheet1.xml � (� ��A�� �� ý"�ug����:=t�V1:�����/�l$��ً��<���=��8 �{9�!b�e�O�L�%�Ev��EwB`�IoT;c��t݉�ҁ܋Ɏ�R���]�C�m�Zle}�dP�1Rb���Jw�^�s�����JT�[�8�K�U?�"kz[}^=P���#ޔTd��~�s�?R�̝MC�".��?hD[�K���~��I�9���������zu�SߘζH�bSJ��CP����2���ُ?��$ fq�)���}�,>��O�Bb��I£�}���>[|v�y��'�$�`����W�vvN��8�������l[��Ȕ<�m���h�ڝ�=<m�̱3t�݅x� |K|������%���%J�`�`�t�5]�9�*�O�U:�HV�|"]�� �������#�|��|>����|>���^�;�:zsS;�� UJi�rw���PK ��[9u]�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�mR'��vÆm�\{GM��v���G� XEWb�������4����ٽM#yAg, �rz���s��m7{eL�s i�&�yMiP' 7�M���IƔ���R�d�t��>g�-�.3���nP���yB� �W�O� F �{�~J�^âHT OZ�����M��Z�)K �nj!^F�^�y&S�G��aj�몭�]e����O�Ν�r��Z"k�����W5z��/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 ��[� ��2 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{���J'm�mN��̒�5�$5I����� ҩO>����9')�Eo`�4�� �1͍��X�LJU�c�<ӂ�FC�p-��9�B�v%n��(u��1��U̇���,0� �Z��qF�#nz����^���/VȪ�Ս ��A�-�� z�ce�K1V1[����G��p�4��~p�<���<N��,ɣ��y4q��t����0�����Z�9J��'��S����:� Vrr+�Nv��a�����Ynj�5��]���bz�.���s������OPK- ��[A�䐷 5 xl/workbook.xmlPK- ��[���� � [Content_Types].xmlPK- ��[}Ă�' ' V _rels/.relsPK- ��[|s��� � � xl/worksheets/sheet1.xmlPK- ��[9u]�� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E 1 xl/styles.xmlPK- ��[� ��2 ~ � xl/sharedStrings.xmlPK � *