Remote configuration

The remote configuration stores configurations that affect only the fulfillmenttools apps and clients, such as Backoffice or the Operations app. These configurations don't change behavior in the backend.

The remote configuration is a key-value store. It allows for storing different values and value types, each identified by a unique key. Each entry can also include a specific scope that restricts its availability to certain user groups or clients. This ensures that configurations are only available in the intended context.

Attention: This filter is not an authorization. Every user can call every remote configuration.

Available remote configurations

Web clients

Backoffice

Group: BACKOFFICE

Key	Type	Example	Effect
CHANNEL_ALLOCATION_VIEW_ENABLED	BOOLEAN	true	Makes the channel inventory tab visible in the stock overview.
INBOUND_VIEW_ENABLED	BOOLEAN	true	Makes the inbound view visible in the facility view.
PROCESS_DETAILS_EDIT_ORDER_ENABLED	BOOLEAN	true	Allows editing orders in the order view.
SENTRY_ENABLED	BOOLEAN	true	If set to false, the system stops tracking errors in pre and prd tenants. By default, error and analytics data are tracked on all tenants.
SERVICE_JOBS_ENABLED	BOOLEAN	true	Makes the service tab visible. The custom-service feature must also be active.
SERVICE_VIEW_ENABLED	BOOLEAN	true	Makes the service tab visible in the task overview. The custom-service feature must also be active.
STOCK_MODIFICATION_ENABLED	BOOLEAN	true	Allows adding products and stock at a location and changing stock in the storage location view. It also allows changing stock on the stock information card and storage location card in the listing detail view.
STORAGE_LOCATION_VIEW_ENABLED	BOOLEAN	true	Makes the storage location view visible in the facility view.

Operations web app

Mobile clients

Some mobile configurations are only available from a specific app version onwards. Check the Availability column for version requirements.

Store Operations app

Group: OPERATIONS_MOBILE

Key	Type	Example	Availability	Effect
HOME_COMPLETED_AS_TASKS	BOOLEAN	TRUE	v4+	Defaults to true if not configured. Defines whether the home screen widget data for the Completed facility/user is shown as tasks or orders.
MOBILE_POLLING_INTERVAL_PARCEL_LABEL	INTEGER	10	v4+	Defaults to 10 seconds if not configured. Defines custom polling intervals (in seconds) for parcel label creation in the app's packing and printing process.
MOBILE_POLLING_INTERVAL_RESTOW	INTEGER	60	v4+	Configures the update interval in seconds for open restow items while the screen is active. The minimum value is 5. Values less than 5 are ignored. The default is 60.
MOBILE_POLLING_INTERVAL_SERVICE	INTEGER	10	v14+	Defaults to 10 seconds if not configured. Defines the polling intervals (in seconds) for service jobs in the app's service process.
ORDER_SWAP_FILTER_SEQUENCE	BOOLEAN	FALSE	v4+	Defaults to false if not configured. If set to true, the status and type filter sequence will be swapped in the order overview screen.
PACKING_CONTAINER_TYPE_SCAN	BOOLEAN	FALSE	v4+	Defaults to false if not configured. Controls whether the container type selection in the packing process displays a screen to scan a container (camera or laser scanner). Otherwise, the app defaults to showing only the manual selection screen.
PACKING_ITEMS_AUTO_INCREMENT	BOOLEAN	FALSE	v4+	Defaults to false if not configured. Controls whether the item selection screen in the packing process automatically counts all items up to the maximum value.
PICKING_PREPARATION_ENABLED	BOOLEAN	TRUE	v8+	Defaults to TRUE if not configured. Defines whether the picking preparation screen is shown (this screen shows a calculated proposal of how many containers should be used for the PickJob and appears at the beginning of the picking flow).
PICKING_SCANNING_RULE	STRING	ARTICLE	v4+	Value can be one of ARTICLE (default), LOCATION, ARTICLE_LOCATION, or LOCATION_ARTICLE. When the value is ARTICLE, only the article's barcode can be scanned during picking. For LOCATION, only the code of the storage location in which the item is placed can be scanned. For ARTICLE_LOCATION, a scan is successful only if the article's code is scanned first, followed by the location's code. For LOCATION_ARTICLE, a scan is successful only if the location's code is scanned first, followed by the article's code.
PICKING_SCANNING_TYPE	STRING	SCAN_NOT_REQUIRED	v4+	Value can be one of SCAN_NOT_REQUIRED (default), MUST_SCAN_FIRST or MUST_SCAN_EACH. When value is SCAN_NOT_REQUIRED then scanning is optional during picking. For MUST_SCAN_FIRST a line item needs to be successfully scanned at least one time — afterwards, the item count can be increased via the number input field without needing to scan the item again. For MUST_SCAN_EACH every single item needs to be scanned during picking.
PICKING_STORAGE_LOCATION_ASSIGNMENT	STRING	DISABLED	v6+	Defines whether containers must be assigned to a storage location during picking and whether the corresponding screen is displayed. Defaults to DISABLED if not configured. If set to MANDATORY, users must assign a storage location to every container before proceeding. If set to OPTIONAL, the storage location assignment screen is shown, but users can skip it without assigning all containers to a location. Possible values: DISABLED, OPTIONAL, MANDATORY
POLLING_INTERVAL_ORDER	INTEGER	10	v4+	Defaults to 10 seconds if not configured. Defines custom polling intervals in seconds for refreshing the orders.
POLLING_INTERVAL_PICKING_STATUS_UPDATES	INTEGER	5	v4+	Defaults to 5 seconds if not configured. Defines custom polling intervals in seconds for status updates while processing PickJobs.
SHORTPICK_REASON_MANDATORY	BOOLEAN	true	v4+	If set to true, a single order pick can only be completed if a short-pick reason has been selected for each short-picked item.
ENABLE_EAN_CHECK_DIGIT_CALCULATION	BOOLEAN	true	DEPRECATED — before v5	Enables the app to automatically calculate the check digit for EAN-8 and EAN-13 barcodes if the scanning device doesn't send the complete code. For camera scans or devices that send the complete code, this setting has no effect.

Operations app

Returns app

Creating a remote configuration

We recommend not storing sensitive data in the remote configuration. Any logged-in user can read and write this data, and it's not stored encrypted.

POST https://ocff-{projectId}.api.fulfillmenttools.com/api/remoteconfigs

The following example shows the payload for creating a remote configuration.

{
    "key": "SHOW_RETURN_SECTION",
    "value": false,
    "valueType": "BOOLEAN",
    "groups": [
        "FULFILLMENT_APPLICATION",
        "BACKOFFICE"
    ],
    "scopes": [
        {
            "id": "SCOPE-ID-0001",
            "facilityRefs": [
                "FACILITY-ID-001"
            ],
            "userRefs": [
                "USER-ID-001",
                "USER-ID-003"
            ]
        }
    ]
}

Retrieving remote configurations

The GET endpoint provides filter parameters to retrieve specific configurations based on the use case. For instance, to get configurations applicable to a specific user and group, the userId and groups query parameters can be combined.

An example is retrieving all configurations for user USER-ID-003 that belong to the FULFILLMENT_APPLICATION group by using the query parameters userId=USER-ID-003 and groups=FULFILLMENT_APPLICATION.

GET https://ocff-{projectId}.api.fulfillmenttools.com/api/remoteconfigs