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": "JsnSdUGk0Eqr3ZJnGS/NVQ==", "guid": "75d2c926-a441-4ad0-abdd-9267192fcd55", "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": "Rs9VwhnTLEm5PySVWVVPbQ==", "previousFormGuid": "c255cf46-d319-492c-b93f-249559554f6d", "nextForm": 1, "nextFormG_UID": "BTcRpVJQ/UO1geyatM1K6w==", "nextFormGuid": "a5113705-5052-43fd-b581-ec9ab4cd4aeb", "attributes": "sample string 10", "updated": "2025-08-02T23:16:00.6436885", "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": "mdUJrlbQnkOrZ4Ig5K/hnA==", "checkoutFormGuid": "ae09d599-d056-439e-ab67-8220e4afe19c", "identifier": "ycd313LibkS5EKaNRZR7Ng==", "identifierGuid": "d777c7c9-e272-446e-b910-a68d45947b36", "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": "EwFHFaZ8t0CRJrffpvPTQw==", "valueGuid": "15470113-7ca6-40b7-9126-b7dfa6f3d343", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-08-02T23:16:00.6436885", "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-08-02T23:16:00.6436885", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "rXddxvhNmEW8JDwsdSZwmw==", "checkoutFormGuid": "c65d77ad-4df8-4598-bc24-3c2c7526709b", "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��}�E�O�||K $���~;|�vl��GN������`̵Jp'mP�]���}1����Z�o�ʳs����^h�a]i�������V��hu<fO���2[��$l �����"*�@bIk�@It�]ISJl!��>��Mפ���.iKw��l�]}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 �[8���' ' _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="Rb863592555714313" /></Relationships>PK �[6�Q�� l xl/worksheets/sheet1.xml � (� �Y�r;����Z�ѕJB-� �$\����"��l���Ȏe��Α�� ��z�[�9x�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�p2:�5v��Z�~6�����SM~���%����o��{�Ɋ�~o:����~2Z����J諻Ų�^>����u���m��B4J)��6]��z�֣+P*����h�t��ԫGέ7u��ufSgv�U��B ��q�B��n���ݦ���E!$�v�K��M�o��+n�"x�.�"�D<�8�U�c%&��$4�='�Ck��U&���v�+z�.w�3�����R���ʨ8���֙p�XEF�Ɇ�\�VBh� !�CT���A9FYe��&w��?���7Bz�m�iFJߞ�İ�5�&��Ext�m��!����R)p6�$�ZlEf�&<�� jZ���JZ�2@�"초�@Ш=��v���Q�`��� 5Z !�r� Q��Т.jg��0e��yy@����>�C�"�����V8��t��Elh "U{g�p�t�Zĝ�,$+��(TF�5���Sloal:ʄa�Q��Ҥt ��#Y0jus0~o&�&�<������0ܨR�\1Vf��Q��Ӈ����#����;-�[θ=TQ�j�Ee�p~��霐�d:D-*��Q�j�E<)�5��^�2�VQ�j�Ek���!�������7�����p9<:�����z9�_}*�����9�/����#q0���� ^t��x�E@q�E`�o�ڈW]�n#^w��x�E�6⤋pm�i�ۈ�c��w�����Z?0��GB�=c ��sB��` ��O�����v�0j#�~e ��KB���@��a�!얌 ��[26�o��\2V�pɘ �%cG$��!��\2�D�rɘ �%cK�<3�D�3�L�<3�D�3�M�<3�T�gƝ����S�x���&?�6EL���nC�P^2�L��;мo�ѤgZӨg 4��;I��&��&��1#��C>0"���(�,1�yb�"��)���;�&B��*/�X�tJ:��&v�L�}˫�;3(��#�CY�(�h�z�{4�Ӳ� ����-]x��������:� e��$/��tL�[��*wiz0�ҔK�_����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�ʃ�7&�j8���zY��ߩl����/PK �[��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;��D`� [�{G$vd�R��E��+ԢR�.�a5��ӓf>�?6��q ��C�l<c@�J�z�5p��i ��怃�i"�~ $��Ѐ�qZS��Q��MhSG;?��R��Iȓ��U��p�$���!:�{��N�G��0�8 19 �al��-�,Q��U��eժ�� U�\�S�:`����g2yU�+�h��+�P#<���ӥ�N��L��R1^/�R�+�M�����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 �[�>�r � xl/sharedStrings.xml � (� ��ko�0�� �;�@R�$U�^V���^�K5m�>I���l����t�Z��>L��sl���1��Dzpv $�l�F~�:�0'�mf���w�:R!FP�����ΧR*Ger�n��>��[(��yL�5%R�UlY @DnTYq��Q�:��L��4s����5,_� :�����4P�iо=+g?�,bMIW��WlV�(.,�%*����=�6��_p��6��G�[|�Dm��g����+�HK*���5H����X�ᇍ�Α�mz��C�h��z��l�`a:��)*i��� }����Uc�q%`Gy-���c��+�D��m��:�+�Lx���y�@v�]E�2Sp�%m#�����`� 1(��C���İl��|�1�rT(@�پy��X���tQ�P ʔ�f b�ᵥ([n?h��fk��ӷ5d_͢Vʲٽ�z�H��h����IJb��c%I�%��� �4��x�I�v�HTV��U[�q�oEmx�~Ȥ�㬋q��x��=2�2/�b���h��I���I�c#(���$L�4Lc/�����8Cy�I� �_F�h����䉮�פ��V(��Z����6"�����;�Q�3` (�/�T�����9zF����!~3���?PK- �[$ �|� 5 xl/workbook.xmlPK- �[���� � [Content_Types].xmlPK- �[8���' ' V _rels/.relsPK- �[6�Q�� l � xl/worksheets/sheet1.xmlPK- �[��� P � xl/_rels/workbook.xml.relsPK- �[Ѓc'2 E xl/styles.xmlPK- �[�>�r � � xl/sharedStrings.xmlPK � V
application/vnd.ms-excel
Sample:
PK �[�WZ(� 5 xl/workbook.xml � (� ����0��&�C���K$�����VhK�||�o�vfg�>8�>�k��t6��M�}�X ;ףw�yq��ŜRZ`��۠��e汃�� ���i��B�dh��f�mi��§f�CHr4���I�b�)�`�ERĂ�������dI���B����9W��<A�te�0Ζ��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&0r' ' _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="Rf746495873dd4c01" /></Relationships>PK �[6�Q�� l xl/worksheets/sheet1.xml � (� �Y�r;����Z�ѕJB-� �$\����"��l���Ȏe��Α�� ��z�[�9x�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�p2:�5v��Z�~6�����SM~���%����o��{�Ɋ�~o:����~2Z����J諻Ų�^>����u���m��B4J)��6]��z�֣+P*����h�t��ԫGέ7u��ufSgv�U��B ��q�B��n���ݦ���E!$�v�K��M�o��+n�"x�.�"�D<�8�U�c%&��$4�='�Ck��U&���v�+z�.w�3�����R���ʨ8���֙p�XEF�Ɇ�\�VBh� !�CT���A9FYe��&w��?���7Bz�m�iFJߞ�İ�5�&��Ext�m��!����R)p6�$�ZlEf�&<�� jZ���JZ�2@�"초�@Ш=��v���Q�`��� 5Z !�r� Q��Т.jg��0e��yy@����>�C�"�����V8��t��Elh "U{g�p�t�Zĝ�,$+��(TF�5���Sloal:ʄa�Q��Ҥt ��#Y0jus0~o&�&�<������0ܨR�\1Vf��Q��Ӈ����#����;-�[θ=TQ�j�Ee�p~��霐�d:D-*��Q�j�E<)�5��^�2�VQ�j�Ek���!�������7�����p9<:�����z9�_}*�����9�/����#q0���� ^t��x�E@q�E`�o�ڈW]�n#^w��x�E�6⤋pm�i�ۈ�c��w�����Z?0��GB�=c ��sB��` ��O�����v�0j#�~e ��KB���@��a�!얌 ��[26�o��\2V�pɘ �%cG$��!��\2�D�rɘ �%cK�<3�D�3�L�<3�D�3�M�<3�T�gƝ����S�x���&?�6EL���nC�P^2�L��;мo�ѤgZӨg 4��;I��&��&��1#��C>0"���(�,1�yb�"��)���;�&B��*/�X�tJ:��&v�L�}˫�;3(��#�CY�(�h�z�{4�Ӳ� ����-]x��������:� e��$/��tL�[��*wiz0�ҔK�_����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�ʃ�7&�j8���zY��ߩl����/PK �[�6�r� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;qH� �n�R.0��$"�#۔r�.z�^��� u� �����4�����{%�{kX$)02Ҫ ��~Z�v��Ӏ!N���<�+�7Ѕ0�8���}b'2���1�Ե|Byx��%ws�3��:��V�^ҳ��L��/֝|G�е�)y~�$R��T�+Q�Z�V��?L͇�@���;��`V�.�y�S!�ˇ�t�H�/=w��gjU.2TXjQ�"#qS�w��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 �[�>�r � xl/sharedStrings.xml � (� ��ko�0�� �;�@R�$U�^V���^�K5m�>I���l����t�Z��>L��sl���1��Dzpv $�l�F~�:�0'�mf���w�:R!FP�����ΧR*Ger�n��>��[(��yL�5%R�UlY @DnTYq��Q�:��L��4s����5,_� :�����4P�iо=+g?�,bMIW��WlV�(.,�%*����=�6��_p��6��G�[|�Dm��g����+�HK*���5H����X�ᇍ�Α�mz��C�h��z��l�`a:��)*i��� }����Uc�q%`Gy-���c��+�D��m��:�+�Lx���y�@v�]E�2Sp�%m#�����`� 1(��C���İl��|�1�rT(@�پy��X���tQ�P ʔ�f b�ᵥ([n?h��fk��ӷ5d_͢Vʲٽ�z�H��h����IJb��c%I�%��� �4��x�I�v�HTV��U[�q�oEmx�~Ȥ�㬋q��x��=2�2/�b���h��I���I�c#(���$L�4Lc/�����8Cy�I� �_F�h����䉮�פ��V(��Z����6"�����;�Q�3` (�/�T�����9zF����!~3���?PK- �[�WZ(� 5 xl/workbook.xmlPK- �[���� � � [Content_Types].xmlPK- �[z&0r' ' U _rels/.relsPK- �[6�Q�� l � xl/worksheets/sheet1.xmlPK- �[�6�r� P � xl/_rels/workbook.xml.relsPK- �[Ѓc'2 E xl/styles.xmlPK- �[�>�r � � xl/sharedStrings.xmlPK � U