Platform settings
View and modify platform setting records, replanning parameters, order (return) and CMS connection settings.
The Platform settings screen is where you view and modify setting records that determine the behavior of the store platform. There are four views on a single screen: general setting records (Settings), parameters used by scheduled jobs (Re-planning), Order settings managing return and review requests, and CMS settings defining the content management connection. Changes here affect the live store behavior; this screen is typically used by system administrators responsible for platform setup and maintenance.
Accessing the screen
Follow the menu path Settings & Authorization › System › Platform settings. If you do not see it in the menu, your account lacks permission for this screen.
If you have view permission but not edit permission, add and edit buttons are hidden; fields in Order settings and CMS settings views are locked and the Save button does not appear.
Screen sections
- Header — Platform settings and description of the selected view. If you have add permission, the Add setting or Add replanning setting button appears at top right depending on the view.
- View selector — options: Settings, Re-planning, Order settings, CMS settings.
- Filter card and list — in Settings and Re-planning views.
- Form — in Order settings and CMS settings views, an editable form appears instead of a list.
Switching between views
In the Settings or Re-planning list, the view selector is below the filter card. When you select another view, the list clears and the message View changed appears; press the Filter button to open the new view. In the Order settings or CMS settings form, the view selector is below the header and applies immediately upon selection.
Settings view
Lists name–value format setting records in the store repository.
Filtering and searching
| Field | Purpose | Tip |
|---|---|---|
| Setting name | Lists settings containing the text you type in their name; you do not need to type the full name. | After typing, press Filter or Enter; the filter is not applied while typing. Clear removes the filter. |
Search by value is not possible; since secret values are protected, this filter is not on the screen.
List
| Column | Meaning |
|---|---|
| First name | The setting's name (key). Cannot be hidden. |
| Value | The setting's value. For settings carrying passwords or keys, the value is masked and a Secret badge appears; the real value is never sent to the console. Empty values appear as —. |
| Integration | If the setting applies to a specific integration, the ID of that integration parameter; if valid for all integrations, —. |
The list opens with 25 records per page; you can increase to 50 or 100 via the Per page selection. You can hide columns from the Columns menu and refresh the list with the refresh icon. Clicking a row does not start an action; there is no record editing in this view, to change a value add a setting with the same name.
Adding or changing a setting value
Use this to define a new setting or change the value of an existing one.
- Click the Add setting button at top right.
- Read the warning at the top of the popup: If a setting with the same name exists, it will be overwritten and the application's ENTIRE cache will be cleared after saving.
- Fill in the fields:
| Field | Required | Description / rule |
|---|---|---|
| First name | Yes | The setting's name; maximum 200 characters. Note below the field: The name is lower-cased; if it exists its value is updated. Leading and trailing spaces are trimmed. |
| Value | Yes | The new value of the setting. Leading and trailing spaces are trimmed; values consisting only of spaces are not accepted. If empty, Required field appears below. |
| Integration parameter (optional) | No | Select from the list if you want the setting to apply only to a specific integration; options are in "Integration (ID)" format. If not selected, All integrations is shown: If empty the setting applies to all integrations. |
- Click Save. The button is enabled only if First name and Value are filled; while saving, the button shows Saving…
Result: If successful, the popup closes, a Saved notification appears, and the list refreshes. If the server rejects the record, the message The server rejected the operation. appears with the reason and the popup remains open.
The same name check looks only at the name: even if you select a different integration parameter, the existing record with the same name is updated.
This action cannot be undone and no confirmation is asked. After saving, the application's entire cache is cleared. If you change an existing setting, note the old value from the list first; to revert, save the old value again with the same name.
Re-planning view
Lists replanning parameters used by scheduled jobs.
There is no filter in this view. A note below the list states: This endpoint does not accept server-side filtering; the list is paged. To find a record, browse pages or increase page size.
List
| Column | Meaning |
|---|---|
| First name | The parameter's key; with a subtitle. Cannot be hidden. |
| Value | The parameter's value. Secret values show mask and Secret badge. |
| Group | The group the parameter belongs to. Hidden by default; can be enabled from the Columns menu. |
Page size can be 25, 50, or 100. If you have edit permission, an Edit button appears at the end of each row.
Editing a parameter value
- Click Edit on the relevant row.
- In the Edit value popup, First name is read-only; enter the new value in the Value field. Value cannot be empty (Required field).
- Click Continue.
- The confirmation popup summarizes the change: "{key}" will be saved as "{value}". This action cannot be undone. If sure, click Save; otherwise, click Cancel. Cancel returns you to the edit popup.
Result: If successful, the popup closes, a Saved notification appears, and the list refreshes. If the server rejects, the message The server rejected the operation. appears. For connection errors or similar, Something went wrong appears and you return to the edit popup; your input is preserved.
If you click Edit on a secret parameter, the popup does not open; the warning A secret value cannot be edited from the console. appears. Since the secret value never reaches the console, it cannot be changed here.
Adding a replanning setting
- Click the Add replanning setting button at top right.
- Read the warning at the top of the popup: The record cannot be undone; it changes the behavior of scheduled jobs.
- Fill in the fields:
| Field | Required | Description / rule |
|---|---|---|
| Setting type | Yes | Which parameter to add. Options are in "Title (value)" format; shows Select when empty. |
| Company | No | Select if the setting applies only to one company; the list shows only companies in your workspace. Leave empty for All. |
| Integration | No | Select if the setting applies only to one integration: WEB, TDY, BYR, HB, AMZ, N11, GG, MRP, CS. Leave empty for All. |
| Warehouse group code | No | Code to limit the setting to a warehouse group. |
| Store code | No | Code to limit the setting to a store. |
| Title | No | Description to help identify the record. |
| Value | Yes | Must be an integer greater than zero. If letters, decimals, zero, or negative values are entered, the field turns red. |
- Click Save. The button is inactive unless Setting type is selected and Value is valid.
Result: If successful, the popup closes, a Saved notification appears, and the list refreshes. If the record is not added, the message The server rejected the operation. appears; if no explanation is given, The record was not added (the key may already exist). is shown.
Order settings view
Settings that determine how customers can open return and review requests in the store front. The description under the header: Order settings managing return and review requests (ordersettings.*).
The Return settings card contains these fields:
| Field | Description / rule |
|---|---|
| Return requests enabled | If checked, customers can create return requests. |
| Customer can partially return an order | If checked, customers can return only part of the products in the order. |
| Auto-confirm return requests | If checked, return requests opened by customers are approved without waiting. |
| Review request creation enabled | If checked, customers can create review requests. |
| Days a return request is available | Required; integer. The form accepts 0 to 9999, but the server saves a maximum of 3650. |
| Days a return cargo code is valid | Required; integer. The form accepts 0 to 9999, but the server saves a maximum of 3650. |
If a checkbox has a Default badge next to it, that setting has not yet been saved and works with the default value. As the card description states: Fields not saved work with default value (off / 0).
Saving order settings
- Change fields. If one of the day fields is invalid, the warning Enter an integer between 0 and 9999. appears and Save is disabled.
- Click Save.
- Read the warning in the confirmation popup: Changed fields will be written to platform settings and change the live store behavior. Confirm by clicking Save.
Result: Only changed fields and fields never saved before are written (day fields do not show a badge but are written on first save). The notification shows how many fields were written, e.g. Saved (2 fields written). If nothing changed, zero fields are written. The form reloads with current server values. If a field is rejected, the process stops there and the message The server rejected the operation. appears; fields written so far remain saved, check the form again. If you enter a number greater than 3650 in a day field, no save occurs and Something went wrong appears.
CMS settings view
Connection information used when connecting the store to the content management system. The description under the header: Content management (CMS) connection settings (cmssettings.*). If no record exists, the card shows No CMS setting saved.
| Field | Description / rule |
|---|---|
| API URL | The content management system's address; maximum 500 characters. If filled, must start with http:// or https://; otherwise, the warning Enter an address starting with http(s). appears and Save is disabled. |
| Client ID | Client ID used in the connection; maximum 200 characters. |
| Client secret | Secret field. If a value is saved, below it says Saved — to change, enter a new value; leave empty to keep. If none, it says No saved value. |
| App name | The name of the application in the content management system; maximum 200 characters. |
| Token | Secret field; same rule as Client secret. |
A note below the card: Secret fields (ClientSecret, Token) are never sent to the console. Therefore, secret fields appear empty every time the form opens; leaving them empty does not delete the existing value.
Saving CMS settings
- Edit the fields you want to change. For secret fields, enter a new value only if you want to change it.
- Click Save and in the confirmation popup click Save again.
Result: Only changed fields and secret fields with new values are written; the notification shows how many fields were written and the form reloads with current values. If a field is rejected, the process stops there; fields written so far remain saved. Note existing values before changing; since old secret values do not appear in the console, they cannot be restored here.
Common situations
- I selected a view but the list is empty and says "View changed". Switching list views is applied by pressing the Filter button. Press Filter.
- I do not see the Add / Edit button. Your account lacks permission to edit on this screen; you can only view settings.
- I received "The server rejected the operation." or "Something went wrong" messages on save. The change was not applied (in Order and CMS settings, fields before the rejected one may have been saved). Read the explanation in the notification; if the problem persists, contact your system administrator.
- A setting's value is masked and shows "Secret". The value carries a password or key and is not sent to the console; it cannot be read here and cannot be edited in the replanning view.
- The integration parameter list is empty. The list comes from the same integration list as the cache screen and may be empty for accounts without permission on that screen. In this case, the setting is saved for all integrations; if a specific integration is required, contact your system administrator.
- Save is inactive when adding a replanning setting. Setting type must be selected and Value must be an integer greater than zero.
- I see an error box instead of Order or CMS settings. Settings could not be read. Click Retry; if the problem persists, send the text in the Technical details section to your system administrator.
- Secret fields in CMS settings always appear empty. This is expected behavior; the hint below indicates if a value is saved. Leaving empty preserves the existing value.
Related screens
- OMS settings — For order management setting groups.
- Store settings — For store front settings.
- Cache — For cache operations after setting changes.
- Return requests — To track return requests opened by customers.
- Using list screens — For general use of filtering, paging, and column settings.