Building Blocks

382 Items

Accordion Component

UI ComponentThe Accordion component is a Mystique content component that can expand to show its child components. It is useful for hiding details with the ability to pull it up when needed.

Add Item Dialogue Component

UI Component

This article describes how to add Add item button (`OpenDataModalButton`) to the drawer and display the list of product items in a modal window ('Add Item' dialogue).

AddFulfilmentTypeAttributeToFulfilment

RuleThe rule adds an attribute with name `FULFILMENTTYPE` to incoming fulfilment with value based on the fulfilment type.

AddFulfilmentTypeAttributeToFulfilmentByFulfilmentChoice

RuleThe rule adds an attribute with name `FulfilmentType` to incoming fulfilment with value based on the fulfilment type.

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.

Adobe Commerce Connector

PackageThe Adobe Commerce Connector provides seamless integration between the Fluent Order Management platform and Adobe Commerce. New and existing Adobe Commerce customers can rapidly adopt omnichannel capabilities with the connector.

AllocateConfirmedItemsByFulfilmentExpiry

RuleAllocates picked items to all Fulfilments in the Wave. Priortizing the Fulfilments expiring first and not in specified statuses. Secondly, notifies Fulfilments with the specified event name.

AllocateConfirmedItemsByFulfilmentExpiry

RuleAllocates picked items to all fulfilments in the Wave. Priortising the fulfilments expiring first and not in specified statuses. Secondly, notifies Fulfilments with the specified event name.

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.

APPEASEMENT_REASON

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

ApplyThresholdControlsToInventoryPosition

RuleApply Threshold Controls to an Inventory Position and determine its status.

ApplyThresholdControlsToVirtualPosition

RuleApply Threshold Controls to a Virtual Position and determine its status.

Area Chart Component

UI ComponentA chart that displays graphically quantitative data. It is based on the line chart. The area between the axis and line is emphasized with colors. Commonly two or more quantities are compared with an area chart.

Area Chart Wrapper

UI ComponentAn area chart wrapper that converts data from Metrics API to chart-readable format.

Attribute Card Component

UI ComponentThe Attribute Card implements the basic card that maps GraphQL responses onto a two-column card with keys on the left and values on the right.

Attribute Column Component

UI Component`fc.attribute.column` is a content component that gives the following options:

apply different styles to multiline data represented in a cell of `fc.list` component;
display multiline data in collapsed/expanded view;
display configured coloured icons in the cell depending on income values;
display sorted data in the cell.

Configurable Drawer Component

UI ComponentThe Configurable Drawer is a Mystique content component that displays other components in the hidden by-default section. The drawer button click event expands this hidden section on the right-hand side of the screen.The component allows you to redefine the context for its descendants.

Attribute Input Component

UI ComponentThe Attribute Input Component is a default field component that allows you to add/edit Fluent entity Attributes in a drawer.

Auto Refresh Page Component

UI ComponentThe Auto Refresh Page Component will automatically refresh the current page every 10 seconds. This is useful for ensuring that the information displayed to the user is as accurate as possible with new entities and status updates reflected in pages within web apps at regular intervals.

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.

Bar Chart Component

UI ComponentA chart that represents categorical data with rectangular bars with heights or lengths proportional to the values that they represent.

Bar Chart Wrapper

UI ComponentA bar chart wrapper that converts data from the Metrics API to chart-readable format.

BPP Metrics Wrapper

UI ComponentThe `fc.list.wrapper.bppmetrics` is a wrapper for the `fc.list` component. It transforms data from the Metrics API to a list-readable format, enabling seamless visualization of batch-processing metrics.

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.

CalculateLocationsDistances

RuleThe rule calculates distances, in meters, from each location to the order delivery address based on the incoming longitude/latitude. Sends event with attributes containing calculated distances.

CalculateOnHand

RuleCalculates the onHand value of an inventory position using inventory quantities filtered by statuses {filterStatuses} and types {filterTypes}, and then send the event {eventName}

CancelAllFulfilmentsForOrder

RuleThe rule changes the status of all fulfilments associated with the incoming order entity to `CANCELLED` and updates fulfilment item's filled quantity and rejected quantity.

CancelFulfilment

RuleThe rule changes the status of the incoming fulfilment to 'CANCELLED' and updates fulfilment item's filled and rejected quantities.

CC Workflow Interface Contracts

Interface Contract

ChangeOrderDeliveryAddress

RuleThe rule changes the order delivery address and creates a comment for the order.

ChangeStateForUnfulfilableFulfilment (Superseded)

RuleThe rule matches the incoming fulfilment's from address location ref to the system rejected location ref provided in the input parameter and if it matches, changes the fulfilment status.Superseded
This approach is still supported but no longer recommended for new implementations. It has been replaced by a more scalable alternative that aligns with Fluent’s product direction and will benefit from future enhancements.Fluent recommends using the `SendEventToProcessUnfulfilableFulfilment` and `SetState` rules instead.

ChangeStateGQL (Superseded)

RuleChanges the state of any type of incoming entity to the status provided in the input parameter using the generic update status mutation in GraphQL. It changes the state of the `event.entityType` to `status` using GraphQL.Superseded
This approach is still supported but no longer recommended for new implementations. It has been replaced by a more scalable alternative that aligns with Fluent’s product direction and will benefit from future enhancements.Fluent recommends using the `SetState` Rule instead.

Circular Progress Component

UI ComponentThe Circular Progress Component visually indicates the ongoing progress of a loading process.

Collapsible Attributes Component

UI ComponentCollapsible Entity Attributes is a component that can be used to improve the user experience when interacting with a lot of attributes. It has the ability to:

Display these attributes on one line separated by commas
Display these attributes line by line.
Collapse and expand based on the number of characters (for one-line)
Collapse and expand based on the number of lines (for line-by-line).

Collapsible Text Component

UI ComponentThe Collapsible Text component takes a string and a maximum number of characters into its props. When the string exceeds the maximum number of characters the text is cut off. Then `More` hyperlink is displayed to allow the user to expand the label to its full length, exposing the remaining text.

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.

Column Component

UI ComponentA simple component that allows you to place other components in a column. Typically used to improve the layout and accessibility of items on a page, see a sample use case and the properties of this component below.

commercetools Connector

PackageThe commercetools Connector provides seamless native integration between the Fluent Order Management platform and commercetools platform with greater flexibility and simplified development. commercetools customers can rapidly adopt omnichannel capabilities with this connector.

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.

Complex Filter Component

UI ComponentThe Complex Filter Component dynamically fetches and filters data based on a configurable GraphQL request. Depending on the configuration, it enables users to search for entities using tailored filters and displays results in either Standard Card or Product Card formats. This adaptability ensures precise data retrieval and a consistent, user-friendly presentation.

