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
Group: BACKOFFICE
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.
Group: OPERATIONS_WEB_APP
NEW_PACKING_ENABLED
BOOLEAN
true
Uses the new packing process.
NEW_PRINT_OVERVIEW_ENABLED
BOOLEAN
true
Uses the new print overview.
OPERATIONS_POLLING_INTERVALS
JSON
Defines custom polling intervals in milliseconds. The client defaults any value below 5000 to 5 seconds. If a specific view's interval is not defined, the system uses its default value. Only specify the keys for the intervals to be changed.
PREFILL_AMOUNT_HANDLER
JSON
{"packing": "true"}
Within the new packing view, the item count in the amount handler is prefilled (e.g., 5/5) and does not need to be selected by the user. By default, the value is not prefilled (e.g., 0/5).
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.
SHORTPICK_REASON_MANDATORY
BOOLEAN
true
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.
SINGLE_PACKING_ENABLED
BOOLEAN
true
Enables a simplified packing process that does not allow packing multiple packages, as only one packing target container is created.
Mobile clients
Group: OPERATIONS_MOBILE
AUTO_SELECT_SYSTEM_PRINTER
BOOLEAN
false
Android v30+ | iOS v10+
Defaults to false if not configured. If set to true, then while printing the documents it auto selects the system printer and directly shows the system printing screen and skips the Printer selection screen.
CCSM_MANDATORY_SERVICES_READ_ONLY
BOOLEAN
true
Android v35+ | iOS v13+
Controls whether shipping services marked as mandatory by the carrier configuration in Carrier country service mapping (CCSM) are editable for the packer on the shipping attributes screen. If false (default), they appear pre-selected and editable. If true, they're read-only.
HOME_COMPLETED_AS_TASKS
BOOLEAN
true
Android v4+ | iOS v1+
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
INT
5
Android v4+ | iOS v1+
Defaults to 5 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
INT
60
Android v4+ | iOS v1+
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
INT
10
Android v14+ | iOS v1+
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
true
Android v4+ | iOS v1+
Defaults to true if not configured. If set to true, the status and type filter sequence will be swapped in the order overview screen.
PACKING_CAMERA_SCANNING_DISABLED
BOOLEAN
false
Android v30+ | iOS v10+
Defaults to false if not configured. If set to true, the camera scanning functionality will be deactivated for the packing process.
PACKING_CONTAINER_TYPE_SCAN
BOOLEAN
false
Android v4+ | iOS v1+
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
Android v4+ | iOS v1+
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.
PACKING_STORAGE_LOCATION_ASSIGNMENT
STRING
DISABLED
Android v29+ | iOS v10+
Defines whether containers must be assigned to a storage location during packing 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
PICKING_CAMERA_SCANNING_DISABLED
BOOLEAN
false
Android v30+ | iOS v10+
Defaults to false if not configured. If set to true, the camera scanning functionality will be deactivated for the picking process.
PICKING_PREPARATION_ENABLED
BOOLEAN
true
Android v8+ | iOS v1+
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
Android v4+ | iOS v1+
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
Android v4+ | iOS v1+
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
Android v6+ | iOS v1+
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
INT
10
Android v4+ | iOS v1+
Defaults to 10 seconds if not configured. Defines custom polling intervals in seconds for refreshing the orders.
POLLING_INTERVAL_PICKING_STATUS_UPDATES
INT
5
Android v4+ | iOS v1+
Defaults to 5 seconds if not configured. Defines custom polling intervals in seconds for status updates while processing PickJobs.
RETURNS_INTEGRATED_FLOW_ENABLED
BOOLEAN
true
Android v33+ | iOS v12+
Defaults to true if not configured. If set to true, the Store Operations will enable the integrated returning process. Otherwise, the integrated returning process is hidden. Additionally, the Android Store Operations app will automatically switch to the installed standalone Returns app for handling returns.
RETURNING_CAMERA_SCANNING_DISABLED
BOOLEAN
false
Android v33+ | iOS v12+
Defaults to false if not configured. If set to true, the camera scanning functionality will be disabled for the returning process.
RETURNING_RETURN_REASON_REQUIRED
BOOLEAN
false
Android v33+ | iOS v12+
Defaults to false if not configured. If set to true, providing the return reason will be mandatory in the returning process. Return reasons need to be configured.
RETURNING_ITEM_CONDITION_REQUIRED
BOOLEAN
false
Android v33+ | iOS v12+
Defaults to false if not configured. If set to true, providing the item condition will be mandatory in the returning process. Item conditions need to be configured.
RETURNING_DECISION_REASON_REJECT_REQUIRED
BOOLEAN
true
Android v33+ | iOS v12+
Defaults to true if not configured. If set to true, providing the decision reason will be mandatory (if the item gets rejected) in the return process. Decision reasons need to be configured.
RETURNING_DECISION_ACCEPT_PRESELECTED
BOOLEAN
true
Android v33+ | iOS v12+
Defaults to true if not configured. If set to true, the decision will be preselected with accept in the return process.
RETURNING_DECISION_TRIGGER_REVIEW_AVAILABLE
BOOLEAN
false
Android v33+ | iOS v12+
Defaults to false if not configured. If set to true, the decision option trigger review (indicate item needs further review) will be available in the return process.
RETURNING_DECISION_CHANGE_FOR_NOT_RETURNABLE_ITEMS_ALLOWED
BOOLEAN
false
Android v33+ | iOS v12+
Defaults to false if not configured. If set to true, the decision for not returnable items can be changed in the returning process. Requires RETURNING_DECISION_TRIGGER_REVIEW_AVAILABLE to be set to true.
SHORTPICK_REASON_MANDATORY
BOOLEAN
true
Android v4+ | iOS v1+
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 Android 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.
Group: OPERATIONS_ANDROID
android_calc_ean_check_digit
BOOLEAN
true
v157+
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.
android_use_picking_focus
BOOLEAN
true
v157+
If true, the user can only scan the item that's currently in focus during the picking process. If false, the user can scan any item in the list. The default value is true. This setting requires android_use_new_picking to be enabled and has no effect for pick jobs that require scanning a storage location or have barcode validation deactivated.
MOBILE_POLLING_INTERVAL_PARCEL_LABEL
INT
10
v164+
Defaults to 10 seconds if not configured. Defines custom polling intervals, in seconds, for parcel label creation during the app's packing and printing process.
MOBILE_POLLING_INTERVAL_RESTOW
INT
60
v154+
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.
PACKING_CONTAINER_TYPE_SCAN
BOOLEAN
FALSE
v164+
Defaults to false if not configured. Controls whether the Container-Type Selection in the App Packing Process will display a screen to scan a container (camera or laser scanner). Otherwise, the app defaults to showing a manual-selection-only screen.
PACKING_ITEMS_AUTO_INCREMENT
BOOLEAN
FALSE
v164+
Defaults to false if not configured. Controls whether the Item Selection Screen in the app packing process automatically counts all items up to the maximum value.
PICKING_SCANNING_RULE
STRING
ARTICLE
v165+
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
v165+
Value can be one of SCAN_NOT_REQUIRED (default), MUST_SCAN_FIRST, or MUST_SCAN_EACH. When the 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 — afterward, the item count can be increased via the number input field without needing to scan the item again. For MUST_SCAN_EACH, every item must be scanned during picking.
SHORTPICK_REASON_MANDATORY
BOOLEAN
true
v157+
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.
android_native_printing_enabled
BOOLEAN
true
DEPRECATED — before v164
Allows selecting the native Android printing interface when printing documents.
android_use_new_load_units
BOOLEAN
true
DEPRECATED — before v165
Enables the selection of load units during the picking process.
android_zebra_printing_enabled
BOOLEAN
true
DEPRECATED — before v164
Allows selecting Zebra printers directly from the network when printing documents.
Group: OPERATIONS_KMP
return_trigger_review_enabled
BOOLEAN
true
v20+
If true, the user can select a checkbox for each article in an ItemReturn to indicate it needs further review. If false, the checkbox isn't shown.
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.
The following example shows the payload for creating a remote configuration.
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.
Last updated
Was this helpful?