GET api/store/{storeID}/zone/{zoneID}/checkoutforms/{formType}?relations={relations}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| storeID | integer |
Required |
|
| zoneID | integer |
Required |
|
| 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": "DPFA/Uj1bEO5D2XqVDPkZw==",
"guid": "fd40f10c-f548-436c-b90f-65ea5433e467",
"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": "UdriI3Y8+k6C2rxKApx3Gw==",
"previousFormGuid": "23e2da51-3c76-4efa-82da-bc4a029c771b",
"nextForm": 1,
"nextFormG_UID": "Ny9yvu+gyUeAtcd4RlK3Ig==",
"nextFormGuid": "be722f37-a0ef-47c9-80b5-c7784652b722",
"attributes": "sample string 10",
"updated": "2026-04-02T21:01:59.3917328",
"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": "qnXy923nykO2jF0czI+E3w==",
"checkoutFormGuid": "f7f275aa-e76d-43ca-b68c-5d1ccc8f84df",
"identifier": "K9j3nuLKa0ScwEZuYP6FkQ==",
"identifierGuid": "9ef7d82b-cae2-446b-9cc0-466e60fe8591",
"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": "5vj6/nTq5UuTALx8y/ADVA==",
"valueGuid": "fefaf8e6-ea74-4be5-9300-bc7ccbf00354",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-02T21:01:59.3917328",
"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-02T21:01:59.3917328",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "2"
}
],
"panels": [
{
"$id": "4",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "LXy+1ieTt0WrIrzUwi1W3A==",
"checkoutFormGuid": "d6be7c2d-9327-45b7-ab22-bcd4c22d56dc",
"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 =��\�+��� 5 xl/workbook.xml � (� ����0��&�C��`���x�པ�m�?ik��-%�x�3;��4�q�`̄>j־v-!ؚ�(�/Ƃ�;n��!J�"�sɠ7�@rͲ�8�i�F{!�������@P�RTjܝO5k����'���j"���o�I��")����4P��s[�c�j�Gy+F�W0��,C;��5d��}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="Rd79fbc44d67941ea" /></Relationships>PK =��\�'�}� k xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!�
ȅ$o>x�]�^�6!�dcٻ�s$C�A=�QowkC������T�Ť��e!��jvU�&�_�����?����ྞ�^��j�������?^.o�
��q5.�������z>.÷�_���zrU�Ww�j��f0�n�˰�b<�]����kq;����ӛ�V��d�?:MB���yu}�/��������mR�/�{���[Wߜ��b�t����{��zxw�����V�_�e`I�k����ko:Yq��M���OF��a�R }u�X��ˇ�X�P�:��I,�A��^Zo�����m=��#hV� ]�6��c�M�~d��ԙ�qUa�PB*o���y��>��m�ݮ^B��i�@�t����ƹ����-���r)�L�#��[�=Va2JLB��ރqR�0���Qd{k��� �r�:�;�I[��.L %X��QqR7;��3�0�q��ړ
��Y���
AB���>i��r����M�Q�5;x�o�����ӌ
��=�7>�a&!j�MQ�����4*MR�[*�f�Q�����'��D-BC�� 4ZI��P&��Z���^� %��W:�C�"��'�B�VC�#�=ŨEhhQ��AJ��2�Z�<�S���8Ġ�L��E��ͥ�p�a���E(\�T��)�!jwZ����佔�qfԌQ�O=��Ʀ�L����5�-MJ���=��&Q7g ��f2j�#]�Q�h�� Í*U�cW������9}��X9b�Q���"`��ۓA��vZT����� i3~PQ�J>�CԢ�iѺ��^��ʨ��UԢ�i��"d{��0�������v��{<\���}o�^�W���q�~g�������H��j7�]�l#^v�Fw�F��"T��mě.´o��F�t��8�"|�a�����V?0B�GBx��@�g�0{�@��p���r�0��WFm��o��{�@��a�!��d �ݒ1!zKƆ@�-9#�KƊ@.3"��d숄�1$�KƒHX.S"��dl��gƘHyf���gƚHyf���gƜ��̸SQ�{�σ���]�æ�I��mH�KB��qs���5��Lk��f}�|'����ڻ��{f$"�y�GB����e�%�<O�]$�>'־tG�D�_[��?�NIG�ܷ�N����y��`%]~&v(��%cMS�q��}Z�QF��gg
��/A��RC3~�4>ߤ��T��E]��Iy���\%�.Mo �^�� ��:�3C�9g0;+�Rw���TƬ�^2���h*7�h*3�i*3�ʉ�$�Nk�kh*�!MeBS91�yb�"��9���;R'�[��TN�t�X��W�fP�ʉ�2�Eɘ������-�dR954�n*���T��E]��Iy���\%�n*3�N*�9c0�Tf04��ߘ��ᨚ���e5_�Ne�?�G�PK =��\S��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8NZ��ݰ���=��&vd����G�
XEWb�������4����M#9���-���V:5ؾ�S�K�n�{EL�s iņL���
N"nF�:��IĔ���BE��*ˆ���Lr�����z����iB� �W�� F �{�-���V$*��ja_/�Ҭ�N65� B��e�����g2��O
r��#����K��ҹS^��ԢZ(��9�uwU�7��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 =��\횔Oq � xl/sharedStrings.xml � (� ��YO�0��J��,�ڎ�"Z�A��h4�q���"�3���~�2 pL2��]o��:�Ǫ������m�,'t��ooN��m �h�JFaa� l�`9BZj({'e����A���j���WH�O��D��b ��|?�*D�ma�P���m5��n`�*�%�r.�gGsO.�^������5�
�u��q��Z2n�/P�v��p��=��a$�a_?�t��r����lwRW7�TD@�8W ����vV�o�r.?��v �Y�>��
��
N�
V}��<A)[�&O��Q�l�n\rx ���
1c��"u��4�n��&<����� tr[�H�Sp��"�TGke Py�(���C ��ayϲ}�굦���R����G�Gj�a�����*�6�p�Z�:����b�o���<}[��Eլ)
����S�[!�rW���:,��/&>v�8�:Q�`'����Ā�(!JR}�@U]�z\�E[+Ɖ�ox��������x�� � G�� q�8ș*��p��`��t��c2H��S�P8Q�g���bGO�$2���1�G�d��:?~"D�3�ݮJ�o֮�*���p��7�
{i�(p��s"��ݿ���^�������S?��PK- =��\�+��� 5 xl/workbook.xmlPK- =��\���� � [Content_Types].xmlPK-
=��\���' ' V _rels/.relsPK- =��\�'�}� k � xl/worksheets/sheet1.xmlPK- =��\S��� P � xl/_rels/workbook.xml.relsPK- =��\Ѓc'2 E
xl/styles.xmlPK- =��\횔Oq � � xl/sharedStrings.xmlPK � Q
application/vnd.ms-excel
Sample:
PK =��\��� 5 xl/workbook.xml � (� ����0��&�C��`
)��x��Э4П�5���H�yۙ��v�l��3�����\��lE��P̟�w�8�B��E�����o:�s���Ă4��z���ay�q? 5�(Ť���]�=%�>�hlu�5D~S4�����f
jܲ�0JΝ�8��U2q�(y��_�km�F����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
=��\��Z�' ' _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="R5bf5cc68e878419f" /></Relationships>PK =��\�'�}� k xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!�
ȅ$o>x�]�^�6!�dcٻ�s$C�A=�QowkC������T�Ť��e!��jvU�&�_�����?����ྞ�^��j�������?^.o�
��q5.�������z>.÷�_���zrU�Ww�j��f0�n�˰�b<�]����kq;����ӛ�V��d�?:MB���yu}�/��������mR�/�{���[Wߜ��b�t����{��zxw�����V�_�e`I�k����ko:Yq��M���OF��a�R }u�X��ˇ�X�P�:��I,�A��^Zo�����m=��#hV� ]�6��c�M�~d��ԙ�qUa�PB*o���y��>��m�ݮ^B��i�@�t����ƹ����-���r)�L�#��[�=Va2JLB��ރqR�0���Qd{k��� �r�:�;�I[��.L %X��QqR7;��3�0�q��ړ
��Y���
AB���>i��r����M�Q�5;x�o�����ӌ
��=�7>�a&!j�MQ�����4*MR�[*�f�Q�����'��D-BC�� 4ZI��P&��Z���^� %��W:�C�"��'�B�VC�#�=ŨEhhQ��AJ��2�Z�<�S���8Ġ�L��E��ͥ�p�a���E(\�T��)�!jwZ����佔�qfԌQ�O=��Ʀ�L����5�-MJ���=��&Q7g ��f2j�#]�Q�h�� Í*U�cW������9}��X9b�Q���"`��ۓA��vZT����� i3~PQ�J>�CԢ�iѺ��^��ʨ��UԢ�i��"d{��0�������v��{<\���}o�^�W���q�~g�������H��j7�]�l#^v�Fw�F��"T��mě.´o��F�t��8�"|�a�����V?0B�GBx��@�g�0{�@��p���r�0��WFm��o��{�@��a�!��d �ݒ1!zKƆ@�-9#�KƊ@.3"��d숄�1$�KƒHX.S"��dl��gƘHyf���gƚHyf���gƜ��̸SQ�{�σ���]�æ�I��mH�KB��qs���5��Lk��f}�|'����ڻ��{f$"�y�GB����e�%�<O�]$�>'־tG�D�_[��?�NIG�ܷ�N����y��`%]~&v(��%cMS�q��}Z�QF��gg
��/A��RC3~�4>ߤ��T��E]��Iy���\%�.Mo �^�� ��:�3C�9g0;+�Rw���TƬ�^2���h*7�h*3�i*3�ʉ�$�Nk�kh*�!MeBS91�yb�"��9���;R'�[��TN�t�X��W�fP�ʉ�2�Eɘ������-�dR954�n*���T��E]��Iy���\%�n*3�N*�9c0�Tf04��ߘ��ᨚ���e5_�Ne�?�G�PK =��\Y�H� P xl/_rels/workbook.xml.rels � (� ��Kn� ���f_�~$��M7٦� ��X���4g�G��R�u�.��
�?��������4�Wt~���,I��V�o��S���#����I|b|:�yM�'�;��e��C,]Og.N�G��iEݒ�Lr����Uj�l�yB� Ӌu'��#w=�~"OoG�D*��l��R+Ye����9�05�#�_��z!SgEQWiY��d<�*��C�\���i/�w�F9!Xǚ����ݿ�~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 =��\횔Oq � xl/sharedStrings.xml � (� ��YO�0��J��,�ڎ�"Z�A��h4�q���"�3���~�2 pL2��]o��:�Ǫ������m�,'t��ooN��m �h�JFaa� l�`9BZj({'e����A���j���WH�O��D��b ��|?�*D�ma�P���m5��n`�*�%�r.�gGsO.�^������5�
�u��q��Z2n�/P�v��p��=��a$�a_?�t��r����lwRW7�TD@�8W ����vV�o�r.?��v �Y�>��
��
N�
V}��<A)[�&O��Q�l�n\rx ���
1c��"u��4�n��&<����� tr[�H�Sp��"�TGke Py�(���C ��ayϲ}�굦���R����G�Gj�a�����*�6�p�Z�:����b�o���<}[��Eլ)
����S�[!�rW���:,��/&>v�8�:Q�`'����Ā�(!JR}�@U]�z\�E[+Ɖ�ox��������x�� � G�� q�8ș*��p��`��t��c2H��S�P8Q�g���bGO�$2���1�G�d��:?~"D�3�ݮJ�o֮�*���p��7�
{i�(p��s"��ݿ���^�������S?��PK- =��\��� 5 xl/workbook.xmlPK- =��\���� � [Content_Types].xmlPK-
=��\��Z�' ' V _rels/.relsPK- =��\�'�}� k � xl/worksheets/sheet1.xmlPK- =��\Y�H� P � xl/_rels/workbook.xml.relsPK- =��\Ѓc'2 E
xl/styles.xmlPK- =��\횔Oq � � xl/sharedStrings.xmlPK � T