Essential Knowledge

The Fluent OMS module is pre-configured with certain standard functions that allow the interface to manage orders, product availability, inventory, and order 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 manifest settings yourself unless you need to customize the existing baseline configuration.

This article will cover the high-level design and features of the SDK.

Fluent Commerce offers a scalable cloud platform with Distributed Order Management functionality. This functionality includes support for Click and Collect, Ship from Store, Omnichannel Returns, and a Single View of Inventory across all locations. The Salesforce connectors enable integration between Salesforce Commerce Cloud (SFCC)storefront, Salesforce Service Cloud (SFSC) customer service application, and Fluent Order Management.

Accessing the Workflow Builder

The Workflow Naming Convention is a set of guidelines recommended for Orchestrated Entity Types in the Fluent Order Management System. This convention will help you:

• Apply best practices for naming entities to achieve better implementation standards;
• Make names consistent and ensure that names are recognisable and can be supported in the future;
• Avoid unexpected system behaviour and decrease the likelihood of error because of incorrect symbol or space usage.

this page is to show how to add a new workflow to your Retailer via the API Put method.

Mutations in GraphQL are operations designed to modify server-side data, encompassing the creation, updating, or deletion of records. They play a critical role in dynamic data management within GraphQL applications, allowing for precise and controlled data manipulation.

Query operations are used for retrieving data. Fluent's GraphQL API provides two types of query operations:

• `Get`

  : To retrieve and display unique results

• `Search`

  : To search and display a list of results

Fluent provides both REST and GraphQL APIs. However, REST APIs are limited to specific Platform operations, while the GraphQL API provides the core Domain Model.

An Article can be created when a fulfillment is fulfilled, or when a dispatch occurs. The Article represents the physical parcel that contains the customer order items. The Article is the entity received by the customer.

APIs use authorization to ensure that client requests access data securely. This can involve authenticating the sender of a request and verifying that they have permission to access or manipulate the relevant data. The below request will return a bearer token. This token can then be used in the header of subsequent API calls to confirm authentication.

Authentication policies dictate how the user's identity will be verified. For Corporate IdP all users are managed by corporate IdP and authentication policy needs to be configured to make sure that all users are authenticated via internal IdP.

Token authentication is mandatory for all Fluent integrations.

Availability Module provides various availability information for different products, taking into account custom attributes defined in a business workflow.  Utilising the Fulfillment Options Workflow, the Availability Module generates Fulfillment Plans for the requested items. This process involves interaction with the Inventory module and applying sourcing logic to select plans from a designated Virtual Catalog for the relevant channel.

The Availability Module facilitates the presentation of Available-to-Sell (ATS) and Available-to-Promise (ATP) data on the Product Detail Page (PDP), Product Listing Page (PLP), and Checkout pages within an e-commerce platform, for instance.

A batch contains a series of records that will have the same operation applied to it. All Batches are run asynchronously so to confirm success or failure the client must request a status update for submitted batches via the GET API at a later stage. Most Batches are limited to 5,000 records.

To create a Batch, the user must first create a Job. A Job is required to store a series of batches. For more information please refer to the Job API.

This page describes how Batch Pre-Processing works, the opportunities available for configuration, and the implementation improvements enabled by using Batch Pre-Processing.

The

`billingAccount`

`payment`

`creditMemo`

`invoice`

Fluent Order Management components are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure. These components operate within the framework to enable the order management experience on the platform.

The Category Batch API is used to create a Category using the Fluent Commerce Batch framework.

An overview of how webhooks work in Fluent Commerce, how they are signed, and validated, and what public keys are used.

A Comment provides an additional piece of information to the entity it is related to. An Order and Return can contain multiple comments associated with it.

The Comment GraphQL API enables you to create, update, and query comments linked to various entities within the Fluent platform. The Comment entity is independent and not tied to a specific entity. When creating a comment, you can associate it with an entity type, entity Id, or entity reference, making it retrievable via the comments query. Multiple comments can be added to the same entity, each automatically capturing the timestamp and user that created the comment. This feature can record specific business actions and events, providing a comprehensive history of interactions and updates.

commercetools CloudFormation Template

commercetools Connector Project Configuration

commercetools connector enables the syncing between commercetools and the Fluent commerce system. There are specific settings that need to be configured in the commercetools system i.e.: custom fields, channels, etc.

The product synchronization process involves the handling of events and messages through various queues and handlers. It utilizes the commercetools platform for product updates, employs a message router to direct events, and features extensible message handlers for customization.

Some common types and conventions are used across many component definitions. These items are not directly configurable in the manifest but will often be referenced in other component definitions that use them.

Getting Started Guide for Component SDK

The Consignment API is responsible for retrieving and updating the status of fulfilment's managed through the Fluent Retail platform. Users can also add consignment details to articles on fulfilment's booked outside of the platform through the Consignment API.

