GET api/checkoutforms/{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 CheckoutForm| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| G_UID | Collection of byte |
None. |
|
| Guid | globally unique identifier |
None. |
|
| ZoneID | integer |
None. |
|
| StoreID | integer |
None. |
|
| Name | string |
None. |
|
| FormType | string |
None. |
|
| LocationX | integer |
None. |
|
| LocationY | integer |
None. |
|
| Width | integer |
None. |
|
| Height | integer |
None. |
|
| Maximised | boolean |
None. |
|
| Resizable | boolean |
None. |
|
| BackgroundImage | string |
None. |
|
| BackgroundColour | string |
None. |
|
| BackgroundColourA | integer |
None. |
|
| BackgroundColourR | integer |
None. |
|
| BackgroundColourG | integer |
None. |
|
| BackgroundColourB | integer |
None. |
|
| FontFamily | string |
None. |
|
| FontSize | decimal number |
None. |
|
| FontStyle | integer |
None. |
|
| PreviousForm | integer |
None. |
|
| PreviousFormG_UID | Collection of byte |
None. |
|
| PreviousFormGuid | globally unique identifier |
None. |
|
| NextForm | integer |
None. |
|
| NextFormG_UID | Collection of byte |
None. |
|
| NextFormGuid | globally unique identifier |
None. |
|
| Attributes | string |
None. |
|
| Updated | date |
None. |
|
| Positioning | integer |
None. |
|
| ContentPanel | string |
String length: inclusive between 0 and 60 |
|
| SelectionMode | integer |
None. |
|
| MaximumSelections | integer |
None. |
|
| AlteredInStore | boolean |
None. |
|
| Deleted | boolean |
None. |
|
| BlueprintID | integer |
None. |
|
| PreserveLayout | boolean |
None. |
|
| MainCheckoutFormName | string |
None. |
|
| NextCheckoutForm | CheckoutForm |
None. |
|
| PreviousCheckoutForm | CheckoutForm |
None. |
|
| Buttons | Collection of CheckoutButton |
None. |
|
| Panels | Collection of CheckoutPanel |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"id": 1,
"g_UID": "ZCJ8h4Cex0C7iTGEC5EW5A==",
"guid": "877c2264-9e80-40c7-bb89-31840b9116e4",
"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": "76ZYQnv50UeSMINGXLy+YQ==",
"previousFormGuid": "4258a6ef-f97b-47d1-9230-83465cbcbe61",
"nextForm": 1,
"nextFormG_UID": "WK4DgmWxfUWZxwYb05Hfsw==",
"nextFormGuid": "8203ae58-b165-457d-99c7-061bd391dfb3",
"attributes": "sample string 10",
"updated": "2026-04-03T06:20:24.6827592",
"positioning": 1,
"contentPanel": "sample string 11",
"selectionMode": 1,
"maximumSelections": 1,
"alteredInStore": true,
"deleted": true,
"blueprintID": 1,
"preserveLayout": true,
"mainCheckoutFormName": "sample string 13",
"nextCheckoutForm": {
"$ref": "1"
},
"previousCheckoutForm": {
"$ref": "1"
},
"buttons": [
{
"$id": "2",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "tWQtVHh/o02Z5pn3G/k8Yw==",
"checkoutFormGuid": "542d64b5-7f78-4da3-99e6-99f71bf93c63",
"identifier": "rymo9m9/KEGu0pspfTGQ5g==",
"identifierGuid": "f6a829af-7f6f-4128-aed2-9b297d3190e6",
"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": "OseM+5RUZkGHsrbcnpZeeg==",
"valueGuid": "fb8cc73a-5494-4166-87b2-b6dc9e965e7a",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-03T06:20:24.6827592",
"action": "sample string 12",
"valueForm": {
"$ref": "1"
},
"image": {
"$id": "3",
"name": "sample string 3.sample string 4",
"imageID": 2,
"imageName": "sample string 3",
"imageExtension": "sample string 4",
"lastUpdate": "2026-04-03T06:20:24.6827592",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "2"
}
],
"panels": [
{
"$id": "4",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "FOcXhK178UyiXBREW8SHcg==",
"checkoutFormGuid": "8417e714-7bad-4cf1-a25c-14445bc48772",
"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": "4"
}
]
},
{
"$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�\���[� 5 xl/workbook.xml � (� ����0D�J��(�P�!`b�ڡ�S"H��T��A u��;��/��j��)h�ܔ1f�%؋�P-�N n���t+ݼ%*�� ���Nhe{1Y���a�� ��Gtr�P����DH�6{
������]M¶�M�v\xEH,h(�ν-���ex$<�(��a�㘧=�,g���PK �2�\���� � [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�\XFh' ' _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="R74b3e1956d574175" /></Relationships>PK �2�\��<\� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6�$�܀\H�惗��l����e��ΑyHL�3�v�8x�gz��]��zvؗ�����U=��~��������z�k1��e/�g�g���x��}6,���t�(��j֮��t�_�����Uu\_�M��r B����.�V���v��O�����#LoZM��Y��`4 �W�����a����s��Gk��Iu�h|�_]�Z}q2:�5v��Z�~6�����SM~���%����o�{�Ɋ�~o:����~2Z����J諻Ų�^>����u���m��B4J)��6]��z�֣+���8���W�z�ȹ��N?��l���Z(!�jf�z���O�w�z����hD��9.]�7��qn�t8�A��e�\���H��Va������<��`��"�}�CT�����io�0��ܹ���Nh� �H �c�CT����w@�L8LN�2jO6��
g�B+ 9���mv�1�*k��r��������p~#�w��fT�����A{0 Q� �h"�Z�G��6�Qi����R)p6�$�ZlEf�&<�� jZ���JZ�2@�"초�pN�P,@�\�@�"��'�B�VC�#�=ŨEhhQ��AJ��2�Z<��PHs<D-�o��.m��`�L�ZĆ�p!R�w��N�Q��Ӣ���`%��3�f��Dx�)��06e�
��_��IliR:�� �,5��9�7�Q�h�j�ZD�|nT�B����d��Et����`��{t�Zĝ�-gܞ��E�Ӣ2E8�X�tNHk2��|j��E�ӢuH%�-�QW��E�Ӣ�E��ma����������x�����|���>���b��ރ�����8�^�n/��F��"��8�"�����Pmī.B����F��"lq�E�6ⴋ�m�[�1B�;BX}�@���#!Ğ1��9!�^0��'B���@�_�v�2��%!�~c ��������vKƄ@�-��H.+a�d̈�⒱#�KƐHH.K"a�dL��撱%R�c"�q&R�k"��&R�s*�3�NEyf�v<B�o�v��"&�_@�!y(/y&��h�7�h�3�i�3����$�Nkok�p��!��GB�u���<�v�X��X��I!i�R�� :%yr_;]&־�U���t��ء,�[��y4M=�=��i�G����vV�W�ة�?i��S
RV*O�.O����U�a��q��7 c/Mo �_����3���[���T�D*cV|/M��4��k4���4�M���Nk������w�H4����2�����<�v�X��X����ʭ�t*'v�L�}˫�;3(M��e�ߢd��Me�I�E2����S7�S
RV*O�.O����U�a��qW7�L'����1�N*3�ʃ�OL��pT�_�����������_PK �2�\�%��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;�I��
�n)p��G$�eZ��E��+ԢR�.�a5��ӓf>�?6��i$�a���Eƀ�QV���ۧ
v��G�D�HZ1��>F��4�'2�ФNk�$cJ}G�T'�!���p�$ǫ��m�
�V�'4�0}��z��(}����R����ȳ��P�B��+���
�aj!^G�^��LFWz���F(œ�Cez�Q�D�.=w��gj,MS9[���%��ѻ��~PK �2�\Ѓ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�\e� �t � xl/sharedStrings.xml � (� ��YO�0��J��lm�Q[D�2H!͂F3Nr�Z$vǾA�_?N�&��y�����s���c]Y $�lj�o[�
^R��ڷ7'Nj[ +I�L��m�&R���29�7��O�'�
�D�|L�5A�)֞�
�� `]y#ߏ��Pf[oN�(�����
,^��Mpvv4�p6�g���Alh����ȅA� 5�u��v��� �����_h�����z�}uIiM%hǹI�H^iۙ��~-�s�YM�x�+ވ}�p_�վ��}s�i�'��Uk"���p7J�Vw�R���.o�c���xD��/�q�Wh��QмA�}r�- �)��vS
�Ge 0�$*-�PAэ[�R�l��~���rX!(�خy��H�3�t^5����f ��I�CP��@q�X盩5;O��|t�C5��p؝�z�J�ڝ�w?�0M�b4�C'��wB�H�<O3g���gAC�#I��@=�ʢ�
㸏oD�y�~H2��a��q8�R��YeI�I8�h�;�8��"/r�͖�?&�NđFI�d��Ə��gA������=\[�ǵ����0�L
�k�J��˅����""ݡ��̀z�^�=��9��+���ٟ�����-���=�Þ�PK- �2�\���[� 5 xl/workbook.xmlPK- �2�\���� � [Content_Types].xmlPK-
�2�\XFh' ' V _rels/.relsPK- �2�\��<\� l � xl/worksheets/sheet1.xmlPK- �2�\�%��� P � xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
xl/styles.xmlPK- �2�\e� �t � � xl/sharedStrings.xmlPK � U
application/vnd.ms-excel
Sample:
PK �2�\@��ֶ 5 xl/workbook.xml � (� ��;� D�H�� ���r�6E��Y������R�t;��oG�>4��
����,�T��e��Z�����a�|��^�+ej,}���;p~a[Hƻ�M�L���� �FL��Q���vC��=
�q����M���M� �^L�8���P29w��=%!3��)y���s���8]�+L��w�PK �2�\���� � [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�\�`�j' ' _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="R1503e903d1a74fd3" /></Relationships>PK �2�\��<\� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6�$�܀\H�惗��l����e��ΑyHL�3�v�8x�gz��]��zvؗ�����U=��~��������z�k1��e/�g�g���x��}6,���t�(��j֮��t�_�����Uu\_�M��r B����.�V���v��O�����#LoZM��Y��`4 �W�����a����s��Gk��Iu�h|�_]�Z}q2:�5v��Z�~6�����SM~���%����o�{�Ɋ�~o:����~2Z����J諻Ų�^>����u���m��B4J)��6]��z�֣+���8���W�z�ȹ��N?��l���Z(!�jf�z���O�w�z����hD��9.]�7��qn�t8�A��e�\���H��Va������<��`��"�}�CT�����io�0��ܹ���Nh� �H �c�CT����w@�L8LN�2jO6��
g�B+ 9���mv�1�*k��r��������p~#�w��fT�����A{0 Q� �h"�Z�G��6�Qi����R)p6�$�ZlEf�&<�� jZ���JZ�2@�"초�pN�P,@�\�@�"��'�B�VC�#�=ŨEhhQ��AJ��2�Z<��PHs<D-�o��.m��`�L�ZĆ�p!R�w��N�Q��Ӣ���`%��3�f��Dx�)��06e�
��_��IliR:�� �,5��9�7�Q�h�j�ZD�|nT�B����d��Et����`��{t�Zĝ�-gܞ��E�Ӣ2E8�X�tNHk2��|j��E�ӢuH%�-�QW��E�Ӣ�E��ma����������x�����|���>���b��ރ�����8�^�n/��F��"��8�"�����Pmī.B����F��"lq�E�6ⴋ�m�[�1B�;BX}�@���#!Ğ1��9!�^0��'B���@�_�v�2��%!�~c ��������vKƄ@�-��H.+a�d̈�⒱#�KƐHH.K"a�dL��撱%R�c"�q&R�k"��&R�s*�3�NEyf�v<B�o�v��"&�_@�!y(/y&��h�7�h�3�i�3����$�Nkok�p��!��GB�u���<�v�X��X��I!i�R�� :%yr_;]&־�U���t��ء,�[��y4M=�=��i�G����vV�W�ة�?i��S
RV*O�.O����U�a��q��7 c/Mo �_����3���[���T�D*cV|/M��4��k4���4�M���Nk������w�H4����2�����<�v�X��X����ʭ�t*'v�L�}˫�;3(M��e�ߢd��Me�I�E2����S7�S
RV*O�.O����U�a��qW7�L'����1�N*3�ʃ�OL��pT�_�����������_PK �2�\Y��&� P xl/_rels/workbook.xml.rels � (� ��An� E����`�q�($�l�Ms��b�6g�G��R�%R�d��<������ٽ����5����r4�稞Z��n0�n=����1�5!Ah�y(��:����T��8.N| RQ��3�=��C�J��V�g0�0y��4@���� ��(��Q��ѳd��)���rE)�Z�i|�0���_��:�Yʾ�h��=tu�P�=ȗ�Ӧs�<�Ԫ�nD�բ�˺T�M�����PK �2�\Ѓ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�\e� �t � xl/sharedStrings.xml � (� ��YO�0��J��lm�Q[D�2H!͂F3Nr�Z$vǾA�_?N�&��y�����s���c]Y $�lj�o[�
^R��ڷ7'Nj[ +I�L��m�&R���29�7��O�'�
�D�|L�5A�)֞�
�� `]y#ߏ��Pf[oN�(�����
,^��Mpvv4�p6�g���Alh����ȅA� 5�u��v��� �����_h�����z�}uIiM%hǹI�H^iۙ��~-�s�YM�x�+ވ}�p_�վ��}s�i�'��Uk"���p7J�Vw�R���.o�c���xD��/�q�Wh��QмA�}r�- �)��vS
�Ge 0�$*-�PAэ[�R�l��~���rX!(�خy��H�3�t^5����f ��I�CP��@q�X盩5;O��|t�C5��p؝�z�J�ڝ�w?�0M�b4�C'��wB�H�<O3g���gAC�#I��@=�ʢ�
㸏oD�y�~H2��a��q8�R��YeI�I8�h�;�8��"/r�͖�?&�NđFI�d��Ə��gA������=\[�ǵ����0�L
�k�J��˅����""ݡ��̀z�^�=��9��+���ٟ�����-���=�Þ�PK- �2�\@��ֶ 5 xl/workbook.xmlPK- �2�\���� � � [Content_Types].xmlPK-
�2�\�`�j' ' U _rels/.relsPK- �2�\��<\� l � xl/worksheets/sheet1.xmlPK- �2�\Y��&� P � xl/_rels/workbook.xml.relsPK- �2�\Ѓc'2 E
xl/styles.xmlPK- �2�\e� �t � � xl/sharedStrings.xmlPK � T