GET api/checkoutforms/{formType}/groups?relations={relations}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formType

string

Required

relations

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of CheckoutFormGroup
NameDescriptionTypeAdditional information
Identifier

Collection of byte

None.

IdentifierGuid

globally unique identifier

None.

Name

string

String length: inclusive between 0 and 60

FormType

string

String length: inclusive between 0 and 60

Forms

Collection of CheckoutForm

None.

Panels

Collection of CheckoutPanel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "identifier": "AqLZ33XFVUKRRIkHuJ8z0Q==",
    "identifierGuid": "dfd9a202-c575-4255-9144-8907b89f33d1",
    "name": "sample string 2",
    "formType": "sample string 3",
    "forms": [
      {
        "$id": "2",
        "id": 1,
        "g_UID": "eB3yc5lTcEOn9+o/CgAzPA==",
        "guid": "73f21d78-5399-4370-a7f7-ea3f0a00333c",
        "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": "l8dxaM23r0e0iA6M0ATTEg==",
        "previousFormGuid": "6871c797-b7cd-47af-b488-0e8cd004d312",
        "nextForm": 1,
        "nextFormG_UID": "2ulbqAAhjUebUDvc4/o6yg==",
        "nextFormGuid": "a85be9da-2100-478d-9b50-3bdce3fa3aca",
        "attributes": "sample string 10",
        "updated": "2025-06-14T06:01:07.8768938",
        "positioning": 1,
        "contentPanel": "sample string 11",
        "selectionMode": 1,
        "maximumSelections": 1,
        "alteredInStore": true,
        "deleted": true,
        "blueprintID": 1,
        "preserveLayout": true,
        "mainCheckoutFormName": "sample string 13",
        "nextCheckoutForm": {
          "$ref": "2"
        },
        "previousCheckoutForm": {
          "$ref": "2"
        },
        "buttons": [
          {
            "$id": "3",
            "id": 1,
            "checkoutFormID": 2,
            "checkoutFormG_UID": "1XamRQRZRUqAtqWgqGbI/w==",
            "checkoutFormGuid": "45a676d5-5904-4a45-80b6-a5a0a866c8ff",
            "identifier": "oXthzPO/BkGlFPSbnnlftg==",
            "identifierGuid": "cc617ba1-bff3-4106-a514-f49b9e795fb6",
            "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": "YS+tyrtoYU+YdMuU4gpmIQ==",
            "valueGuid": "caad2f61-68bb-4f61-9874-cb94e20a6621",
            "buttonText": "sample string 10",
            "valueText": "sample string 11",
            "drawImageAndButton": true,
            "updated": "2025-06-14T06:01:07.8768938",
            "action": "sample string 12",
            "valueForm": {
              "$ref": "2"
            },
            "image": {
              "$id": "4",
              "name": "sample string 3.sample string 4",
              "imageID": 2,
              "imageName": "sample string 3",
              "imageExtension": "sample string 4",
              "lastUpdate": "2025-06-14T06:01:07.8768938",
              "imageData": "QEA=",
              "readOnly": true
            }
          },
          {
            "$ref": "3"
          }
        ],
        "panels": [
          {
            "$id": "5",
            "id": 1,
            "checkoutFormID": 2,
            "checkoutFormG_UID": "ax0sw3BVn0ey8ablJY6x4w==",
            "checkoutFormGuid": "c32c1d6b-5570-479f-b2f1-a6e5258eb1e3",
            "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": "5"
          }
        ]
      },
      {
        "$ref": "2"
      }
    ],
    "panels": [
      {
        "$ref": "5"
      },
      {
        "$ref": "5"
      }
    ]
  },
  {
    "$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ڵ��5xl/workbook.xml �(�����0��&�C��@��x��}-[i�?ik��-%�x�3;��4�q��1/�Q���k����|D�d,��)Q�'3BH���o�:�"�*�p� �������X�:����AM+J�Դ;i�fw��O2[��$l
��T�`�ERD�–����\��攸Z����ť���UY�1��wXö��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="Re220069a414747b2" /></Relationships>PK#0�Zڐ���xl/worksheets/sheet1.xml �(���A�� ��
ý��ug�i��uzh�V1:%$ٟ_$6�H&��Eax�`ȟކ8Jmz5�D9֪��m��$�S���~5��8|4+]����
!Swr�L��rtc��Ce]Wo�j۾�kU9Zc̑��ʺ�L��
<W��Zf�e��%�s���GX�M�O�Z�|&�
������d޵�d�[�ש�) �,
�����l����P����v�mR�3���C?mC�������k�(�3�pF�,��>��_���*�|<��K���`"8�`������Y�&�a�2.D?γ9�>�O�|rɧ<J3F1M)N�����|��S&������G�S�G��lU�Z���î��zvM�ڝ�q7�X���L���%>�D|K�C��_B����H.rb��j���taba��.$�b�7wrߏ^��?�Bb�K��X��D�wY��w7�s/������._^��PK#0�Zn[?��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞8�����ݰa[z��Q;�]�gc���V� �X��j4��'�|�lvo�D^0��;UQA��� ��]��f��Ly"�q�$��(���<P��Y��/�r��0˔�0�E����e�iX3�I��C�ƌ
�:���`���1Z�� ÀI�O)�K��L��Q�iy�4rV3	��L-�����;_�4�s�����;�[sS+����N��J��7�0�mϚ���ѫ��~PK#0�ZЃc'2E
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�Z
HL4~xl/sharedStrings.xml �(���]K�0��J�}ӏ�n���6'�����l�����כ�B�~\yy����I�|S-y����,�te��ǜ�����t\�
9)Y�#�UcN��0Īő��Wjcw���;\`�T&Qt*.5%���kJz-_z(?�_!�����������+�^��z����ߴ�9��kh�ѻ(v588<�EQ�O�$��YL�4
�t���i��'�{���������oy��9�i[��Cd�`e�n$����z�[��,���նd;��욕
TϦw�ꛡ�N������PK-#0�Zڵ��5xl/workbook.xmlPK-#0�Z����	��[Content_Types].xmlPK-
#0�Z�})�''U_rels/.relsPK-#0�Zڐ����xl/worksheets/sheet1.xmlPK-#0�Zn[?��P�xl/_rels/workbook.xml.relsPK-#0�ZЃc'2E
.xl/styles.xmlPK-#0�Z
HL4~�xl/sharedStrings.xmlPK�)