Rules or controls that determine what inventory is available in a Virtual Catalog

Controls can be used to:

• Exclude SKUs or product categories from a virtual catalog
• Manage buffer or safety stock by SKU, Category and/or Location

A best practice guide of creating customer entity.

createFinancialTransaction GraphQL mutation Example

At this stage the only implementation available is AWS Secrets Manager by the 

`connect-sdk-core-aws`

This article illustrates the order journeys for Home Delivery (HD) and Click and Collect (CC) order types.

Rewarding way for customers to share their achievements.

This Data Privacy Addendum (DPA) details the data protection commitments and obligations of Fluent Commerce in relation to its Fluent Order Management cloud-based platform and services. Readers will find detailed information on the processing, transfer, and security of personal data by Fluent Commerce as data processor, and serves as a guide for clients to understand how their personal data is managed and protected.

This document provides a comprehensive overview of our deprecation policy, detailing the lifecycle and end-of-life processes across our Platform components.

This document provides a comprehensive overview of our deprecation policy, detailing the lifecycle and end-of-life processes across our Platform components.

This document explains the GraphQL error code formats used by Fluent Commerce.

Character escaping and unescaping are crucial for data integrity and security in UX frameworks. This document focuses on the Mustache.js templating engine, which escapes HTML by default to prevent XSS attacks. When special characters like ampersands need to be displayed, the framework offers unescaping methods to ensure correct and secure rendering.

This overview highlights the significance of proper value escaping and the techniques for accurately rendering special characters within the UX framework.

Using the Event API

Ready for Launch (RFL) includes a number of tasks and activities involved in configuration, inventory management, workflows, custom plugins and integration analysis during the project lifecycle.  

The Extend Knowledge Content does not form part of the Fluent Order Management Platform or its Documentation, and its use is subject to the terms and conditions below. Extend Knowledge Content is designed to demonstrate how to extend the capabilities of the Fluent Order Management Platform through use of its many extensibility features and tools. Extend Knowledge Content is provided for illustrative purposes only, is not supported or maintained, and may become outdated. Please read the full document thoroughly before using any of the Extend Knowledge Content.

This article provides an overview of methods for configuring components within the UX framework. Customization is possible through configuring the various types of components, such as sub-components, wrapper components, and context components. Read on to find out how to use the above approaches.

The

`financialTransaction`

Fluent Big Inventory is an enterprise inventory hub provided by Fluent Commerce. Fluent Big Inventory is designed to work within your omnichannel ecosystem, managing inventory availability across all your channels to ensure you have a single, unified view of inventory across all of your different go-to-market channels.

The Fluent Big Inventory Web App is a web-based tool designed for efficient management of products, inventory, feeds, and sources. Key features include:

• Feeds: View inventory feed information.
• Sources: Track integrated inventory update sources.
• Products: Manage product catalogs and products.
• Inventory: Monitor allocation, stock on hand (SOH), real-time inventory, and buffers.
• Stores: Manage individual and network locations.
• Insights: Monitor system events.
• Admin: Manage users and system settings.

Each feature integrates to provide a seamless user experience and business value.

List of Fluent Commerce sub-processors.

Project representatives from Fluent Commerce, the Client, and/or the Partner are separated into distinct areas of project responsibility. This article will cover the typical team setups involved in Fluent OMS projects.

Please refer to this document to confirm contact points, SLAs and escalation paths.

Please refer to this agreement to confirm contact points, SLAs and escalation paths.

Please refer to this agreement to confirm contact points, SLAs and escalation paths.

The Connect SDK expects a minimum of 4 configuration files:

• application-connector.yml - Project and Connector specific configuration.
• application.yml - Core Connect SDK configuration. These are mostly default configurations and core settings.
• bootstrap.yml - Server/Container configuration. This file includes settings for all different environments and - follows the spring profile standards.
• logback-spring.xml - Log configuration also supports different configurations based on spring profiles.

It is possible to have dedicated configuration files for each environment, often used to override a common setting for a particular environment. To create such a file, follow Spring Boot's format having the additional desired spring profile name at the end of the application.yml file, for example, application-dev.yml.

The SDK's handling mechanism involves loading and prioritizing handlers during server startup. It provides transparency with special spring actuators for listing active routes and handlers. Message handlers follow error-handling protocols, while job handlers process data polled from external systems. Configuration handlers react to changes, and the SDK supports various ways of receiving messages from external systems.

The following guide will take you through how to use/navigate through the Fluent Order management app for Salesforce Service Cloud.

This page sets out the:

• Platform usage limits;
• Platform data limits; and
• Acceptable Use Policy and other enforcement rights

relating to the Fluent Order Management Cloud Platform (Platform)

The connector requires the settings below to process data being transmitted from Fluent to commercetools and vice versa. It contains a mix of settings and data mapping tables.

Fluent Store is an in-store responsive web application that provides store staff with end-to-end order management capabilities.

