Fluent Commerce Logo
Docs
Help & Feedback

Settings

Settings allow you to configure the platform behavior via the user interface and manage business needs by enabling or disabling certain platform features. These settings are also called feature toggles. 

fc.analytics.returnordertypes

SettingThe `fc.analytics.returnordertypes` is a configuration that defines the available return order types for the Return Order Type Filter on the Returns Dashboard in Fluent Analytics. This allows users to filter return order data based on predefined return order types.

fc.rubix.order.sourcing.criteria

SettingThis Setting defines the Reference Sourcing Criteria Schema. It lists:
  • available Sourcing Criteria
  • their tags
  • parameter descriptors (including UI component metadata)
It allows business users to configure Criteria within Sourcing Strategies.

fc.rubix.order.sourcing.conditions

SettingThis setting defines the Reference Sourcing Conditions Schema. It:
  • Establishes the structure of available Sourcing Conditions and their parameters
  • Allows business users to configure Sourcing Conditions through the user interface and apply them in Sourcing Strategies
  • Ensures flexibility and consistency in managing sourcing logic

fc.mystique.filters.string

Setting`fc.mystique.filters.string` is an account-level setting that controls wildcard behavior for all string-based filters. It defines whether search uses partial matching (starts with/contains), exact matching (no wildcards), or a mix (e.g., only trailing wildcard). This helps balance performance and usability by avoiding costly leading-wildcard queries while still allowing flexible search. New accounts will include this setting by default for consistent behavior.

fc.analytics.queries.orders

SettingThe `fc.analytics.queries.orders` is a configuration that defines the analytics queries for the Fluent Analytics order dashboard. 

fc.analytics.timezones

SettingThe `fc.analytics.timezones` is a configuration that defines all the available timezones for the Timezone filter across Fluent Analytics dashboards. This configuration property is used by Mystique to provide a list of user-selectable timezones to display data in.  This allows users to filter data based on the relevant timezone. 

fc.analytics.queries.returns

SettingThe `fc.analytics.queries.returns` is a configuration that defines the analytics queries for the Fluent Analytics return dashboard. 

fc.analytics.queries.inventory

SettingThe `fc.analytics.queries.inventory` is a configuration that defines the analytics queries for the Fluent Analytics inventory dashboard. 

fc.analytics.queries.fulfilments

SettingThe `fc.analytics.queries.fulfilments` is a configuration that defines the analytics queries for the Fluent Analytics fulfilment dashboard. 

fc.analytics.ordertypes

SettingThe `fc.analytics.ordertypes` is a configuration that defines the available order types for the Order Type Filter on the Orders Dashboard in Fluent Analytics. This allows users to filter order data based on predefined order types.

rubix.entity.parent.status.fix

SettingThis setting fixes the functionality where an inline event would use the status of the parent entity to confirm whether a ruleset should be triggered.Note the default value for new accounts created after 11/11/2021 is `enabled`

fc.mystique.fields.basicpack

SettingThe `fc.mystique.fields.basicpack` setting enables the configuration of the Multi-Parcel Component fields.

PAYMENT.PROVIDER

Setting
This setting is used to describe the Payment Providers used by the Account

PAYMENT.METHOD

SettingThis setting is used to describe the Payment Methods (including Card Types) used by the Account

PAYMENT.CURRENCY

SettingThis setting is used to describe the Payment Currencies used by the Account

fc.oms.mystique.inventory.search.inventory.position.stock.statuses

SettingThe `fc.oms.mystique.inventory.search.inventory.position.stock.statuses` is a configuration that defines the available statuses for the Stock Status Filter on the Inventory Search page. This allows users to filter inventory data based on predefined status options.

fc.oms.mystique.inventory.search.virtual.position.stock.statuses

SettingThe `fc.oms.mystique.inventory.search.virtual.position.stock.statuses` is a configuration that defines the available statuses for the Virtual Stock Status Filter on the Inventory Search page. This allows users to filter virtual positions based on predefined status options.

RETURN_CONDITION

SettingThis setting contains a list of possible return conditions that can be associated with each item being returned.These values should correspond to the different conditions in which items are physically presented to the Operation.This list of returns conditions will be used to populate the conditions dropdown on the returns field

APPEASEMENT_REASON

