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": "iAbXt7NobUKk4LUb4Lw2Mg==", "guid": "b7d70688-68b3-426d-a4e0-b51be0bc3632", "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": "QTO5Kd6+5kKTtQ60si4Z3w==", "previousFormGuid": "29b93341-bede-42e6-93b5-0eb4b22e19df", "nextForm": 1, "nextFormG_UID": "19riNacIp0yiF5NpLdzM1Q==", "nextFormGuid": "35e2dad7-08a7-4ca7-a217-93692ddcccd5", "attributes": "sample string 10", "updated": "2025-06-14T06:00:04.8887701", "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": "RqQ1YPLbE0upB87jyaN3xA==", "checkoutFormGuid": "6035a446-dbf2-4b13-a907-cee3c9a377c4", "identifier": "v+/fbvcGvEqgEDTfGfMLdA==", "identifierGuid": "6edfefbf-06f7-4abc-a010-34df19f30b74", "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": "qgpt3gLd7U+HOsFPfhteSw==", "valueGuid": "de6d0aaa-dd02-4fed-873a-c14f7e1b5e4b", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-06-14T06:00:04.8887701", "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-06-14T06:00:04.8887701", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "6vO8BcFH0kK2tozqzPw5Kg==", "checkoutFormGuid": "05bcf3ea-47c1-42d2-b6b6-8ceaccfc392a", "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 0�Zد� 5 xl/workbook.xml � (� ����0��&�C��&8q���{-[�H����[J ��mgv��ig�_k_�'�a�k \�f�d���k��Ob�P��L$eQ���Ģ�&H�^i������ ��V�f���x@�]���!�dlu�5D~Sm��Y!�4tx`�a����a��oTn�Vu�K%�g��xgﰖl��/PK 0�Z���� � [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 0�Z�~�' ' _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="R9b53a84b074c4e45" /></Relationships>PK 0�Zzw� 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 ��Jz��W�z�ȹ��N?��l���Z(!�7�YH��M�}b��Ի]�(�D#�p�z����s{��� Z/��RD��G'� {��dԘ�桽�ah���*���[;��@�;wԙ� 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�� yi��dt Q���"%��IZ�NHk2��4=)j�BA�)F-BC��p�� R�|�A�"��)�ؠ���a�Q��[3��K[�0*�$F-bC�P���;# �S�C�"�(e!1X�{�ʨ�&�z��-�MG�p�#��!j[��N�1 {$FM�n� ���d�$�G���6��U��+Ʈb?�!j]s�p;X�r��q�E�p��'�*jQ��L�/V7��VQ�J>�CԢ�i�O��&�AKeT��*jQ�hm�=D[B��ar��F�~�=.�G���7_/���Oe��X�4���Ex��s$V�ċ.B�/�h#��l#^u��x�E�6�Maڈ�]�m#N��F�v��x�0FH}�@���#!�~b ��3B�=g ��B���@�_a�+�6��7Bؽd ��������v2�nɘ�%cC ��� �%cE ���P\2vD�q� �%cI$,��)��\2�D�3cL�<3�D�3cM�<3�D�3cNEyfܩ(ό=Վ�A�m��.�aS�$��6$�%!�丹���Mz�5�zB�>q����ib�]b�=3·<�#!���@���s�'�.k�k_�#i"䯭�B��?@��#O�[b������j0��.?;�e~��1���ǸG�>-�(� �Bh�m'^��f��i|�I5HY�<ɋ�<���V���J�]�� ��4�u0g��s�`vVn�2�R��Y�d 4��;�Tn��TfZ�Tf 4��;I��&��%��3#�T�C>2����rb����Eb�sb�Kw�N*��ө���2��=��̠4�;�e~��1O7�L'�[ɤrjh�O�TN5HY�<ɋ�<���V���J�]�Tf0�T�s�`:��`h*�1W�Q5]��j�����O�G�PK 0�Zd&�e� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�N���ݰa[z��Q;�]�gc���V� �X��j4��'�|���o�H^0�!x �b@��`�K8e{w��z���e"�aN���$��<?P���I�*��Kdž8�\���Y���4.p�$���!k��A�&��0} �b�W��,᧔�%�P�< ;Λ�ѵŚk��Bo���y�����/eV�`���Y&t��TƩ��9�r�Ӳ�P�]-X'4��N����ѫ��|PK 0�ZЃ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 0�ZFĶCr � xl/sharedStrings.xml � (� ��[o�0�� �{B�*Iդ���TU/�K��5x�X��CT��פ۪5.�þD�|3�>>Cf�En�@HV���m�J��fn�ޜ8SےH8%y�an7 m�`1�-�����"V�<Of[(�t� �"��(�G��d%�P��"�Bߏ��0n[YYs���Ķj�~װz�+�b���������>=+�?o bͨ�}W;�V^c)�)@�N�n�����Ae��7|a����f���&��`:ǹɞH�w��$��F(��YA6=xU�e-���P��P��P���4�R��1�k�d��c�u�R����l/��c���xD��/�q�WhX�Q��F�:��(�n .K�ڈ���JY/ ���z�!k��%�X��\]��t�r�#�g|?<:=R}��.�*�8m� vpN��6L �-d����F���m�G�W�� ����Q��P����� ���t���4rFaL2�I�A ~�Eq�=�U��,�X�~��F�OL��':�4��Q�@Ab'�ұ�C:J�����=�BJ���d�2�C�`��$�4�2:p���� �t~��ք�Ϥp�Qȥ{�^�j��6"�����o�ˠ���A��=gw���s�:9�/؇������^�PK- 0�Zد� 5 xl/workbook.xmlPK- 0�Z���� � � [Content_Types].xmlPK- 0�Z�~�' ' U _rels/.relsPK- 0�Zzw� l � xl/worksheets/sheet1.xmlPK- 0�Zd&�e� P � xl/_rels/workbook.xml.relsPK- 0�ZЃc'2 E xl/styles.xmlPK- 0�ZFĶCr � � xl/sharedStrings.xmlPK � P
application/vnd.ms-excel
Sample:
PK 0�Zlg�ø