This guide helps to select the correct IDP configuration and plan SSO implementation.

A fulfilment represents one or more items in an order that need to be picked & packed for the customer. A fulfilment is assigned to a location based on the retailer's fulfilment rules and available inventory. A fulfilment will have an origin (from) and destination (to) associated with it.

An overview different types of fulfilment that is used in OOTB workflow

In the September 2023 release, we improved our Fulfilment Options response times by up to 50%. One of these improvements is disabled by default for existing Accounts. This section will detail how to turn on this setting.

The Fluent Big Inventory Web App is pre-configured with standard functions that provide the interface for managing products, inventory, feeds, and sources and serve as a starting point for your projects.

The default UX templates are hosted on the platform, so you don't have to create the manifest settings unless you need to customize the existing baseline configuration.

This document will explain how to use Big Inventory for existing Customers and Partners. Additionally, we will cover any pre-requisites for each new feature and any existing configuration needed.

Sample GQL payload to use @skip and @include directives

Retrieve inventory position, variant product, virtual base position and virtual aggregate position records based on input parameters.

Sample Inventory Queries that can be used on a daily basis.

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. It provides a complete and easy-to-understand description of the data in your API. Its ability to return select fields enables it to be used with powerful developer tools and ensures that APIs are easily scalable.

Fluent's GraphQL API has two operations:

• Queries 
• Mutations

Queries include predefined Queries and Custom Queries, both of which will be covered below.

Retrieve an order by

`id`

Every GraphQL operation is currently protected by Permissions. 

Sample Product Queries that can be used on a daily basis

This document will detail how Batch Pre-Processing works. This will allow Partners to understand how their inventory implementation interacts with Batch Pre-Processing.

This document will describe how Inventory Feeds work and guide users through understanding any prerequisites to integrate with Inventory Feeds.

The Returns feature is available for any OMX web apps. The following guide will step through the areas of configuration to enable the Returns reference solution.

Describes Fluent’s approach to name messages used by the module’s workflows. The message is a mode of communication between two different systems. The naming convention helps to keep all messages uniform and consistent across all Fluent modules allowing partners to understand and adopt the format and follow it during their customisation.

A message can be of 2 types:

• Command: A Command is a message directed at a receiver to get something done (aka action). The producer of command has an intent and may expect a response from the receiver. Example: create an order
• Event: Events communicate the performed action from one system to another system. It’s a fact that cannot be changed as that has already happened in the past. Example: Order update notification: When the order is created or modified, a notification is sent from Fluent to external systems.

Fluent Commerce can post standard webhooks to a configured endpoint so that the third-party system can be notified or react to the provided event. For example, common webhook scenarios include order status updates and shipping notifications.

This page provides all the information needed to design best practice Rules for your workflows. There are some important things to be aware of, so we highly recommend you thoroughly read through this page, and refer back to it regularly during development.

This page describes how Event Execution works.

This page provides naming recommendations to follow for labels across the Fluent platform.

• nameSpace.domain.[subdomain].module.[submodules...].label
• submodules = page.tab.component(card/table)
• All levels use the singular. For example, order instead of orders and component instead of components.
• Use Camel Case to separate words. For example,: fc.om.order.ui.list.title).

The Wave Dashboard Template is a preconfigured UX Template used within the Fluent Store Web App.

The Fulfilment Choice Entity is used to store the shipment specific information:

• Delivery method
• Delivery or pickup address
• Delivery dates

The Pick by Expiry Template is a preconfigured UX Template used within the Fluent Store Web App.

Fluent's Order Management domain oversees the entire order process, including entities like Order, Fulfillment, and Return Order. Billing Management handles financial operations, while Global Inventory aggregates product inventory. The Foundation domain configures setups, and Store Fulfillment manages order fulfillment through the Wave entity. Security governs users and permissions, Shipping records shipping details, and the Product Availability domain ensures real-time product availability. Fulfillment Option and Fulfillment Plan provide flexibility in order fulfillment strategies.

The Pack Template is a preconfigured UX Template used within the Fluent Store Web App

Component SDK provides a collection of React hooks to allow custom components to access the core UX framework functionality.

The SDK includes Typescript declaration files that tell your IDE and compiler what these look like and that they are available on the global scope.

General Principles and the Features of the SDK

The 

`@EventAttribute`

The Rules SDK comes with 2 API Collections:

• Postman Collection
• Insomnia Collection

The Fluent platform leverages advanced cloud technologies to provide a seamless, scalable, cost-effective solution. Designed natively for the cloud, it offers users:

• Automatic scaling to efficiently manage fluctuating demand without manual intervention.
• Cost savings through optimized resource utilization and infrastructure sharing.
• Continuous operations with updates and upgrades that do not disrupt retailer activities.

Warehouses configuration contains:

• Warehouses page
• Warehouse Details page