SettingThis setting captures the list of reasons for appeasement used by a customer care representative while creating an appeasement.

DEFAULT_TAX_TYPE

SettingThis setting is used to store the default values of the tax details.  

GST

SettingTax Setting to declare the GST percentage value for return calculation.

REFUND_ENABLED

SettingThis setting is used for the rest APIs and is used to store the conditions to create a return order/process. During a return process, if the return type is 'cannot_fulfil' or 'cancellation', then the system checks this setting value and if the value is TRUE then the system allows creation of return.

COLLECTION_EXPIRY_TIME

SettingThis setting is used to store the number of days a parcel remains available for collection once it is ready to pick up from the store. This is used for accounts where settings RUBIX_ENABLED is FALSE for 'Click and Collect' orders. The default value is 7 days. During the execution of the orders, there is a cron job that checks all the articles that are updated in the last 7 days and generates an event to expire those articles.

PICK_N_PACK_CUSTOM_PICK_LIST

SettingThe customization of the pick list is created using a custom template stored in this setting that can be triggered using a request.

AWAITING_WAVE_STATUSES

SettingThis setting stores the permissible fulfilment statuses to create wave on a retailer location using Service Point. The setting is used by the createWave rule.

QUANTITY.WEIGHTING.FACTOR

SettingThis setting stores the default values for proximity and quantity parameters to calculate the weightage to decide the order of stores in which they will be picked up. This setting is used by `fulfilment.SearchInventoryCommonRule.` 

EVENT_ATTR_WAVE_MAX_COUNT

SettingThis setting stores the value for the permissible number of waves for an order. This setting is used by the CreateWave rule which creates the maximum number of waves equal to the number stored in this setting. If nothing is found then the rule creates a default of 5 waves.

TRADING_HOURS_ETA

SettingThis setting stores the data to compute the Service Level Agreement (SLA) when there is an article that needs to be moved from one store to another store. The following logic is used to determine the SLA:
  • ETA FROM BOTH STORES.
  • GREATER OF ( from_Store ETA) AND ( To_Store ETA)
  • ETA OF from_Store
  • ETA OF To_Store
  • ETA FROM THE SETTING
  • DEFAULT VALUE OF 3 HOURS

fc.mystique.manifest.store.fragment.waves

SettingWhen this setting is set, the waves page will be overriden in the Fluent Store Web App

fc.mystique.manifest.store

SettingWhen this setting is set, the default Fluent Store web app will be overridden.

GLOBAL_INVENTORY_ENABLED

SettingEnables a backward compatibility for clients who are not using Fluent Commerce's Global Inventory (GI) system. If this setting is enabled, the system activates GI for those clients. For more information about the application of this setting, see Global Inventory.

INVENTORY_BATCH_ENHANCEMENT_ENABLED

SettingWhen enabled, this setting stores the inventory JSON in s3, and each Rubix server processes one batch at a time. This enhances the performance of the inventory load.

RUBIX_ENABLED

SettingProvides backward compatibility to those clients who are not on Fluent Commerce’s Rubix platform. These clients are still utilising the API driven logic that is now moved to the workflows and rules in the Rubix Platform.
If this setting is set to TRUE then the system skips the logic embedded within the APIs and goes to the Rubix platform based workflow execution.

DEFAULT_RETURN_DESTINATION_LOCATION

Setting
If the return destination is not provided to the workflow, then the rule will look for the default return destination stored in this setting.The value in this setting will be used to populate the `destination location` field on the return order object when it is created.A field may optionally send in its destination location for custom returns solutions when submitting the user action. The setting will serve as a fallback value if the field does not provide a destination location (which the reference solution does not)See destinationLocation in the `CreateReturnOrder` GraphQL schema for details.

rubix.enable.enhanced.gi.exception.audit.event

SettingThis setting extends the Inventory domain Audit Events to include the Event Attribute Payload.Note the default value for new accounts created after 20/08/2022 is `true`

ALLOW_CREATE_ARTICLE_AFTER_PACK

SettingThis setting enables creation of multiple articles for one fulfilment. If this setting is set to TRUE then the article creation is done post packing to facilitate multiple article creation for one fulfilment. If this setting is set to FALSE then the rule creates only one article for the fulfilment.

