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 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": "J7bx6dCfukecz+mWGkapuA==",
"guid": "e9f1b627-9fd0-47ba-9ccf-e9961a46a9b8",
"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": "HjEFdBbLe0O+G+17M3wMEQ==",
"previousFormGuid": "7405311e-cb16-437b-be1b-ed7b337c0c11",
"nextForm": 1,
"nextFormG_UID": "ZFjC76dDCUGtMT//ujnM4Q==",
"nextFormGuid": "efc25864-43a7-4109-ad31-3fffba39cce1",
"attributes": "sample string 10",
"updated": "2026-06-03T18:31:27.523766",
"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": "i/faXMMNrUOKyCBATa1UsQ==",
"checkoutFormGuid": "5cdaf78b-0dc3-43ad-8ac8-20404dad54b1",
"identifier": "Ho8T+DzvkEGXeBGwxxsTOw==",
"identifierGuid": "f8138f1e-ef3c-4190-9778-11b0c71b133b",
"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": "dDKBYThffUOCbh2wQv3GAA==",
"valueGuid": "61813274-5f38-437d-826e-1db042fdc600",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:31:27.523766",
"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:31:27.523766",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "2"
}
],
"panels": [
{
"$id": "4",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "NxgcbYAEyESUIwr71rB2Mg==",
"checkoutFormGuid": "6d1c1837-0480-44c8-9423-0afbd6b07632",
"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 ��\A/�� 5 xl/workbook.xml � (� ���� ��M��(�jz��k�#��(`��>~�Io����~;t2�o���G
������ �q���A�]g�b>H�"��$����I�$gba`^�^h���h��N x5,(Ť��~���=%L.�`�ug�%D~S4¶���f
J\3�0�ν-�#[�0<�'����³�5�{�Q����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
��\��J' ' _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="R5f1460c228894b3e" /></Relationships>PK ��\L�O� j xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!�
ȅ$o>x�]�^�6!�dcٻ�s$C�A=�QowkC������T�Ť��e!��jvU�&�_�����?����ྞ�^��j�������?^.o�
��q5.�������z>.÷�_���zrU�Ww�j��f0�n�˰�b<�]����kq;����ӛ�V��d�?:MB���yu}�/��������mR�/�{���[Wߜ��b�t����{��zxw�����V�_�e`I�k����ko:Yq��M���OF��a�R }u�X��ˇ�X�P�:��I,�A��^Zo�����m=�����!*o��jS�9����G֙M�ٝWV%d��9�z���O�w�z����hD��9.]�7��qn�t8�A��e�\���H��Va������<��`��"�}�CT�����io�0�EP[�Cԙ� M��wa)�z�t�����!�h� ���UdԞl���j%�Vr<D�I���c�U�Hor��������p~#�w��fT�����A{0 Q� �h"�Z�G��6�Qi����R)p6�$�ZlEf�&<�� jZ���JZ�2@�"초�0^?��a���E0MOJ����G�{�Q��Т.jg��0e�;-�)
���J����5C�����2Lb�"6�����3B8e:D-�N�R���1dx��g�Q�O=��Ʀ�L����5�-MJ���=��&Q7g ��f2j�#]�Q�h�� Í*U�cW������9}��X9b�Q���"`��ۓA��vZT����� is/SQ�J>�CԢ�iѺ��^����<���N��!�C��!��&o������rxt0��{��r��T����Ksx^���?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�Ӳ�2�E���s�`'h_�ff�iz�I5H9�<�k�<���V���J�\�^ ��4� {u0g��s�`vNn�2�B��Y�d 4��;�Pn��PfZ�Pf 4��;I��&��%��3#�P�C>2���rb����Eb�sb�Kw�N(��ӡ���2��=��̠4�;�e~��1O7�L'�[I�rjf�N�PN5H9�<�k�<���V���J�\�Pf0�P�s�`:��`h(�/W�Q5]��j�����?N��PK ��\�Z#Z� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8u���ݰa[z��d�DM��v���G�
XE�Tb�������4������xazgkXd9��5����`�Y�x��&B�OA�j�b�VR�xĐ��m��G�)�����زTy^J?g�5S�������F���|u�:�b���X�O)�KXd�
⩩aW(��tuOzY ���B<~���#�%)S5T�n+ӡ��9�t�Ӽ<S+�9(� �0ڨ�&��b�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 ��\};NEr � xl/sharedStrings.xml � (� �UkO�0�+Q��EڄLm-�!Q�xh4m�s�Z$vg� ¯�S��4���9�\���\gr�XW�H�����p*
�WS�����w����n�uf��ѥ\M�5��S(���(_l�k��&�?�*P �Pk ��`/��&��
ǩ;�\���w�W@o�f��M�M���9�ykV��cSy�BZ�RC;�g�i7~.(Am��o}�+p�?[���.�#���8W���+��9��+��+�j��A/D%9� ���C���4�R���1���r7��t�R���.og��;�%R���_p뢯�e�CD��A���MA�L��P����>�Ж �K¡2RЮn)
òm��Uc�rX!H(��vx�쑮�t:��H��j�� ��e_���k���6���o5]�.ͼA�v럁^�
���-�ݏ> Y��^�eez�4'^Fi�A�%%$���5�ԛ
��-Z9��tҧodcx�$�M���t��(��Q��4�r�r�4�㔆4�[J�7�OFZNRo��G�8��,sk���y�F�C�q�?~bK��3)�n*�/��*����w�o��2(�)p����L���_W�������6�o��{�PK- ��\A/�� 5 xl/workbook.xmlPK- ��\���� � [Content_Types].xmlPK-
��\��J' ' V _rels/.relsPK- ��\L�O� j � xl/worksheets/sheet1.xmlPK- ��\�Z#Z� P � xl/_rels/workbook.xml.relsPK- ��\Ѓc'2 E
xl/styles.xmlPK- ��\};NEr � � xl/sharedStrings.xmlPK � S
application/vnd.ms-excel
Sample:
PK ��\rh�<� 5 xl/workbook.xml � (� ����0D�&�C����@������
�%m
~�P�7o;��o����t�z�r[R���3��
����7V���}1ùl�6�[���E ��F;!G�?,7X�� D���@jZ�w�s����9k��$l ��T`�EPD������ڒ)����;D1��|��MgIJ7�+����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
��\*̌�' ' _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="R3fcc3bd7cef1498f" /></Relationships>PK ��\L�O� j xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!�
ȅ$o>x�]�^�6!�dcٻ�s$C�A=�QowkC������T�Ť��e!��jvU�&�_�����?����ྞ�^��j�������?^.o�
��q5.�������z>.÷�_���zrU�Ww�j��f0�n�˰�b<�]����kq;����ӛ�V��d�?:MB���yu}�/��������mR�/�{���[Wߜ��b�t����{��zxw�����V�_�e`I�k����ko:Yq��M���OF��a�R }u�X��ˇ�X�P�:��I,�A��^Zo�����m=�����!*o��jS�9����G֙M�ٝWV%d��9�z���O�w�z����hD��9.]�7��qn�t8�A��e�\���H��Va������<��`��"�}�CT�����io�0�EP[�Cԙ� M��wa)�z�t�����!�h� ���UdԞl���j%�Vr<D�I���c�U�Hor��������p~#�w��fT�����A{0 Q� �h"�Z�G��6�Qi����R)p6�$�ZlEf�&<�� jZ���JZ�2@�"초�0^?��a���E0MOJ����G�{�Q��Т.jg��0e�;-�)
���J����5C�����2Lb�"6�����3B8e:D-�N�R���1dx��g�Q�O=��Ʀ�L����5�-MJ���=��&Q7g ��f2j�#]�Q�h�� Í*U�cW������9}��X9b�Q���"`��ۓA��vZT����� is/SQ�J>�CԢ�iѺ��^����<���N��!�C��!��&o������rxt0��{��r��T����Ksx^���?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�Ӳ�2�E���s�`'h_�ff�iz�I5H9�<�k�<���V���J�\�^ ��4� {u0g��s�`vNn�2�B��Y�d 4��;�Pn��PfZ�Pf 4��;I��&��%��3#�P�C>2���rb����Eb�sb�Kw�N(��ӡ���2��=��̠4�;�e~��1O7�L'�[I�rjf�N�PN5H9�<�k�<���V���J�\�Pf0�P�s�`:��`h(�/W�Q5]��j�����?N��PK ��\��K<� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞ح�6��vÆm�g�DMl�v���G�
XEWb�������4����ݿ�yAFkXe���
��~�`��p�1M�at��btJ�p���M�h�gS�{�:�钱�9n��xq���zT�h�yF� �W�Oa@�@����)z
�"Q�<u
$�k�.+%D���л��x�0�z}癌��u�\�(x��Uf����ӥs�����\j\�V��W5z��/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 ��\};NEr � xl/sharedStrings.xml � (� �UkO�0�+Q��EڄLm-�!Q�xh4m�s�Z$vg� ¯�S��4���9�\���\gr�XW�H�����p*
�WS�����w����n�uf��ѥ\M�5��S(���(_l�k��&�?�*P �Pk ��`/��&��
ǩ;�\���w�W@o�f��M�M���9�ykV��cSy�BZ�RC;�g�i7~.(Am��o}�+p�?[���.�#���8W���+��9��+��+�j��A/D%9� ���C���4�R���1���r7��t�R���.og��;�%R���_p뢯�e�CD��A���MA�L��P����>�Ж �K¡2RЮn)
òm��Uc�rX!H(��vx�쑮�t:��H��j�� ��e_���k���6���o5]�.ͼA�v럁^�
���-�ݏ> Y��^�eez�4'^Fi�A�%%$���5�ԛ
��-Z9��tҧodcx�$�M���t��(��Q��4�r�r�4�㔆4�[J�7�OFZNRo��G�8��,sk���y�F�C�q�?~bK��3)�n*�/��*����w�o��2(�)p����L���_W�������6�o��{�PK- ��\rh�<� 5 xl/workbook.xmlPK- ��\���� � [Content_Types].xmlPK-
��\*̌�' ' V _rels/.relsPK- ��\L�O� j � xl/worksheets/sheet1.xmlPK- ��\��K<� P � xl/_rels/workbook.xml.relsPK- ��\Ѓc'2 E
xl/styles.xmlPK- ��\};NEr � � xl/sharedStrings.xmlPK � T