Cloud Technology Environments on the Fluent platform include Sandbox and Production settings. The Sandbox is for testing and training, mirroring the live Production environment. Retailers ensure secure operations using HTTPS and tailored firewall or proxy configurations. These environments are fundamental for smooth retail activities on the Fluent Commerce Cloud platform.

Stores configuration contains:

• Stores page
• Store Details page
• Location Ref
• Created On
• Updated On

This document provides an overview of enhancing visual representation within a system by displaying coloured dots. These dots serve as a quick reference to different statuses of orders or items, making it easier to recognize and prioritize tasks at a glance. You will learn how to customize the appearance of these dots by changing their colour through hex codes and understand the default settings. The guide also includes recommendations for a colour palette to optimize the utility of status indicators.

Federated identity management means establishing of a trusted relationship between separate organizations and third parties, allowing users to authenticate to one domain and access resources in another without a separate login, enhancing security and user satisfaction. Fluent's Federated SSO utilizes protocols like SAML and OIDC for secure data exchange, providing a seamless single sign-on experience across Fluent OMX applications. These open standards enable the secure transmission of authentication and access information across domains

Connect SDK is the launchpad to connect any external system with Fluent Commerce in a predictable way. 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 micro-service applications that communicate with the Fluent Order Management System and any external system.

This topic explains the dispatch process for Home Delivery (HD) and Click and Collect (CC) fulfilments using the ServicePoint console.

Roles & Permissions configuration contains:

• Roles & permissions page
• Role Details page

Customer configuration contains:

• Customer List page
• Customer Details page

An identity provider (IdP) is a service that stores and manages digital identities. Companies use these services to allow their employees or users to connect with the resources they need. They provide a way to control access, adding or removing privileges, while security remains tight.

For companies who don’t have corporate IdP, Fluent provides a solution that allows them to receive all SSO benefits without needing to support their own SSO solution.

Waves configuration contains:

• Waves List page
• Wave Details page

Networks configuration contains:

• Networks List page
• Network Details page

• Fulfilment Options page
• Further Reading

The Billing account entity represents financial operations. Billing accounts are responsible for orchestrating all invoices and invoice adjustments (Credit & Debit memos). Additionally, Billing Accounts also manages all associated downstream outcomes including payments, invoice notifications, and ERP integrations.

Billing Account configuration contains:

• Billing Account List page
• Billing Account details page

Collections configuration contains:

• Collections List page
• Article Details page

This article will explore the different stages involved in an order's lifecycle. Through the various tabs and sections in the Fluent OMS interface, you can easily track the status and progress of orders including customer delivery preferences and details. This promotes transparency and efficiency in the order fulfillment process.

Returns OMS configuration contains:

• Creating a Return
• Returns List page
• Return Details page
• Return Fulfillment Details page

A Location represents a physical place, whether a retail store, a warehouse, or even third-party vendor facilities.  A Location page displays the list of existing locations, while a Location Details page displays detailed information about the particular location.

Single sign-on (SSO) is a session and user authentication module that gives users the ability to sign on once and with a single set of credentials to access multiple services and resources. It means is that the user will be authenticated against any Fluent platform application via corporate identity management provider (IdP) or Fluent IdP.

A fulfillment represents one or more items in an order that need to be picked and packed for the customer. It is assigned to a location based on the retailer's fulfillment rules and available inventory. A fulfillment will have an origin (from) and destination (to) associated with it. A fulfillment containing unfulfillable items can be moved to the Escalated state. The Escalated Fulfilments page displays fulfillments in the Escalated state.

Arrivals configuration contains:

• Arrivals List page
• Article Details page

The Insights module is a comprehensive repository of system Events, representing occurrences or triggers within the Fluent Platform. These Events, like changes in inventory position or entity states, act as notifications, prompting specific workflows and providing a dynamic overview accessible through a user-friendly configuration featuring the Events Search Form, the Events Search Results, and the Event Details Drawer for efficient information retrieval.

A batch contains a series of records that will have the same operation applied to it. All batches are run asynchronously as such the client will be required to request a status update for entered batches. A batch can include a maximum of 5000 records.

To create a Batch, the user must first create a Job. A job is required to store a series of batches. For more information please refer to the Job API.

This document is intended to introduce the Inventory Feeds feature to Customers and Partners. This page will describe the Inventory Feeds feature and how they fit within the Fluent Big Inventory Product and will direct the reader to resources describing how to use Inventory Feeds.

A Location is any place where an order can be fulfilled and/or collected by the customer. Locations can include a store, warehouse, drop-ship vendor, lockers, or a third-party logistics or collection point.

Fluent Commerce cloud-native Multi-Tenant Software as a Service (SaaS) is a solution engineered to optimize order management processes. It uses multi-availability zone microservices and a pooled resources multi-tenancy model for performance and scalability. The Purpose of this document is to explain the high level process for migration of a Client from a multi-tenant environment to a single tenant environment.