COMPATIBILITY_EVENT_ENABLED

SettingThis Setting enables the clients who are not on Global Inventory (GI) to utilise the GI-based rules. This helps the developers to write GI based rules for non-GI enabled clients. When this setting is set to TRUE the system generates the virtual catalog using the legacy inventory tables and legacy catalogue tables.

DEFAULT.COORDINATES

SettingIf the rule parameter is set to true and the Google Geocoding request fails or the response contains no result, the DEFAULT.COORDINATES setting will be used.  this setting is also used by a few rules such as `ValidateOrderDeliveryAddress` 

EXCHANGE_REASON

SettingThis setting holds the default values for the settings. When a user creates an exchange, this system pulls the values from the setting.

fc.graphql.order.create.event

SettingThis setting is a feature toggle that enables Order creation across multiple Retailers with a single integration user. It allows the creation of Orders independent of the primary Retailer of the user and specifically enables the sending of the corresponding `CREATE` event.

fc.order.sourcing.proceeding.time

SettingThis setting determines the time when we start the pick and pack process for an order. It is measured in hours and set at retailer and/or agent levels. The setting also determines when a fulfillment will appear in the store by changing the status from `SCHEDULED` to `AWAITING_WAVE`.

fc.order.sourcing.reservation.time

SettingThis setting determines the time when we reserve inventory for an order. It is measured in hours and is set at the account and/or retailer level. The system will create fulfillment based on the `DeliverAfter` value.

FETCH_USER_COORDINATE

SettingThis setting fetches the location coordinates from the Google API. If this is set to TRUE and the coordinate is not supplied by the requestor then the logic fetches the coordinates from Google API.

GEOCODER.API

SettingThis setting is used to store the API Key to send an address and get back the longitude and latitude values.

ORDER_ADDRESS_VALIDATION_REQUIRED

SettingThis setting is an additional check to the FETCH_USER_COORDINATE setting to decide the exception handler's behavior when the location is not available from all sources. If the location is neither provided within the order and nor fetched from the Google API then the system checks for this flag and if it is set to TRUE then the order is failed.

PICK_N_PACK_TIME_LIMIT

SettingThis setting is created to capture the configurable time limit for allowing the pick and pack process. This can be set to a specific number of hours.UPSERT_LOCATION event (from the ES Starter Pack) will auto-create this setting as part of the event trigger.  Therefore, the user is not required to manually create this setting for each location.

PROXIMITY.WEIGHTING.FACTOR

SettingThis setting stores the default values for proximity and quantity parameters to calculate the weightage to decide the order of stores in which they will be picked up for fulfilment.SearchInventoryCommonRule uses this setting.

RETURN_REASON

SettingThis setting contains a list of possible return reasons that can be associated with each returned item. These values should correspond to the different reasons for customers to return items.
This list of reasons will be used to populate the reasons dropdown on the returns field.

WAVE_RUBIXIFIED

SettingProvides backward compatibility to clients not yet on Fluent Commerce's Rubix platform. 

CUSTOM_PICK_LIST_SORT_CONFIG

SettingThis setting optimizes picklist sorting for efficient picking runs. Define sorting criteria like: Parent department (e.g., MEN), Child department (e.g., SHOES), and Category (e.g., Sneakers). Sorting by levels (1: Parent, 2: Child, 3: Category) helps staff pick items from the same area at once, reducing travel time between locations.

fc.graphql.compatibility.nullEmptyValidation

SettingThis setting is a feature toggle that defines how empty strings and `null` inputs are handled by the GraphQL API and how the values are persisted. To enable it, set the setting `fc.graphql.compatibility.nullEmptyValidation` value to `validate-empty-fields`.

fc.fulfilmentoptions.create.event.persistence

SettingThis setting enables an account fulfillment options event creation to be run asynchronously to the request.  Read more about it in Fulfilment Options improvements enablement.

fc.mystique.fields.fulfilmentpack

SettingThis setting is utilized in the Pack component to configure the Pack Wizard.

fc.oms.inventory.search.product.catalogue.default

SettingThe `fc.oms.inventory.search.product.catalogue.default` setting is a configuration used to set the default value for the Product Catalogue Filter on the Inventory Search page. This ensures that the filter is pre-applied with a specific catalog.

