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": "p4lRVW+lTE+A0m7QDvB6Xg==", "identifierGuid": "555189a7-a56f-4f4c-80d2-6ed00ef07a5e", "name": "sample string 2", "formType": "sample string 3", "forms": [ { "$id": "2", "id": 1, "g_UID": "jlBHS1THPE2ZehV+Z23O3Q==", "guid": "4b47508e-c754-4d3c-997a-157e676dcedd", "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": "KKTMDcV2/E20tiIgDysBDg==", "previousFormGuid": "0dcca428-76c5-4dfc-b4b6-22200f2b010e", "nextForm": 1, "nextFormG_UID": "S7NZhBtvLkOaqRea+rCGFg==", "nextFormGuid": "8459b34b-6f1b-432e-9aa9-179afab08616", "attributes": "sample string 10", "updated": "2025-10-04T04:00:46.7168256", "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": "dSOUOEaF7kO/KxwLugLCNA==", "checkoutFormGuid": "38942375-8546-43ee-bf2b-1c0bba02c234", "identifier": "jN/rLX0d2U2JjbeYiPdtTw==", "identifierGuid": "2debdf8c-1d7d-4dd9-898d-b79888f76d4f", "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": "nTenqmtlxEKgZcDHJEgSag==", "valueGuid": "aaa7379d-656b-42c4-a065-c0c72448126a", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-04T04:00:46.7168256", "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-04T04:00:46.7168256", "imageData": "QEA=", "readOnly": true } }, { "$ref": "3" } ], "panels": [ { "$id": "5", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "p4L2lOMKPEirrMPPrfkaHA==", "checkoutFormGuid": "94f682a7-0ae3-483c-abac-c3cfadf91a1c", "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[�L�� 5 xl/workbook.xml � (� ����0��&�C������x�ུ�m�?ik��-%�x�3;��4�q�`̄>j־v-!ؚ�(�/Ƃ���8EC��E�8J�ao:�"�*�`�A텴o�X�:����� ��Ը;�j�fO �O2{��Dd��T�`�ERHS-�i�%��[�c�j��c9���eU�`��쿻/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="R59443c10e3844925" /></Relationships>PK D[C%�� � xl/worksheets/sheet1.xml � (� ��O�� �� ý�W��qg�4��:=�g�������/�l$���0<�?`(�^�=8)c{=�!I0j�uӏ�5<����Oeq���vJ9��Ѯ�v�VٺSCe}P�k�*�f�t������8��!�q���W�Oe��`�ڿԲ��&,a�_J U?²hz_}Z=0�]�g��2PY�G���MLI~i�2u�6k��"x&�f@���w�����w����{�`觭�`�^���7��-���8�8'"�G���s�S���٧W���cIi.�����l��m~��sLx�I)��>�}��~:���Y"rN$�� ����l���/?��2�3���G�cg��\UF�� þ��z�MN���W�T��&w&>��'>��'61���1��mL�W�`�t��FN�Hb�.&�"]L�t1Aۼ}�����-�k��X拉e��X拉(�d�����Ҕ�j� w��̖�PK D[��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�O5� ��8�8��ؖ�=�����ĂMW��==i���c�{[�>�����i�l�NQ�q�m7{\DLa�] iń���AN��PX�&u����)�#uBň�*ˎ���Lr8;��j=K|�����0!F �G�=���V$*�'��^ %��!CU7]S�7S�`����3��n����m�5��7���G�}�t3��m�*�⃮�{�5z��/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[���1 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{���۔��6'���v 6I�M����� ҩO>����9'ɖ�%o�PY�� �)SY��!��u���0R��@N@J�E��Ih5�����s�������NJw��9 �[���k�%��kJz�^{(�@X���7�W��q_d�H�ʦWr�� c�7��G�c��3z?�ͮ�Oc1M���R�#���hZO�h�$���c��H�v��]!c"'����/甶m��� �m��S�U�'���F�����[mK���N�Y�@�b{�����S������OPK- D[�L�� 5 xl/workbook.xmlPK- D[���� � � [Content_Types].xmlPK- D[٬'�' ' U _rels/.relsPK- D[C%�� � � xl/worksheets/sheet1.xmlPK- D[��� P � xl/_rels/workbook.xml.relsPK- D[Ѓc'2 E / xl/styles.xmlPK- D[���1 ~ � xl/sharedStrings.xmlPK � '
application/vnd.ms-excel
Sample:
PK D[��G� 5 xl/workbook.xml � (� ����0��&�C��@���x��})[i�?ik��-%�x�3;��Գq�ޘ��I��5t�V�y>�2u� ��(ݓ!$���BX�eW�p� �������X�:����AM+J�Դ=��f��O2[��$l ��T�`�ERD�v���܆�攸J���s� �e������a5�~�_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[�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="R380dea3f622342fc" /></Relationships>PK D[C%�� � xl/worksheets/sheet1.xml � (� ��O�� �� ý�W��qg�4��:=�g�������/�l$���0<�?`(�^�=8)c{=�!I0j�uӏ�5<����Oeq���vJ9��Ѯ�v�VٺSCe}P�k�*�f�t������8��!�q���W�Oe��`�ڿԲ��&,a�_J U?²hz_}Z=0�]�g��2PY�G���MLI~i�2u�6k��"x&�f@���w�����w����{�`觭�`�^���7��-���8�8'"�G���s�S���٧W���cIi.�����l��m~��sLx�I)��>�}��~:���Y"rN$�� ����l���/?��2�3���G�cg��\UF�� þ��z�MN���W�T��&w&>��'>��'61���1��mL�W�`�t��FN�Hb�.&�"]L�t1Aۼ}�����-�k��X拉e��X拉(�d�����Ҕ�j� w��̖�PK D[>���� P xl/_rels/workbook.xml.rels � (� ��An� E��f_c";��8�d�m�L`�����ٺ�z��Tj��E7Y��OO3|���o��^ȇњDQ##�M��9�����&��FFXzbBC��� �1֑Im��1���� {⋲\r�3��G�!Z�GI;+�3����Z Qv@�S��' �z�"Q�=��RP�(���T-����e����]g25�� �ꈢ�T��*3�'�}�t�Ǚ%��ͪ�*ͩ�����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[���1 ~ xl/sharedStrings.xml � (� ��_K�0ſJ�{���۔��6'���v 6I�M����� ҩO>����9'ɖ�%o�PY�� �)SY��!��u���0R��@N@J�E��Ih5�����s�������NJw��9 �[���k�%��kJz�^{(�@X���7�W��q_d�H�ʦWr�� c�7��G�c��3z?�ͮ�Oc1M���R�#���hZO�h�$���c��H�v��]!c"'����/甶m��� �m��S�U�'���F�����[mK���N�Y�@�b{�����S������OPK- D[��G� 5 xl/workbook.xmlPK- D[���� � � [Content_Types].xmlPK- D[�u-�' ' T _rels/.relsPK- D[C%�� � � xl/worksheets/sheet1.xmlPK- D[>���� P � xl/_rels/workbook.xml.relsPK- D[Ѓc'2 E / xl/styles.xmlPK- D[���1 ~ � xl/sharedStrings.xmlPK � '