This config guide refers to version 1 of the UX Framework which is now deprecated

An order is a customers request to purchase one or more items from a retailer. An order is created when a customer completes the checkout process against a Retailer Products.

A network is a collection of physical fulfillment or collection locations such as stores, warehouses, distribution centres, or even lockers. Fluent Retail allows users to manage their network from a centralized position with control of network-specific order logic via custom rules. The Network API defines the creation and addition of networks as well as retrieval of details pertaining to a network and updating the parameters of a network.

There are three default networks,Collection Point Network,C&C Network, and Home Delivery Network. These can be extended and configured with subnetworks.

The Order Management Experience (OMX) Design System provides guidelines for delivering a user experience tailored to the Omnichannel Order Management space. This article 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. 

The OMX UX Component Library contains a suite of UI Components, ready to be configured and used in Fluent Web Apps.  The Library contains Foundation, Content, Layout,  Interaction and Field Components.

Open Source Licenses

A detailed explanation of Fluent OMS entities and how they can be used throughout the order journey.

Fluent's Order Management Experience (OMX) framework comprises the UX Framework, Workflow Framework, and Connect Framework, which can be configured and extended (or customised) using software development kits (SDKs).

Order Management Experience is all about delivering the best possible experiences for our clients, that allow them to tailor their businesses to the fast-changing retail landscape, keeping costs down, and customer satisfaction high.

The Activity Log is an audit trail of events that happen in the Fluent Commerce OMS app. 

The

`orderBillingAddress`

`billingAddress`

`billingAddress`

Below are the key features from 

`fc-commercetools-module`

• Fluent Order Management enables the management of payments throughout the lifecycle of an Order.
• Build custom payment logic into the Order workflow using the OMX Workflow Framework and provided entities.
• This document provides an overview of the Payment Data Model and GraphQL API capabilities and does not include any reference Rules, Workflows, or UX Components.

The Pick and Pack feature suiteof the Store Fulfilment app allows stores to pick and pack online orders that are allocated to the store based on store inventory at the time of order creation. The Fluent Store’s interface is used to access the capabilities of the Pick and Pack feature suite.

The General module manages credentials, API authentication, webhook validation, and a unified approach for making API requests, among other features. All other modules have a dependency on the General module.

The Pack feature of the Fluent Store empowers Store Associates to efficiently manage the packing process for multi-parcel shipments. It allows them to allocate items to specific parcels, add new parcels as needed, set parcel dimensions and weight, remove parcels, and reject items that don't meet requirements. This feature ensures that each parcel is properly organized and labeled, giving Store Associates complete control over the packing process.

The values on the packing list.

The

`payment`

The

`paymentServiceProvider`

The

`paymentTransaction`

All the details you need to know about Fluent Commerce support during the Peak period 2024.

The content provided in this article offers clients/partners a general overview of the steps and checks involved in the SSO Cutover process. However, the specific details may vary depending on the client's specific Fluent implementation. This page serves as a guiding resource only. Engaging in discussions with your partner and ES contact is recommended for further clarification and customization.

This page sets out the:

• Platform usage limits;
• Platform data limits; and
• Acceptable Use Policy and other enforcement rights

relating to the Fluent Order Management Cloud Platform (Platform)

This page sets out the:

• Platform usage limits;
• Platform acceptable use policy; and
• Data restrictions which apply to the use by clients and partners and their users of the Fluent Commerce Platform (Platform), also referred to as the Fluent Order Management or the Cloud Services.

This page sets out the:

• Platform usage limits;
• Platform data limits; and
• Acceptable Use Policy and other enforcement rights

relating to the Fluent Order Management Cloud Platform (Platform)

This page sets out the:

• Platform usage limits;
• Platform data limits; and
• Acceptable Use Policy and other enforcement rights

relating to the Fluent Order Management Cloud Platform (Platform)

A Product is a conceptual entity with a product description and multiple sets of attributes. A unique combination of the Product attributes defines a SKU which is an item for sale.

This is the Product Description for the Fluent Big Inventory Product. Fluent Big Inventory enables fast, intelligent processing of inventory data at scale. It serves as a unified solution for receiving, managing, and ensuring the accessibility of your inventory data for your business systems.

This Product is available to purchase and use standalone or combined with other Fluent Order Management products.

Product Master in Fluent OMS is defined in this hierarchy:

• Categories
• Standard Product
• Variant Product

The UPSERT_PRODUCT event will help the user to manage the product-related entities in the OMS.

Fluent representatives who work with implementation partners and during projects.

A typical setup of a Fluent ecosystem for a project will include production and non-production (or sandbox) accounts.  This article will cover the provisioning of Fluent accounts that are provided to the partner or client.

Every company has a unique approach to project estimation, so there is no one-size-fits-all solution.  This article covers the typical approaches used to estimate projects. 

This is a tool for comparing 2 entities' attributes with the OMS. For example, customer support would like to compare order attributes between Production and UAT.