fc.oms.inventory.search.inventory.catalogue.default

SettingThe `fc.oms.inventory.search.inventory.catalogue.default` setting is a configuration used to set the default value for the Inventory Catalogue Filter on the Inventory Search page. This ensures that the filter is pre-applied with a specific catalog. The setting can be configured as a string or a JSON value, allowing support for multiple inventory catalogs by including their references.

fc.graphql.comment.access

SettingThis setting is a feature toggle that enables the Retailer-specific Permissions for the Comment GraphQL API.It allows you to manage User access rights for creating, updating, and viewing Comments with the corresponding GraphQL Permissions at the Account or Retailer level.

fc.enable.batch.preprocessing

SettingA setting to enable or disable Batch Pre-Processing feature.

fc.mystique.pack.rejection.reasons

SettingThis setting provides a list of rejection reasons to be applied during the packing process. These reasons will populate the dropdown menu in the rejection field during Pack. The list can be customized or expanded to meet specific business requirements.

fc.api.fulfilment.uniqueness

SettingEnabled a new unique constraint for the fulfillment creation process to prevent duplicate fulfillments. Enabling this feature toggle can impact the existing business process of replay fulfillments at the same location; see the Managing Duplicate Fulfilments functionality.

SSO.DETAILS

SettingThis setting is added when an Account is SSO enabled. This setting contains details about the specific SSO provider environment for this Account

fc.rubix.sdk.webhook.retry.schedule

SettingConfigures the Webhook retry schedule with an escalating back-off pattern.

fc.rubix.sdk.primaryEntityCache

SettingImproves Workflow performance by preventing context.getEvent() from making excessive GraphQL calls.

fc.rubix.sdk.webhook.retry.method

SettingMakes Webhook retries for custom Webhook rules using custom Webhook rule logic instead of the default logic.

PICK_N_PACK_ENFORCE_BARCODE

SettingWhen this setting is set, the ServicePoint only allows barcode instead of +/- button.

SERVICEPOINT_GQL_DASHBOARD

Setting
You can configure the information displayed on the tiles on the ServicePoint dashboard via this setting.
The components on the dashboard are generated based on the query and variables passed in this setting.
For more information, see the ServicePoint Dashboard page.

DISPLAY_ORDER_ITEMS_IN_COLLECTION_SCREEN

SettingDisplays order items in the collection screen. The following permissions must be enabled for the users in RETAILER CONTEXT to view order details:
- ORDER_VIEW

- ORDERITEM_VIEW

- PRODUCT_VIEW

- VARIANTPRODUCT_VIEW

- STANDARDPRODUCT_VIEW

- GROUPPRODUCT_VIEW

- CATEGORY_VIEW

MAJOR_ADDRESS_CHANGE_FIELDS

SettingEnables the change delivery address feature. Users can configure major field changes such as cancellation of a fulfilment. Once delivery address change request is received by user action based event in Order workflow we evaluate whether it is a significant Address change. This is decided based on `MAJOR_ADDRESS_CHANGE_FIELDS` setting. In case of a minor change, the Order delivery address is updated in order and fulfillments. For significant address change, the existing fulfilment is cancelled and re-run the create fulfilment logic with the new delivery address. Ensure that `ChangeOrderDeliveryAddress` and the `EvaluateFulfilmentsForAddressChange` rules have been added to the Order workflow.

CALCULATE_INVENTORY_OVERVIEW

SettingThis setting stores which retailer IDs will be executed in the database stored procedure - inventory_view to aggregate the inventory results. This aggregation is executed every 6 hours by the cron job and the inventory result is used by the Admin Console. It is used by clients not on Rubix platform.

HOTFIX_NEW_APOLLO_CLIENT_ENABLED

SettingThis setting is required for orchestrated returns.This setting is required to enable the `DEAFULT_TAX_TYPE` setting. This setting enables reading and writing raw JSON. This is a Boolean setting that should be set to `TRUE`.

fc.batch.auth.expiry.code

