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": "QGmiqAlFd02l4WzkION1gA==",
"guid": "a8a26940-4509-4d77-a5e1-6ce420e37580",
"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": "G5VDsXniBU+iA9MYp++pow==",
"previousFormGuid": "b143951b-e279-4f05-a203-d318a7efa9a3",
"nextForm": 1,
"nextFormG_UID": "CU4n8zPLcki2BCmi3KuL8w==",
"nextFormGuid": "f3274e09-cb33-4872-b604-29a2dcab8bf3",
"attributes": "sample string 10",
"updated": "2026-04-03T06:15:30.577093",
"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": "TwUDxI5eO061jE4maX6SGQ==",
"checkoutFormGuid": "c403054f-5e8e-4e3b-b58c-4e26697e9219",
"identifier": "Ys/aGMMUWEuhnIwU/2CYog==",
"identifierGuid": "18dacf62-14c3-4b58-a19c-8c14ff6098a2",
"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": "rG1GOb0RQUy4veP6YawH5g==",
"valueGuid": "39466dac-11bd-4c41-b8bd-e3fa61ac07e6",
"buttonText": "sample string 10",
"valueText": "sample string 11",
"drawImageAndButton": true,
"updated": "2026-04-03T06:15:30.577093",
"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-04-03T06:15:30.577093",
"imageData": "QEA=",
"readOnly": true
}
},
{
"$ref": "2"
}
],
"panels": [
{
"$id": "4",
"id": 1,
"checkoutFormID": 2,
"checkoutFormG_UID": "dSQ0MnkV+0ulajhr1a5eqQ==",
"checkoutFormGuid": "32342475-1579-4bfb-a56a-386bd5ae5ea9",
"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 �1�\N���� 5 xl/workbook.xml � (� ����0D�&�C���F�N\�z���6Ж�5��$��ξ>Z���v�{�sWP3����h�NX�!D�^�
��l��hK�����5^��Ӆ����1�~AiP���!|j�T8�YFc�;��-!���3l��1����dv�mA���\��qʲ�)�5���э��8[�_PK �1�\���� � [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
�1�\�F{' ' _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="Rf1cc63a70f0a46bb" /></Relationships>PK �1�\E�me� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6�$�܀\H�惗��l����e��Αy ��F�ݭ
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}s2:�5v��Z�~6�����SM~���%����o믽�d�]�7�Y�}?-LJ}_H%���bYO/~,c�Cl�`['���RJxi�M�����
c�"�0�)��W�z�ȹ��N?��l���Z(!��ZH��M�}b��Ի]�(�D#����7��qn�t8�A��e�\���H��Va������<��`��"�}�CT�����io�0��ܹ���Nh� �H �c�CT����w@�L8d�"��dC|�pV+!�B���!�O�f�����Fz�;Eԟt�ޅ�!��6�4��o��bI��DA�"<:�y�J��J��%A�"`+2C�0� �u Q��Т/ �V�*'��� �A7cW
�J^Ԕ����I�P���r���E]8��)a>� jvZD[8'B�8�M�C�"�����V8��0�Q���".D�������;-JYHV�^��83jƨI���b{c�Q&���u��Ė&�ShLx�d��I��������D�HWc�"��3�p�Jr��U�';D-�kNn+V�أC�"�n9��dPE-���)����sBڌTԢ�O���vZ�� ��נ�2���E�Ӣ�E��ma����������x�����|���>���b��ރ�����8�^�n/��F��"��8�"�����Pmī.B����F��"lq�E�6ⴋ�m�[�1B�;BX}�@���#!Ğ1��9!�^0��'B���@�_�v�2��%!�~c ��������vKƄ@�-��H.+a�d̈�⒱#�KƐHH.K"a�dL��撱%R�c"�q&R�k"��&R�s*�3�NEyf�v<B�o�v��"&�_@�!y(/y&��h�7�h�3�i�3����$�Nkok�p��!��GB�u���<�v�X��X��I!i�R�� :%yr_;]&־�U���t��ء,�[��y4M=�=��i�G�F���^�ib��f��i|�N5HY�<ɋ�<���V���J�]�� ��4�u0g��s�`vVn�2�R��Y�d 4��;�Tn��TfZ�Tf 4��;I��&��&��1#�T�C>0����rb����Eb�Sb�sw�N*��ө���2��-���̠4�;�e~��1O7�L'�[ɤrjh�O�TN5HY�<ɋ�<���V���J�]�Tf0�T�s�`:��`h*�1W�Q5U��j������N��PK �1�\6g��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;qH��
�n)p�q�ؖmh9[=R�P�J�����h~OO��|�����\����Y�0r�}砞�m7�x�~�'qE���R/��όE;ʸ�����Z.N�GZ������Lr�Z��(5
�q�Q�?��ո��#w=�~J���"�T ϲ�C�X��@^�]��>L͇����;Od�K)K,U'�V�2w(_���N��r�&��Y)U��X*��ѻ��~PK �1�\Ѓ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 �1�\Pc�t � xl/sharedStrings.xml � (� �U�n�@��;w0Pَb��Hq�^��]`l�������4Q�np��93�3g�,ӃǪ4�Z���ٮi �낲�̼�9��HXAʚ���@���|*2����El>9�ȷPa�
0ɬk^��|㈆)� ���]w�T�2����̌R�h�����G���gGS�S��zFN�j��C��X��ƚk�R�;�3�t����9A)��oC�-p;?�lq���#�� e�+�d����.�+�*���uY�|�/�j_�龀��4�RѲ�1��Is7�NU���[�_���ѻ ��.�u�_pm�WRS��ӬEC�)�.���-&tH-�$��0(�C y���E�����5F��D�P�����#���tQ��p�P+� � 礫[�P��B~/�^7�j������"�b-�f؝~
z� ��^tw?�$I�?IC�
#7��"�-�gMr}�8J�a� US�|\�D#�'C����&�S�q:��!�ya�F^f���nd�
�"��$�?A*�gA`�I�[��
-?%~��,��J��6�=�y�^��DW��g���*��>^-m�Uvoa�����(�)0�4�ϩ�_�ݿV����w���o�;�=�PK- �1�\N���� 5 xl/workbook.xmlPK- �1�\���� � � [Content_Types].xmlPK-
�1�\�F{' ' U _rels/.relsPK- �1�\E�me� l � xl/worksheets/sheet1.xmlPK- �1�\6g��� P � xl/_rels/workbook.xml.relsPK- �1�\Ѓc'2 E
xl/styles.xmlPK- �1�\Pc�t � � xl/sharedStrings.xmlPK � V
application/vnd.ms-excel
Sample:
PK �1�\!bʇ� 5 xl/workbook.xml � (� ���� D�M��(X�6���zYQ� ���*F��zۙ�};lr����cJ_a�XZ����λ�y��,�����-4�}���)���٠��J��F\Ͱ����Bli��0�$gc�����!�b �_$�,7P�G�Qr��F����yF魐���%��������PK �1�\���� � [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
�1�\�s90' ' _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="R19886129f02c446a" /></Relationships>PK �1�\E�me� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6�$�܀\H�惗��l����e��Αy ��F�ݭ
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}s2:�5v��Z�~6�����SM~���%����o믽�d�]�7�Y�}?-LJ}_H%���bYO/~,c�Cl�`['���RJxi�M�����
c�"�0�)��W�z�ȹ��N?��l���Z(!��ZH��M�}b��Ի]�(�D#����7��qn�t8�A��e�\���H��Va������<��`��"�}�CT�����io�0��ܹ���Nh� �H �c�CT����w@�L8d�"��dC|�pV+!�B���!�O�f�����Fz�;Eԟt�ޅ�!��6�4��o��bI��DA�"<:�y�J��J��%A�"`+2C�0� �u Q��Т/ �V�*'��� �A7cW
�J^Ԕ����I�P���r���E]8��)a>� jvZD[8'B�8�M�C�"�����V8��0�Q���".D�������;-JYHV�^��83jƨI���b{c�Q&���u��Ė&�ShLx�d��I��������D�HWc�"��3�p�Jr��U�';D-�kNn+V�أC�"�n9��dPE-���)����sBڌTԢ�O���vZ�� ��נ�2���E�Ӣ�E��ma����������x�����|���>���b��ރ�����8�^�n/��F��"��8�"�����Pmī.B����F��"lq�E�6ⴋ�m�[�1B�;BX}�@���#!Ğ1��9!�^0��'B���@�_�v�2��%!�~c ��������vKƄ@�-��H.+a�d̈�⒱#�KƐHH.K"a�dL��撱%R�c"�q&R�k"��&R�s*�3�NEyf�v<B�o�v��"&�_@�!y(/y&��h�7�h�3�i�3����$�Nkok�p��!��GB�u���<�v�X��X��I!i�R�� :%yr_;]&־�U���t��ء,�[��y4M=�=��i�G�F���^�ib��f��i|�N5HY�<ɋ�<���V���J�]�� ��4�u0g��s�`vVn�2�R��Y�d 4��;�Tn��TfZ�Tf 4��;I��&��&��1#�T�C>0����rb����Eb�Sb�sw�N*��ө���2��-���̠4�;�e~��1O7�L'�[ɤrjh�O�TN5HY�<ɋ�<���V���J�]�Tf0�T�s�`:��`h*�1W�Q5U��j������N��PK �1�\_z�f� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�qLIP�nذ-��?�$jbG��l,8W� R���F�{z�����z�:��C�k�,tڛ�u-���a�Y�p�)O�~�#�+.�Ч4�Su��������a�)������!匭hX2�I���C���>N��`���!�� �^�S?�Hϡ,2ȣia������T�4�2
��ZL���w��������j�h���L/���N��B�Kˮ�j4*!�8�ы��|PK �1�\Ѓ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 �1�\Pc�t � xl/sharedStrings.xml � (� �U�n�@��;w0Pَb��Hq�^��]`l�������4Q�np��93�3g�,ӃǪ4�Z���ٮi �낲�̼�9��HXAʚ���@���|*2����El>9�ȷPa�
0ɬk^��|㈆)� ���]w�T�2����̌R�h�����G���gGS�S��zFN�j��C��X��ƚk�R�;�3�t����9A)��oC�-p;?�lq���#�� e�+�d����.�+�*���uY�|�/�j_�龀��4�RѲ�1��Is7�NU���[�_���ѻ ��.�u�_pm�WRS��ӬEC�)�.���-&tH-�$��0(�C y���E�����5F��D�P�����#���tQ��p�P+� � 礫[�P��B~/�^7�j������"�b-�f؝~
z� ��^tw?�$I�?IC�
#7��"�-�gMr}�8J�a� US�|\�D#�'C����&�S�q:��!�ya�F^f���nd�
�"��$�?A*�gA`�I�[��
-?%~��,��J��6�=�y�^��DW��g���*��>^-m�Uvoa�����(�)0�4�ϩ�_�ݿV����w���o�;�=�PK- �1�\!bʇ� 5 xl/workbook.xmlPK- �1�\���� � [Content_Types].xmlPK-
�1�\�s90' ' V _rels/.relsPK- �1�\E�me� l � xl/worksheets/sheet1.xmlPK- �1�\_z�f� P � xl/_rels/workbook.xml.relsPK- �1�\Ѓc'2 E
xl/styles.xmlPK- �1�\Pc�t � � xl/sharedStrings.xmlPK � W