PUT api/store/{storeID}/machine/{machine}/checkoutsetting/{section}/{keyName}

Request Information

URI Parameters

Name	Type	Additional information
storeID	integer	Required
machine	string	Required
section	string	Required
keyName	string	Required

Body Parameters

CheckoutSetting

Name	Description	Type	Additional information
StoreID		integer	None.
MachineID		integer	None.
Section	Section under which this setting is saved	string	String length: inclusive between 0 and 60
KeyName	KeyName under which this setting is saved. Combo of Section + KeyName is unique per setting	string	String length: inclusive between 0 and 60
Value		string	None.
UpdatedBy	User or operator that updated this setting	string	String length: inclusive between 0 and 60
TerminalG_UID	Guid of the terminal that this setting applies to	Collection of byte	None.
TerminalGuid	Guid of the terminal that this setting applies to	globally unique identifier	None.
ZoneID	Zone ID that this setting applies to	integer	None.
SoftwareUpdatedBy	The software that last updated this settings value	CheckoutSettingSoftwareUpdatedBy	None.

Request Formats

application/json, text/json

Sample:

{
  "storeID": 1,
  "machineID": 1,
  "machineName": "sample string 1",
  "section": "sample string 2",
  "keyName": "sample string 3",
  "value": "sample string 4",
  "updated": "2026-06-03T18:33:16.0068436",
  "updatedBy": "sample string 5",
  "terminalG_UID": "+OkrZqdd6kmDqY6ig5FeRg==",
  "terminalGuid": "662be9f8-5da7-49ea-83a9-8ea283915e46",
  "zoneID": 1,
  "softwareUpdatedBy": 0,
  "storeName": "sample string 6",
  "machine": {
    "$id": "2",
    "id": 1,
    "storeScaleID": 2,
    "scaleID": "sample string 3",
    "scaleName": "sample string 4",
    "description": "sample string 5",
    "scaleLocation": 1,
    "zoneID": 1,
    "storeID": 1,
    "scaleType": 1,
    "checkFrequency": 1,
    "testWeight": 1.1,
    "terminalG_UID": "4QAbofR2zkKU1mjHwd1EzQ==",
    "terminalGuid": "a11b00e1-76f4-42ce-94d6-68c7c1dd44cd",
    "storeName": "sample string 6",
    "zoneName": "sample string 7",
    "scaleLocationName": "sample string 8",
    "settingsZone": {
      "$id": "3",
      "id": 1,
      "storeID": 2,
      "name": "sample string 3",
      "machines": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ]
    },
    "terminal": {
      "$id": "4",
      "id": 1,
      "g_UID": "gn5dbURAdkGZsdCVN4b+gQ==",
      "guid": "6d5d7e82-4044-4176-99b1-d0953786fe81",
      "name": "sample string 3",
      "description": "sample string 4",
      "terminalNumber": 1,
      "posKey": "xhRfOqEIH06Qg7Y3oX8Twg==",
      "linkedPOSKey": "3a5f14c6-08a1-4e1f-9083-b637a17f13c2",
      "location": 1,
      "zoneID": 1,
      "currentMachineID": 1,
      "storeID": 1,
      "deleted": true,
      "updated": "2026-06-03T18:33:16.0068436",
      "currentMachine": {
        "$ref": "2"
      },
      "currentLane": {
        "$id": "5",
        "identifier": "ZkJd+1PRfE+z27npSvOtdA==",
        "identifierGuid": "fb5d4266-d153-4f7c-b3db-b9e94af3ad74",
        "name": "sample string 1",
        "storeID": 2,
        "machineID": 3,
        "scaleID": "sample string 4",
        "lastPingLocal": "2026-06-03T18:33:16.0068436",
        "lastSaleLocal": "2026-06-03T18:33:16.0068436",
        "status": 0,
        "statusDate": "2026-06-03T18:33:16.0068436",
        "statusName": "None",
        "storeName": "sample string 5",
        "machineName": "sample string 6",
        "zoneName": "sample string 7"
      }
    }
  },
  "terminalName": "sample string 7",
  "terminal": {
    "$ref": "4"
  },
  "machineGroupName": "sample string 8",
  "header": {
    "$id": "6",
    "type": 0,
    "possibleValues": "sample string 1",
    "defaultValue": "sample string 2",
    "description": "sample string 3",
    "section": "sample string 4",
    "subSection": "sample string 5",
    "keyName": "sample string 6",
    "scope": 0
  },
  "possibleValues": "sample string 9",
  "type": 0,
  "defaultValue": "sample string 10",
  "description": "sample string 11",
  "subSection": "sample string 12",
  "scope": 0,
  "ingressId": "sample string 13"
}

application/xml, text/xml

Sample:

<CheckoutSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager">
  <KeyName>sample string 3</KeyName>
  <MachineID>1</MachineID>
  <Section>sample string 2</Section>
  <SoftwareUpdatedBy>POS</SoftwareUpdatedBy>
  <StoreID>1</StoreID>
  <TerminalG_UID>+OkrZqdd6kmDqY6ig5FeRg==</TerminalG_UID>
  <TerminalGuid>662be9f8-5da7-49ea-83a9-8ea283915e46</TerminalGuid>
  <UpdatedBy>sample string 5</UpdatedBy>
  <Value>sample string 4</Value>
  <ZoneID>1</ZoneID>
</CheckoutSetting>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.