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": "iuJ4OqWxXEefnSyaRB4SsQ==", "guid": "3a78e28a-b1a5-475c-9f9d-2c9a441e12b1", "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": "OeCqW7UfUkWmt9LE0XakeQ==", "previousFormGuid": "5baae039-1fb5-4552-a6b7-d2c4d176a479", "nextForm": 1, "nextFormG_UID": "yDpOwjY7Nk+UUv3j4N+yVA==", "nextFormGuid": "c24e3ac8-3b36-4f36-9452-fde3e0dfb254", "attributes": "sample string 10", "updated": "2025-08-02T23:10:33.8646262", "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": "q2aGnS81nEeLVpZWTkrgMg==", "checkoutFormGuid": "9d8666ab-352f-479c-8b56-96564e4ae032", "identifier": "SjiQ8OJwqkSDYvpAOgii2Q==", "identifierGuid": "f090384a-70e2-44aa-8362-fa403a08a2d9", "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": "0z3nPR57aU6jlFdyaARcbg==", "valueGuid": "3de73dd3-7b1e-4e69-a394-577268045c6e", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-08-02T23:10:33.8646262", "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-08-02T23:10:33.8646262", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "KYSSa9xkO0iomX8RS3r1BQ==", "checkoutFormGuid": "6b928429-64dc-483b-a899-7f114b7af505", "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 P�[䄣Z� 5 xl/workbook.xml � (� ����0��&�C��E�'8q����[i�-ik��-%�x�3;��䓱}mLO>j�.��3�\ӡw0#��*�A�3B�+Ӽjώ�_���4�urtt���r�Eh]��հ�HM����|n��8�(��֝M�M��]DE4(,h(�ν-hB��d���O�5�"Mo�n� ���w�PK P�[���� � [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 P�[��\�' ' _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="R1b74e19d988e4957" /></Relationships>PK P�[~���� l 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=�Bxm��ҡIM�z��zS�Yg6ufw^UX-����,����>��m�ݮ^�)#�p�z����s{��� Z/��RD��G'� {��dԘ�桽�ah�3��$6��N{c�A/���u&wB�� �]�@J�3��nv�Zg�a c�'�s��Z ���Q}�6;�e�5қ�)���kv�.�?�;osO3*P���� �=���AO4D-£�n�wШ4AHan�8�QD-�"3� �@^� -��h%�rB�� jt3v�����s<D-�izR�Pj5�<��S�Z��u�P;���(��E�im����J�����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�]�~�C�"����v�b�=:D-�N���3nOUԢ�iQ�"�_�n:'�ͽLE-*��Q�j�E� ��5h��ʸZE-���-B��hCH�?L�hׯ������`^������������������Ϫv�x�E�6�em�q�mī.B����F��"Lm�I�ڈ�.·����a�!�~d ��O�{�@���P{�@��!�!�~e�F���@�������v0��OB�-��dl�ߒ3"!�d���1#�KƎH8.C"!�d,���1%�KƖHyf���gƙHyf���gƛHyf̩(ό;噱���<��M~�%?l��D݆䡼d �7w�y�\�Iϴ�Q�@h�'�w�X;M��K��gF"����|d DZ�Q�Yb����Eb�sb�Kw$M���U^H���t��}K�t�X��W�fP��gb���oQ2��4��hڧe� (o�1����W��?i�oR RV*O�.O����U�a��q��7 c/Mo �_����3���[���T�D*cV|/M��4��k4���4�M���Nk���w����H4����2�����<�v�X��X����ʭ�t*'v�L�}ϫ�3(M��e�ߢd��Me�I�E2����S7�S RV*O�.O����U�a��qW7�L'����1�N*3�ʃ�oL��pT�_���������ӣ� PK P�[(x�� P xl/_rels/workbook.xml.rels � (� ��An� E������$ ɦ�n�\ �`��`i��u�#� E����n�B���h�|���ߦ�@��w����zp���dVx��`�)߈v�#�O\ئ4o���$c�gp�c|�d�e��,�I�@�.I(������C�� �:O��`���)Z���Q���?Q$ף�2�'-�v�� �-���U��M-�����.d�k50�L��z]�U�� �9���ҩ���1��bچ�%������PK P�[Ѓ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 P�[�'�t � xl/sharedStrings.xml � (� ���n�0EEл$k�R�bgi�8��KP��8��H�J��(__�i�Dd�>�ŀ��;���,��� >sC�:�sA���ۛo�: ��fn�u�S��ѭ\��-b�)T���(_T�5YYԏr�J�j�eD��0( 㮓����M'�Ss���嫠_��S��M�O���Y9�ykkF��w�c��������v��p�T�~.r�ڰ��o]�Q�v���6[�+��J��8�(�D��������g%���(D-���}W� N�,L�9�����\�'��hӍK LԪ��>f�ѻK�.�m���E_�e�CDɲAu�mE �)�����EKm p�$ #�P@���5,�E�._k���� O��>�NE �d�6+�pNQ[&����{�Z�l��z��棋�YԈ����3��F!���A��х1�!/I�%�4�&� ��|B�$�0��n�"eU���j�6Nڏ�]|#kÓ�-�~<�Ǔ.N3B`O�p��#�i�a6�h�'4 I22z�(���c/�⡗���$эk 1�:�Ҥ�`�ckw��[�?��oG�P��j���ۈ(�/03��a/���r��)�������3r��^�����=�PK- P�[䄣Z� 5 xl/workbook.xmlPK- P�[���� � [Content_Types].xmlPK- P�[��\�' ' V _rels/.relsPK- P�[~���� l � xl/worksheets/sheet1.xmlPK- P�[(x�� P � xl/_rels/workbook.xml.relsPK- P�[Ѓc'2 E xl/styles.xmlPK- P�[�'�t � � xl/sharedStrings.xmlPK � W
application/vnd.ms-excel
Sample:
PK P�[g � 5 xl/workbook.xml � (� ����0��&�C���N\�z��bhK�||�o�vfg�1X�>�m�Gw�g.�2�>c�W5���ь��: a���lӨ K[�5���O�aAY��=�i��|�j/��f�eh��"�f���r4���I�b�)a�ETĀƜ�������)q����J�3�I��<�te�0����PK P�[���� � [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 P�[$M' ' _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="R397bd8f7363940d4" /></Relationships>PK P�[~���� l 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=�Bxm��ҡIM�z��zS�Yg6ufw^UX-����,����>��m�ݮ^�)#�p�z����s{��� Z/��RD��G'� {��dԘ�桽�ah�3��$6��N{c�A/���u&wB�� �]�@J�3��nv�Zg�a c�'�s��Z ���Q}�6;�e�5қ�)���kv�.�?�;osO3*P���� �=���AO4D-£�n�wШ4AHan�8�QD-�"3� �@^� -��h%�rB�� jt3v�����s<D-�izR�Pj5�<��S�Z��u�P;���(��E�im����J�����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�]�~�C�"����v�b�=:D-�N���3nOUԢ�iQ�"�_�n:'�ͽLE-*��Q�j�E� ��5h��ʸZE-���-B��hCH�?L�hׯ������`^������������������Ϫv�x�E�6�em�q�mī.B����F��"Lm�I�ڈ�.·����a�!�~d ��O�{�@���P{�@��!�!�~e�F���@�������v0��OB�-��dl�ߒ3"!�d���1#�KƎH8.C"!�d,���1%�KƖHyf���gƙHyf���gƛHyf̩(ό;噱���<��M~�%?l��D݆䡼d �7w�y�\�Iϴ�Q�@h�'�w�X;M��K��gF"����|d DZ�Q�Yb����Eb�sb�Kw$M���U^H���t��}K�t�X��W�fP��gb���oQ2��4��hڧe� (o�1����W��?i�oR RV*O�.O����U�a��q��7 c/Mo �_����3���[���T�D*cV|/M��4��k4���4�M���Nk���w����H4����2�����<�v�X��X����ʭ�t*'v�L�}ϫ�3(M��e�ߢd��Me�I�E2����S7�S RV*O�.O����U�a��qW7�L'����1�N*3�ʃ�oL��pT�_���������ӣ� PK P�[c܄� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;��!D`æ[�{G$vdZ��E��+ԢR�.�a5��ӓf>�?6��i$t~���4a@�+ӷpꩆ�vs���8��0{W�oA�0�)�B��}bg4����x�����ʼn�H3�J��g��u���R���� M�L_�;y����1��S���$R�<��(���Lv��*B���uD����/d�S��U����z����Kp��K�ey��W��ԪCV�B��M�����PK P�[Ѓ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 P�[�'�t � xl/sharedStrings.xml � (� ���n�0EEл$k�R�bgi�8��KP��8��H�J��(__�i�Dd�>�ŀ��;���,��� >sC�:�sA���ۛo�: ��fn�u�S��ѭ\��-b�)T���(_T�5YYԏr�J�j�eD��0( 㮓����M'�Ss���嫠_��S��M�O���Y9�ykkF��w�c��������v��p�T�~.r�ڰ��o]�Q�v���6[�+��J��8�(�D��������g%���(D-���}W� N�,L�9�����\�'��hӍK LԪ��>f�ѻK�.�m���E_�e�CDɲAu�mE �)�����EKm p�$ #�P@���5,�E�._k���� O��>�NE �d�6+�pNQ[&����{�Z�l��z��棋�YԈ����3��F!���A��х1�!/I�%�4�&� ��|B�$�0��n�"eU���j�6Nڏ�]|#kÓ�-�~<�Ǔ.N3B`O�p��#�i�a6�h�'4 I22z�(���c/�⡗���$эk 1�:�Ҥ�`�ckw��[�?��oG�P��j���ۈ(�/03��a/���r��)�������3r��^�����=�PK- P�[g � 5 xl/workbook.xmlPK- P�[���� � [Content_Types].xmlPK- P�[$M' ' V _rels/.relsPK- P�[~���� l � xl/worksheets/sheet1.xmlPK- P�[c܄� P � xl/_rels/workbook.xml.relsPK- P�[Ѓc'2 E xl/styles.xmlPK- P�[�'�t � � xl/sharedStrings.xmlPK � W