POST api/possettings

Bulk update a setting where you can provide the stores, machine groups and terminals to update the setting for.

Request Information

URI Parameters

None.

Body Parameters

The POS setting to update

Name	Description	Type	Additional information
SplitBy	What parameter this checkout setting has been split by	CheckoutSettingSplitByLevel	None.
Children	List of all checkout settings split by one level lower than the current level; null if this is the lowest level in which case this setting applies to all children You can limit the depth returned by providing during retrieval	Collection of POSSettingSplitBy	Relation. This field may not always be loaded or used for updates.
StoreID		integer	None.
MachineID		integer	None.
MachineName	ScaleDescription.ScaleID or ScaleDescription.ScaleName	string	String length: inclusive between 0 and 60
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.
Updated	Date-time that this setting was last updated	date	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.
StoreName	Name of the store this setting/value belongs. Only populated if relations is true	string	Relation. This field may not always be loaded or used for updates.
Machine		Machine	Relation. This field may not always be loaded or used for updates.
TerminalName	Details about the terminal. Only populated if relations is true	string	Relation. This field may not always be loaded or used for updates.
Terminal	Details about the terminal. Only populated if relations is true	Terminal	Relation. This field may not always be loaded or used for updates.
MachineGroupName	Details about the machine group. Only populated if relations is true	string	Relation. This field may not always be loaded or used for updates.
Header	Provides extra details about this setting such as scope, possible values, description and subsection. There is only one header per section and keyname.	POSSettingHeader	Relation. This field may not always be loaded or used for updates.
PossibleValues		string	Relation. This field may not always be loaded or used for updates.
Type		CheckoutSettingType	Relation. This field may not always be loaded or used for updates.
DefaultValue		string	Relation. This field may not always be loaded or used for updates.
Description		string	Relation. This field may not always be loaded or used for updates.
SubSection		string	Relation. This field may not always be loaded or used for updates.
Scope		CheckoutSettingScope	Relation. This field may not always be loaded or used for updates.
IngressId	ID of the Ingress entry (Redis Stream message ID)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "splitBy": 0,
  "children": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "storeID": 1,
  "machineID": 1,
  "machineName": "sample string 1",
  "section": "sample string 2",
  "keyName": "sample string 3",
  "value": "sample string 4",
  "updated": "2026-04-03T06:27:10.3072435",
  "updatedBy": "sample string 5",
  "terminalG_UID": "sSx7oHkFAEq2Eu6qOpscDQ==",
  "terminalGuid": "a07b2cb1-0579-4a00-b612-eeaa3a9b1c0d",
  "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": "Bz1qWazPvEe2NbXKhbauUA==",
    "terminalGuid": "596a3d07-cfac-47bc-b635-b5ca85b6ae50",
    "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": "L+tEBeYCIEez1s+Tmh5Qbw==",
      "guid": "0544eb2f-02e6-4720-b3d6-cf939a1e506f",
      "name": "sample string 3",
      "description": "sample string 4",
      "terminalNumber": 1,
      "posKey": "Oy71WAof402mybm88lI4Pg==",
      "linkedPOSKey": "58f52e3b-1f0a-4de3-a6c9-b9bcf252383e",
      "location": 1,
      "zoneID": 1,
      "currentMachineID": 1,
      "storeID": 1,
      "deleted": true,
      "updated": "2026-04-03T06:27:10.3072435",
      "currentMachine": {
        "$ref": "2"
      },
      "currentLane": {
        "$id": "5",
        "identifier": "iWeoqr0N1E2c1aR1hsKijQ==",
        "identifierGuid": "aaa86789-0dbd-4dd4-9cd5-a47586c2a28d",
        "name": "sample string 1",
        "storeID": 2,
        "machineID": 3,
        "scaleID": "sample string 4",
        "lastPingLocal": "2026-04-03T06:27:10.3072435",
        "lastSaleLocal": "2026-04-03T06:27:10.3072435",
        "status": 0,
        "statusDate": "2026-04-03T06:27:10.3072435",
        "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

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.