Component SDK

PackageThe Component SDK allows clients and partners to develop new components to extend the functionality of the Fluent Web Apps.

Conditional Component

UI ComponentOptionally render descendants only if certain criteria are met. This can be used to show different components depending on the results of the page query, for example:

a different location card when the order is home delivery vs customer collection
a completely different screen when a wave is in a given state

ConfirmFulfilmentItems

RuleThe rule updates the fulfillment items with the quantity details using the quantity details from the items received in the event attribute.

Connect SDK

PackageConnect SDK is the launchpad to connect any external system with Fluent Commerce predictably. It reduces implementation timelines and costs so customers can see faster ROI. Technically, Connect SDK is a Java Maven Archetype and Java Library Utils that form a toolkit for building Spring Boot microservice applications that communicate with the Fluent Order Management System and any external system.

Control Group Workflow Interface Contracts

Interface Contract

CopyAttributesFromFulfilmentToArticle

RuleThe rule copies all the attributes from the parent fulfilment onto the article entity in the incoming event.

Core Reference Module

PackageThe Core Reference Module is a foundational Reference Module. It provides a base set of general purpose Rules:

that other Modules are built upon
or that can be included in your own Workflows

Extensible by design, use this Module as a base to build a solution for the needs of your customers.

Core Utilities

PackageThe Core Utility (`util-core`) is a standard library of utility functions designed to simplify and accelerate Rule development on the Fluent Commerce platform. It provides a foundational set of helper classes that address the most common challenges and repetitive tasks developers face.

Connector Contract - Create Order

Interface Contract FlowThrough the GraphQL API, create a new order in Fluent. The Customer must exist before placing the order, whether a guest user or not. FlowThe activity flow for both standard and guest users is identical. However, in a guest checkout scenario, a new Customer is always created before the order is placed. The source system should generate a new unique identification for guest users, even if the email address used is the same as that of an existing standard user.Order createThe activity flow has to first fetch the Customer ID from Fluent before placing the order.API DetailsCreate OrderAPI contract - createOrderCreate CustomerAPI contract - createCustomerCreate PaymentAPI contract - Create Order PaymentGet CustomerAPI contract - getCustomer Query

Connector Contracts - Create Order Payment

Interface Contract FlowPayment transactions reflect when and how a customer has paid for an order. Multiple (split) payments are supported and custom business logic can be applied on the Fluent side, to identify when an order has been fully paid.Considerations for the payment workflow:

The workflow needs to reflect the business model on when to capture the payment: at order placement, or at fulfilment.
Create order payment should simply track the payment details against the order placed, nothing more.
All available payment transactions (authorisation and/or capture) should be pushed to Fluent.
These transactions can be used to issue refunds on returns or cancellations.
Payment pre-authorisations usually only hold for 5-7 days. The workflow should expect it to fail when capturing at fulfilment time for delayed orders.
Pre-orders will need a different flow, as capturing at fulfilment time will most likely be outside the 5-7 window.

API DetailsEvent Names

`fc.connect.order.transaction.add`

API contract

Event API
Financial Transaction

To download the add payment transaction connector payload schema click here.

CreateAggregateVirtualPosition

RuleCreate an Aggregate Virtual Position, calculate its Available-to-Sell (ATS) quantity, and send an event.Aggregate Virtual Position ATS calculation is based on the associated Inventory Positions Stock on Hand (SOH) quantities and the applied Controls.The associated Inventory Positions are defined with:

The given Product Reference
The list of Locations for the given Network (the first Network assigned to the Virtual Catalog)
The specified Inventory Position Statuses

CreateArticlesForFulfilment

RuleThe rule creates one or more articles for the Fulfilment in the incoming event.

CreateBaseVirtualPosition

RuleCreates a base virtual position and sends the event `{eventName}`

CreateBaseVirtualPositionIfNotPresent

RuleChecks if a Virtual Position does not exist, if the Virtual Position does not exist it will create a new Virtual Position with the matching attributes

CreateBillingAccount

RuleThe rule creates customer’s Billing Account with billing account reference.

CreateCategory

RuleCreates a category based on the information passed in the event

CreateCreditMemoForRevisedOrder

RuleThe rule creates a CreditMemo for the BillingAccount using the supplied revised order details and the old order as well.

CreateCreditMemoFromAppeasement

RuleThe rule creates a CreditMemo for the BillingAccount using the supplied Order details.

CreateDeltaInventoryQuantities

RuleCreate an Inventory Quantity(ies) for the specified Inventory Position.

CreateDemoConsignment

RuleThe rule creates a demo consignment.Creates a demo consignment with label {"PROP_LABEL_URL"} and carrier {"PROP_CARRIER_REF"}.

CreateFinancialTransaction

RuleThe rule processes a payment event and creates a financial transaction.

CreateFulfilment

RuleThe rule creates fulfilment based on the incoming proposed fulfilment, excluding fulfilments in specified statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateFulfilmentForFulfilmentChoice

RuleThe rule creates a fulfilment based on the incoming proposed fulfilment, excluding fulfilments in specified statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateFulfilmentForFulfilmentChoiceForUnfulfillableItems

RuleThe rule creates a rejected fulfilment for order items that could not be fulfilled (no inventory) based on location. The rule processes only fulfilments that are in accepted statuses and not in rejected statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateFulfilmentForUnfulfillableItems

RuleThe rule creates `SYSTEM_REJECTED` fulfilments for unfulfillable items using a location ref provided in input parameters. It uses a mathematical calculation on counts of all fulfilments by dividing them into 2 different groups depending on their statuses i.e. accepted statuses and rejected statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateFulfilmentInventoryQuantity

RuleCreate inventory quantity of type {inventoryQuantityType} using event attributes, or set default type as {defaultType}, condition as {defaultCondition} and storageRef as {defaultStorageAreaRef}

CreateFulfilmentWithSourcingProfile

RuleCreate Fulfillment(s) using the specified Sourcing Profile.

CreateInventoryPosition

RuleCreate an inventory position based on the incoming event attributes

CreateInventoryQuantity

RuleCreate an inventory quantity based on the incoming event attributes

CreateStandardProduct

RuleCreate a standard product based on the information provided in the event

CreateInvoiceForOrder

RuleThe rule creates an Invoice for the order.

CreateParcelsForFulfilment

RuleThis rule is executed to create articles based on the items packed into parcels.

CreatePartialFulfilmentWithSourcingProfile

RuleCreate Partial Fulfillment(s) using the specified Sourcing Profile.

CreateRejectedFulfilment

RuleCreate a System Rejected Fulfillment for Unfulfilled Items that can not be fulfilled.

CreateReturnOrderFromOrder