The following guidelines and specifications apply to the entire schema, with any exceptions documented in the schema of the relevant entity.

The Ready for Launch process (RFL) is an engagement with the Fluent Commerce Expert Services team throughout the lifecycle of a Fluent project. The process is initiated at the beginning of a Fluent Commerce project and completed with the go-live of the project in production.

The final review ("RFL Launch Gate") should be planned for 3-4 weeks before the desired Go-Live event to receive the approval to move into production.

Project team setups typically include Fluent's Expert Services team, implementation partners, and clients.  Projects are usually client-led or partner-led projects; however, In-house projects are also possible.  Successful project delivery involves all parties working collaboratively. This article will cover the various roles and associated tasks in delivering a successful project.

The Connect SDK provides fundamental capabilities for integrating Fluent Commerce with external platforms, and it also offers additional features to facilitate multiple integrations between systems. To help clients comprehend these features, Fluent Commerce has created reference solutions, which are small projects that demonstrate how to leverage Connect SDK's capabilities to solve specific integration challenges. Essentially, reference solutions are examples that illustrate how to achieve various types of system integrations. This should be taken as a sample ONLY and accordingly modified specifically to production needs. Watch out for this page as we add more reference solutions over the coming months!

This document describes Fluent Commerce's methodology to remove Personal Data submitted by or on behalf of a Client to the Fluent OMS and Fluent Commerce’s Ticketing System (Personal Data) from those systems.

Discover how the Reports page in the Big Inventory Web App enables understanding an account Inventory Position Update and Inventory Position Change usage for selected periods.

This section explains the settings used in Retailer context.

A return is a customer's request to send back one or more items against an Order from the Retailer. A return can exist with or without the original order reference. If the original order reference exists, the return can contain the details of the returned items, the reasons, and the amount to be refunded. A return also could represent items within an original order that could not be fulfilled or has been canceled by the customer and requires a subsequent refund. Through the type of return, we can identify the context of the return, i.e., if it is a customer return, cannot fulfill or cancel.

Rule Actions are the single output of a Rule.

Rules do not perform actions directly. Rather, they inform the Workflow Engine what it should do as a result of the rule execution. The Workflow Engine interprets the specific Action produced by the Rule and handles it appropriately.

Most Actions are queued internally within the Workflow Engine and executed at the end of the current process.

Frequently Asked Questions on Connect SDK

How to manage inventory visibility to each sales channel

The Rules SDK Maven archetype will generate 2 sample Rules into the Plugin Project.

• DemoSendArbitraryEvent
• DemoAddAttributeToOrder

The integration between Azure Active Directory (or any other Identity Manager supporting SCIM 2.0 Specification) and the Fluent Commerce platform is done via a new component referenced further as Fluent Commerce SCIM Connector.

There are a number of features provided as part of the SCIM Connector. 

SCIM Connector Project Configuration

Description of the technical and organisational measures implemented by the Fluent Commerce (including any relevant certifications) to ensure an appropriate level of security, taking into account the nature, scope, context and purpose of the processing, and the risks for the rights and freedoms of natural persons.

The Fluent Order Management Cloud Platform is underpinned by a comprehensive infrastructure designed to support order management and inventory availability processes, comprising of technical capabilities organized into Services and Frameworks, each facilitating specific functionalities critical to platform operations.

The Setting Schema is a JSON schema used by the Settings Component to provide metadata for a setting, helping to define its structure. This schema primarily describes the fields that the component will render, allowing for a no-code configuration experience within the Fluent platform.

This page provides a high-level understanding of what settings represent within the Fluent platform.

To accelerate carrier integration between the Shippit and Fluent Order Management platforms, Shippit and Fluent Commerce provide a connector that enables seamless pick, pack and dispatch processes inside the Fluent Store App.  

If a company has an internal IdP then this IdP can be integrated with our SSO Vendor and used for future user authentication.

API user is always managed in the SSO vendor environment and doesn't have an MFA authentication option.

This guide helps to select correct IDP configuration and plan SSO implementation.

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.

The Fluent Store Web App empowers retailers to enhance their operational efficiency by transforming stores into fulfillment centers and optimizing inventory management, ultimately delivering a superior customer experience through streamlined order fulfillment and improved inventory control. 

The app contains the following configurations:

• All Locations
• Stores
• Warehouses
• Networks

This Support Policy describes the support services provided by Fluent Commerce in connection with the “Fluent Order Management” Cloud Platform.

This Support Policy describes the support services provided by Fluent Commerce in connection with the “Fluent Order Management” Cloud Platform.

Platform Support Process

Fluent Expert Services (ES) are our subject-matter experts who are responsible for ensuring that project implementation leverages the full extent of the software features and capabilities of Fluent OMS, and that best practices are followed.  This article will cover the different service packages that are on offer to help facilitate the project, keep it moving forward, and involve all parties (Expert Services, Partner, and/or the Client) working collaboratively to validate choices, monitor progress, and review developments.

