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 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": "Po2SA8MylUmxeBnner2bjQ==", "guid": "03928d3e-32c3-4995-b178-19e77abd9b8d", "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": "zWJQCvdlwkynaFpBTTsetQ==", "previousFormGuid": "0a5062cd-65f7-4cc2-a768-5a414d3b1eb5", "nextForm": 1, "nextFormG_UID": "to3nhM/SsE+Nb3zbsQeqEg==", "nextFormGuid": "84e78db6-d2cf-4fb0-8d6f-7cdbb107aa12", "attributes": "sample string 10", "updated": "2025-10-04T23:57:29.0868452", "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": "AGV4vRvXS0KBCgZMEM08FA==", "checkoutFormGuid": "bd786500-d71b-424b-810a-064c10cd3c14", "identifier": "BPEpT7Cc7UKZdDUCAIgG/Q==", "identifierGuid": "4f29f104-9cb0-42ed-9974-3502008806fd", "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": "2RyeoKmiREi3olpckbMvgg==", "valueGuid": "a09e1cd9-a2a9-4844-b7a2-5a5c91b32f82", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-04T23:57:29.0868452", "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-10-04T23:57:29.0868452", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "DDGo6xQDikKzrc3vKfDPPA==", "checkoutFormGuid": "eba8310c-0314-428a-b3ad-cdef29f0cf3c", "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 .�D[~�Pƶ 5 xl/workbook.xml � (� ��;�0D�H����@����I�"�b��d;"���.�������Ck�@>z4���1��� $j��̻�z q���l�+��o�&�,I �q��� R�@7�?��<B$b��Ҡ��'B���p �����b���o����bUĀƊ6��չwM)G�b�淶�5�у}�8��_PK .�D[���� � [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="R68da48702f0945b0" /></Relationships>PK .�D[���w� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!� ȅ$o>x�]�^�6!�dcٻ�s$C�A=�Qowk������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=�BH@/$+�KM�z��zS�Yg6ufw^UX-����,����>��m�ݮ^+�D��9����7��7h�L�Ku"I��*��Qc�����Z����t�*���[;�&H ]��Qgr'4iޅ ��1�!*N�f��;�u&2V�Q{�!>W8��Z!H���'m�CP�QVY#�ɝ"�O�f������y�{�Q�ҷg��1��$D �x�� jwۼ�F� B sK��ٌ� j���V���:��Ehh��F+i��dt Q���"�B�B�^(�t���E0MOJ����G�{�Q��Т.jg��0e�;-� ����8P^��)���fW���a0T�I�ZĆ�p!R�wF@�L��E�iQ�Bb���R�Ǚ9FM"<��[��2�GدC�$�4)�Bc �H��Dݜ�ߛɨI4�t5F-�m>7�T!W�{��t�ZDל>�V��G��E�i0�r��ɠ�ZT;-*S���M焴&�!jQɧv�ZT;-ZW�T�k�R�{��ZT;-Z[�l�����<�Ѯ_�����������ˡ��S>.�/��=x^������U�m��.ڈ�.ۈW]�j#^w��x�E�6�maۈ�.µ�]�o#�1�R�3��Bh��@��!���f�����n?3B�B��ʨ�����v/a�;!��` �ݟ��[2&Bo���%gDBp�X�%cF$���p\2�DBr�X �%cJ$4��-���)ό3���X)ό7��̘SQ�w*�3cO��yB���K~�1��� �Cy�@�39n�@�F��iM���ЬO��$�v�X{�X{όD��!��@��>1���Ĝ牵�����ڗ�H��k���b��)�ȓ����2��=��̠����e�ߢḍi�1�ѴO�>J{/�ށF���{�����&� e��$/��tL�[��*wiz0���`����1:�9��Y��ʸKeL�2f�����Tn�@S��FS�iMS���TN��$�v�X{�X{όDS9��@h*3�ʉ9�k��ω�/ݑ:��*O�rb������j0��TN�P��-J�<�Tf0�TnY$�ʩ�?uS9� e��$/��tL�[��*wuS��tRy���2���<h��d\ G��u]/���w*�?��PK .�D[z�_�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞x⺡EM�aö��=����.г��H\�H�J,�t5��ӓf>�?6��id/���l e���jg��p��� v�͞F�D�9��bC }���A�4�P��l��O*��w|V��:���>g�5��3����v����i"� �W珡'���wk�)~ e����L {��r�T�\H�0~3��#�_��<���4�0�h����ʓy�>]:w�˙�Z#��x���E�_���PK .�D[Ѓ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 .�D[��_Lr � xl/sharedStrings.xml � (� ��YO�0��J���m���"Z�A��h4�q���"�3���~�2 �M:��]o��:ӃǪt@H��̍��u�aN(���ۛ/s�#��fn�u�S)���29s�J՟�@�-TH���ɚ� )�)6�� "� �*�8��B��� S3w��N������^�Χj~v4 �|t_����[��P�����|�*�k'�7mm��#� ����_(Q۾��f��� =ҊJ0�s�>��4��@�~#�s�B���%o�>~���j_�龂��4S'��ek#���r7ZW��ƥ���]����]�%R�l���I_�e�C�-�Onk����K.i1ݠ}�Ԗ S��Ai�J�ݸ'�e��5�k����R� r�v�ӧGz�e����ZP��6Kp�Z�X:����f�o���<}[��E�,�,���g�TP��V�ݏ>Gy��x���q�O�"J3/�!MQA�"3쑨�KЏ��h�L�q��7�1<y?$��0#�I�Ęx�d�zc�c�I�M�8�QAa�!C��"�H���x]�^F���bRQ�"��ۈ�=<��G}~�DW��gR�]+��?^-}�U~��o���(�)0��T�_�ݿ��=#G�o�]������PK- .�D[~�Pƶ 5 xl/workbook.xmlPK- .�D[���� � � [Content_Types].xmlPK- .�D[��' ' U _rels/.relsPK- .�D[���w� l � xl/worksheets/sheet1.xmlPK- .�D[z�_�� P � xl/_rels/workbook.xml.relsPK- .�D[Ѓc'2 E xl/styles.xmlPK- .�D[��_Lr � � xl/sharedStrings.xmlPK � P
application/vnd.ms-excel
Sample:
PK .�D[� � 5 xl/workbook.xml � (� ���� D�M��(�(�=y鵇��B*`��~~Q�Io���ξ6;��{��m�}�U�SMH 7�M;��1I�$NJ-�s�m�F�g%F��A�)��+L�@4�2\[ܞO���C�V����b"���o����bU�r �x���mh�#_�4�J�eO+QH��}���_PK .�D[���� � [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="R36710693099649bc" /></Relationships>PK .�D[���w� l xl/worksheets/sheet1.xml � (� �Y�R;����Z��5�6!� ȅ$o>x�]�^�6!�dcٻ�s$C�A=�Qowk������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=�BH@/$+�KM�z��zS�Yg6ufw^UX-����,����>��m�ݮ^+�D��9����7��7h�L�Ku"I��*��Qc�����Z����t�*���[;�&H ]��Qgr'4iޅ ��1�!*N�f��;�u&2V�Q{�!>W8��Z!H���'m�CP�QVY#�ɝ"�O�f������y�{�Q�ҷg��1��$D �x�� jwۼ�F� B sK��ٌ� j���V���:��Ehh��F+i��dt Q���"�B�B�^(�t���E0MOJ����G�{�Q��Т.jg��0e�;-� ����8P^��)���fW���a0T�I�ZĆ�p!R�wF@�L��E�iQ�Bb���R�Ǚ9FM"<��[��2�GدC�$�4)�Bc �H��Dݜ�ߛɨI4�t5F-�m>7�T!W�{��t�ZDל>�V��G��E�i0�r��ɠ�ZT;-*S���M焴&�!jQɧv�ZT;-ZW�T�k�R�{��ZT;-Z[�l�����<�Ѯ_�����������ˡ��S>.�/��=x^������U�m��.ڈ�.ۈW]�j#^w��x�E�6�maۈ�.µ�]�o#�1�R�3��Bh��@��!���f�����n?3B�B��ʨ�����v/a�;!��` �ݟ��[2&Bo���%gDBp�X�%cF$���p\2�DBr�X �%cJ$4��-���)ό3���X)ό7��̘SQ�w*�3cO��yB���K~�1��� �Cy�@�39n�@�F��iM���ЬO��$�v�X{�X{όD��!��@��>1���Ĝ牵�����ڗ�H��k���b��)�ȓ����2��=��̠����e�ߢḍi�1�ѴO�>J{/�ށF���{�����&� e��$/��tL�[��*wiz0���`����1:�9��Y��ʸKeL�2f�����Tn�@S��FS�iMS���TN��$�v�X{�X{όDS9��@h*3�ʉ9�k��ω�/ݑ:��*O�rb������j0��TN�P��-J�<�Tf0�TnY$�ʩ�?uS9� e��$/��tL�[��*wuS��tRy���2���<h��d\ G��u]/���w*�?��PK .�D[��ړ� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8NҠ��tö��3��&vd����G� XE�Tb�������4����M#9���X�A�\7�^�)�l7�=�2��`�9��b� ��DiP'27�M��$cJ}Og���GZ�yE���Lr�����zP�s�4������`#���=F?�@��e� ���UU�MU�U��V-z7�/#�_��|!�Xr]�Eɛ9S�2Fz�^�O�^:-���5R�9grUs,�U�����PK .�D[Ѓ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 .�D[��_Lr � xl/sharedStrings.xml � (� ��YO�0��J���m���"Z�A��h4�q���"�3���~�2 �M:��]o��:ӃǪt@H��̍��u�aN(���ۛ/s�#��fn�u�S)���29s�J՟�@�-TH���ɚ� )�)6�� "� �*�8��B��� S3w��N������^�Χj~v4 �|t_����[��P�����|�*�k'�7mm��#� ����_(Q۾��f��� =ҊJ0�s�>��4��@�~#�s�B���%o�>~���j_�龂��4S'��ek#���r7ZW��ƥ���]����]�%R�l���I_�e�C�-�Onk����K.i1ݠ}�Ԗ S��Ai�J�ݸ'�e��5�k����R� r�v�ӧGz�e����ZP��6Kp�Z�X:����f�o���<}[��E�,�,���g�TP��V�ݏ>Gy��x���q�O�"J3/�!MQA�"3쑨�KЏ��h�L�q��7�1<y?$��0#�I�Ęx�d�zc�c�I�M�8�QAa�!C��"�H���x]�^F���bRQ�"��ۈ�=<��G}~�DW��gR�]+��?^-}�U~��o���(�)0��T�_�ݿ��=#G�o�]������PK- .�D[� � 5 xl/workbook.xmlPK- .�D[���� � � [Content_Types].xmlPK- .�D[ ��' ' U _rels/.relsPK- .�D[���w� l � xl/worksheets/sheet1.xmlPK- .�D[��ړ� P � xl/_rels/workbook.xml.relsPK- .�D[Ѓc'2 E xl/styles.xmlPK- .�D[��_Lr � � xl/sharedStrings.xmlPK � R