RuleThe rule creates a return entity. The return entity is then used to initiate the process of order items return.

CreateRevisedOrder

RuleThe rule creates a revised order based on the revised order attributes passed in the event.

CreateVariantProduct

RuleCreate a variant product based on the information provided in the event

CreateWaveByExpiry

RuleCreate a wave from fulfilments in statuses `{status}`, prioritizing those with the earliest expiry.

CreateWaveByFulfilmentIds

RuleThe CreateWaveByFulfilmentIds takes a list of Fulfillments and creates a Wave with them.

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.

Dashboard Threshold Component

UI ComponentThe dashboard threshold component displays a card with a number referring to the total records returned by a GraphQL query. Tiles can be configured to change colour based on configured threshold limits to indicate their status.Each tile is configurable with a high and low threshold value, allowing users to view any 'total' data records.

GraphQL Data Provider Component

UI ComponentThe GraphQL Data Provider component is a wrapper component that changes the data context for its descendants. It is useful when you want to display a separate set of data that is different from the page query. Additionally, it provides more control options on how data is queried, including the ability to paginate and fetch data in bulk. Note that the maximum amount of data retrieved with the component is restricted.

Date Range Field Component

UI ComponentThis document describes the Date Range Field Component properties and sample usage. The component allows users to select a date and time range in the relevant form.

Date Range Forwarding Wrapper

UI ComponentThe `fc.daterange.wrapper.forwarder` is a wrapper designed to forward date range data to a URL.

Date-Time Field Component

UI ComponentThis reusable Date-Time Field Component offers an intuitive calendar-based UI for selecting a date. Below the calendar, clearly labeled input fields allow users to enter precise date and time values. Outputs are returned in ISO 8601 format to maintain consistency across systems.

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`

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.

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.

DEFAULT_TAX_TYPE

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

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

Download Print Button

UI ComponentThere are some Fluent APIs that directly produce HTML pack slips.These files can't be directly linked as they require authentication, so the Download Print Button exists to allow them to be downloaded directly from the page.

DownToCategory

RuleForward the incoming event with event name {eventName} to the category entity with the provided ref

DownToInventoryPosition

RuleSend an event to the inventory position specified in event attributes from the inventory catalogue

DownToInventoryPositionIfExists

RuleForward event `{eventName}` if the inventory position exists.

DownToProduct

RuleForward the incoming event with event name {eventName} to the product entity with the provided ref.

DownToVirtualPositionIfExists

RuleSends event {eventName} to the virtual position if a Virtual Position does exist

Add Item Dialogue Component

UI ComponentThis article describes adding the 'Add item' button (OpenDataModalButton) to a drawer and displaying the 'Add Item' dialogue in a modal window. This allows users to easily review product items in an order before submitting.

Dynamic Utilities

PackageThe `util-dynamic` library is a collection of powerful utility functions that allow you to generate GraphQL queries and mutations at runtime. This enables the creation of highly configurable and reusable rules that can adapt to different needs without requiring code changes.

EvaluateFulfilmentsForAddressChange

RuleThe rule defines whether the address change is major based on the address fields that have been modified.

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.

Event Details Drawer Component

UI ComponentThis new component adds a drawer functionality to event searching, when a user clicks on an event it will now open a drawer with the event details instead of navigating to another page. This allows users not to lose search results and stop waiting for page navigation while going back and forth between the list of events. Learn more about the functionality of this component below.

Events Search Component

UI ComponentThe Events Search is a plugin component for events:

filtering,
displaying,
exporting.

The component fetches events using the REST Event API based on the selected search criteria.

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.

Extended Address Input

UI Component`ExtendedAddressInput` is a Mystique component that can support the extended address in order details and a digital/e-mail shipping method. The component supports delivery addresses with lengthy street/city/company name fields (255 characters).

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.

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.enable.batch.preprocessing

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

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.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.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.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).

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.

fc.mystique.fields.basicpack

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

Fulfilment List Field Component

UI Component

The Fulfilment List Field Component allows users to select and filter Fulfilments. In the reference solution, these are then used to create Waves.
Readers will understand the functionality of this component, how it can be configured and extended in order to implement different Store Fulfilment use cases.

fc.mystique.fields.fulfilmentpack

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

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.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.

fc.mystique.manifest.store

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

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.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.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.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.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.

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.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.

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.

Filter Panel Component

UI ComponentThe `fc.filterPanel` component is a versatile feature for filtering data, supporting two key use cases: standalone list filtering or as an embedded feature within the `fc.list` component for inner list filtering. It enables developers to customize filters via overrides, manage dynamic GraphQL queries, and exclude specific fields. When embedded, it enhances the user experience with dynamic, row-level filtering. Flexible configuration options ensure precise control over behavior and appearance, adapting seamlessly to various scenarios.

FilterLocationsByRadius

RuleThe rule finds locations which are outside the radius provided in the event attribute.

Fluent CLI

PackageThe Fluent CLI is an NPM Package, which can be installed by following the Getting Started Guide.

Forward

RuleForward the incoming event with event name {eventName}.

ForwardEventByFulfilmentChoiceType

RuleThe rule sends an event with a proper name if the fulfilment choice has a definite type.

ForwardEventsWithFulfilmentChoiceReference

RuleThe rule sends event to all fulfilment choices with definite reference.

ForwardEventWithDeliveryAddressCoordinates

RuleThe rule forwards the input event with coordinates of the order delivery address.

ForwardEventWithDeliveryAddressCoordinatesByType

RuleThe rule forwards the event containing the longitude & latitude of the delivery address if fulfilment choice has definite delivery type.

ForwardEventWithPickupLocationCoordinates

RuleThe rule forwards the input event with coordinates of the pickup location.

ForwardEventWithPickupLocationCoordinatesByType

RuleThe rule forwards the event containing the longitude & latitude of the pickup location if the fulfilment choice has definite delivery type.

ForwardIfCategoryExists

RuleForwards the event with name {eventName} if the category exists.

ForwardIfCategoryNotExists

RuleForwards the event with name {eventName} if the category does not exist.

ForwardIfDeliveryAddressNotPresent

RuleThe rule forwards the input event if the order’s delivery address is not present.

ForwardIfDeliveryAddressPresent

RuleThe rule forwards the input event if the order’s delivery address is present.

ForwardIfFulfilmentChoiceCoordinatesNotPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address longitude and latitude are invalid.

ForwardIfFulfilmentChoiceCoordinatesPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address longitude and latitude are valid.

ForwardIfFulfilmentChoiceDeliveryAddressNotPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address is invalid.

ForwardIfFulfilmentChoiceDeliveryAddressPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address is present.

ForwardIfIncomingAttributeEquals

RuleForward the incoming event with the event name `{eventName}` if event attribute key `{attributeKey}` has value `{attributeValue}`.

ForwardIfInventoryPositionNotExists

RuleForward event {eventName} if the inventory position does NOT exist.

ForwardIfInventoryPositionStatusEquals

RuleThis article covers the following topics:

Supported Entities: `VIRTUAL_POSITION`
This rule produces a `SendEventAction`
Rule Parameters
Event Attributes
Exceptions
Configuration Example
Detailed Technical Description

ForwardIfInventoryQuantityOfTypeExists

RuleConditionally trigger another Ruleset when the Inventory Position and Quantity of the specified type exist.

ForwardIfInventoryQuantityOfTypeNotExists

RuleConditionally trigger another Ruleset when the Inventory Quantity of the specified type does NOT exist.

ForwardIfLocationStatusEquals

RuleForwards an event if the location has a different status compared to the inventory position and the location status is the same as the given {status} in the input parameters

ForwardIfMaxSplitLimitNotReached

RuleThe rule forwards the input event if the split limit is not reached for the order, excluding fulfilment with one of the given statuses.

ForwardIfMaxSplitLimitReached

RuleThe rule forwards the input event if the split limit is reached for the order, excluding fulfilment with one of the given statuses.

ForwardIfOnHandChanged

RuleForwards the configured event when the inventory position’s on-hand value changes.The rule compares the current on-hand value with the newly calculated on-hand value and forwards the event only when these values differ.

ForwardIfOrderCoordinatesNotPresent

RuleThe rule forwards the input event if coordinates of the order delivery address do not exist.

ForwardIfOrderCoordinatesPresent

RuleThe rule forwards the input event if coordinates of the order delivery address exist.

ForwardIfPickupLocationNotValid

RuleThe rule sends an event if the pickup location is not part of the network specified or doesn’t match the specified location status.

ForwardIfPickupLocationValid

RuleThe rule sends an event if the pickup location is part of the network specified and matches the specified location status.

ForwardIfProductStatusEquals

RuleSend an event {eventName} if the status of the product in the product catalogue with ref {productCatalogueRef} has the current status of {status}.

ForwardIfProposedFulfilmentNotPresent

RuleThis rule forwards the input event if a proposed fulfilment is not present.

ForwardIfProposedFulfilmentPresent

RuleThe rule forwards the input event if a proposed fulfilment is present.

ForwardIfStandardProductExists

RuleForwards the event with name {eventName} if the Standard Product exists.

ForwardIfStandardProductNotExists

RuleForwards the event with name {eventName} if the Standard Product does not exist.

ForwardIfUnfilfilledItemsExist

RuleThe rule forwards the input event if unfulfilled items exist in the order, excluding fulfilment with one of the given statuses.

ForwardIfUnfulfilledItemsExistInFulfilmentChoice

RuleThe rule forwards the event with the proper event name if fulfilment statuses are not from the provided list and there are unfulfilled items in the fulfilment choice.

ForwardIfVariantProductExists

RuleForwards the event with name {eventName} if the Variant Product exists.

ForwardIfVariantProductNotExists

RuleForwards the event with name {eventName} if the Variant Product does not exist.

ForwardIfVirtualPositionNotExists

RuleForwards the event {eventName} if the virtual position does not exist

Fulfilment Options - Extension Module

PackageThe Fulfilment Options Module is the foundation for Product Availability. It provides Workflows to enable Product Availability for Home Delivery and Click-and-Collect. Extensible by design, this Module can be used as a base to build a solution that fits your business's unique needs.

Fulfillment Reference Module

PackageThe Fulfilment Reference Module is the foundation for in-store operations. It provides a reference Workflow to enable picking, packing, and shipping orders. Extensible by design, use this Module as a base to build a solution that fits your business's unique needs.

Gauge Chart Component

UI ComponentThis component is a chart that indicates progress and consists of an arc with two sectors (active and inactive) and two texts - primary (big bold one) and secondary (normal size and font weight).

Gauge Chart Wrapper

UI ComponentThe gauge chart wrapper will convert Metrics data to be displayed in a gauge. This is configurable for different color and fill thresholds.

GEOCODER.API

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

GetLocationsForNetwork

RuleThe rule finds the locations with a required status in network and sends event.

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.

Google Map Pin Component

UI ComponentGoogle Map component is a custom content component that displays the location (put pinpoint (location identifier/pin)) according to the location latitude and longitude. The component supports multi-language.

GRAPHQL.DISABLE_GRAPHQL_ME_QUERY

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

Grid Component

UI ComponentA base grid component that lays data out in a four-column format. The primary use case of this component is to display product attributes, as the data must be keys and their corresponding values.

GST

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

HD Workflow Interface Contracts

Interface Contract

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`.

