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 CheckoutFormName | 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": "jO/y8Z55qU+4tWPHPheQ0g==", "guid": "f1f2ef8c-799e-4fa9-b8b5-63c73e1790d2", "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": "SByqqt1Wn0mR+I34VALqVQ==", "previousFormGuid": "aaaa1c48-56dd-499f-91f8-8df85402ea55", "nextForm": 1, "nextFormG_UID": "Cm6peBA5DUqbDy2Mlm1BfQ==", "nextFormGuid": "78a96e0a-3910-4a0d-9b0f-2d8c966d417d", "attributes": "sample string 10", "updated": "2025-10-05T00:00:00.5286913", "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": "R6Z0xswNk0CkSiglU8LjZQ==", "checkoutFormGuid": "c674a647-0dcc-4093-a44a-282553c2e365", "identifier": "x3dcucHW3kqiIH41Sug2ug==", "identifierGuid": "b95c77c7-d6c1-4ade-a220-7e354ae836ba", "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": "RIUEKlN00E64twxOjutViw==", "valueGuid": "2a048544-7453-4ed0-b8b7-0c4e8eeb558b", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-05T00:00:00.5286913", "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": "2025-10-05T00:00:00.5286913", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "gMWHdF27UUSMmeNzDa8a3Q==", "checkoutFormGuid": "7487c580-bb5d-4451-8c99-e3730daf1add", "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 E["��� 5 xl/workbook.xml � (� ����0��J}�(�@������k���&��(IE�!�n�|����ޘ�|Ԭ}�*B�c~��_�Ew�8!J�b�s9`g��B�5�J�p� ��BZO7�?,o��bP�R 5m�'B��S�Ⓦ�^w5 �B�7U'�q�Ѡ���$9���9%��qx `�C^�c����V��w�PK E[���� � [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 E[]lC' ' _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="Rde8553f20049469a" /></Relationships>PK E[�Y� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��RJ�rr!ɛ^bW��Z���?�����s$C�A=�Qowk�������rV-��`�A���&�ů�����;|~tp_տ�Ӳ\ |�|V�����hy5-��eQݖ��v]���*|[�U�׳�����H0�Guy3^������r��m�^�ۺO6#�oZ�dz���`2������p��3����`��6+σ�Q�����oN&�C���z�כ�������ݬ.������tXR����f��:���� ��������jz8t�L����[����Ïy�~��:���P( ZJ�7Τ�a[�zЅS�ii�0\�t����Gέ�u�uz[�����(&�N[kD��l�����6��`4T[+X�/��w�s;���5���9�:a�$���X��1.ڇvNh�C+��Uơ����i�486w�3���B0g��� �!*��v��� cu8��X�G���la���) ��Q}ܴ;��I��ӹSD�q���l8�f�YgrO3*���N� �=�Q��=�D"jQ<:�vy'Z�:)�ͥ�d�$�t"3�2�@^"jQ��� ZIn�eRgt �E�E0��)4L�bDD- ��$���(�H�bԢhiQ�5AJ��2�(-�-d�{��[��<DԢp��ե��a���EQ����@e�L��Eh��y�!X�9���̨�&A<��[ڎ <:�u����&��kQ�=��&A�g���d�$�G�������ː+ڬc?�!jl{�p;�v���Ѣ�p�i�'�2jQ6Z���g��2nt�CԢ�O��(-[.yx�S\��]Ԣl�hL�=D[���ar��F�y�=��Guu?�7ˡ���������������Ϻv�x�G�.�e!���>��W}��"^���x�G�.�ma���>�v�}��"��!R����h�H@��"��� f� ���� n?D����J� ���� v/ b�;A�� �ݟ�� D�'l(��2""�V�aO�Ş�# �=aH@${�X��)�� [�0&`� g晰&`� o�0��<g��yB���I~�-"���7D�%A�丽���Nz�5�z��>q����ib�]b�=1·<�#A��D@���s�'�.k�k_�#)$䯝��?Vr��ܷ�N����y�� E]~&v�>��'̣p��Q�O�>R9Pņ3�9~W�RC~R8>ߤ���O���{`R��{���R� �� @���9#0x�s�X���Ф2$R��{I@p*�w���^éL�ƩL@p*'�w�X;M��K��'F©��|$ 8� N�Ĝ牵�����ڗ�H�TS9��eb�{^�?�Aq*'v�>��'��Oe�K�E2����S?�S RV�'yQ��=0)o�=�� w�S���Ry���2���<j��dZ�'e���Ve�����O�G�PK E[Z��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8iݸAu�aö���Q۲]�gc���V���X��j4��'�|�lvo�D^0��YMUA�\?�A�)�5춛=N2�hFI^�Q�I��S��Y��y���]�e�i���(���ni(p�$�����֣��N3�����p�19�0`�S���*S�<��(�md�2|F�5Bo��y�����2�������c�[�T�Ȁ�S �ҥSY.�t���Z,;ΙZ������PK E[Ѓ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 E[z�u � xl/sharedStrings.xml � (� ��Yo�0�� �-�Q��I���TU�R�f|I���ؗ��I�U�]2��6��fz�X�H������LP�73����K\G!����m@���|�:z(W3w�X} �m�$�pMr!K��UnUI Tm�,�A�AIw�L�g�8u����5,_� 6����h�|�o����[�X3�վ����(�E� %t�����2�s�Ԇ}�|�/��+~��bW]�GV2�v�@�'�.��,Hv���9zV�M^�B�r?�Wp���t_��t�� )Y���5{���ֱ1ݸ���D����c��+�D��6�n��Z&<D�l]#�.��(A3�B�6b�A�h�-���Ca� ��q+A �v����c-��z�w�ӥGz�e����J2�V��8'��-��rٽf�o��l=}[��A��,jD�fw��u�J� ����<��'�7IS�F9I�u�{�0�!��!t�(RV��U[�q��8��Y��2��I?N���'�F�7�)�Fi�{i�'^B�d< @��& Ic�7L����z�:̽M�4��(��y��(�ã=|���OlE��&�߶B������]�Q~_`�f@�a/���2��)�������3r��>����Þ�PK- E["��� 5 xl/workbook.xmlPK- E[���� � � [Content_Types].xmlPK- E[]lC' ' T _rels/.relsPK- E[�Y� l � xl/worksheets/sheet1.xmlPK- E[Z��� P � xl/_rels/workbook.xml.relsPK- E[Ѓc'2 E xl/styles.xmlPK- E[z�u � � xl/sharedStrings.xmlPK � S
application/vnd.ms-excel
Sample:
PK E[�R� � 5 xl/workbook.xml � (� ����0��&�C���G '.^=x�e� �'m >��Do�vfg�:7<��[��W��"[� ���X�q��X��=��{ɡ5��@�gّ8Y�F{!�����X�@P�RLj�l7ѹ�]�䓌Ʒ�l"���o�&�z��LA�[Fɹv5�c�*�[^B��2?�s ���F��w�PK E[���� � [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 E[*��' ' _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="Rf99f66330d7c4100" /></Relationships>PK E[�Y� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��RJ�rr!ɛ^bW��Z���?�����s$C�A=�Qowk�������rV-��`�A���&�ů�����;|~tp_տ�Ӳ\ |�|V�����hy5-��eQݖ��v]���*|[�U�׳�����H0�Guy3^������r��m�^�ۺO6#�oZ�dz���`2������p��3����`��6+σ�Q�����oN&�C���z�כ�������ݬ.������tXR����f��:���� ��������jz8t�L����[����Ïy�~��:���P( ZJ�7Τ�a[�zЅS�ii�0\�t����Gέ�u�uz[�����(&�N[kD��l�����6��`4T[+X�/��w�s;���5���9�:a�$���X��1.ڇvNh�C+��Uơ����i�486w�3���B0g��� �!*��v��� cu8��X�G���la���) ��Q}ܴ;��I��ӹSD�q���l8�f�YgrO3*���N� �=�Q��=�D"jQ<:�vy'Z�:)�ͥ�d�$�t"3�2�@^"jQ��� ZIn�eRgt �E�E0��)4L�bDD- ��$���(�H�bԢhiQ�5AJ��2�(-�-d�{��[��<DԢp��ե��a���EQ����@e�L��Eh��y�!X�9���̨�&A<��[ڎ <:�u����&��kQ�=��&A�g���d�$�G�������ː+ڬc?�!jl{�p;�v���Ѣ�p�i�'�2jQ6Z���g��2nt�CԢ�O��(-[.yx�S\��]Ԣl�hL�=D[���ar��F�y�=��Guu?�7ˡ���������������Ϻv�x�G�.�e!���>��W}��"^���x�G�.�ma���>�v�}��"��!R����h�H@��"��� f� ���� n?D����J� ���� v/ b�;A�� �ݟ�� D�'l(��2""�V�aO�Ş�# �=aH@${�X��)�� [�0&`� g晰&`� o�0��<g��yB���I~�-"���7D�%A�丽���Nz�5�z��>q����ib�]b�=1·<�#A��D@���s�'�.k�k_�#)$䯝��?Vr��ܷ�N����y�� E]~&v�>��'̣p��Q�O�>R9Pņ3�9~W�RC~R8>ߤ���O���{`R��{���R� �� @���9#0x�s�X���Ф2$R��{I@p*�w���^éL�ƩL@p*'�w�X;M��K��'F©��|$ 8� N�Ĝ牵�����ڗ�H�TS9��eb�{^�?�Aq*'v�>��'��Oe�K�E2����S?�S RV�'yQ��=0)o�=�� w�S���Ry���2���<j��dZ�'e���Ve�����O�G�PK E[��}� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8����ݰa[z�'Q;�ݖ��G� XE�Tb�������4����M#9a��w���N{3�N�1ه���G��D�9��⢄>���Ҩ{�T,��.w��J9 ��>�)+�G��e��e������g������}8�1٫�a��S���"S�� ;&�k#XS���B��e�����/d� Smc8oV�]ezм��/�tZ�j�ֆc�[Ya��ћ��|PK E[Ѓ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 E[z�u � xl/sharedStrings.xml � (� ��Yo�0�� �-�Q��I���TU�R�f|I���ؗ��I�U�]2��6��fz�X�H������LP�73����K\G!����m@���|�:z(W3w�X} �m�$�pMr!K��UnUI Tm�,�A�AIw�L�g�8u����5,_� 6����h�|�o����[�X3�վ����(�E� %t�����2�s�Ԇ}�|�/��+~��bW]�GV2�v�@�'�.��,Hv���9zV�M^�B�r?�Wp���t_��t�� )Y���5{���ֱ1ݸ���D����c��+�D��6�n��Z&<D�l]#�.��(A3�B�6b�A�h�-���Ca� ��q+A �v����c-��z�w�ӥGz�e����J2�V��8'��-��rٽf�o��l=}[��A��,jD�fw��u�J� ����<��'�7IS�F9I�u�{�0�!��!t�(RV��U[�q��8��Y��2��I?N���'�F�7�)�Fi�{i�'^B�d< @��& Ic�7L����z�:̽M�4��(��y��(�ã=|���OlE��&�߶B������]�Q~_`�f@�a/���2��)�������3r��>����Þ�PK- E[�R� � 5 xl/workbook.xmlPK- E[���� � [Content_Types].xmlPK- E[*��' ' V _rels/.relsPK- E[�Y� l � xl/worksheets/sheet1.xmlPK- E[��}� P � xl/_rels/workbook.xml.relsPK- E[Ѓc'2 E xl/styles.xmlPK- E[z�u � � xl/sharedStrings.xmlPK � V