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": "oT/C09aneUOcWMZ5a9pUSQ==", "identifierGuid": "d3c23fa1-a7d6-4379-9c58-c6796bda5449", "name": "sample string 2", "formType": "sample string 3", "forms": [ { "$id": "2", "id": 1, "g_UID": "KC6zLOWbM069Rr2tVJbohQ==", "guid": "2cb32e28-9be5-4e33-bd46-bdad5496e885", "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": "ychBXgLoHkWKRBqr4fZshA==", "previousFormGuid": "5e41c8c9-e802-451e-8a44-1aabe1f66c84", "nextForm": 1, "nextFormG_UID": "YEQzTYCdO0CN8xHybxGHlw==", "nextFormGuid": "4d334460-9d80-403b-8df3-11f26f118797", "attributes": "sample string 10", "updated": "2025-06-14T06:23:08.5581027", "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": "uE5Gmv7jVESZJWuopFaHag==", "checkoutFormGuid": "9a464eb8-e3fe-4454-9925-6ba8a456876a", "identifier": "UaJiPa9KSUKcvyR0XQoYGw==", "identifierGuid": "3d62a251-4aaf-4249-9cbf-24745d0a181b", "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": "UhIGX/kuy0K9o7Q15/z/Wg==", "valueGuid": "5f061252-2ef9-42cb-bda3-b435e7fcff5a", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-06-14T06:23:08.5581027", "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-06-14T06:23:08.5581027", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "Wzv56eVhK06plA7mWYFq+g==", "checkoutFormGuid": "e9f93b5b-61e5-4e2b-a994-0ee659816afa", "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 �2�Z�~y'� 5 xl/workbook.xml � (� ����@�{����䠢���_`��O�����O ��ۙ��v�h\_ӳ���\]6���)�'cIO��8�a���M�ʚJS���/Q�pGi������ay��5�(�RCq<0&�fOI�_�dlug��5�Sb���b�Pb@`�sor8s���G|C�������-Nag�0����PK �2�Z���� � [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 �2�Z$�U�' ' _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="R9665428d786b4d41" /></Relationships>PK �2�Z��� � 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���ُ?��$ BF8g<���O�\�g! 1M�$���>]|�I�->��<xJq���p~��x���;;� Kc�bz�G�cpg��LUdJ��rö��z�M�N���W�X�:��B<��%��DtKl}���|���O��l�K��.�x��'�*�O$�t>����^msy���k>�a>�X��u>�X�� /�d�����}҄*�4B��|yf��PK �2�Z~�gl� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�!N��ݰa[z��3��&vd�@�Ƃ#q�"A*�`��h~OO��|�Xoߦ�����-Y��r�`�NQ�հݬw4bL�s`iņL���M27�M���1���3�#�����~ɀk&۟g��i=(zt�4�������`�"�=��b?��/���S��N4�y�B�������B<�~���L�h!�~Pu����2=u�ѧK/����XvRH�U*Q]���_l� PK �2�ZЃ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�Zu,/�3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{��ݺU�,���OC0&wk�Ij���ӛ�A�S�|����sN�/�U���:it��d�hn���?�V�#��1 ܃�hQ��yZ�+p�}{E��5(�iA�`�b>��H]k� Wx��x4J�bRc�M�}Xc�i��A�� Y澼��<H�9�eNOt��;)��S0d�pӮo�n�LCsA�{�A�����q(���Ɂ�#6i4IfY���<��,K��N&ٰ�1�62�!r�-'��S����:� Vrr+��r�4;�%#�#��Tdk9�&U ��t�T]����4�ͧ���PK- �2�Z�~y'� 5 xl/workbook.xmlPK- �2�Z���� � � [Content_Types].xmlPK- �2�Z$�U�' ' U _rels/.relsPK- �2�Z��� � � xl/worksheets/sheet1.xmlPK- �2�Z~�gl� P � xl/_rels/workbook.xml.relsPK- �2�ZЃc'2 E / xl/styles.xmlPK- �2�Zu,/�3 ~ � xl/sharedStrings.xmlPK � )
application/vnd.ms-excel
Sample:
PK �2�Z���M� 5 xl/workbook.xml � (� ����0D�&�C��"J������ڒ�?�R�7o;��o����Z��#esSR�ܘ3f��A�����F��Ҽ��:�`���D�XEgfp '��\��.�Xv4��NJ�P���)�f�� �k��$l ��T`�EPD�Ē�����ڒ)1���=���% �iw�@F7�+����PK �2�Z���� � [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 �2�Z �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="Radb6ae0cfb0549ed" /></Relationships>PK �2�Z��� � 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���ُ?��$ BF8g<���O�\�g! 1M�$���>]|�I�->��<xJq���p~��x���;;� Kc�bz�G�cpg��LUdJ��rö��z�M�N���W�X�:��B<��%��DtKl}���|���O��l�K��.�x��'�*�O$�t>����^msy���k>�a>�X��u>�X�� /�d�����}҄*�4B��|yf��PK �2�Z��2� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞��7�i7l�-���㨉�n�gc���V� �X��j4��'�|���o�����`Mi"���L��)��l7�=�����Y\1���ȹ�4M�;��e݄!���3vG�gBT�-p�d��L�!Z����lw�Ȅ?��պ��D�]O�����א&� l'[ؗ�̛:�)+U����������w��A%����0m ,�]e4:����K/���Z*rU��+%�F������PK �2�ZЃ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�Zu,/�3 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{��ݺU�,���OC0&wk�Ij���ӛ�A�S�|����sN�/�U���:it��d�hn���?�V�#��1 ܃�hQ��yZ�+p�}{E��5(�iA�`�b>��H]k� Wx��x4J�bRc�M�}Xc�i��A�� Y澼��<H�9�eNOt��;)��S0d�pӮo�n�LCsA�{�A�����q(���Ɂ�#6i4IfY���<��,K��N&ٰ�1�62�!r�-'��S����:� Vrr+��r�4;�%#�#��Tdk9�&U ��t�T]����4�ͧ���PK- �2�Z���M� 5 xl/workbook.xmlPK- �2�Z���� � [Content_Types].xmlPK- �2�Z �T' ' V _rels/.relsPK- �2�Z��� � � xl/worksheets/sheet1.xmlPK- �2�Z��2� P � xl/_rels/workbook.xml.relsPK- �2�ZЃc'2 E / xl/styles.xmlPK- �2�Zu,/�3 ~ � xl/sharedStrings.xmlPK � )