GET api/store/{storeID}/zone/{zoneID}/checkoutforms/{formType}?relations={relations}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
storeID

integer

Required

zoneID

integer

Required

formType

string

Required

relations

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of CheckoutForm
NameDescriptionTypeAdditional 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": "hameA1Iy3ESmH5echhZDtw==",
    "guid": "039ea985-3252-44dc-a61f-979c861643b7",
    "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": "nLul7Kp4GEOkHx3RNjoifw==",
    "previousFormGuid": "eca5bb9c-78aa-4318-a41f-1dd1363a227f",
    "nextForm": 1,
    "nextFormG_UID": "ugp9brzIxU6MJkJLwoO2HA==",
    "nextFormGuid": "6e7d0aba-c8bc-4ec5-8c26-424bc283b61c",
    "attributes": "sample string 10",
    "updated": "2025-06-14T06:35:19.9770363",
    "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": "T+ILs9LPWEy6+CYm6bRqZQ==",
        "checkoutFormGuid": "b30be24f-cfd2-4c58-baf8-2626e9b46a65",
        "identifier": "wlF26HFptkO+mykZuDVCAg==",
        "identifierGuid": "e87651c2-6971-43b6-be9b-2919b8354202",
        "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": "iYt2gztLhkaTteNB+gaRhw==",
        "valueGuid": "83768b89-4b3b-4686-93b5-e341fa069187",
        "buttonText": "sample string 10",
        "valueText": "sample string 11",
        "drawImageAndButton": true,
        "updated": "2025-06-14T06:35:19.9770363",
        "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:35:19.9770363",
          "imageData": "QEA=",
          "readOnly": true
        }
      },
      {
        "$ref": "2"
      }
    ],
    "panels": [
      {
        "$id": "4",
        "id": 1,
        "checkoutFormID": 2,
        "checkoutFormG_UID": "+Nuv7diEhUyCnw8CcLhkiw==",
        "checkoutFormGuid": "edafdbf8-84d8-4c85-829f-0f0270b8648b",
        "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:
PKj4�Z�]�
�5xl/workbook.xml �(�����0D�&�C��@�R8q����
[�H[����[J ��mgv���ٺ��������5T�0Ռ�^�����iQ�'�B�;ۿ5���,+�����K5y���a��!^"=�(
���x �/��
g�d4���I�b�)�`�ERĀƆv���\��攸Z�ᆕ���ļ:�x�;{�q��n�PKj4�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
j4�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="Rc4d329b0664a453c" /></Relationships>PKj4�Z\����lxl/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��rB����.�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�����
�w蜱ҹt��ԫGέ7u��ufSgv�U��B	��q�B��n���ݦ���E!$�vD�/����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�.��靷��(}{o|�LB� �'����q��;hT� �0�T
��(	�[�j�	O ��Z��}h��V9�LF�;-�]Ç��hp�c0jLӓR�F�!��b�"4����� %�GD-�k^�V�
Ω\��E��ե�p�a���E(\��p�!�2�q�E)��J�Kg�Y`�$�SO�����(np��:DMbK��)4`�d��I��������D�HWc�"��3�p�Jr%Je:D-�kNn+V�أC�"�n9��dPE-���)����s"�"�!jQɧv�ZT;-ZW�T��T&�I��vZ����-!��09xx�]���ã�y}ߛ��C�է2|\�_��{�"�~�>�߫�
�E!ۈ�]��]��v��x�E�6�uaڈ7]�m#N��F�v��x�0FH}�@����!�~d ��3B�=g ��B���@��a��6��WBؽd ��o�����v0�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�mb�3��<�!���@���s�'�.k�k��#i"�/��B��@��#O�kb���ڷ�j�3��.?;�e~��1���ǸG�>-�(�
�J���04�SC3~�4>_���T��E]��Iy���\%�.Mo�^����:�3C�9g0���Jeܥ2&R��{�@h*7w���\��̴���@h*'�w�X;M��M��cF����|` 4�M�Ĝ牵��ڧ����H�Tn��S9��eb�[^�ߙAi*'v(��%c�n*3�N*�,�I��Ќ����j��Ry�uy�&�rs������`:����tR���T4~c2���j�����|�;����PKj4�Z��PN�Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞8DŽ�i7lؖ^`�㨉�.�g�#q�"A*�`��h~OO���|���ido���lE�#�\7ؾ�c�
l7���D0�XZ����<(C���dSG;?aL�����=�2�%�K�2��<��N�AѳSljl��ߝ?C����[�)~
E���^�v�h�����F(��񻩅x)�z}�%˪���j�(�]ez�^�O�^:-�5]W(P(]�$�I_���_l�PKj4�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��PKj4�Z��@t�xl/sharedStrings.xml �(��U�n�0��;.!d��j��Vj���Z�3M����CT��k�m�
����33�9>cf�En�@*&���ݑm�"c|3�ooN�Ķ��\p��5(�:X̔BK�r5����'�StQ�(�k�^Ȃ���O�H��X�^0�^A�-**�s{<������^}[�pqv4�p1�g���mX��ľ�ۑ�(d|A
0�=�M]��sA	j��~D|3�/,í	~�٢���#+���8W��I�V;KB6R+��d�C�D.*9�\
�,�Js<!��.�=u܍Ʊn�q)a�D�����:m�.��R�]�_�΢�dG�CD��
A��m�l��R(�XL/�I��$��p�[��h��YK����5���a� !;���1�#����2����c��
��I-��
`|����F���l4}��E��,+Ďa�����Z!�F��a��p
d���0Ne�!��L'S��~����Q�(sЏ��hc���ؤod���}���I?=5i�d��S�LB�(��DzD?��0IL�͜&و�ġIJ���Ih;Q�4H�4�i�h����䏟ؚp�LJ�Y�\��땫��m,��>����~�^�=�Q��)����k�g�|��؛�M}O��PK-j4�Z�]�
�5xl/workbook.xmlPK-j4�Z����	��[Content_Types].xmlPK-
j4�Z��''T_rels/.relsPK-j4�Z\����l�xl/worksheets/sheet1.xmlPK-j4�Z��PN�P�	xl/_rels/workbook.xml.relsPK-j4�ZЃc'2E
xl/styles.xmlPK-j4�Z��@t��xl/sharedStrings.xmlPK�R

application/vnd.ms-excel

Sample:
PKj4�ZaQ���5xl/workbook.xml �(�����0��&�C��`�AR8q����R��@[����%�x�3;���Ѻ���#�����!9c^����f�I�4�I��R*��o�&�c�\����Ʒj�t����Ch|�t��4(C���>7{*}���֝M–�M��.�"4���D��4���j���sI}���f�n�
�����PKj4�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
j4�Z]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="R3e371765dc634982" /></Relationships>PKj4�Z\����lxl/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��rB����.�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�����
�w蜱ҹt��ԫGέ7u��ufSgv�U��B	��q�B��n���ݦ���E!$�vD�/����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�.��靷��(}{o|�LB� �'����q��;hT� �0�T
��(	�[�j�	O ��Z��}h��V9�LF�;-�]Ç��hp�c0jLӓR�F�!��b�"4����� %�GD-�k^�V�
Ω\��E��ե�p�a���E(\��p�!�2�q�E)��J�Kg�Y`�$�SO�����(np��:DMbK��)4`�d��I��������D�HWc�"��3�p�Jr%Je:D-�kNn+V�أC�"�n9��dPE-���)����s"�"�!jQɧv�ZT;-ZW�T��T&�I��vZ����-!��09xx�]���ã�y}ߛ��C�է2|\�_��{�"�~�>�߫�
�E!ۈ�]��]��v��x�E�6�uaڈ7]�m#N��F�v��x�0FH}�@����!�~d ��3B�=g ��B���@��a��6��WBؽd ��o�����v0�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�mb�3��<�!���@���s�'�.k�k��#i"�/��B��@��#O�kb���ڷ�j�3��.?;�e~��1���ǸG�>-�(�
�J���04�SC3~�4>_���T��E]��Iy���\%�.Mo�^����:�3C�9g0���Jeܥ2&R��{�@h*7w���\��̴���@h*'�w�X;M��M��cF����|` 4�M�Ĝ牵��ڧ����H�Tn��S9��eb�[^�ߙAi*'v(��%c�n*3�N*�,�I��Ќ����j��Ry�uy�&�rs������`:����tR���T4~c2���j�����|�;����PKj4�Zh�C�Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞�)i㠦�tö�{�DM��v=�����ĂMW��==i���c�}v&zgk�3��r��m
�h$l7�=
�D��)��bC
]���Au4b��D6u��#Ɣ��O���_��~΀[&;\&���+�9u��?����c�"���b
?���!�س�a����ESbS�R�wS�2P����g2�4U^.�BHY覺�L���K���s�yy�&�㪨4j�WasU�7��PKj4�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��PKj4�Z��@t�xl/sharedStrings.xml �(��U�n�0��;.!d��j��Vj���Z�3M����CT��k�m�
����33�9>cf�En�@*&���ݑm�"c|3�ooN�Ķ��\p��5(�:X̔BK�r5����'�StQ�(�k�^Ȃ���O�H��X�^0�^A�-**�s{<������^}[�pqv4�p1�g���mX��ľ�ۑ�(d|A
0�=�M]��sA	j��~D|3�/,í	~�٢���#+���8W��I�V;KB6R+��d�C�D.*9�\
�,�Js<!��.�=u܍Ʊn�q)a�D�����:m�.��R�]�_�΢�dG�CD��
A��m�l��R(�XL/�I��$��p�[��h��YK����5���a� !;���1�#����2����c��
��I-��
`|����F���l4}��E��,+Ďa�����Z!�F��a��p
d���0Ne�!��L'S��~����Q�(sЏ��hc���ؤod���}���I?=5i�d��S�LB�(��DzD?��0IL�͜&و�ġIJ���Ih;Q�4H�4�i�h����䏟ؚp�LJ�Y�\��땫��m,��>����~�^�=�Q��)����k�g�|��؛�M}O��PK-j4�ZaQ���5xl/workbook.xmlPK-j4�Z����	�[Content_Types].xmlPK-
j4�Z]m��''V_rels/.relsPK-j4�Z\����l�xl/worksheets/sheet1.xmlPK-j4�Zh�C�P�	xl/_rels/workbook.xml.relsPK-j4�ZЃc'2E
xl/styles.xmlPK-j4�Z��@t��xl/sharedStrings.xmlPK�V