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": "w5VXrnh2AE6DLvP8Ulk/Jg==",
"guid": "ae5795c3-7678-4e00-832e-f3fc52593f26",
"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": "4KS0+AwFOEuLaEHGI94wLg==",
"previousFormGuid": "f8b4a4e0-050c-4b38-8b68-41c623de302e",
"nextForm": 1,
"nextFormG_UID": "BbYD5II+YECWr9VjdRXeUg==",
"nextFormGuid": "e403b605-3e82-4060-96af-d5637515de52",
"attributes": "sample string 10",
"updated": "2026-06-03T18:33:38.8140076",
"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": "U29hhdqqS0eK9hohlZhLSg==",
"checkoutFormGuid": "85616f53-aada-474b-8af6-1a2195984b4a",
"identifier": "tHxiFvLqAkKmU2Rznxr5lg==",
"identifierGuid": "16627cb4-eaf2-4202-a653-64739f1af996",
"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": "tDbBu8PoUkWMLE4uAfGP+Q==",
"valueGuid": "bbc136b4-e8c3-4552-8c2c-4e2e01f18ff9",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:33:38.8140076",
"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-06-03T18:33:38.8140076",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "2"
}
],
"panels": [
{
"$id": "4",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "paHD2ha2FEG5BgkilOACrg==",
"checkoutFormGuid": "dac3a1a5-b616-4114-b906-092294e002ae",
"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 3��\���� 5 xl/workbook.xml � (� ����0��J}�(�@!����k��LA~����� �[7�����ٸ�5f$5i_���l���*�cQ��`���{13���to�:�k�d��A텴�n�X�:��Ġ�
�@jZ�O��K���ٯ2{��$l��T��U
+�@ JV��W4��2�.�4MZ��9����>`%��_PK 3��\���� � [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
3��\�v��' ' _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="R5774a9488f1a428f" /></Relationships>PK 3��\,̺ɼ j xl/worksheets/sheet1.xml � (� �Y�R;����Z��RJ�rr!ɛ^bW��Z���?�����9�B�A=�Q��wC�������rV-��`�A���&�ů�����;|~tp_տ�Ӳ\
|�|V�����hy5-��eQݖ��v]���*|[�U�׳�����H0�Guy3^������r�ЭO��m]�'��7����bxt0�����uy}8���?��`tt�A��������(�V���7'��!�`G����g�`R^��nV���r�k�
,�M�Uu��|�gk�������d5=��K�E@_�-W�����<V?ԉm���q(�-�d�g�����]=�Bh˴�V�GN��u�uz[�����QL2.��ֈt��֛'��m��׳�q�,m�`6]���qn'U8���t9gQ%���+0�E����p����e:D�qh쭬r�0
��͝;��ƃL��a΅q���U�C�]��:Fd�£�xC|��FIƔ�E���>n��r�4�h�t�Q�6;8ίw֙�mFrמ�i�ЃI5(�M$�ţ�n�v�Q�����\JaMFI"jQ@+0CmH<�C"jQ4��
ZIn�eRgt ��^�`����
Vf:D-
��$���(�H�n1jQ4��
ʚ %�G��Z�y����0��q��E�Z3��2�B0T�I�Z��EaC�*g5!�2�a�Ep .x��p�5C�$���b������ׁ��!jZ�7 Z�#Y jTs�]o&�&A?����y��\�\цg�Q�`�Ӈ��akG���{-
O9m{2(��^�R��l�������(�S;D-ʽMH.�+��Rˌ�eԢ�kј"d{��0w�����}v��{<^����~Po�C��'>.7���-x^����џu���m��.B��]����F��"T��m��.´']�m#N��F�#C��' ������ ^?D�A̞D�A�~& ��/���Pb�A�^��w���A@�? b�&�^O�P ~=eDD�'�(Þ0# �=aG@{�H��%�� S����3aL�<��3aM�<��3aN�y&�)1τ=��Q�]�}�m��/D�!�����qs���5��Dk�g}�|'����ڻ��{b$$�y�G����� e�%�<O�]$�>'־tGRH�_[�g�?���ܷ�N����y�� E]~&v�>��'̣p��Q�O�>R�����u���RC~R8>ߤ���O���=0)o���~�R� @���9#0x�s���V*�>�!�ʐ�K�S��N��Ne�5Ne�S9q����ib�]b�=1N�<�#��L@p*'�<O�]$�>'־tG�r�<�ʉ�.k���A�S9����-<a�n*�N*�,�I��Є����j���?ɋڟ�����{����2��r���2���<j��dZ�'e���Ve�����?N��PK 3��\.
�� P xl/_rels/workbook.xml.rels � (� ��Kj�0@�"f_�rd�8�d�m�L�mbKFR��l]�H�BE
�]t������j�1�썜�i@d902ʶ��8�T�f��ш!n�~�=�O�o�a~�ܫ�&���ĉ�n�K���;�E�Wܥ�g��y���փ��U��L��߭;��( ۣ�(4pmy~I"�T`/m;U��Aʺ&)�������NdP���u)�B>T�GG�kp�S������ҕ(�B(sI5~w�PK 3��\Ѓ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 3��\Y'�as � xl/sharedStrings.xml � (� �U�n�0��;�@ d��j��Vj���Z�:0I����CU��k�m�b���>r��x����<��� R1����'�<9㛩{{s⥮������m@���l�::����E�>�ʶPR�
�f�B������@s���BB�����N&j�S7�N�����>��&8;;�8���3r����,�b�u�f�5
i�/h ]�D�p�T~.2�Z��ߺ���~��b]�GV2�8W��]F;s��o�V.?+馇^�B�r�/�j_�龀��4�Z���1���r7��T�R��j/�����]��R���/���+i)x�(٪FP]��)�.����ڥZ�xI9�례��[�ܐlg��|�1z9,$�g|�<]�H�Y:�5T�q�ʬ@>�9mDm� �[��5��f[�Vӷ1]d_̼F����@��P����G����qy�d�zC �K��u���0G�0��(ZV��UK�q�~�Ⱦ������Q?����.�NWC�'�HL2o��R/]%z�A��Q ��`H�UBb/�4�$!�8�k/��h�ⰿ�����Q�?~bK��3)�v
�/��*��������
{Y�8H���L��ݿV����w���o���=�PK- 3��\���� 5 xl/workbook.xmlPK- 3��\���� � � [Content_Types].xmlPK-
3��\�v��' ' U _rels/.relsPK- 3��\,̺ɼ j � xl/worksheets/sheet1.xmlPK- 3��\.
�� P � xl/_rels/workbook.xml.relsPK- 3��\Ѓc'2 E
xl/styles.xmlPK- 3��\Y'�as � � xl/sharedStrings.xmlPK � O
application/vnd.ms-excel
Sample:
PK 3��\�Ȃ�� 5 xl/workbook.xml � (� ����0��&�C��(j,)��x���b�O�||K $���~;l2nh��G����"[�[������7N��{����ڴo:�S�]���i��z���ay�w^ 5.(ť��~���=%L>�h�ug�%D~S,������
J\��1Jν+�#W�8<��������L�o�
�����PK 3��\���� � [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
3��\�"~' ' _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="R629262386ebe4a74" /></Relationships>PK 3��\,̺ɼ j xl/worksheets/sheet1.xml � (� �Y�R;����Z��RJ�rr!ɛ^bW��Z���?�����9�B�A=�Q��wC�������rV-��`�A���&�ů�����;|~tp_տ�Ӳ\
|�|V�����hy5-��eQݖ��v]���*|[�U�׳�����H0�Guy3^������r�ЭO��m]�'��7����bxt0�����uy}8���?��`tt�A��������(�V���7'��!�`G����g�`R^��nV���r�k�
,�M�Uu��|�gk�������d5=��K�E@_�-W�����<V?ԉm���q(�-�d�g�����]=�Bh˴�V�GN��u�uz[�����QL2.��ֈt��֛'��m��׳�q�,m�`6]���qn'U8���t9gQ%���+0�E����p����e:D�qh쭬r�0
��͝;��ƃL��a΅q���U�C�]��:Fd�£�xC|��FIƔ�E���>n��r�4�h�t�Q�6;8ίw֙�mFrמ�i�ЃI5(�M$�ţ�n�v�Q�����\JaMFI"jQ@+0CmH<�C"jQ4��
ZIn�eRgt ��^�`����
Vf:D-
��$���(�H�n1jQ4��
ʚ %�G��Z�y����0��q��E�Z3��2�B0T�I�Z��EaC�*g5!�2�a�Ep .x��p�5C�$���b������ׁ��!jZ�7 Z�#Y jTs�]o&�&A?����y��\�\цg�Q�`�Ӈ��akG���{-
O9m{2(��^�R��l�������(�S;D-ʽMH.�+��Rˌ�eԢ�kј"d{��0w�����}v��{<^����~Po�C��'>.7���-x^����џu���m��.B��]����F��"T��m��.´']�m#N��F�#C��' ������ ^?D�A̞D�A�~& ��/���Pb�A�^��w���A@�? b�&�^O�P ~=eDD�'�(Þ0# �=aG@{�H��%�� S����3aL�<��3aM�<��3aN�y&�)1τ=��Q�]�}�m��/D�!�����qs���5��Dk�g}�|'����ڻ��{b$$�y�G����� e�%�<O�]$�>'־tGRH�_[�g�?���ܷ�N����y�� E]~&v�>��'̣p��Q�O�>R�����u���RC~R8>ߤ���O���=0)o���~�R� @���9#0x�s���V*�>�!�ʐ�K�S��N��Ne�5Ne�S9q����ib�]b�=1N�<�#��L@p*'�<O�]$�>'־tG�r�<�ʉ�.k���A�S9����-<a�n*�N*�,�I��Є����j���?ɋڟ�����{����2��r���2���<j��dZ�'e���Ve�����?N��PK 3��\�X\�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�i���ݰa[z��Q۲]�gc���V� �X��j4��'�|�lvo�D^0���ʂA�\?ڡ�S�w
춛=N2�hFI^�����4*�����hsG�0˔�0P/�QHW��iX2�Ig��!:�G��N�f��0}u�
br�a���O)�K(�L�Է�τ�Bp�: �fj1�'��^��B��PT]Y��k��T�Ȁ�s
��K�ey��:^߳u��s^�.j��/�_PK 3��\Ѓ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 3��\Y'�as � xl/sharedStrings.xml � (� �U�n�0��;�@ d��j��Vj���Z�:0I����CU��k�m�b���>r��x����<��� R1����'�<9㛩{{s⥮������m@���l�::����E�>�ʶPR�
�f�B������@s���BB�����N&j�S7�N�����>��&8;;�8���3r����,�b�u�f�5
i�/h ]�D�p�T~.2�Z��ߺ���~��b]�GV2�8W��]F;s��o�V.?+馇^�B�r�/�j_�龀��4�Z���1���r7��T�R��j/�����]��R���/���+i)x�(٪FP]��)�.����ڥZ�xI9�례��[�ܐlg��|�1z9,$�g|�<]�H�Y:�5T�q�ʬ@>�9mDm� �[��5��f[�Vӷ1]d_̼F����@��P����G����qy�d�zC �K��u���0G�0��(ZV��UK�q�~�Ⱦ������Q?����.�NWC�'�HL2o��R/]%z�A��Q ��`H�UBb/�4�$!�8�k/��h�ⰿ�����Q�?~bK��3)�v
�/��*��������
{Y�8H���L��ݿV����w���o���=�PK- 3��\�Ȃ�� 5 xl/workbook.xmlPK- 3��\���� � [Content_Types].xmlPK-
3��\�"~' ' V _rels/.relsPK- 3��\,̺ɼ j � xl/worksheets/sheet1.xmlPK- 3��\�X\�� P � xl/_rels/workbook.xml.relsPK- 3��\Ѓc'2 E
xl/styles.xmlPK- 3��\Y'�as � � xl/sharedStrings.xmlPK � O