SettingPreviously, customers had an impact by an edge case in our authentication token expiry, which would occur when authentication expires while a batch job was in progress. The platform returns the HTTP response code of 500 instead of 401. This issue has now been fixed, and a 401 response code will return when the authentication token expires while running a batch job.To ensure backward compatibility, we have implemented a setting to toggle between the correct (i.e. return 401 HTTP response code) and previous (i.e. return 500 HTTP response code) functionality. The setting details are mentioned in this document.

fc.mystique.apps

SettingUsing the Workflow Builder (Orchestration Modeller), you can add user actions in the context of a custom web app name, by adding this new setting to your account. A custom web app is a web app that is not developed and supported by Fluent Commerce. Examples of the current web apps developed and supported by Fluent Commerce are Admin Console and Fluent Store (ServicePoint).

GRAPHQL.DISABLE_GRAPHQL_ME_QUERY

SettingWhen this setting is enabled, The GraphQL Me Query is disabled for this Account.

LARGE_VOLUME_CLIENT.BOOLEAN

SettingWhen this is set to TRUE then it prohibits filter based query. For accounts with LARGE_VOLUME_CLIENT setting enabled Event query API should be used with account token.

ADMIN_CONSOLE_MANIFEST

SettingThis setting manages the Fluent Admin Console. The setting contains all the labels required to display and customize the Admin Console. To support languages other than English users can enter the labels directly into the configuration of their preferred language. Alternatively, they can create a language key and add the translation in more than one language setting files.

FC.MYSTIQUE.EVENT.SEARCH.FILTERBASED

SettingDisplays the Event search UI component on the Admin Console. For more information about how to use this setting, see the Event Search functionality.

TRACK_UNFULFILLED_ITEMS

SettingThis setting is used to determine whether a Distribution Center (DC) fulfilment is allowed as a final attempt. If this setting is set to TRUE then the system attempts to create one last fulfilment from the DC for the unfulfilled items of the order that can not be fulfilled by a store or store network. The setting is used for clients not on Rubix platform.FOR HD ORDER, SHIPMENTTYPE = HD_PFDC
FOR CC ORDER, SHIPMENTTYPE = CC_PFDC

RETAILER_ADDRESS_VALIDATION_CONDITION

Setting
This setting is used to validate a retailer's location address at the time of courier booking the orders from a location. This is used by the order Booking API and Create Fulfilment API. The setting is used for clients not on Rubix platform.

RETAILER_LOGO_URL

SettingThis setting stores the default URL for the retailer's logo. This logo may be used in the pack slips, emails etc.

RETURN_ORCHESTRATED

SettingThis Setting is created to enable/disable the Return feature in Service Point so that clients who do not use orchestrated return through Rubix do not see the feature in service point and hence are not impacted. If this setting is TRUE, then the return module is visible on Service Point.

REMIND_DAYS_TOTAL

SettingThis setting can be configured to identify the number of days to wait before a reminder email is sent to the customer informing them that they have an order for collection. This setting is used by clients not on Rubix platform.

ORDER_EXPIRY_TIME

SettingThis setting stores the default value of the expiry time for the fulfilment of an order and is used by ScheduleFulilmentExpiry rule.The rule gets the expiry time from the event. If the value is not supplied in the event then the rule takes the value from this setting. During actual execution of the order , once the time limit reaches, the order should expire. This setting is used by clients that are not on the Rubix platform.

DEFAULT_INVENTORY_CATALOGUE

Setting
This setting stores the default Inventory Catalogue Rules. If the rule does not find any inventory catalogue then it checks in the default catalogue.

PACKING_SLIP_PROPS

SettingThis setting captures the retailer's information used to create packing slips.
Building Blocks
Building Blocks
Packages & Modules
All UI Components
Workflows
Settings
Interface Contracts
All Rules
By Type
All Types
Knowledge Tracks
Extend Knowledge
Glossary
All How-to Guides
Sitemap
Topics
Use Cases
Helpful Resources
Platform Limits
Support Policy
Service Level Agreement (SLA) - Enterprise
Deprecation Policy
Extend Knowledge Content – Terms and Conditions
System and Organization Controls (SOC) 3 Report
Data Privacy Addendum
Security Policy
Quick Links
For Partners
Customer Resources
Webinars and Events
Certifications
Training Resources
Knowledge Tracks
Builders Portal
Product Update Newsletter
Industry Blogs & Events Newsletter
Trust Center Portal

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Fluent Logo