IfPropertyEquals

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute matches the provided value.

IfPropertyIsBetween

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is between the provided values.

IfPropertyIsGreaterThan

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is greater than the provided value.An example of this includes pushing an Order through a fraud-check flow only when the `totalPrice` field is greater than `100`.

IfPropertyIsLessThan

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is less than the provided value.

IfPropertyIsNotPresent

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is null.This is typically used as an "else" case for the IfPropertyIsPresent Rule.

IfPropertyIsPresent

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is not null.

IfPropertyNotEquals

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute does not match the provided value.This is typically used as an "else" case for the IfPropertyEquals Rule.

Image Card Component

UI ComponentThe Image Card Component enables you to display an image alongside other components within a card.For example, you can place download buttons below an image to prompt the reader to interact with the buttons.

Inline Print Button (legacy)

UI ComponentThe Print Button combines the page query with an HTML setting to generate a document that can be printed.On click, a modal preview is presented with a print button that triggers the browser's print action. From there the document may be printed directly or saved out to PDF using a print-to-pdf tool.This can be used to produce things like pick lists, packing slips, and order invoices.Note that this feature is a legacy design. The new print component can be found here: New Print Component.

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.

Inventory Catalogue Workflow Interface Contracts

Interface Contract

Inventory Catalog Workflow Template

WorkflowThis is the Reference Inventory Catalog Workflow provided as part of the Inventory Reference Module.Fluent Commerce provides `fc-workflow-inventory-catalogue.json` file that can be imported directly into any Retailer setup to use the Reference Workflow template. It is also possible to update and configure Workflows to fit your specific client requirements using our OMX Workflow Framework.The Inventory Module Getting Started Guide defines configuration capabilities for the Reference Inventory Workflows.

Inventory Reference Module

PackageThe Inventory Reference Module is the foundation for inventory related implementations. It provides reference Workflows for inventory ingestion and processing. Extensible by design, use this Module as a base to build a solution to the needs of your customers.The Inventory Module includes the following areas:

