Some of the recently updated content.
The Feeds interface provides visibility into feeds for an , enabling monitoring and analysis of feed activity over selected time periods.
It includes:
The Products interface is a collection of products and any attributes and details associated with each product in the category.
The Products interface of the Fluent Web App provides comprehensive capabilities:
The module contains the following configurations:
Learning Pathways offer structured learning consisting of Knowledge Tracks, Labs, and Assessments to up-skill for specific roles. You can choose from various pathways tailored to your role and complete assessments to earn certificates. Completing all pathways is recommended before you pursue a full certification.
To accelerate carrier integration between the Shippit and Fluent Management platforms, Shippit and Fluent Commerce provide a that enables seamless pick, pack and processes inside the Fluent Store App.
This Study Guide helps prepare for the Functional Practitioner Certification Exam. It provides some summaries of various areas that will be relevant for the exam and other details to help you pass the exam.
Batch Events offer insights into the processing status of Batches, helping to determine whether the corresponding records within a batch were successfully submitted for processing.
`CREATE`
and `BATCH_COMPLETE`
events provide insights into the processing status of Inventory BatchesRulesets are fundamental components in implementing business flows. They are reusable collections of rules that contain logic. These functions can be applied across various workflows and use cases, providing flexibility and efficiency. The Order, Inventory, and Fulfilment reference modules contain a set of pre-defined rulesets, each with its corresponding rules.
Workflows are the backbone of the Fluent platform as they describe the lifecycle of an . Defining subsections or sub-processes within a allows to manage and evolve them independently. Thus fostering loosely coupled and self-contained fragments with no duplication of shared or unchanged behavior of a baseline .
On this page we will look at the different ways of structuring workflows into fragments and then how to optimally merge them into a final that is used to orchestrate entities. Finally how to package both workflows and fragments into a module.
`workflows`
before `workflow-fragments`
.`orderById`
GraphQL query is used to look up an order by ID. However, only one order can be searched at a time, and there is no wildcard search.`ref2`
field on the order entity included in the Enhanced Order Lookup and Tagging Capabilities release.`rules`
.`order.ref2`
. Click here for the how-to guide.The Fluent Platform provides and number of REST APIs for interacting with the platform.
These differ from the primary GraphQL APIs which primarily cover domain entities. This section provides access to the REST based Platform APIs reference documentation.
In this document we will describe how to work with workflows and fragments using the . Then delve into how the tool is tracking the installed workflows, fragments in the log.
`workflowlog`
to manage the workflow and fragment lifecycleThe Fluent GraphQL API provides powerful access to data, integration, and orchestration-driven business logic. It provides an opportunity to streamline and optimize requests to the Fluent Management platform in a way that is more flexible than the REST-based API.
This page covers the various commands which can be used to configure / install Fulfilment Options module
In this sample project, we will go through some basic features of the SDK by creating a that can receive notifications from Fluent System, which is processed and sent to any external system like Email, Slack, Datadog, etc.
These are the topics covered by this guide:
As a part of Internationalisation, the Fluent platform supports multiple languages. This support allows users of web apps such as OMS Webapp and Fluent Store to configure and view the modules and interfaces of the Fluent platform in their preferred language.
As of the Fluent v4.45 release, the Fluent platform provides pre-configured support for the following languages.
Fluent Management uses a default language of Australian English `en-AU`
.
`en-AU`
- Default`en-US`
`fr-FR`
`es-MX`
`it-IT`
The Upsert Module contains the and supporting rules to update or create (aka upsert) locations. This page covers the steps to configure and install the Upsert Module.
This section describes the different types, prerequisites, and processes for requesting an .
A Fluent is the representation of a of the Fluent platform. An is isolated and secure and provides access to the Fluent Management Platform on either a sandbox or production environment. For information about the Fluent environments, see environments. Access to an is via the account-specific URL, in the format `https://<ACCOUNTID>.sandbox.console.fluentretail.com`
. This is a unique Console URL in a sandbox environment.
Learn how module dependencies work, how they are described and when they are enforced.
`resources/module.json`
The Fluent OMS module is pre-configured with certain standard functions that allow the interface to manage orders, product availability, , and fulfilment and serve as a starting point for your projects.
The default UX templates are hosted on the platform, so there is no need to create the settings yourself unless you need to customize the existing baseline configuration.
`https://<ACCOUNT_ID>.<ENVIRONMENT>.apps.fluentcommerce.com/oms`
This document explains how to interpret the Batch Pre-Processing (BPP) dashboard, focusing on the Change Rate Efficiency metric. It provides methods for analyzing batch trends and optimizing data submissions. Implementation partners can use these insights to enhance batch performance and deduplication, while customers gain better visibility into changed vs. unchanged records. The dashboard supports a date range of up to 31 days, with historical data limited to the last five months.
This document will guide you through how to use Feeds and some example cases where an Feed is a preferred data export option.
Pre-requisites
This document assumes you are knowledgeable and aware of the following subjects:
Key points
This document is intended to introduce the Feeds feature to Customers and Partners. This page will describe the Feeds feature and how they fit within the Fluent Product and will direct the reader to resources describing how to use Feeds.
This describes the details of the different events in the Fluent platform and provides the required base knowledge for troubleshooting. This expects that you have a good understanding of the Fluent Event Execution process and how Events are matched before the corresponding business logic is executed.
The `comments`
Query retrieves Comments based on various filter criteria.
Prerequisites
`COMMENT_VIEW`
Permission is required for retrieving Comments`comments`
Query to retrieve existing Comments`fc.graphql.comment.access`
Setting (`retailer`
value)The `commentById`
Query retrieves a Comment based on a provided Id.
Prerequisites
`COMMENT_VIEW`
Permission is required for retrieving a Comment`commentById`
Query to retrieve an existing Comment`fc.graphql.comment.access`
Setting (`retailer`
value)The `updateComment`
Mutation allows for the updating of an existing Comment object.
Prerequisites
Specific Permissions are required for updating Comments:
`COMMENT_UPDATE`
`COMMENT_VIEW`
`updateComment`
Mutation to update an existing Comment`fc.graphql.comment.access`
Setting (`retailer`
value)The `createComment`
Mutation allows the creation of a Comment against a known .
Prerequisites
Specific Permissions are required for creating Comments:
`COMMENT_CREATE`
`COMMENT_VIEW`
`createComment`
Mutation to create a Comment against a known Entity`fc.graphql.comment.access`
Setting (`retailer`
value)`retailerId`
of the associated EntityThis contains the list of Settings used in the context of ACCOUNT.
Modules are the package structure used by Fluent Commerce to ship preconfigured features and functions. They are designed to be self-describing, isolated, but inter-dependent assets that can work together with other modules, or be extended by custom modules, all while remaining upgradeable.
Here we'll look at the different designations of Modules and describe the Module's Package Structure and Project Structure.
`fluent module install`
only operate on the Module Archive or Module StructureThe Inventory Reference Module is the foundation for inventory-related implementations. It provides reference Workflows for ingestion and processing. Extensible by design, use this Module as a base to build a solution to your customers' needs.
Pre-requisites:
This technical guide provides detailed steps on how you can submit Batches to the Fluent platform.
Ingestion in Fluent Commerce ensures that stock levels across all sales channels remain accurate and up-to-date, enabling effective management. It allows businesses to send updates to the platform using two distinct methods: Inventory Batch and Inventory Delta. Each method is tailored to different scenarios, depending on data volume, frequency, and operational needs.
Batch enables bulk uploading of updates to the Fluent Commerce platform, handling high data volumes from thousands to million updates per operation. Leveraging Fluent 's Batch API and Inventory Batch Pre-Processing, it ensures faster processing and accurate availability in the Fluent Management System.
This scalable solution keeps data synchronized across channels, empowering businesses to manage stock efficiently and meet customer expectations with accurate, up-to-date stock information.
A is a Module provided by Fluent Commerce that is designed to provide reference artifacts that you can use to create your own solutions. While an Extension contains an entire solution within itself, Reference Modules provide Domain Artifacts that can be used to speed up building your solutions. Structurally, Reference Modules are identical to Modules, as are Extensions.
Workflow Framework Rules are written using Java and contain a specific structure and metadata for describing and validating the . In this lesson, you will learn how to write Rules by adding customised business logic.
This lesson introduces a practical client scenario: visualizing product availability on a map. Building upon the foundation laid in the UX Framework course, we'll enhance the Fluent Store app's Product Availability screen by adding a map that displays nearby store locations and stock information for a selected product variant. This hands-on lab will guide you through configuring the product lookup and detail availability pages, the stage for creating custom components in subsequent lessons.
This guide provides solutions to common issues encountered in eLearning environments, including troubleshooting steps for login errors, exam resets, and password recovery.
The Comment API enables you to Create, Update, and Query comments linked to various entities within the Fluent platform.
Prerequisites
To guide you through your journey of understanding and learning the Fluent Commerce OMS platform, the documentation is modeled according to the internal building blocks of the system, like 🔀Workflow or ⚙️Settings, with other top-level content types, such as 💡Essential Knowledge and 🧭How-to Guides layered on top of it. Dive right into it by starting here.
Fluent Management components are Web Apps, Modules, Management Experience (OMX), Engine, and Cloud Infrastructure. These components operate within the framework to enable the management experience on the platform.
Fluent Management components are Web Apps, Modules, Management Experience (OMX), Engine, and Cloud Infrastructure. These components operate within the framework to enable the management experience on the platform.
The Template is a preconfigured UX Template used within the Fluent Store Web App.
This document is intended to introduce the Metrics and describe their place within the Fluent Big Inventory product.
Pre-requisites:
The Management Experience (OMX) Design System provides guidelines for delivering a user experience tailored to the Omnichannel Management space. This will describe the foundations of the Design System, including color palette and typography which make up the overarching design theme of the Fluent Commerce platform.
This document sets out the definitions for the terminology used in the Platform Limits document some of which is also used in your contractual agreement documents (e.g. Form) with Fluent Commerce.
For definitions of other essential terminology, visit the Glossary of Key Terms and Product Taxonomy pages.
This document sets out the definitions for the terminology used in the Platform Limits document some of which is also used in your contractual agreement documents (e.g. Form) with Fluent Commerce.
For definitions of other essential terminology, visit the Glossary of Key Terms and Product Taxonomy pages.
We provide three reference workflows (HD), Click and Collect (CC) and Mixed Baskets. Suppose our reference workflows do not accommodate your business case. In that case, you can create a new to support additional Types that require different processing and timing, with such as marketplace orders and back orders
Learn more about supported reference workflows here.
This document is intended to describe to implementers Metrics technical details within the Fluent Big Inventory product.
Pre-requisites:
`metricInstant`
and `metricRange`
GraphQL queries to retrieve the Metrics data.`byName`
attributes access in the manifest`devrel.provider.rest`
component to display information from the Fluent REST APIs using standard the standard UX Component LibraryThis explains how to transform manifests v1.0 into the new manifests v2.0. From this guide, you will learn how to configure with necessary menu items, add filters and configure them, and add custom components. The examples below demonstrate the following Fluent OMS menu items:
Learn more about App-Level and Route-Level configuration here.
Differences between and Fluent OMS manifests are summarised in the following tables
This page provides an overview of the guidelines and best practices for custom development.
It is highly recommended that you first read Designing Rules and Writing Custom Rules if you have not done so already.
The Framework Engine ensures that all Exceptions thrown out of Rules are recorded within the Audit Events, accessible via the Event API. This is important for providing detailed information about what went wrong.
This section provides Rules SDK reference and guidelines for Writing Rules.
Additionally, make sure you read the Rule Coding Best Practices.
These docs were generated by graphql-docs. Just starting out with ? Check out 's official documentation!
This guide is intended to provide implementers with information about the Metrics API within the Fluent Big Inventory product, describing its functionalities and utilization principles within the Fluent Platform.
Pre-requisites:
`METRICS_VIEW`
permission for Metrics data access.`metricInstant`
and `metricRange`
GraphQL queries to retrieve the Metrics data.This document is intended to describe to implementers which Metrics are available within the Fluent Big Inventory product and what kind of data they provide to achieve Platform Observability.
Pre-requisites:
The configures icons, cards, and templates. Templates can be structured in various ways; for further details, please consult the UX Configuration Common Concepts . This , however, will specifically concentrate on the any Match template.
This template functions as a filter for a stream (such as a list of items), capable of matching none, some, or all records where a specific condition is met by a field path. This feature is particularly valuable for filtering purposes.
`STRING_PATH_TO_VARIABLE`
, `VALUE`
and `OPTIONAL_FUNCTION .`
This document will detail how customers can view their Inventory Position Update(IPU) and Inventory Position Change(IPC) usage from within the Web App. Using this, customers can easily compare their usage to contracted rates.
Pre-requisites
`ACCOUNTUSAGE_VIEW`
permission`ACCOUNTUSAGE_VIEW`
permission in the Fluent Big Inventory Web application.The Fluent is a web browser-based portal, for retail business users, that provides the interface to manage orders, product availability, and . The is used by businesses and administrators to access a large range of functionality provided by the following Fluent Commerce apps:
Each app provides out-of-the-box capabilities that are accessed by the Fluent .
By default, the displays content in English. However, v4.44 release onwards, the Fluent platform provides support for multiple languages. For more information on languages and localization and configuring other languages, click here. The console should be used on tablets and computers that have an active internet connection and a supported web browser.
Fluent Commerce doesn't support static IP whitelisting due to AWS Cloud's dynamic nature. Instead, robust authentication measures are in place for security, including cryptographic signing and signature verification. While static IPs aren't recommended, securing endpoints is achievable by configuring unique URLs and firewall rules. Additionally, up custom authorizers or message queue validation enhances security. Each establishes a single connection, with inbound and outbound calls dependent on events. For detailed guidance, refer to Fluent's 'Webhook overview' documentation.
Attached to this page is the “connectors.yaml” template which is used to create Cloudformation Stack for the Connectors API. The resulting stack deploys ECS Fargate containers that run the API and produce a public endpoint. This public endpoint is secured with an SSL certificate which is applied to the Application Load Balancer.
Using the API
Best Practices for Design: Keep in Mind These Principles.
The OMS Dashboard is an exception management tool that displays information on entities (orders, fulfilments, etc.). The Console Dashboard is entirely configurable and is powered and configured by the Mystique manifest. The Dashboard component is configured to display data coming from a GraphQL query, and the number shows the total number of records returned by the configured GraphQL query.
Clients and Partners will need to have their Fluent Account set up prior to being able to work with .
You should have received an " Ready" email with your Fluent Details, including user login credentials.
If you do not have access to a Sandbox , please contact your Fluent Manager.
The below settings control the allowed values in the transaction create method in the REST API (POST /api/v4.1//{orderId}/transaction). The createFinancialTransaction mutation can use custom-defined paymentProvider, paymentMethod and currency fields. We recommend that the below settings be used as the way to look up current configured values dynamically without hardcoding values for these fields.
These settings can be modified and retrieved via the settings API.
The Fluent OMS module is pre-configured with certain standard functions. Mixed Baskets functionality is not a part of the default pre-configuration. The reference manifest fragment represents the new UI for Mixed Baskets functionality. Detailed information on configuring UI for Mixed Baskets is available in the guide.
Parameters, also known as properties or props, and the configuration time inputs to the .
Parameters should be considered always required. Optional inputs to a should usually be managed via Event Attributes.
Product is a collection of products and any attributes and details associated with each product in the category. The products module contains the following menu items:
More information on Product Catalogs.
The Arrivals feature of Fluent Store is used for inter store transfers for Click and Collect orders sourced from a different to customer’s chosen pick up . In this section of the module, the store users can view Inbound orders expected to arrive in store from another .
When a arrives at a , the store user marks the as arrived.
The store user performs the following steps to mark an as arrived: