CCC Configurations

The Checkout App's settings are configured using the Customer Controlled Configuration (CCC) API. This service enables remote configuration management for different platforms.

The app currently utilizes the cha.settings.v1 schema. Remote settings and configurations are retrieved during login action.

How to configure
POS Settings
MPOS Settings

How to configure

Link to schema cha.settings.v1 Link to CCC Api Documentation

The schema outlines properties and types, with validations to be implemented subsequently.

Currently, only the "host" property is mandatory and will default to "https://testrunner-eu.checkout-api.retailsvc.com".

The ccc-api OpenAPI JSON collection facilitates the adding of configurations via tools such as Postman or Swagger, offering interim functionality until the development of a dedicated configuration portal.

⚠️ Important: Configuration settings can be defined at the workstation, business unit, business unit group, or tenant level. In the absence of specific configurations at lower levels, they will be inherited from higher levels, if available.

Here is example of curl request for updating the configuration on workstation level.

curl --location --request PUT 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "server": {
                "host": "https://testrunner-eu.checkout-api.retailsvc.com",
                "networkCallTimeout": 30000
            },
        },
        "mpos": {
            "server": {
               "host": "https://testrunner-eu.checkout-api.retailsvc.com",
                "networkCallTimeout": 20000
            }
        }
    }
}'

POS Settings

Minimum required setup

In order to have a workable workstation, the Checkout App requires a two-step setup process:

Initial Workstation Settings
See Minimum required settings for desktop
CCC API Configuration
Minimum required:
- Server settings (link)
- SCO enabled setting if using SCO (link)
- HYBRID setting if using HYBRID (link)

See below for complete configuration options.

Server (required)

host (required) - The Checkout Engine server that the workstation should connect to. This is a domain name, a computer name or an IP address
networkCallTimeout (required) - Specifies number of milliseconds to wait while the server performs the request. If the server doesn't send the response during this timeout, corresponding error will be displayed

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "server": {
                "host": "https://testrunner-eu.checkout-api.retailsvc.com",
                "networkCallTimeout": 30000
            }
        }
    }
}'

Edge (optional)

host - Host URL for offline Edge solution. This setting is required if using Checkout Client connected to a Edge deployed Checkout Engine

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "edge": {
                "host": "https://testrunner-eu.checkout-api.retailsvc.com/"
            }
        }
    }
}'

Peripherals (optional)

scanner (scanner1 and scanner2):
- logicalName (required) - Scanner's logical name, specified in config file (jpos.xml)
- autoConnect (required) - Enables auto connect after app loading
printer:
- enabled (required) - If this variable is on (true) then the system will try to connect to a real printer
- autoConnect (required) - Enables auto connect
- logicalName (required) - Printer's logical name specified in configuration file (jpos.xml)
- cashdrawerEnabled - If true, then Checkout Engine will try to use a real cashdrawer. If false, then emulated cashdrawer will be used instead, optional
- cashdrawerLogicalName - Specifies logical name of the cashdrawer in the configuration file of the printer (jpos.xml), as the cashdrawer is connected using printer, optional

Note: To run dummy peripherals:

printer:

"printer": {
  "enabled": true,
  "autoConnect": true,
  "logicalName": "Emulator",
}

scanner - no support for dummy scanner

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "peripherals": {
                "scanner1": {
                    "logicalName": "SCANNER1",
                    "autoConnect": true
                },
                "scanner2": {
                    "logicalName": "SCANNER2",
                    "autoConnect": true
                },
                "printer": {
                    "enabled": true,
                    "autoConnect": true,
                    "logicalName": "PRINTER1",
                    "cashdrawerEnabled": true,
                    "cashdrawerLogicalName": "CASHDRAWER1"
                }
            }
        }
    }
}'

Lock (optional)

timeout - Number of idle seconds before automatically being logged out from the App if there are no active receipt (default: 0)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "lock": {
                "timeout": 300
            }
        }
    }
}'

Schedule (optional)

schedule - Define operating hours for different days of the week or day groups for self-checkout workstations. This allows to configure when the SCO should be active. More information can be found here

Logout timeout (optional) - Specifies the number of minutes after which the SCO will automatically log out even with pending transaction. This setting is only applicable if the schedule is defined. Defaults to 30 minutes.

Available day patterns:

Individual days: MO, TU, WE, TH, FR, SA, SU
Day groups: ALL, WORKDAYS, WEEKEND

Note: In case of overlapping settings, the most specific setting takes precedence. For example, if both WORKDAYS and MO are defined, the MO setting will override the WORKDAYS setting for Monday. All other days will follow the WORKDAYS setting.

Note: If start time is after end time, it is considered as next day. For example, if start time is 22:00:00 and end time is 02:00:00, it means the store is open from 10 PM to 2 AM the next day. If both start and end times are the same, it means the store is opened for the entire day.

Note: If schedule is defined, then the SCO lock feature will be enabled automatically. This means that the SCO automatically switch to the lock screen after the defined idle time when workstation is in logged out state.

Properties for each schedule entry:

start (required) - Opening time in HH:MM:SS format (24-hour), e.g., "09:00:00"
end (required) - Closing time in HH:MM:SS format (24-hour), e.g., "17:00:00"

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "schedule": {
                "logoutTimeout": 30,
                "WORKDAYS": {
                    "start": "08:00:00",
                    "end": "18:00:00"
                },
                "SA": {
                    "start": "09:00:00",
                    "end": "16:00:00"
                },
                "SU": {
                    "start": "10:00:00",
                    "end": "15:00:00"
                }
            }
        }
    }
}'

Receipt (optional)

clearTimeout (required) - Duration for finalized receipt on screen visibility after finalization in milliseconds (default: 5000)
linkedPromptionsIndicatorEnabled (optional) - Enables visual linking of related promotion items with color bars in the active receipt view (default: enabled)
layout (optional):
- identifierType - Type of identifier to display ("id" or "barcode", default: "ID")
- visibleAttributes - Array of visible attributes ("color", "size")

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "receipt": {
                "clearTimeout": 5000,
                "linkedPromptionsIndicatorEnabled": false,
                "layout": {
                    "identifierType": "barcode",
                    "visibleAttributes": ["color", "size"]
                }
            }
        }
    }
}'

External Links (optional)

enabled - Enables embedded url links in the Checkout App GUI (default: false)
links - Embedded URL links list
- url (required) - External web page url
- name (required) - Name of the web site to display in the choice list
- shareAuthorizationToken (optional) - Set true to share authorization token with this website
- shareRetailInformation (optional) - Set true to share retail info like: countryCode, businessunitId, workstationId, operatorId, tenantId

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "externalLinks": {
                "enabled": true,
                "links": [
                    {
                        "url": "https://example.com/support",
                        "name": "Support Portal",
                        "shareAuthorizationToken": true,
                        "shareRetailInformation": false
                    }
                ]
            }
        }
    }
}'

Variant Search (optional)

enabled - Enables variant search functionality (default: false)

Note: A pre-requisite for this functionality is that you have correctly applied item links on your items and provided into Hii Retail in the Item Input api's.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "variantSearch": {
                "enabled": true
            }
        }
    }
}'

Prompt (optional)

integerMonetary - If on (true) then monetary inputs will have value without decimals (with .00 at the end)
keyboardOverrides - Specify a keyboard layout via a configuration object to override the default keyboard type for specific prompts based on their unique code. The supported layout types are NUMERIC and ALPHA_NUMERIC.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "prompt": {
                "integerMonetary": true,
                "keyboardOverrides": {
                    "get.loyalty.card.data.message": "NUMERIC"
                }
            }
        }
    }
}'

Auto Update (optional)

channel (required) - Release channel ("preview", "stable")

Note: All new updates will appear in the preview channel before being promoted to the stable channel. A preview channel will get preview and stable updates. A stable channel will get only stable updates. Customers are encouraged to setup a few tills on the preview channels to test drive new updates before being promoted to stable

Maintenance window settings (required) - The maintenance window for the update
- days (required) - Days of the week when the maintenance can occur (["MO", "TU", ...]), min items - one
- start (required) - The start time of the maintenance window. Specify in the UTC time zone (18:00:00)
- end (required) - The end time of the maintenance window. Specify in the UTC time zone (23:59:00)

Note: During this window the update will download and install automatically. To start update, the app must be open else it will try to update on the next maintenance window. The maintenance window is applied to preview and stable channels for major, minor and patch updates(see semantic versioning)

Maintenance Exclusion settings - The maintenance exclusion window for the update, optional
- start (required) - The start date and time of the maintenance exclusion. UTC time zone (2024-01-14T07:00:00.000Z)
- duration (required) - The number of days from the start date for the maintenance exclusion to take precedence

Note: The exclusion maintenance period takes precedence over any scheduled maintenance window. Maximum of 30 days allowed. The exclusion window is applied only for stable channel and only for major and minor updates (we follow semantic versioning best practices (semver.org) for all of our updates)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "autoUpdate": {
                "channel": "stable",
                "maintenanceExclusion": {
                    "start": "2024-01-14T07:00:00.000Z",
                    "duration": 5
                },
                "maintenanceWindow": {
                    "days": ["MO", "TU", "WE"],
                    "start": "18:00:00",
                    "end": "23:59:00"
                }
            }
        }
    }
}'

Hot Keys (deprecated)

⚠️ Important: The hot keys configuration is deprecated and will be removed in a future release. Please use the Keyboard Shortcuts configuration instead.

Note: The following hot keys are available and can be enabled via configuration:

registerWithQuantity - Enables the user to register an item with a specified quantity. More information can be found here

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "hotKeys": [
                "registerWithQuantity"
            ]
        }
    }
}'

Keyboard Shortcuts (optional)

keyBindings - Settings for keyboard shortcuts that trigger various actions in the POS application
- primaryAction - Used to set the keybinding that triggers the primary action (such as submitting prompts)
- secondaryAction - Used to set the keybinding that triggers the secondary action (such as canceling prompts)
- lock - Used to set the keybinding that triggers the lock confirmation dialog
- primaryPaymentMethod - Used to set the keybinding for the primary payment method (highlighted button in payment menu)
- secondaryPaymentMethod - Used to set the keybinding for the secondary payment method
- openPLU - Used to set the keybinding to open the PLU screen
- openTransactionsSearch - Used to set the keybinding to open transactions search
- openWebBrowser - Used to set the keybinding to open the embedded web browser (requires external links to be enabled - link)
- openVariantSearch - Used to set the keybinding to open variant search (requires variant search to be enabled - link)
- openRescans - Used to set the keybinding to open rescans (requires SSLP to be enabled - link)
- openItemSearch - Used to set the keybinding to open item search
- addItem - Used to set keybindings for adding specific items by barcode
fastCommands - Settings for enabling fast commands
- registerWithQuantity - Settings for the register with quantity fast command
  - enabled - Enables the user to register an item with a specified quantity. More information can be found here

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "keyboardShortcuts": {
                "keyBindings": {
                    "primaryAction": {
                        "keyCode": "Enter",
                        "altKey": false,
                        "ctrlKey": false,
                        "shiftKey": false,
                        "metaKey": false
                    },
                    "lock": {
                        "keyCode": "L",
                        "ctrlKey": true
                    },
                    "addItem": {
                        "your-barcode-1": {
                            "keyCode": "b",
                            "altKey": false,
                            "ctrlKey": true,
                            "shiftKey": true,
                            "metaKey": false
                        },
                        "your-barcode-2": {
                            "keyCode": "p",
                            "ctrlKey": true,
                            "shiftKey": true
                        }
                    }
                },
                "fastCommands": {
                    "registerWithQuantity": {
                        "enabled": true
                    }
                }
            }
        }
    }
}'

Additional Settings

Fullscreen (required)

fullscreen - Whether the application should open in full screen by default (default: false)

Kiosk (required)

kiosk - Hides the settings button from drawer (default: false)

Zoom Factor (optional)

zoomFactor - Scales the POS application to a specified value (default: 1). The value must be between 0.6 and 2.0 and is rounded to one decimal place.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "pos": {
            "fullscreen": true,
            "kiosk": false,
            "zoomFactor": 1,
            "itemPicturesEnabled": true,
            "priceVerificationEnabled": true,
            "wallpaperUri": "https://example.com/wallpaper.jpg",
            "logs": {
              "uploadEnabled": true
            },
            "theme": {
              "colors":{
                "primary":"#484543",
                "primaryLight":"#A5A29F",
                "primaryDark":"#262422"
              }
            }
        }
    }
}'

SCO Settings

Enable SCO (optional)

If on (enabled: true) then SCO will be enabled with the casco OCMS (default: false)

Hybrid Mode (optional)

hybrid - If on (true) then the hybrid mode will be enabled (default: false). Only applicable when SCO is enabled.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "enabled": true
            }
        }
    }
}'

Enable HYBRID (optional)

If on (hybrid: true) then checkout will behave both as POS or SCO depending on in app switch.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "hybrid": true
            }
        }
    }
}'

Session alive time (required)

sessionKeepAliveInterval - Time to keep session alive. If this variable is missing, 10 minutes interval is used as default. To be set in milliseconds

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "sessionKeepAliveInterval": 600000
            }
        }
    }
}'

Receipt (optional)

layout:
- identifierType - Type of identifier to display ("id" or "barcode", default: "ID")
- visibleAttributes - Array of visible attributes ("color", "size")

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "receipt": {
                "layout": {
                    "identifierType": "barcode",
                    "visibleAttributes": ["color", "size"]
                }
            }
        }
    }
}'

Bags (optional)

enabled (required) - If on (true) then SCO Bags button will be shown (default: false)
paperBag (required):
- ean (required) - EAN of the paper bag
- title (required) - Name of the paper bag
plasticBag (required):
- ean (required) - EAN of the plastic bag
- title (required) - Name of the plastic bag

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "bags": {
                "enabled": true,
                "paperBag": {
                    "ean": "10001",
                    "title": "Paper bag"
                },
                "plasticBag": {
                    "ean": "10002",
                    "title": "Plastic bag"
                }
            }
        }
    }
}'

Language (optional)

availableLanguages (required) - Defines the available languages in SCO mode. Comma separated i.e en-GB,sv-SE (default: "en-GB,sv-SE,de-DE,fr-FR,es-ES,da-DK,fi-FI,nb-NO")
defaultLanguage (required) - Default language (default: "en-GB")

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "language": {
                "availableLanguages": "en-GB,sv-SE,de-DE,fr-FR,es-ES,da-DK,fi-FI,nb-NO",
                "defaultLanguage": "en-GB"
            }
        }
    }
}'

PLU (optional)

enabled (required) - Enables PLU button in SCO mode
shortcutsEnabled - Allows PLU shortcut items button in main view (default: false)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "plu": {
                "enabled": true,
                "shortcutsEnabled": true
            }
        }
    }
}'

Prompt (optional)

keyboardOverrides - Specify a keyboard layout via a configuration object to override the default keyboard type for specific prompts based on their unique code. The supported layout types are NUMERIC and ALPHA_NUMERIC.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "prompt": {
                "keyboardOverrides": {
                    "get.loyalty.card.data.message": "NUMERIC"
                }
            }
        }
    }
}'

Loyalty (optional)

countryCodePrefix (required) - Prefix for loyalty card phone number input.
cardReminderEnabled - Enables loyalty card reminder dialog (default: false)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "loyalty": {
                "countryCodePrefix": "+503",
                "cardReminderEnabled": true
            }
        }
    }
}'

SCO Lock (optional)

enabled (required) - If on (true) then SCO lockscreen feature will be enabled (default: false)
timeout - Number of idle seconds before appearance of the sco lockscreen (default: 15)

Note: If the SCO lock feature isn't enabled, but sco schedule settings are, then the SCO lock feature will be enabled automatically. This means that the SCO automatically switch to the lock screen after the defined idle time when workstation is in logged out state.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "lock": {
                "enabled": true,
                "timeout": 300
            }
        }
    }
}'

Attendant (optional)

enabled (required) - If on (true) the attendant feature in SCO mode is enabled

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "attendant": {
                "enabled": true
            }
        }
    }
}'

Logo URI (optional)

logoUri - URI for logo in SCO mode (must be HTTPS URL or base64 data URI for jpg/jpeg/png)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "logoUri": "https://example.com/wallpaper.jpg"
        }
    }
}'

Call Assistant (optional)

callAssistantEnabled - Enables call assistant button (default: false)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "callAssistantEnabled": true
        }
    }
}'

Decrease Enabled (optional)

decreaseEnabled - Allows item quantity decrease (default: false)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "decreaseEnabled": true
        }
    }
}'

Basket Audit and Rescan (SSLP) (optional)

enabled (required) - Enables basket audit and rescan functionality on SCO and POS. More information can be found here

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "sco": {
            "sslp": {
                "enabled": true
            }
        }
    }
}'

CFD Settings

Auto Start (required)

autoStart - If on (true) then CFD is displayed when the app is loaded without manual opening (default: false)

Welcome Message (optional)

welcomeMessage - After opening, CFD will show the CFD welcome message until you start a new receipt. Minimum formating is supported in the form of new line breaks. e.g "Before \n after break line."

Zoom Factor (optional)

zoomFactor - Scales the CFD application to a specified value (default: 1). The value must be between 0.6 and 2.0 and is rounded to one decimal place.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "cfd": {
            "autoStart": true,
            "welcomeMessage": "Welcome \n Scan your items"
            "zoomFactor": 1.2,
        }
    }
}'

MPOS Settings

Minimum required setup

At least the folodwing should be set to have a workable MPOS:

Initial Workstation Settings
See Minimum required settings for mobile
CCC API Configuration
Minimum required:
- Server settings (link)

See below for complete configuration options.

Server (required)

host (required) - The Checkout Engine server that the workstation should connect to. This is a domain name, a computer name or an IP address
networkCallTimeout (required) - Specifies number of milliseconds to wait while the server performs the request. If the server doesn't send the response during this timeout, corresponding error will be displayed

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "server": {
                "host": "https://testrunner-eu.checkout-api.retailsvc.com",
                "networkCallTimeout": 30000
            }
        }
    }
}'

Receipt (optional)

clearTimeout (required) - Duration for finalized receipt on screen visibility after finalization in milliseconds (default: 5000)
linkedPromptionsIndicatorEnabled (optional) - Enables visual linking of related promotion items with color bars in the active receipt view (default: enabled)
layout (optional):
- identifierType - Type of identifier to display ("id" or "barcode", default: "ID")
- visibleAttributes - Array of visible attributes ("color", "size")

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "receipt": {
                "clearTimeout": 3000,
                "linkedPromptionsIndicatorEnabled": false,
                "layout": {
                    "identifierType": "barcode",
                    "visibleAttributes": ["color", "size"]
                }
            }
        }
    }
}'

Peripherals (optional)

printer:
- enabled - Enables the printing, optional

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "peripherals": {
                "printer": {
                    "enabled": true
                }
            }
        }
    }
}'

cameraScanner (optional):
- enabled - The main flag, if its false the camera scanner will not show regardless of the whitelistedPrompts (default: true)
- whitelistedPrompts - Array of prompt codes, where camera scanner should be enabled only. If it is empty, the camera will be enabled everywhere

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "peripherals": {
                "cameraScanner": {
                    "enabled": false,
                    "whitelistedPrompts": ["ugcp.enter.giftcard.message"]
                }
            }
        }
    }
}'

Connect (optional)

provider - Sets the Soft terminal provider ("viva", "softpay", or null), default: null

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "connect": {
                "provider": "softpay"
            }
        }
    }
}'

Lock (optional)

timeout - Number of idle seconds before automatically being logged out from the App if there are no active receipt (default: 0)

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "lock": {
                "timeout": 300
            }
        }
    }
}'

External Links (optional)

enabled - Enables embedded url links in the Checkout Mobile GUI (default: false)
links - Embedded URL links list
- url (required) - External web page url
- name (required) - Name of the web site to display in the choice list
- shareAuthorizationToken (optional) - Set true to share authorization token with this website
- shareRetailInformation (optional) - Set true to share retail info like: countryCode, businessunitId, workstationId, operatorId, tenantId

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "externalLinks": {
                "enabled": true,
                "links": [
                    {
                        "url": "https://example.com/support",
                        "name": "Support Portal",
                        "shareAuthorizationToken": true,
                        "shareRetailInformation": false
                    }
                ]
            }
        }
    }
}'

Prompt (optional)

keyboardOverrides - Specify a keyboard layout via a configuration object to override the default keyboard type for specific prompts based on their unique code. The supported layout types are NUMERIC and ALPHA_NUMERIC.

Example:

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "prompt": {
                "keyboardOverrides": {
                    "get.loyalty.card.data.message": "NUMERIC"
                }
            }
        }
    }
}'

MPOS Additional Settings

Theme (optional)

theme - Theme object for customisation of the app

Wallpaper URI (optional)

wallpaperUri - URI for the wallpaper image (HTTPS URLs or Base64-encoded Image Data URIs)

Logs (optional)

uploadEnabled - Indicates if the logs should be uploaded to the server. This also enables the logs button in the settings tab

Example

curl --location --request PATCH 'https://ccc-api.retailsvc.com/api/v1/config/cha.settings.v1/values/business-units/{businessUnitId}/workstations/{workstationId}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **INSERT_YOUR_TOKEN_HERE**' \
--data '{
    "value": {
        "mpos": {
            "wallpaperUri": "https://example.com/wallpaper.jpg",
            "logs": {
              "uploadEnabled": true
            },
            "theme": {
              "colors":{
                "primary":"#484543",
                "primaryLight":"#A5A29F",
                "primaryDark":"#262422"
              }
            }
        }
    }
}'

CCC Configurations

Table of Contents​

How to configure​

POS Settings​

Minimum required setup​

Server (required)​

Edge (optional)​

Peripherals (optional)​

Lock (optional)​

Schedule (optional)​

Receipt (optional)​

External Links (optional)​

Variant Search (optional)​

Prompt (optional)​

Auto Update (optional)​

Hot Keys (deprecated)​

Keyboard Shortcuts (optional)​

Additional Settings​

Fullscreen (required)​

Kiosk (required)​

Zoom Factor (optional)​

Item Pictures (optional)​

Price Verification (optional)​

Theme (optional)​

Wallpaper URI (optional)​

Logs (optional)​

Example:​

SCO Settings​

Enable SCO (optional)​

Hybrid Mode (optional)​

Enable HYBRID (optional)​

Session alive time (required)​

Receipt (optional)​

Bags (optional)​

Language (optional)​

PLU (optional)​

Prompt (optional)​

Loyalty (optional)​

SCO Lock (optional)​

Attendant (optional)​

Logo URI (optional)​

Call Assistant (optional)​

Decrease Enabled (optional)​

Basket Audit and Rescan (SSLP) (optional)​

CFD Settings​

Auto Start (required)​

Welcome Message (optional)​

Zoom Factor (optional)​

MPOS Settings​

Minimum required setup​

Server (required)​

Receipt (optional)​

Peripherals (optional)​

Connect (optional)​

Lock (optional)​

External Links (optional)​

Prompt (optional)​

MPOS Additional Settings​

Theme (optional)​

Wallpaper URI (optional)​

Logs (optional)​

Example​

Table of Contents

How to configure

POS Settings

Minimum required setup

Server (required)

Edge (optional)

Peripherals (optional)

Lock (optional)

Schedule (optional)

Receipt (optional)

External Links (optional)

Variant Search (optional)

Prompt (optional)

Auto Update (optional)

Hot Keys (deprecated)

Keyboard Shortcuts (optional)

Additional Settings

Fullscreen (required)

Kiosk (required)

Zoom Factor (optional)

Item Pictures (optional)

Price Verification (optional)

Theme (optional)

Wallpaper URI (optional)

Logs (optional)

Example:

SCO Settings

Enable SCO (optional)

Hybrid Mode (optional)

Enable HYBRID (optional)

Session alive time (required)

Receipt (optional)

Bags (optional)

Language (optional)

PLU (optional)

Prompt (optional)

Loyalty (optional)

SCO Lock (optional)

Attendant (optional)

Logo URI (optional)

Call Assistant (optional)

Decrease Enabled (optional)

Basket Audit and Rescan (SSLP) (optional)

CFD Settings

Auto Start (required)

Welcome Message (optional)

Zoom Factor (optional)

MPOS Settings

Minimum required setup

Server (required)

Receipt (optional)

Peripherals (optional)

Connect (optional)

Lock (optional)

External Links (optional)

Prompt (optional)

MPOS Additional Settings

Theme (optional)

Wallpaper URI (optional)

Logs (optional)

Example