application/vnd.ms-excel

Sample:
PK#0�Z�J7��5xl/workbook.xml �(���;�0D{$�`�8D���*
-�⬱��#�(�|�Htt;��oG�>�O�{�KU���9T�%��B:��n�)-�I��J���o�.��(8�8@6�%mB�+�V
�K1�aEY0�6�!bn�08�EN�Vw6	[C�7%�~�(��bM[�@��ܺ��)�����RxYp~�Rҝ���~7_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�ZktT''_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="R624863cd7abc46f4" /></Relationships>PK#0�Zڐ���xl/worksheets/sheet1.xml �(���A�� ��
ý��ug�i��uzh�V1:%$ٟ_$6�H&��Eax�`ȟކ8Jmz5�D9֪��m��$�S���~5��8|4+]����
!Swr�L��rtc��Ce]Wo�j۾�kU9Zc̑��ʺ�L��
<W��Zf�e��%�s���GX�M�O�Z�|&�
������d޵�d�[�ש�) �,
�����l����P����v�mR�3���C?mC�������k�(�3�pF�,��>��_���*�|<��K���`"8�`������Y�&�a�2.D?γ9�>�O�|rɧ<J3F1M)N�����|��S&������G�S�G��lU�Z���î��zvM�ڝ�q7�X���L���%>�D|K�C��_B����H.rb��j���taba��.$�b�7wrߏ^��?�Bb�K��X��D�wY��w7�s/������._^��PK#0�Z�Ϸ:�Pxl/_rels/workbook.xml.rels �(���1n�0E�"p�e��q�d��,M�Flɐ��9[��W���t�I���@���c�{��>���Pd9��޶5��Y,a��x��n����HOl���qZK��C�&��c�1�ҷrB:a˲�s-���Lq�L��3�'�;:�l�`���)t��}˱��(����cS�����5�^�����Z���ï׵��`�f����X���t�y�>mz�4�gj���T�Ճ�JQu�����/PK#0�ZЃc'2E
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�Z
HL4~xl/sharedStrings.xml �(���]K�0��J�}ӏ�n���6'�����l�����כ�B�~\yy����I�|S-y����,�te��ǜ�����t\�
9)Y�#�UcN��0Īő��Wjcw���;\`�T&Qt*.5%���kJz-_z(?�_!�����������+�^��z����ߴ�9��kh�ѻ(v588<�EQ�O�$��YL�4
�t���i��'�{���������oy��9�i[��Cd�`e�n$����z�[��,���նd;��욕
TϦw�ꛡ�N������PK-#0�Z�J7��5xl/workbook.xmlPK-#0�Z����	��[Content_Types].xmlPK-
#0�ZktT''T_rels/.relsPK-#0�Zڐ����xl/worksheets/sheet1.xmlPK-#0�Z�Ϸ:�P�xl/_rels/workbook.xml.relsPK-#0�ZЃc'2E
,xl/styles.xmlPK-#0�Z
HL4~�xl/sharedStrings.xmlPK�'