This page describes the best practice testing approaches for rules and plugins.

The Inventory module of the Fluent Web app provides comprehensive inventory management capabilities:

• Inventory visibility
• Inventory allocation
• The total quantity of stock for a specific item (stock on hand(SOH)) and the status of that inventory
• Available to promise inventory levels
• Inventory buffers to reduce overselling of products

The 

`run`

TRAINING TERMS AND CONDITIONS

The UNCOLLECTED Articles feature of the Fluent Store module provides a capability for the retailers to set a collection SLA for the customers.

The Fluent platform generates unique IDs internally, which serve as the primary key for each new record. They are unique and enforced to avoid ambiguity. Users cannot set these via API. Whereas refs are typically from third-party integrations, they represent external system IDs and occasionally are generated internally with guaranteed uniqueness. It is the integrator's responsibility to ensure refs are unique in Fluent Commerce.

Understand what are some general Rule principles.

Multi-factor authentication (MFA) is used to ensure that digital users provide at least two pieces of evidence to prove their identity. Each piece of evidence must come from a different category, something they know, have, or something they are.

Traditionally, authentication mechanisms or factors have been categorized as belonging to one of three groups:

• Something you know (for example, a password or a PIN).
• Something you have (for example, a mobile phone or a token).
• Something you are (for example, a fingerprint or other biometric data).

In best practice, though, MFA goes beyond 2FA by requiring a user to authenticate via two or more authentication factors from different categories (e.g., a “something you know” combined with a “something you have”). The goal of having two or more authentication factors from different categories is to reduce the likelihood of an impostor gaining access.

The OMX UX Framework delivers configuration-based solution implementation for UIs (Web Apps). Configuration is managed in a JSON document called the OMX Web App Manifest.

This page describes where to find user activity logs in SSO Environment. Ping Identity (SSO Vendor) logs all actions performed in the SSO admin console and keeps logs for two years by default. Review logs if you need to investigate an activity of a certain users or check a number of failed logins.

A password policy dictates the strength and complexity requirements for a password or passphrase.

Fluent IdP supports the following types of password policies:

• Basic: The basic policy is a more relaxed standard that allows maximum customer flexibility. The basic policy can be less secure because users are not required to change their passwords.
• Passphrase: The passphrase policy encourages users to use a passphrase instead of a password for stronger authentication. A passphrase can be easier to remember and more secure because of its length.
• Standard: The standard password policy incorporates industry best practices for a typical password policy. By default, a basic password policy with all requirements and rules cleared is set for each Client Account on the Fluent IdP side.

Learn about the typical phases in delivering Fluent OMS projects from Discovery to 'Go Live'.

Fluent Order Management components are Web Apps, Modules, Order Management Experience (OMX), Orchestration Engine, and Cloud Infrastructure. These components operate within the framework to enable the order management experience on the platform.

Exponential backoff is a standard error handling policy for network communications such as the Fluent APIs. 

Exponential backoff involves a client periodically retrying a failed request over an increasing amount of time.

You will learn how to design workflows, what they consist off and what are the best practices. 

This is a guidepost for Developers highlighting important guides and articles to speed up Fluent Commerce's learning process. 

We are here to help and there are several ways how to get in touch with our team. Read on if you'd like some help!

The Admin user interface in the Fluent OMS Web App provides comprehensive administrative capabilities to manage the entire system efficiently.

GQL createOrderAndCustomer example

The Fluent Store web app is a preconfigured baseline web app which can be used as a starting point for your projects.

The default UX templates are hosted on the platform, so there is no need to create the manifest settings yourself, unless you need to customize the existing baseline configuration.

• GraphQL API Error Codes are summarised in this document.
• These include:
  • General API Errors
  • The error code format explains the format in which the error is shown to the user. It includes:
    • Prefixes
    • Suffixes
    • 4 Digit Code
  • Errors are classified into client errors and server errors. 
  • Current error codes are also classified into client errors and server errors with possible solutions.
• Fluent REST API returns specific HTTP error codes which may vary depending on the API endpoint and is explained in this document.

Authentication policies dictate how to verify a user's identity.

Handy reference guide on how to display date time value on the UI

For Date format and conversion in UI, two functions can be used:

• `formateDate`