Product Catalog workflow
Inventory Catalog workflow
Control Group workflows
Virtual Catalog workflows

IPU and IPC Report Component

UI ComponentCustom component to display a page with an IPU/IPC report chart that displays data filtered by three parameters: report type, time period, and granularity.

JSON Editor Component

UI Component`fc.attribute.jsoneditor` is a custom content component that allows editing data in JSON format. The component has additional editing commands which can be accessed by right mouse button click on the component editor field.

JSON Viewer Component

UI Component`fc.attribute.json` is a custom content component that displays data in JSON format. If data contains a valid JSON, it will be parsed and displayed properly, while invalid data will be represented as is (raw).

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.

Line Chart Component

UI ComponentA line chart visually represents data points over a continuous interval, typically along a horizontal axis. It offers a clear depiction of trends, patterns, or fluctuations in the data by connecting points with lines, aiding in easy comprehension of the data's trajectory over time or across categories. The x-axis commonly denotes time or categories, while the y-axis represents the numerical values being measured, providing a quick snapshot of data relationships.

Link Component

UI ComponentThe Link Component is a text element with a hyperlink, designed for scenarios where a link needs to be applied. It can be used anywhere and integrates seamlessly with conditional logic when wrapped within a Conditional Component. This allows the link's display or functionality to adapt based on the conditions defined in the manifest (e.g. when the link should be active or inactive).

List Component (fc.list)

UI ComponentStandard table card that takes array-like content and renders it as a table. While the Material UI table is available directly, the Mystique Table component adds several enhancements, including:

mapping, transforming, and translating values from the GraphQL API
pagination automatically hooked up to the page-level query
per-row and bulk user action support driven by the workflow

List Feed Wrapper

UI ComponentThe list feed wrapper is a wrapper for the fc.list component that converts data from the Metrics API to a list-readable format.

List Source Wrapper

UI ComponentThe list source wrapper is a wrapper for the fc.list component that converts data from the Metrics API to a list-readable format.

LoadInventoryPosition

RuleForward event `{eventName}` (inline event) with the attribute 'inventoryPositionExists' set to true or false if the inventory position exists or not respectively.

LoadInventoryPositionData

RuleSend an inline event including the `inventoryPositionExists` flag indicating whether the corresponding Inventory Position exists or not.This Rule is a simplified version of the `LoadInventoryPosition` rule, excluding the logic for:

Retrieving Inventory Quantity data of type `LAST_ON_HAND` in status `ACTIVE` or `CREATED`
Setting and forwarding the `inventoryQuantityExists` flag (true or false)

LoadProductAndLocationStatus

RuleForward event {eventName} (inline event) with the attribute "productStatus" and "locationStatus" if the product and location exist.

LoadVirtualPositionAndVirtualCatalogueDetails

RuleLoads the virtual position details and then sends an event {eventName}

Location Connector Contract

Interface Contract

Connector Contract - Location Event Notification

Interface Contract FlowEvery time a Location is created or updated in Fluent, a webhook notification will be triggered to the specified destination to notify external systems of the change. It is important to note that the notification will only contain the essential details to allow the external system to make a call to Fluent and retrieve the complete information about the affected Location.API DetailsFluent WebhookEvent NamesCreate Location

`fc.connect.location.create`

Update Location

`fc.connect.location.update`

Location Id Component

UI Componentfc.attribute.locationId is a custom field component that allows to add / edit a Location on a drawer. The component’s key feature is the possibility to add a Location Id only in situations when it is necessary. Let’s consider the following situations, when a user is created

When new user with user type “AGENT” is created, the Location Id is a required parameter;
When user with other type is created, the Location Id is an optional parameter.

Upsert Location - Extension Module

PackageThe Upsert Location Module enables Event based integration for Location Feed. It provides workflows to create and update locations of type STORE and WAREHOUSE. The workflows orchestrate the following activities:

Create/Update of Location entity as well the User entity linked to that Location
Create `PICK_N_PACK_TIME_LIMIT` setting for the newly created Location
Process Network changes
ACTIVATE / DEACTIVATE Location
Send `LocationStatusChanged` event to the configured Inventory Catalogue upon Location status change

Location Workflow Interface Contract

Interface Contract

Location Workflow Templates

WorkflowThis article explains the logic that triggers the creation of a wave. Commonly, waves are created based on the fulfillment expiry time. Alternatively, the logic can be based on specific attributes of identified items (e.g. bulk items). Making this change can help facilitate a more efficient picking process according to the store layout.

User actions can be created throughout the wave process to reinforce specific business procedures. For example, we can ensure that in-store staff confirms the completion of the picking phase by using a confirmation dialogue box.

Repeater Component

UI ComponentThe Repeater component allows you to display a set of components once per item in an array or connection. For example, use the repeater to show a table of items for each article in an order.

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.

Mixed Baskets Workflow Interface Contracts

Interface Contract

Multi Card Component

UI ComponentThe Multi Card Component can be used to nest multiple components within the same card.

Multi-Parcel Component

UI Component

Multi-Parcel is an alternative Wave configuration to the Packing step for Fluent Store. The Multi-Parcel field component supports the ability to create multiple parcels per fulfilment.
It supports the ability to create common parcel types for a location. These parcel types can contain useful information such as dimensions and weight attributes to improve the packing process.
To get started with the Multi-Parcel field component in your Fluent Store configuration we recommend the following knowledge base guide.

Multi-Value Search Component

UI ComponentThe Multi-Value Search Component enables flexible entry and management of multiple values in a single field by converting inputs into chips while removing duplicates and ignoring invalid entries. It supports two search modes: Context Search (default, partial matches) and Exact Search (`exactSearch: true`, strict case-sensitive matching). The output format is configurable via the `type` property, returning either an array of strings (`text`, default) or an array of numbers (`number`).

NotifyFulfilmentsInWave

RuleSends an event to all Fulfilments in a Wave. Optionally, it can also send each event with a list of Articles and their dimensions, such as length, width, height, and weight.

NotifyInventoryCatalogueForProduct

RuleSend {eventName} event with productRef attribute to the {inventoryCatalogueRef} inventory catalogue with retailer id {retailerId}

NotifyVirtualCatalogueOnNetworkMatch

RuleConditionally send an event to the Virtual Catalog (specified by its Reference) if it passes the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).The `Rule NotifyVirtualCataloguesByRefsOnNetworksMatch` is a newer version of the `NotifyVirtualCatalogueOnNetworkMatch`. Moving forward, please use the `NotifyVirtualCataloguesByRefsOnNetworksMatch` instead of the `NotifyVirtualCatalogueOnNetworkMatch`.

NotifyVirtualCataloguesByRefsOnNetworksMatch

