GET api/checkoutforms/{formType}?relations={relations}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| 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": "mgjfTmo+gEK2u93mOWiIPg==",
"guid": "4edf089a-3e6a-4280-b6bb-dde63968883e",
"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": "U9G2V6sNYESWNGtOphPrrg==",
"previousFormGuid": "57b6d153-0dab-4460-9634-6b4ea613ebae",
"nextForm": 1,
"nextFormG_UID": "0eI2WAVXWUetrFZxpfzNRg==",
"nextFormGuid": "5836e2d1-5705-4759-adac-5671a5fccd46",
"attributes": "sample string 10",
"updated": "2026-06-03T18:30:31.1348378",
"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": "W2F6/pVzfEWo4T3vKFJtfw==",
"checkoutFormGuid": "fe7a615b-7395-457c-a8e1-3def28526d7f",
"identifier": "AjJpgHFJVUam7w70yxk8SA==",
"identifierGuid": "80693202-4971-4655-a6ef-0ef4cb193c48",
"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": "UeKNRKrcAUmDggaoEUuE8Q==",
"valueGuid": "448de251-dcaa-4901-8382-06a8114b84f1",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-06-03T18:30:31.1348378",
"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:30:31.1348378",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "2"
}
],
"panels": [
{
"$id": "4",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "4DPw4b6Rzk+9XDX6P2bJXQ==",
"checkoutFormGuid": "e1f033e0-91be-4fce-bd5c-35fa3f66c95d",
"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 ϓ�\��58� 5 xl/workbook.xml � (� ����0��&�C����)��x��}-�m�?ik��-%�x�3;������i�H>z2��
�1��� $j'�Ф�`����1;J`g�[���<�+�q��� R�@W�?��<B$b�ӊҠm�B���pY&c�����!����_dEhlh(�έohA��U�} ʲ/�� �bc�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
ϓ�\a?�}' ' _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="R91b350e815ee4d92" /></Relationships>PK ϓ�\��X�� k 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��VN��(�2��m�|��j[�Y��u�9�,�b�q鴵F��Ͷ�<��n�mS�
�A�@����t��ֹֻ�T�����E��G�w
{��x��C;'�劅���t�*���[Y�a�;w�o��M!��a΅q���U�C�]��:Fd�£�xK|��FIƔ�E���>n��r�4�h�t�Qܶ;8ίw֙�ӌ
�;��.�a&EԠ`O4��Z���]މVeȫ���RX�Q��ZЉ�P�txy��E�Ң+h%���I�с�Z��LAH�!�J���(tۓ\��D�#�{�Q���EUXP�)A>�DԢh�&�B�z�5��CD)
�!�\�0�O"!JZR�
������ J)r^pNr���43b�(IO=�����t��A��!J:��V��B�,% �=��no&�$A?����� \�\�Xцg�Q�`�Ӈ����!����1k�'�2jQ6Z���g��2nt�CԢ�O��(-[���Rˌ�eԢl�hL�=$[���ar��B�y�=��Guu?�7ˡ�����w���o�����Ϻ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�>R������N�Z�RC~R8>ߤ���O���{`R��{���R� �0���z�3��9'0��;�M*C"�!+���r{���5��Dk���r�|'����ڻ��{b$��y�G�S���TN�y�X�H�}N�}��K�Ny:�;]&־�U���rb��[x�<�T&0�T�X$�ʩ� ?�S9� e%��?�����\�pW?� L/�����^*�ʣ�oL��xR֯�jU֛ߩ��rz�PK ϓ�\`��)� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8v�)�i7lؖ^`�㨉�.г��H\�H�J,�t5��ӓf>�?6��id/���l"ˁ�U�l��)�5춛=��D0�XZ�����yP�&��ɦ�v~R���{�2�+��f��y���փ�G�N����:�(;��)6�S
�D������]����Za�J �7S�<R���Η2��Ri!�Rm��TƠ��9�t�Ӳ�P[W2�m��EQ��/j��/�_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 ϓ�\,~=5r � xl/sharedStrings.xml � (� ���N�0�_%�}N��jw���"�A=��u�a�"�S{�O_g)������x<�Ǚ�?��� R1��v���<���ܾ�>vR�RH8%��0�P����)��^����"V�<O�[(�rE\�;!K��Sn<UI Tm�,�=�O��0n[��9��xj[5g�kX�
z�����p��b�_���ϛ�f��}���W(d�|NJ�j���Me�g"'���#��0�ۮ��f�]uMY�ǹŞHV�,I~���s�$�����?�8X���xLJV4}�=�܍ֱ1�q!၉Z��7�zm�.��R��}�_�ޤ��'��dY���䦢M\�Z����n p�
��P@ޮ[j�lg��|�1j9($�S��.=��z*]5T�q�m�� g�u�0��B~�Y۷��l{�6棋�Yֈ=����P��P����GF@��tJ��D{��dI�9�BN�4MC���U�q�-�X�0N��Z�#'�8��.�'YB�8t|J2'�ߙ&a�$Y$ BȈQP�� ����'~�D�x�Jr'N&���F��ޗ�#<�a�=�5����n;
�r��+WO��ZD�C�������{$��3��Wp��ٟ�g���m�3����a/� PK- ϓ�\��58� 5 xl/workbook.xmlPK- ϓ�\���� � � [Content_Types].xmlPK-
ϓ�\a?�}' ' T _rels/.relsPK- ϓ�\��X�� k � xl/worksheets/sheet1.xmlPK- ϓ�\`��)� P � xl/_rels/workbook.xml.relsPK- ϓ�\Ѓc'2 E
xl/styles.xmlPK- ϓ�\,~=5r � � xl/sharedStrings.xmlPK � P
application/vnd.ms-excel
Sample:
PK ϓ�\��*� 5 xl/workbook.xml � (� ����0��&�C�`Q�
)��x���E�O�||o�vfg�6������sW@��)�M�������5N��{QӶ���4o�:�S�\�Ái������ay��!5,(ť�r�#�M͞G?�h�u'��%DSl�m�"�+,�����(���2�$�6x;�:M�"����]�_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="R043028b8b6e04252" /></Relationships>PK ϓ�\��X�� k 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��VN��(�2��m�|��j[�Y��u�9�,�b�q鴵F��Ͷ�<��n�mS�
�A�@����t��ֹֻ�T�����E��G�w
{��x��C;'�劅���t�*���[Y�a�;w�o��M!��a΅q���U�C�]��:Fd�£�xK|��FIƔ�E���>n��r�4�h�t�Qܶ;8ίw֙�ӌ
�;��.�a&EԠ`O4��Z���]މVeȫ���RX�Q��ZЉ�P�txy��E�Ң+h%���I�с�Z��LAH�!�J���(tۓ\��D�#�{�Q���EUXP�)A>�DԢh�&�B�z�5��CD)
�!�\�0�O"!JZR�
������ J)r^pNr���43b�(IO=�����t��A��!J:��V��B�,% �=��no&�$A?����� \�\�Xцg�Q�`�Ӈ����!����1k�'�2jQ6Z���g��2nt�CԢ�O��(-[���Rˌ�eԢl�hL�=$[���ar��B�y�=��Guu?�7ˡ�����w���o�����Ϻ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�>R������N�Z�RC~R8>ߤ���O���{`R��{���R� �0���z�3��9'0��;�M*C"�!+���r{���5��Dk���r�|'����ڻ��{b$��y�G�S���TN�y�X�H�}N�}��K�Ny:�;]&־�U���rb��[x�<�T&0�T�X$�ʩ� ?�S9� e%��?�����\�pW?� L/�����^*�ʣ�oL��xR֯�jU֛ߩ��rz�PK ϓ�\#�3b� P xl/_rels/workbook.xml.rels � (� ��An� E��f_�8�Q�l��6����9[=R�P�J�#u�MVh���������4�W�a���E�A#�L��9����GӍ�.��Ą�݊� {�DȬC�:��I�T��:!O�CZ�9�~{&9\��h�$>[y���?��b�)��A�c?Q��c�%*��ja�7
��z���U�B��u����]�e�rY�,�:g\���£z�>mz�4�gj�t��GV!kJ~S�w�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 ϓ�\,~=5r � xl/sharedStrings.xml � (� ���N�0�_%�}N��jw���"�A=��u�a�"�S{�O_g)������x<�Ǚ�?��� R1��v���<���ܾ�>vR�RH8%��0�P����)��^����"V�<O�[(�rE\�;!K��Sn<UI Tm�,�=�O��0n[��9��xj[5g�kX�
z�����p��b�_���ϛ�f��}���W(d�|NJ�j���Me�g"'���#��0�ۮ��f�]uMY�ǹŞHV�,I~���s�$�����?�8X���xLJV4}�=�܍ֱ1�q!၉Z��7�zm�.��R��}�_�ޤ��'��dY���䦢M\�Z����n p�
��P@ޮ[j�lg��|�1j9($�S��.=��z*]5T�q�m�� g�u�0��B~�Y۷��l{�6棋�Yֈ=����P��P����GF@��tJ��D{��dI�9�BN�4MC���U�q�-�X�0N��Z�#'�8��.�'YB�8t|J2'�ߙ&a�$Y$ BȈQP�� ����'~�D�x�Jr'N&���F��ޗ�#<�a�=�5����n;
�r��+WO��ZD�C�������{$��3��Wp��ٟ�g���m�3����a/� PK- ϓ�\��*� 5 xl/workbook.xmlPK- ϓ�\���� � � [Content_Types].xmlPK-
ϓ�\���' ' U _rels/.relsPK- ϓ�\��X�� k � xl/worksheets/sheet1.xmlPK- ϓ�\#�3b� P � xl/_rels/workbook.xml.relsPK- ϓ�\Ѓc'2 E
xl/styles.xmlPK- ϓ�\,~=5r � � xl/sharedStrings.xmlPK � S