• `dateStringFormatter`

  (if true, then it will leave it as UTC timezone, else, it will convert to the user's browser timezone)

Discovery is the critical first phase of any project where all parties develop a shared understanding and mutually devise strategies to solve the various problems from an OMS perspective.   It gives the opportunity to align the client, project team, business, IT stakeholders, and other vendors but also ensures the project is steered in the right direction with a strong foundation.  Discovery topics refer to the main areas we suggest should be covered during a discovery session.

OMS Webapp's Users List page allows users to efficiently search and view existing users using a versatile filter component. The Users table provides essential user details, with a clickable Username link leading to a detailed User Details page displaying user information. The paging control at the bottom ensures easy entry management with customizable rows per page and intuitive navigation.

This guide is designed to help you implement the enhanced

`attributes`

`attributes`

User management is a client’s internal process. Your nominated IT team or a partner is responsible for user management.

The document describes the best practice for onboarding and offboarding users.

The Fluent platform provides a comprehensive user role management system, allowing for the assignment of diverse permissions via roles to regulate platform access and functionalities. Custom roles can be created and fine-tuned, ensuring users only have access to appropriate functionality and data. The system provides flexibility to specify the scope for a role at different context levels, such as Accounts, Retailers, and Locations.

The OMX UX Framework, or Mystique, delivers configuration-based solution implementation for UIs (Web Apps) that understand the Fluent Platform. It enables UIs to react to changes within workflows and provides best-in-class user experience and design. Web apps can be built using code-free configuration, utilising a rich library of ready-to-use UI Components.  Customising UIs to meet specific business requirements using Component SDKs is also possible.  Configuration is managed in a JSON document called the OMX Web App Manifest.  

The OMX UX Framework, or Mystique, delivers configuration-based solution implementation for UIs (Web Apps) that understand the Fluent Platform. It enables UIs to react to changes within workflows and provides best-in-class user experience and design. Web apps can be built using code-free configuration, utilising a rich library of ready-to-use UI Components.  Customising UIs to meet specific business requirements using Component SDKs is also possible.  Configuration is managed in a JSON document called the OMX Web App Manifest.  

Below are the properties available in the Category object, which can be updated and retrieved through the APIs in this document.

Events are a fundamental part of the Fluent Platform. Not only are they used to trigger workflow logic, but they also capture everything that happens within the system. Events are categorized by type.

The Fulfillment Options API retrieves the proposed Fulfillment Options for the customer order.

A Job represents a container that can hold multiple batches. A job stays open until midnight (UTC), where the status will change to CLOSED. All jobs are processed concurrently.

An Order Item is the SKU purchased by the customer on the Retailer's online store. There can be one or many Order Items within an Order. Each order item has an associated quantity and paid price.

The Plugin API provides methods for uploading, installing, and viewing Plugins.

A Plugin Bundle represents a collection of rules for a retailer that is uploaded and installed into Rubix for use in workflows. They can be developed and installed through the use of the Fluent SDK.

Settings API is used to set configurations used by the platform, accounts and retailers. See Commerce Apps documentation for specific settings keys and their function.

Configurations have a hierarchy of contexts in which they can be applied. GLOBAL, ACCOUNT and RETAILER are the levels in decreasing order of context, where GLOBAL is reserved by platform use and ACCOUNT and RETAILER are available to developers to override the GLOBAL defaults.

SKU is the specific item that can be purchased by the customer. SKU has a unique set of attributes such as colour and size. Product is the parent of SKU and must be created before the SKU API can be used.

An API Order transaction defines the payment or refund details associated with an Order.

An Order transaction defines the payment or refund details associated with an Order.

The User Action API provides the framework to interact with orchestration via the ServicePoint and Admin Console platform portals, as well as the capability to interact with various other external applications. This interaction provides the capability to translate unique requirements into a user interface.

A workflow defines the orchestrated business logic to be applied to an entity on a given event. A workflow consists of Workflow States and Workflow Rule Sets for an Entity. The Workflow States specify the states that the entity could be in at any given point in time. The Workflow Rule Sets specify the business rules behind the progression of these states.

Sample Virtual Position Queries that can be used on a daily basis

Settings configuration contain:

• Settings List page
• Setting Details page

This resource page offers detailed instructions on how to find assistance when looking to alter the Rules that are part of a Module.

This article introduces the concept of a Fluent Commerce Module, describing it's basic structure and content.

Extension definition in Fluent OMS

The Connect Framework provides low-code tools that allow non-technical users to configure their ecosystem integrations easily. In situations where the standard configuration options are not enough, developers can build their own custom solutions using the Software Development Kits (SDKs) provided, which include tools and design patterns for building specific integrations and processes via Connector SDK, which is used to build custom Integrations.

Anti-Patterns are patterns found which are not recommended practice, or violate best practice guidelines, and can be harmful to performance and reliability.

This section covers the fundamentals of the Workflow Engine, provides an overview of the architecture, identifies key concepts, and prepares clients to build and use their workflows.

The Workflow Engine (aka Rubix) is the engine that drives the Fluent platform. The Workflow Engine enables business process orchestration, workflow automation, and underpins the specific feature sets and functionality for each of the Fluent apps. Additionally, the Workflow Engine is built to be highly scalable, and provide high-performance workflow execution across any domain.

Best Practices for Workflow Design: Keep in Mind These Principles.

This article describes settings that can be added to a Workflow.