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 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": "2xn7f+ZiZ0ifwxqT78I70A==", "guid": "7ffb19db-62e6-4867-9fc3-1a93efc23bd0", "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": "b15XCLy5XkCFd2H6n9QErw==", "previousFormGuid": "08575e6f-b9bc-405e-8577-61fa9fd404af", "nextForm": 1, "nextFormG_UID": "pFITlDEVvEOqBQPBAmbfCA==", "nextFormGuid": "941352a4-1531-43bc-aa05-03c10266df08", "attributes": "sample string 10", "updated": "2025-10-04T23:56:35.9255582", "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": "Ln6G0mago0+0cfTh/kgFAw==", "checkoutFormGuid": "d2867e2e-a066-4fa3-b471-f4e1fe480503", "identifier": "yzb4wMbm/0a5rZWJDgIq+w==", "identifierGuid": "c0f836cb-e6c6-46ff-b9ad-95890e022afb", "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": "VqZtC5oaGUqCN9MyBpMpNA==", "valueGuid": "0b6da656-1a9a-4a19-8237-d33206932934", "buttonText": "sample string 10", "valueText": "sample string 11", "drawImageAndButton": true, "updated": "2025-10-04T23:56:35.9255582", "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:56:35.9255582", "imageData": "QEA=", "readOnly": true } }, { "$ref": "2" } ], "panels": [ { "$id": "4", "id": 1, "checkoutFormID": 2, "checkoutFormG_UID": "V0C4geuGoEq8rSaBnBUJ4w==", "checkoutFormGuid": "81b84057-86eb-4aa0-bcad-26819c1509e3", "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[K�� 5 xl/workbook.xml � (� ����0��&�C��J@� '.^=x_ak�O�||o�vfg��r4�ӓ��/\EE�`̷������ D�^�p.[lL�V�K��3s8@�F{!�������1�aA)����!���!q���Zw2 [B�7Uΰ�bVD�6��ٹu=Q� �;�<��!�$�dW��7X����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[�(4' ' _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="Re501ca6aa9be438d" /></Relationships>PK �D[���4� 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����h���� ��W�z�ȹ��N?��l���Z(!�7�YH��M�}b��Ի]�(�D#�����~S���J���>C�Q'��ɭ�+15&�yh��8�EZ�L��2������Xa�t�sG�ɝФ-@x&���L��8���֙p�XEF�Ɇ�\�VBh� !�CT���A9FYe��&w��?���7Bz�m�6��o��bI��DA�"<:�y�J��J��%A�"`+2C�0��:��Ehh��F+i��dt Q��[��Q��Vy-sF-�izR*�h5�<��-F-BC��p�� R�|�A�"초��Z�]�����Zߚ!<��.��3Lb�"6���f0B8e:D-�N�R����2\g�.0jᩧ�>���(��g�>�&��I��G�`�$��`��LFM�y��1jm�0<Q� �b�*����5�O+V�أC�"��r��ɠ�ZT;-*S��Փ.�JY�����S;D-���+@*�5h��ʸZE-��m�&%B��!��&o������rxt0��{��r��T����Ksx^����G�`�{U�A��"d6⸋�6��.B����F��"Lm�I�ڈ�.·o���a�=!�~` ��{�@���P{�@��!�3!�~a�F���@�������v�3��B�-��dl�ߒ3"!�d���1#�KƎH8.C"!�d,���1%�KƖHyf���gƙHyf���gƛHyf̩(ό;噱���<��M~�%?l��D݆�R^2r'��h�7�h�3�i�3����$�Nkok�p��!��GB�u���<�v�X��X��I!i�R�� :%�����.k����J��H�P��-J�<���M��죴����A'�?@hb��f��i|�N5HY�<ɋ�<���V���J�]�>{i�`����1:�9���[+�q�ʘHe̊�%���܁�rs��2Ӛ�2���8�Ib�4��6�����r��Tf 4�s�'�.k�k��#uR�U�N��N���oy�~g���ء,�[��y���`:�ܲH&�SC3~�r�A�J�I^�������=�U2��2����3�IeCSy���ɸ�����^V���T��uz�PK �D[0�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;�S�d�M�i.01c@�Nڜ���W��J-���&�����4����ڼM#;��5 dI ����`�NA?HجW;1� ��gq����'ν�iB�ؙL�h�&1u�Q�#��i�ݒ�L������zP���4� ���uG�`{t�~J�_C�D*�綁jYBJ�EU�����|������)��L��+����L��ڗ�⥗N��B�,u�(�á�3A%]���_�� 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[_�s � xl/sharedStrings.xml � (� ��[o�0�� �[�$��TMz�JMU���T�]CbkU�_�n�ָ����f�}|��ea<