RuleConditionally send an event (or multiple events) to the Virtual Catalog(s) specified by their References, which passed the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

NotifyVirtualCataloguesByTypesOnNetworksMatch

RuleConditionally send an event (or multiple events) to Virtual Catalog(s) specified by their Types, which passed the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

NotifyVirtualCataloguesOnNetworksMatch

RuleConditionally send an event (or multiple events) to Virtual Catalog(s), which passed the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

Nullable Field Component

UI ComponentThe Nullable Field Component provides a simple way to handle fields that need to support both `null` and explicit overrides. It combines a toggle and an input into one reusable component, making it ideal for input types that do not natively support empty values (e.g., 'number', 'integer', 'int', 'select', 'boolean').When the toggle is OFF, the field is treated as `null`. When the toggle is ON, the field accepts and sends an explicit value.

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.

Order Connector Contract

Interface Contract

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.

Order Item Details Drawer Component

UI Component`fc.order.itemDetails` is a custom content component that allows displaying order item details on a drawer.

Order Reference Module

PackageThe Order Reference Module is the foundation for order-related implementations. It provides reference workflows for Click and Collect, Home Delivery and Mixed Baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.

Connector Contracts - Order Update Contract

Interface Contract FlowWebhook notifications enable external systems to receive updates about a certain entity when it’s created or modified. These notifications are flexible and can be added at any point in the workflow - it is up to the business requirements to define when these notifications are sent. By definition, a notification is always related to a past event/fact that has already happened in the system (Fluent).In the order update scenario, the workflow notifies external systems of any order progression or modification through its lifecycle.API DetailsEvent Names:`fc.connect.order.webhook.status-update`

Pack Field Component

UI ComponentThe Pack Component in Fluent Store is designed to organize the packing process by outlining each box's contents in multi-parcel shipments, setting parcel parameters, rejecting items, and providing detailed information for each item through the Pack Wizard.

PACKING_SLIP_PROPS

SettingThis setting captures the retailer's information used to create packing slips.

Page Component

UI ComponentThe Page component is the basic top-level layout component, that renders a header bar (with user actions) and a set of children in a Material UI Grid.

Page Filter Select Component

UI ComponentThe page filter select component allows to change variables on the page-level query.

Page Section Component

UI ComponentThe page section is a simple component that renders all children. It is primarily used for grouping multiple components together for index-based components like the tab card.There are no properties on the page section, but standard configuration options like descendants and datasource work as usual.

Page Section Header Component

UI ComponentThis component allows rendering a title on top of the page (fc.page) component. In addition, this component can take "descendants" and render them on the right side of the component, this is useful for action buttons.The three common use cases for the Section Header component are:

render a title on top of the page.
render an icon + title on top of the page.
render an icon + title on the top left of the page, and some other component/s on the top right of the page (passed as descendants, generally a print button).

Connector Contracts - Payment Authorise

Interface Contract FlowAuthorization transactions reserve funds in the customer’s account to be used in a future payment.Note that in most cases, this flow should be handled on the e-commerce side but may be applicable for certain types of integration (like “store credit”). Please do not share customer credit card details with Fluent.FlowPayment is usually authorized when an e-commerce order is placed. This authorization ensures the retailer can get funds from the customer once the items are shipped.The payment Service Provider validates the received authorized payment request and sends a valid authorized payment response token back to the Connector; the Connector sends the token back to the Fluent system for further processing of the order.API DetailsEvent Names`fc.connect.payment.authorise`
API contractEvent APITo download the payment-authorized connector payload schema, click here.

Connector Contracts - Payment Capture

Interface Contract FlowPayment Capture is the flow in which some or all of the authorized funds are taken.In many jurisdictions, this must happen at the point of shipping the product, in which case Fluent will send a webhook to the Payment Service Provider connector with details of the authorization and capture amount.FlowTypically, the order is placed on an e-commerce system with appropriate payment information, and the Order and authorized transaction information are passed to Fluent (see Order Connector Contract).Once we’re ready to capture some or all of that payment, Fluent workflows will produce the “capture request” webhook for the Payment Connector.The Payment Service Provider will then validate and process the request and respond (asynchronously) with either a “success” or “error” event.API DetailsEvent Names`fc.connect.payment.capture`API contractEvent APITo download the payment capture connector payload schema, click here.

Payment Connector Contract

Interface Contract

PAYMENT.CURRENCY

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

PAYMENT.METHOD

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

PAYMENT.PROVIDER

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

Connector Contracts - Payment Reauthorise

Interface Contract FlowAuthorisations do not reserve funds indefinitely; funds are automatically released after a defined period of time by the business. The defined time period depends on card types.When authorisation expires, it is necessary to reauthorise or secure a new authorisation for the value of expired authorisation.When Fluent workflows produce a “reauthorisation” webhook to the Payment Connector, the Payment Service Provider will validate the received reauthorise payment request, and respond (asynchronously) with either a “success” or “error” event.API DetailsEvent Names`fc.connect.payment.reauthorise`API contractEvent APITo download payment reauthorise connector contract click here.

Connector Contract - Payment Refund

Interface Contract FlowA refund is required when you have charged a payer, and need to cancel the payment and return the funds to the payer. The funds will be returned to the payment method that the payer initially used to make the payment.When Fluent workflows produce a “reauthorisation” webhook to the Payment Connector, the Payment Service Provider will validate the received refund payment request, and respond (asynchronously) with either a “success” or “error” event.API DetailsEvent Names`fc.connect.payment.refund`API contractEvent APITo download the payment refund connector payload schema click here.

Pick List Component

UI ComponentThe Pick list field allows for extra information to be displayed for each item within the picking step of the Wave Wizard. The purpose of this field is to enable more complex and efficient picking by providing users with more information about the item.

The Pick list provides an expandable table that can be configured to display information in any order.
Additional components can be added to an expandable row that is accessed on click.
The quantity selector can be configured to start with either 0 or the maximum amount required.

PICK_N_PACK_ENFORCE_BARCODE

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

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.

Print Button

UI ComponentThe Print Button combines the page query with an HTML setting to generate a document that can be printed. A user can use this component to print pick lists, packing slips, order invoices, and more.

ProducePositionEventsForLocation

RuleSend a scheduled event to each inventory position using the locationRef from the event attributes.

ProduceVirtualPositionEventsForControlUpdate

RuleSend an event {eventName} to each virtual position in the catalogue which is impacted by the control update. Only VariantProduct/Location and VariantProduct control changes are considered.

Product Card Component

UI ComponentThe Product Card Component is a consistent way to represent product information across the applications. Alongside the typical card features it can also display an image, attributes, a count, and a close icon, while also allowing nested components for added functionality.

Product Catalog Workflow Interface Contracts

Interface Contract

