GET api/store/{storeID}/checkoutforms/{formType}?relations={relations}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
storeID | 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": "pQ/syBF5dUut86yM/G1LAQ==", "guid": "c8ec0fa5-7911-4b75-adf3-ac8cfc6d4b01", "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": "Wk3bGp/NkkiK5gkfAvJtDA==", "previousFormGuid": "1adb4d5a-cd9f-4892-8ae6-091f02f26d0c", "nextForm": 1, "nextFormG_UID": "UjJ823DXi0mqzjNzgCTolw==", "nextFormGuid": "db7c3252-d770-498b-aace-33738024e897", "attributes": "sample string 10", "updated": "2025-06-14T06:11:11.2815948", "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": "bNMzdTWstk60oulNXoBYrA==", "checkoutFormGuid": "7533d36c-ac35-4eb6-b4a2-e94d5e8058ac", "identifier": "rB99hsRGRUSNTHAI4loMrA==", "identifierGuid": "867d1fac-46c4-4445-8d4c-7008e25a0cac", "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": "GGCkAK/+oEaLkNhCesm6xA==", "valueGuid": "00a46018-feaf-46a0-8b90-d8427ac9bac4", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-06-14T06:11:11.2815948", "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-06-14T06:11:11.2815948", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "FwPQv3KpYUia4VZ7WZzrFg==", "checkoutFormGuid": "bfd00317-a972-4861-9ae1-567b599ceb16", "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 e1�ZO��� 5 xl/workbook.xml � (� ����0��&�C�` &�p��Ճ��,������Ǘ�@������#F�_�s/�1� �/A�8���`8����7'��u��T;�6d#O�$�z��٠�`��� �'l�"��_Q���x`L���ư�����&�k�����/�,*�ƈ��֖p�= w�mz�e�^3ʚF���a�o��/PK e1�Z���� � [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 e1�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="Ra9835179363c4f8c" /></Relationships>PK e1�Z��1V� j xl/worksheets/sheet1.xml � (� �Y�VK��g��k��5��hnj.&y��X����Afj�t�>(ػ����gă��7�?�|1�g�}Y�~��]գ���a�ny���??:����Z�|�x6?쏗��g���j\M�����fa��O���v�kP__O�����nZ͖����p�Z�'���C�}z-n��p�az��j:���G�I辚�7����|V�c�78:X��M��E�uou��������/��A�z��ټ7���w7ˋ��m5�5^��檾Y�����w��t�w��~2Z����J諻Ų�^>�Z��:����Nb� ����z���M=n��N��Jjk�r�z��W��[o��#�̦��Ϋ ��Ry㜅t����'ֻM��ՋBH4"P��_~S���J���^�˥�:�$Nn�X�ɨ1 �C{�I-���g:D�Il쭝�� �^�˝;�L�&m»0��`=f:D�I��x�΄�@�*2jO6�� g�B+ 9���mv�1�*k�7�SD�I���]8��;osW3*P���� �=���AO4D-£�n�wШ4AHan�8�QD-�"3� �@^� -��h%�rB�� jvZD[��6�=J�2��4=)j�BA�*F-BC��p�� R�|�A�"초�0^�T0F�Ü���f�.m��`���� -B�B�jN�Q��Ӣ���`%�.g�5���Sl���t� wp��:DMbK��)4`�d��I��������D�HWc�"��5�pG�*䊱2��ZDל>��X9b�Q���"`���'�*jQ��L�/Vw:'�5�Q�J>�CԢ�iѺ��^���d��N��!�C��!��&O������rxt0��{��r�zU����Csx^���?G�`�gU�A��"d6⸋�6�U�ڈ�]�n#�t��x�E�6⤋pm�i�ۈwc��������Z?2��'B�=c ��sB��` ��������v�2j#�~c ��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���nCrQ^2rM��;мo�ѤgZӨg 4��;I��&��%��3#�|�C>2"�O�(�,1�yb�"��9���;�&B��*/�X:%�r�;]&־�U���t��ء,�[��y4M=�=��i�GiP��ք?�hh�J���I��|�j�rRy��ty�&e�ro���4�0��p�ث�9c0t�s�sr+�qʘe�j�%���܁�rs��2Ӛ�2���8�Ib�4��.�����r��Pf 4�s�'�.k�k_�#uB�U���N����y��`���ء,�[��y���`:�ܲH:�S33v�r�A�I�I^�������=�U2��2����3� eCCy���d\ G��u]/�����?N��PK e1�Z%X�d� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�qL��ݰa[zי�Q۲]�gc�#� XE�Tb�������4s�<�6�H�0��Y e���ծl/ᘺ�6��G��D4��$��(��䗔FmpR�pm�t.L*�4��+}P=R�XMÜ�L�;y��uݠ����6���.�AL@v*�$��"����T /����-�j��B���5z7��N#�_��|&�`[6�ՊY����Q����N��L�UOU�&r�\\���_�� PK e1�ZЃ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 e1�Z�82�t � xl/sharedStrings.xml � (� ��Yo�0�� �u���(3Y)EY�%�Zc_f��=�M��k&M���G�w���υ��cU: $�l�F~�:�0'�m���͉���T�Trs��:����ѭL�ݭR�OA �*$}��I�E��~�@� "� �*�8�A�(s�k���$s����5�^� ������,P�Y�>=+�?o-bM��}�;�V^+.,����N�n�]G?�)m��7|�DmM�3��V��=ҊJ�� $}By�������Α� mz���C�p��j��t�`�u��TѲ��k�d�����ƥ��k�^^���]�%R�l���E_�e�C��k�$�;�T7�\�6bz@M�Җ S��A�I=��۾5'�����ך�^K���I�t�e�˲���LYm� �5��L e�-�{�Z�l��z��棋�Y�JY����^7RA�/w?L�S�a�&^�E�7Γ��H1�Nq��d����#Q�+A\�Egҏ�&�uǓ�-I?N�qf��|L&��$+�q��^�`�YT�qOI���'xOb�$I荳4���F�( �1���.�p���L~�D�Ϥ��Q(��^�z��6"�����o�ˠ���@P�S�~Ew���s�:9�/؇�����a/� PK- e1�ZO��� 5 xl/workbook.xmlPK- e1�Z���� � � [Content_Types].xmlPK- e1�Z��=' ' U _rels/.relsPK- e1�Z��1V� j � xl/worksheets/sheet1.xmlPK- e1�Z%X�d� P � xl/_rels/workbook.xml.relsPK- e1�ZЃc'2 E xl/styles.xmlPK- e1�Z�82�t � � xl/sharedStrings.xmlPK � R
application/vnd.ms-excel
Sample:
PK e1�Z(� �� 5 xl/workbook.xml � (� ����0��&�C���(R8q�����,�@[�����O ��mgv����t�#�ې���19cA�h �܀v�5����/�F+��z���9O���v6�zt��� �G�C�M��hK��17{j�"'c�;���!��l�X�`��D�dq�uAJ|���d¯��)$�"o��;L��w�PK e1�Z���� � [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 e1�ZXE�' ' _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="R52997224089c4b91" /></Relationships>PK e1�Z��1V� j xl/worksheets/sheet1.xml � (� �Y�VK��g��k��5��hnj.&y��X����Afj�t�>(ػ����gă��7�?�|1�g�}Y�~��]գ���a�ny���??:����Z�|�x6?쏗��g���j\M�����fa��O���v�kP__O�����nZ͖����p�Z�'���C�}z-n��p�az��j:���G�I辚�7����|V�c�78:X��M��E�uou��������/��A�z��ټ7���w7ˋ��m5�5^��檾Y�����w��t�w��~2Z����J諻Ų�^>�Z��:����Nb� ����z���M=n��N��Jjk�r�z��W��[o��#�̦��Ϋ ��Ry㜅t����'ֻM��ՋBH4"P��_~S���J���^�˥�:�$Nn�X�ɨ1 �C{�I-���g:D�Il쭝�� �^�˝;�L�&m»0��`=f:D�I��x�΄�@�*2jO6�� g�B+ 9���mv�1�*k�7�SD�I���]8��;osW3*P���� �=���AO4D-£�n�wШ4AHan�8�QD-�"3� �@^� -��h%�rB�� jvZD[��6�=J�2��4=)j�BA�*F-BC��p�� R�|�A�"초�0^�T0F�Ü���f�.m��`���� -B�B�jN�Q��Ӣ���`%�.g�5���Sl���t� wp��:DMbK��)4`�d��I��������D�HWc�"��5�pG�*䊱2��ZDל>��X9b�Q���"`���'�*jQ��L�/Vw:'�5�Q�J>�CԢ�iѺ��^���d��N��!�C��!��&O������rxt0��{��r�zU����Csx^���?G�`�gU�A��"d6⸋�6�U�ڈ�]�n#�t��x�E�6⤋pm�i�ۈwc��������Z?2��'B�=c ��sB��` ��������v�2j#�~c ��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���nCrQ^2rM��;мo�ѤgZӨg 4��;I��&��%��3#�|�C>2"�O�(�,1�yb�"��9���;�&B��*/�X:%�r�;]&־�U���t��ء,�[��y4M=�=��i�GiP��ք?�hh�J���I��|�j�rRy��ty�&e�ro���4�0��p�ث�9c0t�s�sr+�qʘe�j�%���܁�rs��2Ӛ�2���8�Ib�4��.�����r��Pf 4�s�'�.k�k_�#uB�U���N����y��`���ء,�[��y���`:�ܲH:�S33v�r�A�I�I^�������=�U2��2����3� eCCy���d\ G��u]/�����?N��PK e1�Z(��D� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�&q��ݰ���=����n�gc���V� �X��j4��'�|���o�H����l <c@�jg��p�탄�f��Q�4�a$��PC㼢4�'27�M���IŔ���JU�4g��~ɀ[&9\f�ѵ����ӄ6����C����0��S �x��@v���n8{���P�����л��x1�z}�ޚB��4�R�P�2��h^�O�^:-�K5�3Y!s)důj��/6_PK e1�ZЃ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 e1�Z�82�t � xl/sharedStrings.xml � (� ��Yo�0�� �u���(3Y)EY�%�Zc_f��=�M��k&M���G�w���υ��cU: $�l�F~�:�0'�m���͉���T�Trs��:����ѭL�ݭR�OA �*$}��I�E��~�@� "� �*�8�A�(s�k���$s����5�^� ������,P�Y�>=+�?o-bM��}�;�V^+.,����N�n�]G?�)m��7|�DmM�3��V��=ҊJ�� $}By�������Α� mz���C�p��j��t�`�u��TѲ��k�d�����ƥ��k�^^���]�%R�l���E_�e�C��k�$�;�T7�\�6bz@M�Җ S��A�I=��۾5'�����ך�^K���I�t�e�˲���LYm� �5��L e�-�{�Z�l��z��棋�Y�JY����^7RA�/w?L�S�a�&^�E�7Γ��H1�Nq��d����#Q�+A\�Egҏ�&�uǓ�-I?N�qf��|L&��$+�q��^�`�YT�qOI���'xOb�$I荳4���F�( �1���.�p���L~�D�Ϥ��Q(��^�z��6"�����o�ˠ���@P�S�~Ew���s�:9�/؇�����a/� PK- e1�Z(� �� 5 xl/workbook.xmlPK- e1�Z���� � [Content_Types].xmlPK- e1�ZXE�' ' V _rels/.relsPK- e1�Z��1V� j � xl/worksheets/sheet1.xmlPK- e1�Z(��D� P � xl/_rels/workbook.xml.relsPK- e1�ZЃc'2 E xl/styles.xmlPK- e1�Z�82�t � � xl/sharedStrings.xmlPK � S