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": "xusRSOEqXk23NbIKUBQF2A==", "guid": "4811ebc6-2ae1-4d5e-b735-b20a501405d8", "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": "23WUB8GTrEOIEwhVl0lLlw==", "previousFormGuid": "079475db-93c1-43ac-8813-085597494b97", "nextForm": 1, "nextFormG_UID": "3AjMGS5EgU62KDmh+P1dxw==", "nextFormGuid": "19cc08dc-442e-4e81-b628-39a1f8fd5dc7", "attributes": "sample string 10", "updated": "2025-08-02T23:12:22.3418073", "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": "cmZS7wtfm0eZleq59ftgKg==", "checkoutFormGuid": "ef526672-5f0b-479b-9995-eab9f5fb602a", "identifier": "Tcql9+Wqsk+RFo7IbCPMEA==", "identifierGuid": "f7a5ca4d-aae5-4fb2-9116-8ec86c23cc10", "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": "dY58rXWxLUGKN4Upbj6Scw==", "valueGuid": "ad7c8e75-b175-412d-8a37-85296e3e9273", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-08-02T23:12:22.3418073", "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:12:22.3418073", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "9mcJ4tXWrE6Ua+FUIcZYaQ==", "checkoutFormGuid": "e20967f6-d6d5-4eac-946b-e15421c65869", "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��(F-)��x���V�O�||K $���~;l2nh��G����}� ķ=(�Ƃ�;a��!J�"F�Bmڷ�)�.��ȃ4���z���ay�w�j\P�K���!67{J�|��X��&"K���X�mI!����c��{W�#F��qxtYCo�J��9�W��7#���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 ��[�d' ' _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="R14542fc8a01c4877" /></Relationships>PK ��[YՊ� k xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!� ȅ$o>x�]�^�6!�dcٻ�s$C��F�ݭ�s�������/&��/��U��z4��:��-��q��G����b\U�^������ry�l0X\���pQԷ�,�]���p~����ד�긾��V�� �0�yu3\�������m�^��y5�G��<��'����h����ͫ��~)����� ���o��~���[�ߺ����dt�k�~���l�U�û��E}����/Kz]sU�,ֿ���w��t�w���d��}!�0�Ww�e=�|�k��`S�:��6h�R�K�m�7���GW8ƃ6�K�.W�r�ȱ��N?��l���Z(!�7�YH��M�}b��Ի]�(�D#����7��qn�t8�A��e�\�(�H��V`�U����<�qR�0���Qd{k��� �r�:�;�I[��.L %X��QqR7;��j7�q��ړ ��X��� AB���>i��r����M�Q�5;x�o�����ӌ ��=�7>�a&!j�MQ�����4*CN���R�lFI��J�P+Lxy@�"4��@���� e2:��E���]1�2F��Q�`��� 5Z !� ����E]8��)a>� jvZD[h魒B;Z�t�Zߚ!�\� ��P&1jZ�p)��3B8e:D-�N�R����2<Ό�1jᩧ�^��t� 8�~�&��I��G�`�$���=`o&�&�<������0ܨRW���d��Et����`��{t�Zĝ�-gܞ��E�Ӣ2E8�X�tNH��ZT���N�� ���TF�^��N��!�C��!��&/�����rxt0��{��r��T����;sx ^���?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���nC�P^2�L��;мo�ѤgZӨg 4��;I��&��%��3#�|�C>2"�O�(�,1�yb�"��9���;�&B��*/�X�tJ:��%v�L�}ϫ�3(��3�CY�(�h�z�{4�Ӳ� ���7�� Au��Ujh�O���T���ʓ����=0)o�{��dܥ� ��K���Ws�`�<�fg�V*�.�1�ʘ�KBS��M��Me�5MeBS9q����ib�]b�=3M�<�#���@h*'�<O�]$�>'־tG�r�<�ʉ�.k����JS9�CY�(�tS��tR�e�L*��f��M�T���ʓ����=0)o�{��d��Me�I�=0g�������ɸ����^V��w*��9=�PK ��[1��� P xl/_rels/workbook.xml.rels � (� ��An� E��f_�qdC'�l�Ms�m�Hۜ���W(J�֑��&+4��i������m��8x�BY0 �7��Z8'� `�Y�qT)߈�0G����B���Hi�=N*~F�;ևI�\���J�T��3VӰd�-�.3���4�>O��`���)�� �A�S?Q�ף,2ȓiao�Q ��J�]U�B��e����]/dx�d-y�e�V%w��U@�B���i/Ԏ�c�<ϩf��Fo���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 ��[S΅r � xl/sharedStrings.xml � (� �U�n�0�A�lɖ �A� A���"76�tɕ��K9M�H�Շ>jfw�;��&�e�lAi.�ԍ��u@PɸXM�ۛ/u�D0RHS��:����T���q�)4]CI�/7 s/UI�|�U�7 �k ,�`���$\������d�S ����+`�� �Ύ&�&A��������gm��y�RY�RB;13�ԛ~.)A#��om�g�n������F�䑗\Cg�+����E��9�+e�cg%Y���������N��]��������O��18�]5.l��tsy�8���X,u�h+��[����������n3�F��K�yc1��mja$��D@�q=@���d�v���טN/��v&v��f�L���yQ�Fq�V�5�-��ZV� �b��`�F7�j6�����"���+D˰;�:�u�J^#��h�qE�ӑ7 y1K������!I�(��s4)7���H�r���Mߨ������~����M��,',��!5# ��4za�$�8��<�e��)�^��!��|4H�aF���%��t�=|�����_a�I�7�Ph�x���V��E���0=`ް�E�OA���?�Ew�Z��z��v&~S?0?��PK- ��[ ���� 5 xl/workbook.xmlPK- ��[���� � [Content_Types].xmlPK- ��[�d' ' V _rels/.relsPK- ��[YՊ� k � xl/worksheets/sheet1.xmlPK- ��[1��� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E xl/styles.xmlPK- ��[S΅r � � xl/sharedStrings.xmlPK � U
application/vnd.ms-excel
Sample:
PK ��[��ڶ 5 xl/workbook.xml � (� ����0��&�C���R8q���{-[�@����[J ��mgv�ۡ�����}�dB�[,ct !�K�,���v�z�b��E��Co�[���\5�0��� R��W�?��<�!H�����2�;�K���9d����b"���o�f�~�2LC�{Fٹ -.1�J�]\��Pռ,8�����a�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 ��[��cz' ' _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="R0d64d01a595d416b" /></Relationships>PK ��[YՊ� k xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!� ȅ$o>x�]�^�6!�dcٻ�s$C��F�ݭ�s�������/&��/��U��z4��:��-��q��G����b\U�^������ry�l0X\���pQԷ�,�]���p~����ד�긾��V�� �0�yu3\�������m�^��y5�G��<��'����h����ͫ��~)����� ���o��~���[�ߺ����dt�k�~���l�U�û��E}����/Kz]sU�,ֿ���w��t�w���d��}!�0�Ww�e=�|�k��`S�:��6h�R�K�m�7���GW8ƃ6�K�.W�r�ȱ��N?��l���Z(!�7�YH��M�}b��Ի]�(�D#����7��qn�t8�A��e�\�(�H��V`�U����<�qR�0���Qd{k��� �r�:�;�I[��.L %X��QqR7;��j7�q��ړ ��X��� AB���>i��r����M�Q�5;x�o�����ӌ ��=�7>�a&!j�MQ�����4*CN���R�lFI��J�P+Lxy@�"4��@���� e2:��E���]1�2F��Q�`��� 5Z !� ����E]8��)a>� jvZD[h魒B;Z�t�Zߚ!�\� ��P&1jZ�p)��3B8e:D-�N�R����2<Ό�1jᩧ�^��t� 8�~�&��I��G�`�$���=`o&�&�<������0ܨRW���d��Et����`��{t�Zĝ�-gܞ��E�Ӣ2E8�X�tNH��ZT���N�� ���TF�^��N��!�C��!��&/�����rxt0��{��r��T����;sx ^���?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���nC�P^2�L��;мo�ѤgZӨg 4��;I��&��%��3#�|�C>2"�O�(�,1�yb�"��9���;�&B��*/�X�tJ:��%v�L�}ϫ�3(��3�CY�(�h�z�{4�Ӳ� ���7�� Au��Ujh�O���T���ʓ����=0)o�{��dܥ� ��K���Ws�`�<�fg�V*�.�1�ʘ�KBS��M��Me�5MeBS9q����ib�]b�=3M�<�#���@h*'�<O�]$�>'־tG�r�<�ʉ�.k����JS9�CY�(�tS��tR�e�L*��f��M�T���ʓ����=0)o�{��d��Me�I�=0g�������ɸ����^V��w*��9=�PK ��[�i� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8&&I��ݰa[z��Q;�]�gc���V� �X��f1������|���ަ��`��wXQA��\/��]��f��Ly#�a�$?qQ�Mi^S��I�������0ɔ���Y���ޗeMÒ�Lr8���7fP���iB�� �W��"& zL~Z�^+2ȓ�7 �4�+��z3���#�_��z!�y���:���67��2�~N!���i�^�1�X˪N���|U_���]l� 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 ��[S΅r � xl/sharedStrings.xml � (� �U�n�0�A�lɖ �A� A���"76�tɕ��K9M�H�Շ>jfw�;��&�e�lAi.�ԍ��u@PɸXM�ۛ/u�D0RHS��:����T���q�)4]CI�/7 s/UI�|�U�7 �k ,�`���$\������d�S ����+`�� �Ύ&�&A��������gm��y�RY�RB;13�ԛ~.)A#��om�g�n������F�䑗\Cg�+����E��9�+e�cg%Y���������N��]��������O��18�]5.l��tsy�8���X,u�h+��[����������n3�F��K�yc1��mja$��D@�q=@���d�v���טN/��v&v��f�L���yQ�Fq�V�5�-��ZV� �b��`�F7�j6�����"���+D˰;�:�u�J^#��h�qE�ӑ7 y1K������!I�(��s4)7���H�r���Mߨ������~����M��,',��!5# ��4za�$�8��<�e��)�^��!��|4H�aF���%��t�=|�����_a�I�7�Ph�x���V��E���0=`ް�E�OA���?�Ew�Z��z��v&~S?0?��PK- ��[��ڶ 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[��cz' ' U _rels/.relsPK- ��[YՊ� k � xl/worksheets/sheet1.xmlPK- ��[�i� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E xl/styles.xmlPK- ��[S΅r � � xl/sharedStrings.xmlPK � T