Connector Contracts - Product Category Upsert

Interface Contract FlowCreates or updates a product category in Fluent Order Management. Categories are optional. If the targeted Product Catalogue includes base products or variants that are mapped to categories then these categories need to be created first. Then the Base Product and last the associated Variants .
API DetailsEvent Names`fc.connect.product.category.upsert`API contractEvent APITo download the product category payload schema click here

Product Connector Contract

Interface Contract

Connector Contracts - Product Upsert

Interface Contract FlowCreates or updates a product in Fluent. This API will handle both the base product and variants.The workflow expects to receive the base product first, then the variants. If the base product or variants have references to categories, then these should be sent before the base product and variant.API DetailsEvent Names`fc.connect.product.upsert`API contractEvent APITo download the product upsert payload schema click here.

ProducePositionEventsForProduct

RuleSend scheduled event to each inventory position using the productRef from the event attributes.

Profile Modal Component

UI ComponentThe Profile Modal is a custom UI component that confirms profile actions to make sure changes are applied intentionally.

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.

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.`

Integer Range Filter Component

UI ComponentThe Integer Range Filter component allows users to filter data by specifying an integer range. It provides two input fields: a minimum value and a maximum value, where users can manually enter one or both values. Once the range is set, the filter displays only the data that falls within the selected range.

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.

RejectFulfilment

RuleThe rule rejects a fulfilment by updating the rejected quantities of all fulfilment items to the requested quantities.

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.

ResetBaseVirtualPosition

RuleResets the virtual position

ResolveFulfilmentChoiceCoordinates

RuleThe rule resolves the longitude and latitude of the fulfilment choice delivery address. It sends specific event depending on whether the coordinates could be resolved or not.

ResolveOrderCoordinates

RuleThe rule determines the longitude and latitude of an order based on the delivery address.

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 Id Component

UI ComponentRetailer Id (fc.attribute.retailerId) Component is a custom field component that allows to add/edit a Retailer on a drawer.

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_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

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.

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.

Returns Component

UI ComponentThe Returns Field Component provides an end user experience for creating Returns through an OMX web application. Example usage of this component is provided as part of the Returns configuration guide

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`

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.

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`

Rules SDK

PackageThe Rules SDK is the Software Development Kit for the Fluent Workflow Framework. It allows Java Developers to build custom rules for the Workflow Framework Rule Library.The Rules SDK comes equipped with a Java API Client for REST and GraphQL APIs, making integration of rule logic with the platform simple and quick to implement.

Salesforce Commerce Cloud connector

PackageFluent Commerce provides a connector certified by Salesforce using the Salesforce Reference front end architecture to accelerate integration between the Salesforce Commerce Cloud (SFCC) storefront and Fluent Order Management. This connector provides the following functionality and integration points between SFCC and Fluent Order Management:

Salesforce Service Cloud (SFSC) connector

PackageTo accelerate integration between the Salesforce Service Cloud (SFSC) and Fluent Order Management, Fluent Commerce provides a connector certified by Salesforce using their reference front-end architecture. The connector enables Customer Service Representatives to find and manage customer orders from a single application, which helps to:

Reduce call time by managing orders from just one application
Enhance customer experience - Shorter call times mean happier customers.
Reduce training time - Using the familiar Salesforce UI.
Access powerful business logic stored in Fluent Order Management.

ScheduleEvent

RuleSend an event to trigger another Ruleset for the same entity after a specified amount of time has passed.

ScheduleFulfilmentCreationForDeliverAfter

RuleThe rule schedules an event based on the Shipment’s Delivery From date (fulfilment choice’s `deliverAfter` date).

ScheduleFulfilmentExpiry

RuleThis rule sets an expiry time for the incoming fulfilment and schedules a `FulfilmentExpiry` event.

ScheduleFulfilmentReleaseForDeliverAfter

RuleThe rule schedules an event based on the Shipment’s Delivery From date (fulfillment choice’s `deliverAfter` date).

SCIM Connector

PackageSCIM Connector powered by Fluent is a service using SCIM protocol to integrate the Azure Active Directory and Fluent Commerce platform natively, enabling automation of user management from client Azure IDP to the Fluent platform.

SearchInventoryAtLocations

RuleThe rule searches inventory based on the incoming event information using virtual catalogue reference.

SearchInventoryAtLocationsForFulfilmentChoice

RuleThe rule searches inventory based on the incoming event information using virtual catalogue with virtual catalogue ref, and sends event.

Select Field Component

UI ComponentThe Select Component is a field component designed for use in any form. It allows users to view a list of options as a drop-down regardless of the number of items in the list. This sets it apart from the field, which displays a drop-down only when the list contains more than three items; otherwise, it switches to a radio button group. The component supports flexible value sourcing. It can retrieve options either via a query, from a predefined setting, or from a manifest.

SelectProposedFulfilment

RuleThe rule selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilment in defined statuses.

SelectProposedFulfilmentForFulfilmentChoice

RuleThe rule selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilments in the specified excluded fulfilments statuses.

SendEvent

RuleSend an event to trigger another Ruleset for the same entity.

SendEventForAllFulfilmentChoices

RuleThe rule sends event to all fulfilment choices.

SendEventForAllFulfilments

RuleThe rule sends an event to all fulfilments.

SendEventForAppeasementToBillingAccount

RuleThis rule sends an event to the billing workflow from an order workflow with a customer's billing account information and refund information to create a credit memo of type Credit with the refund amount for the order.

ScheduleFulfilmentExpiryNow

RuleThe rule sets an expiry time for the incoming fulfilment based on the location’s `Pick&PackTimeLimit` and schedules a "FulfilmentExpiry" event.

SendEventForFulfilment

RuleThe rule sends an event to the related fulfilment.

SendEventForFulfilmentChoice

RuleThe rule sends event to the associated fulfilment choice.

SendEventForFulfilmentChoiceOnVerifyingRejections

RuleThis rule triggers an event to the fulfillment choice if no items were rejected during the Pack step.

SendEventForOrder

RuleThe rule sends an event for the associated Order.

SendEventForOrderOnVerifyingRejections

RuleThis rule triggers an event for the order when no items were rejected during the packing process.

SendEventForRevisedOrderToBillingAccount

RuleThe rule sends an event to the billing workflow with billing account information and entity information

SendEventGQL

RuleSend an event {eventName} for the (current entity)

SendEventOnFulfilmentInventoryUpdate

RuleSends an event to inventory positions based on the fulfillment update type:

Reserve when inventory is reserved
Cancel when inventory is unreserved
Confirm when a pick is confirmed

Each event includes:

The configured inventory quantity types (for example, `RESERVED`, `SALE`, `CORRECTION`)
The current on-hand value of the inventory position, so downstream workflows can accurately detect real stock changes

SendEventOnVerifyingAllArticleStates

RuleThe rule sends event to the entity from the incoming event on verifying if all the articles of the incoming entity are in any of the given statuses.

SendEventOnVerifyingAllArticleStatesByFulfilmentChoice

RuleThe rule sends event to the entity from the incoming event if all the articles of the incoming entity are in one of the given statuses.

SendEventOnVerifyingAllFulfilmentChoiceStates

RuleThe rule sends event if all fulfilment choices of entityType have statuses from the specified list.

SendEventOnVerifyingAllFulfilmentStates

RuleThe rule verifies if all fulfilments for order are in defined statuses. If yes then send an event to order, else no processing.

SendEventOnVerifyingAllFulfilmentStatesByFulfilmentChoice

RuleThe rule verifies if all fulfillments for fulfilment choice are in given status. If yes, then it sends an event to the fulfilment choice, else no processing.

SendEventOnVerifyingAllOrderItemsProcessed

RuleThe rule sends an event to current Order when for all items in the Order, sum of `filledQty` of fulfilments in defined statuses, `rejectedQty` of fulfilments in defined statuses and `requestedQty` of fulfilments in defined statuses matches the `requestedQty` of the Items in the Order.

SendEventOnVerifyingAnyFulfilmentStates

RuleThe rule verifies if any fulfilment in the incoming order is in one of the given statuses in the input parameter. If yes then the rule will send an event to order, otherwise no processing is done.

SendEventOnVerifyingAttributeValue

RuleThe rule sends and event with the name specified in the input parameter in case the incoming entity has an attribute name and value that matches with the name and value provided in the input parameters. Otherwise, a no match event is sent.

SendEventOnVerifyingConsignment

RuleThe rule verifies if the incoming consignment entity has the label URL and the consignment status from input parameter is a success or failure and sends an event.

SendEventOnVerifyingNoParcels

RuleThis rule is executed when no items are packed into parcels and all items are rejected.

SendEventOnVerifyingParcelsComplete

RuleThis rule triggers an event when items are packed into parcels without rejection.

SendEventOnVerifyingParcelsPartiallyComplete

RuleThis rule is executed when both packed items and rejections are present.

SendEventToAllInventoryQuantities

RuleSend an event {eventName} to inventory quantities of type {inventoryQuantityTypes} using event attributes

SendEventToFulfilmentOnVerifyingFulfilmentChoiceStatus

RuleThe rule sends an event to the incoming fulfilment entity if the fulfilment choice is in any of the statuses provided in input parameter.

SendEventToFulfilmentOnVerifyingOrderStatus

RuleThe rule sends an event to the incoming fulfilment entity if the parent order is in any of the statuses provided in input parameter.

SendEventToProcessUnfulfilableFulfilment

RuleSends an event to act on fulfillments that have been assigned to a system-rejected location. This rule checks if the fulfillment's source matches the configured system-rejected location reference and triggers the specified event if they match.

SendEventToUpdateInventoryQuantity

RuleThe rule triggers inventory re-calculation event with event name provided in the input parameter with +/-ve quantities of each item on the basis of the type of operation.

SendWebhook

RuleSend an Event payload to an external system, defined by a Setting configuration.

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.

SetFulfilmentItemRejections

RuleThis rule is executed to update item quantities and record rejection reasons when items are rejected.

SetState

RuleChange the Status of the current Entity to the value provided.

Setting Form Component

UI ComponentThe Setting Form Component displays Fluent Settings as user-friendly UI elements, enabling a no-code experience for configuring Fluent web apps. By presenting settings as UI components instead of JSON, business users can directly configure Fluent, reducing their reliance on developers.This article details the capabilities of the Settings Form Component and provides a guide on how to use this component alongside related features to create a no-code experience within an Fluent Commerce web app.

Shipment Details drawer Component

UI ComponentShipment Details drawer is a custom content component that displays detailed information about a particular shipment on a drawer.

Sortable List

UI ComponentThe Sortable List component provides an intuitive, drag-and-drop interface for reordering items where the sequence has functional or business significance. It enhances user experience by allowing direct manipulation of list order, eliminating the need for manual priority inputs or complex form controls.

Sourcing Modal Component

UI ComponentThe Sourcing Modal is a custom UI component designed to support confirmation workflows for sensitive strategy-related actions, specifically activation, inactivation, and removal of sourcing strategies.

Sourcing Utilities

PackageThe `util-sourcing` library is a comprehensive collection of utility functions designed to minimize the overhead and complexity of writing sourcing logic in your Fluent Commerce rules.

SplitDeltasAndDownToInventoryPosition

RuleNotifies the inventory positions of the incoming deltas with event `{eventName}`

SplitInventoryUpdates (Deprecated)

RuleNotifies the inventory positions of the incoming updates with event {eventName}

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

Sourcing Profile Drawer

UI ComponentThe Sourcing Profile Drawer is a side-panel UI component used to edit sourcing profiles and manage strategies within them. It displays structured form fields for profile attributes, sourcing strategies, and fallback strategies. The drawer opens alongside the main view, allowing users to add or update configuration details without navigating away from the profile details page.

Tab Card Component

UI ComponentThe tab card is used to put tabs at the top of a group of card-like components (Attributes Card, List Component, etc) and allows users to switch between them. This can help to reduce the number of clicks a user takes when navigating between pages.The descendants of the Tab Card component are used as the content of the tabs, linked by index. The first descendant will be shown while the first tab is active. For cases where multiple descendants should be shown under a single tab, use the Page Section component (or similar) to group them.

Test Utilities

PackageThe `util-test` library is a comprehensive collection of utility functions, mock objects, and executors designed to minimize the overhead and complexity of testing your Fluent Commerce rules. It provides a fluent, builder-style API that makes writing clean, readable, and robust tests straightforward.

Tile Metric Component

UI ComponentThe Tile Metric component can be used to display a metrics data and the title of that metric within a single tile.

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

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

SendEventForArticles

RuleThe rule sends an event to the related articles.

Activity Component

UI Component

The Activity component displays events and related entities for a lifecycle of the entity that the page represents.
This document describes what is an activity component, its properties, and sample usage.

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.

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.

fc.rubix.sdk.webhook.retry.method

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

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.

UpdateAggregateVirtualPosition

RuleUpdate an Aggregate Virtual Position and calculate its Available-to-Sell (ATS) quantity.Aggregate Virtual Position ATS calculation is based on the associated Inventory Positions Stock on Hand (SOH) quantities and the applied Controls.The associated Inventory Positions are defined with:

The given Product Reference
The list of Locations for the given Network (the first Network assigned to the Virtual Catalog)
The specified Inventory Position Statuses