Recently Updated

In this article, you will explore a real-life business scenario and learn how PLP helps address it.

• As a customer, you would browse an e-commerce site and be shown the available quantity for sale.
• PLP and PDP use different methods to retrieve the ATS quantity and can showcase different levels of granularity regarding the data of the queried SKUs.

This course introduces the fundamentals of the availability module, helping you familiarize yourself with key terms and providing an overview of its high-level implementation in Fluent OMS.

• Availability calculates Available-to-sell Inventory based on product, customer location, and delivery method.
• To set up Availability in Fluent OMS, you must set up master data, Inventory Catalogue workflow, and Virtual Catalogue workflow. 

In this article, you will understand how fulfillment options provide the available to sell quantities.

•  Fulfillment Options generate Fulfillment Plans based on the requested items. If necessary, the response payload can be personalized to include additional information, such as the Expected Time of Arrival. 
• Typically, the PLP would rely on cache inventory on Ecom to provide the ATS quantities, and the PDP will use Fulfillment options to provide real-time ATS quantities.

Fluent supports various fulfillment options like Click and Collect, Ship-from-Store, and Ship-from-Warehouse. The process involves checking inventory, reserving stock, and notifying relevant parties at each stage. Orders are managed through the Fluent platform, allowing customers to collect from stores or receive deliveries at home, with real-time updates on order status.

• Click and Collect: Customers order online, collect from selected stores.
• Inventory Check: Verifies stock availability before fulfillment.
• Store Fulfillment: Store staff pick, pack, and notify customers for collection.
• Ship-from-Store: Orders shipped from stores with integrated courier booking.
• Warehouse Fulfillment: Uses webhook communication for real-time updates.
• Order Status Updates: Real-time tracking through Fluent workflows.

Order management in Fluent includes handling cancellations, revisions, and returns. Cancellations can be for entire or partial orders. Order revisions allow modifications to in-progress orders before dispatch, and returns handle customer issues with delivered items. These processes can be managed manually by customer service or automated within workflows, depending on the business needs.

• Order Cancellation: Cancels entire or partial orders, resetting inventory.
• Cancellation Timing: Configurable to specific workflow statuses.
• Order Revision: Allows changes to in-flight orders before dispatch.
• Return Workflow: Manages customer-initiated returns for various reasons.
• Action Modes: Supports both automated and manual (self-service and customer service) actions.
• Refund Handling: Automatic refunds are processed if payment is taken.

Fluent workflows use webhooks for real-time communication with external systems, triggered at specific workflow points. Webhooks provide timely updates for order status, shipping, payments, and inventory movements. The standard SendWebhook rule simplifies outbound communication by sending basic data, allowing external systems to retrieve additional information as needed.

• Real-time Communication: Outbound communication from workflows.
• Reusable Rule:  

  `sendWebhook`

  rule can be used across multiple workflows.
• Order Status Updates: Triggers for status changes (e.g., order completion).
• Payment Processing: Webhooks manage payment processes post-dispatch.
• Inventory Tracking: Tracks stock changes via webhooks to external systems.

Split fulfilment allows retailers to complete an Order from multiple locations if a single location can't fulfil the whole Order. Rejection occurs when orders can't be fully met due to various constraints, leading to escalated statuses where customer notification and resolution actions are taken. In-flight revisions enable modifications to order items, allowing flexibility in managing customer orders.

• Split Fulfillment: Orders can be fulfilled from multiple locations if needed.
• Rejection Criteria: Orders are rejected if fulfillment criteria aren't met.
• Escalated Status: Notifies and manages unfulfilled orders.
• Customer Communication: Notify customers of rejected orders.
• In-Flight Revisions: Add or remove items from existing orders.

Sourcing determines the best fulfillment location for an order based on various business rules and priorities. It aims to optimize delivery speed, cost, and inventory management while enhancing customer experience. Retailers can quickly adapt sourcing strategies to market changes and manage fulfillment efficiently, ensuring maximum flexibility and revenue.

• Optimized Fulfillment: Chooses the best location for delivery based on speed and cost.
• Inventory Management: Clears old stock and protects key store inventory.
• Customer Prioritization: Prioritizes VIP customers for better service.
• Flexibility: Easily adapts sourcing rules to market changes.
• Split Management: Controls order splitting to reduce costs and complexity.

This article focuses on understanding the Order Domain within Fluent, highlighting orchestrated and non-orchestrated domains. The Order is the central entity with relationships to sub-entities like Fulfillment, Article, Consignment, and Return Order. These relationships determine the flow of order processing, including picking, packing, delivery, and optional returns.

• Order: Central entity in the Order Management domain.
• Fulfillments: One Order can have multiple Fulfillments.
• Article Packing: Fulfillments involve multiple Articles.
• Consignment Delivery: Articles are delivered through Consignments.
• Returns: Optional Return Order linked to original Order.
• Customer Relationship: Orders tied to a Customer for billing purposes.

The 'Order Orchestration' module is integral to Fluent Order Management. It handles the end-to-end management of orders from creation to fulfillment. It optimizes the fulfillment process, allowing flexibility and control over sourcing and fulfillment strategies.

• Dynamic Sourcing: Selects the best location based on inventory and business rules.
• Split Fulfillment: Supports fulfilling orders from multiple locations.
• Custom Workflows: Allows tailoring workflows for Home Delivery, Click & Collect, and more.
• Fulfillment Management: Tracks multiple fulfillments and manages SLAs and exceptions.
• Retailer Benefits: Reduces costs, optimizes sourcing, and ensures operational flexibility.

In this course you will learn how Controls and Control Groups are used to define the Available To sell quantity. 

•  Control Groups are "containers" for Controls
• There are multiple types of Controls, some of which are QUANTITY_BUFFER and EXCLUSION. They allow you to limit the number of items Available to Sell

In this course, you will understand how the Virtual Catalogue enables the calculation of the Available to Sell quantity.

• A Virtual Catalogue contains Virtual Positions which typically represent the Available To Sell (ATS) quantity of a product in a location, or a product across all locations in a network.
• A Virtual Catalogue calculates the ATS quantity by combining inputs from the Inventory Catalogue and the Control Groups - the ATS quantity is the inventory on hand quantity with buffer values applied.

This course covers how the Inventory Position On Hand quantity is calculated from the different Inventory Quantity types.

• The Inventory Position On Hand quantity is the sum of the LAST_ON_HAND quantity and any active RESERVED, SALE, CORRECTED and DELTA quantities.
• Inventory Positions are deactivated and not considered during availability calls or order sourcing if the location or the product is inactive. 
• The Inventory Catalogue workflow considers both external events (resulting from third systems) and internal events (resulting from workflow updates) to calculate the On Hand quantities. 

In this lesson, you will learn how delta inventory updates can be sent to Fluent OMS.

•  An inventory update can be done either via Batch API for bulk updates, or the Event API for smaller delta updates.
• While a Batch update creates or updates a LAST_ON_HAND inventory quantity, a Delta update creates or updates a DELTA inventory quantity

In this course you will learn how inventory is uploaded into Fluent OMS and how the Inventory Catalogue enables the maintenance of stock-on-hand records across all locations.

• An inventory stock-on-hand record represents the QUANTITY of a SKU at a LOCATION. 
• The on-hand quantity is a combination of the last received on-hand stock, and inventory updates resulting from order workflow events.
• Inventory can be sent into Fluent via Full Loads or Inventory Position Change updates.

This course covers how product master data is handled in Fluent.

• Products are handled in product catalogs in a parent-child hierarchy: standard and variant products. 
• A set of products can be grouped in a category, which can be relevant in scenarios where business logic is applied to a group of products.
• Group products can be used to model bundle products. 

This course covers the basics of the inventory module. You will become acquainted with key terms and concepts and understand the core data objects and flows.

• The inventory module covers everything related to inventory management in Fluent OMS.  Base capabilities are configurable via workflows for product catalogue, inventory catalogue, control group and virtual catalogue entities.
• The inventory module allows for the configuration of the inventory availability flow, starting with the upload of inventory data and ending with the calculation of on-hand and availability to sell (ATS) values.  Different configurations, for example safety stock buffers, virtual catalogs and inventory reservation triggers, allow for the adjustment of this flow. 
• The Fluent Rules SDKs can be used to extend inventory module capabilities in addition to the base functionality.

The Fluent CLI provides command line tooling for interacting with Fluent Accounts and Modules.

Usage

The Fluent CLI is activated by typing the keyword

`fluent`

`fluent <command> <subcommand> <argument> [options]`

• The

  `<command>`

  will refer to a noun (or “a thing”).
• The

  `<subcommand>`

  will refer to a verb (or action).
• The

  `<argument>`

  is the primary required name of the “thing” identified by the

  `<command>`

  .
• The

  `[options]`

  may include required or optional additional parameters to be used by the

  `<command>`

  and

  `<subcommand>`

  .

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

• SSO is only supported by the OMX framework
• All API users will be stored in Fluent IdP and cannot be stored in Corporate IdP as it’s not an individual user and has a separate machine-to-machine authentication flowSSO/Ping Identity Environment

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

• Single sign-on (SSO) is exclusive to the OMX framework, and API users are managed in Fluent IdP, not Corporate IdP, with creation possible through API.
• SSO, enabled for each Fluent account, involves creating a corresponding SSO Ping Identity environment managed by the SRE team, covering admin user setup, password policy configuration, branding, and application enablement.
• SSO Environment Admin Users, Fluent IdP Configuration, Password Policy, and other guides provide comprehensive details for SSO enablement, Corporate IdP integration, user management, authentication policies, multi-factor authentication, and configurations with Azure AD and Okta.

The values on the packing list.

• List of values on the packing list 

This guide provides solutions to common issues encountered in eLearning environments, including troubleshooting steps for login errors, exam resets, and password recovery.

The  Orchestration Engine powers the execution of workflows, business logic, and business processes. It enables real-time sync for orchestrated availability calls, high-volume batch processing for inventory loads and updates, event tracking which logs all activities, responds to events triggering execution, and triggers activity in external systems.

• Orchestration Engine
  • Powers the execution of workflows, business logic, and business processes.
  • Enables real-time sync for orchestrated availability calls, high-volume batch processing for inventory loads and updates, event tracking which logs all activities
  • Responds to events triggering execution, and triggers activity in external systems.

• A step-by-step guide how to convert workflow statuses list into CSV / Excel table format

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.

• Batch Properties
• Category Batch
• Inventory Batch
• Location Batch
• Response on Failures

• Batch Pre-Processing (BPP) occurs before batch inventory updates reach the inventory workflows. This means if you have any configurations within the workflows that rely on every update reaching the workflow, it is best to opt-out of BPP, make sure to read through this article before toggling this setting off via settings (Read the 'Disabling Batch Pre-Processing' callout shown later)
• BPP is by default enabled at an ACCOUNT and RETAILER context level, to turn it off see the callout 'Disabling Batch Pre-Processing' below
• If enabled at an ACCOUNT level, every retailer under that ACCOUNT will have their batch inventory updates pre-processed
• If enabled at RETAILER levels, it will only pre-process updates for that specific retailer
• The RETAILER context setting overrides the ACCOUNT context setting. This allows you to enable for the whole account and disable for specific retailers. 

A topic on how to run Inventory Batches in the OMS. 

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

• Pre-requistes
• Data Model
• Entities
• Explanation of the Entity Relationships through an Example
• Relationship details
• GraphQL queries required for Payments

The

`payment`

• The page provides GQL example of how to use

  `payment`

  :
  • Create
  • Update
  • Query

This guide teaches you how to manage large monetary values accurately in Fluent OMS using

`scale`

`unscaledValue`

`amount`

• Avoid floating-point inaccuracies by using

  `scale`

  and

  `unscaledValue`

  for large amounts.
• Treat

  `unscaledValue`

  and

  `scale`

  as the source of truth for exact monetary values.
• Adjust

  `scale`

  to handle very large amounts while maintaining precision.
• For display and reporting, always reconstruct amounts from

  `unscaledValue`

  and

  `scale`

  .

The Comment GraphQL API allows customers to manage Comments across various Entities.

Multiple Comments can be added against the same Entity, with each Comment automatically capturing:

• The timestamp
• The User who created it

This feature allows Users to record specific business actions and events, providing a comprehensive history of interactions and updates.

• Add Comments to any Entity Type, enabling detailed documentation of business actions
• Specific Permissions are required for Comment operations
• Use the

  `createComment`

  and

  `updateComment`

  Mutations to manage Comments
• Use the

  `commentById`

  and  

  `comments`

  Queries to retrieve Comments

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

• Batch Pre-Processing processes batch inventory updates before they get passed onto the inventory workflows
• This processing identifies inventory records that don't need to be processed by the workflow engine
• This will reduce the total end-to-end time to process inventory updates by reducing the load on the workflow engine

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

• Batch Pre-Processing optimises the performance of Inventory Batches
• This optimisation reduces the time it takes to process Inventory Batches
• Batch Pre-Processing can be enabled per Account and Retailer as needed

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.  

• The client must have a direct account with Shippit about their shipping agreement.  The Shippit Connector helps to speed up the integration timeline between Fluent and Shippit. 
• Before obtaining the Shippit Connector, a Fluent commercial agreement must be in place prior to using the connector; please get in touch with your Fluent Customer Success Manager.
• The Shippit Connector will be integrated with the Fluent Store App, where the pick, pack, and dispatch processes will be integrated with the Shippit integration.
• The Shippit Connector can support the following features:
  • Creating labels and shipping manifests at the wave level that streamline the Store User process;
  • The Store User can select one or more articles for a manifest within the same location;

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.

• Roles and responsibilities involved in Fluent OMS implementation projects 
• Partner-led projects
• Client-led projects

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.

• Article Entity Relationship
• Article Properties
• What you can do with Article

• An easy step-by-step guide on how to add a new ruleset to update fulfilmentChoice status.
• This example can be used on the MULTI order type (mixed basket) workflow.

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

• Entities in Fluent OMS are data objects that store and process information throughout the order journey, such as orders, fulfilments, and financial transactions.
• Entities are managed via GraphQL, with mutations and queries used to create, update, and retrieve entity data.
• Entities should not be deleted but controlled using status fields, although some "remove" mutations can disconnect entities.
• Orchestrated Entities trigger a CREATE event upon successful creation, enabling workflow automation.
• Entities in Fluent OMS serve unique purposes to enable an end-end digital commerce journey and their statuses determine at what stage they sit.

Rewarding way for customers to share their achievements.

• How to engage in the Reference Program? 
• What can I get when Im completing a marketing activity?
• How can I use my points ? 

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.

• The authentication policy needs to be configured to make sure that all users are authenticated via internal IdP.
• API users and Fluent IdP users will be managed via separate authentication policies.

• This guide covers setting up an SSO connection between PingOne and Google Workspace using SAML.
• Ensure you have admin access in PingOne and a Google Workspace account with an active subscription.
• You need to register the application in Google Workspace to configure it as an external identity provider.

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.

• A role can be assigned to multiple users, and a user can be assigned multiple roles.
• Permissions are granular access controls and protect every GraphQL or REST API operations. GraphQL permissions follow specific naming conventions.
• Context plays a pivotal role in access levels, allowing users to have role-based access to data for specific Accounts, Retailers, or Locations.

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.

• Data Encryption: Both in-transit and at-rest data are secured using advanced encryption methods, including TLS 1.2+ for data in transit and AES-256 for data at rest.
• System Resilience: Infrastructure across multiple AWS zones with auto-scaling and real-time monitoring ensures high availability and resilience.
• Access Control: Access to data is strictly controlled through least privilege access principles, strong password policies, and Multi-Factor Authentication.
• Incident Response: Fluent Commerce has measures in place for rapid data restoration and system recovery in the event of a physical or technical incident.

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.

• The Fluent Big Inventory Web App comes with pre-configured standard functions, offering a user-friendly interface for effective management of products, inventory, feeds, and sources.
• Default UX templates are readily available on the platform, eliminating the need to create manifest settings unless customization of the existing baseline configuration is required, streamlining the setup process for a seamless user experience.

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.

• Instructions on how to override the default manifest document
• Details on where to find baseline manifests and configuration guides
• Recommendations for text editors to use when editing manifest documents
• Guidance on saving manifest documents to your account
• Information on adding new fragments to your web app

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.

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

• Explanation of Control and Control Groups
• Control Types

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

• Date of the Peak period 2024
• Fluent Commerce support model

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.

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

• Workflows that consist of states, rulesets, triggers, user actions, and Modules, used for distributing workflows and it's artifacts, are a key part of the Fluent Commerce platform.
• Settings are used to adjust Workflow execution

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.

• The Data Privacy Addendum details Fluent Commerce's obligations in line with applicable data protection laws as data processor when processing personal data as data processor in context of its Clients' use of the Fluent Order Management Platform and Services. 
• Clients maintain control as data controllers, while Fluent Commerce acts as a data processor, adhering to the Client's documented instructions for data processing.
• Sub-processors may be engaged by Fluent Commerce with prior notification to the Client complying with applicable data protection laws.
• Transfer of personal data across borders is governed by Standard Contractual Clauses to safeguard data in accordance with GDPR and other applicable data protection laws.

• Use Bulk Threshold Controls to manage Out of Stock and At Risk Statuses for Inventory and Virtual Positions
• Create Control Groups for Inventory and/or Virtual Catalogs to respectively apply Bulk Threshold Controls
• Configure Bulk Threshold Controls with:
  • Context
  • Threshold
  • Status
  • and Execution Order

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)

• Usage of the Platform and all related Products are subject to the Platform limits, data limits and acceptable use policy set out or referred to in this document.
•  Read this together with your Agreement/Order Form relating to the Platform. 
• Platform limits (for each type of Account) apply in aggregate across all applicable Accounts referred to in your Order Form.  

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)

• Usage of the Platform and all related Products are subject to the Platform limits, data limits and acceptable use policy set out or referred to in this document.
•  Read this together with your Agreement/Order Form relating to the Platform. 
• Platform limits (for each type of Account) apply in aggregate across all applicable Accounts referred to in your Order Form.  

• Create your Master-Retailer Inventory Catalog
• Create your Sub-Retailer(s) Virtual Catalog(s)
• Configure your Inventory Catalog Workflow for Cross-Retailer events sending

There are numerous ways of monitoring the Fluent platform and its functionality. We can distinguish between different types of monitoring, such as business or technical monitoring.

• Create a profile
• Create a retailer
• Install the Fluent Reference Modules
• Install B2C Sample Data modules
• Validate the Account set up

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.

• Event Types: Understand the different event categories such as ORCHESTRATION, ORCHESTRATION_AUDIT, API, and GENERAL events, each serving distinct purposes within the Fluent Platform.
• Event Retrieval: Use the GET methods with appropriate parameters to retrieve specific events or a filtered list of events, ensuring you handle possible 404 errors for not found items.
• Event Creation: Leverage the POST methods to create new events either asynchronously (/event/async) or synchronously (/event/sync) based on the workflow requirements.
• Authentication: Remember that authentication is required for all operations within the Event API, ensuring secure access and interaction with the event system.

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.

• Operations
• Queries
• Mutations
• Custom Queries

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.

• The Setting Schema is defined using JSON schema standards.
• It describes the structure of a setting rather than validating the content of a JSON file.
• Only a subset of JSON schema keywords is utilized to define the structure.

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.

• The OMX Web App Manifest document is essential for configuring Fluent Platform web apps and is stored in a setting following the convention "fc.mystique.manifest.<appname>". For instance, Fluent Commerce UIs have settings like "fc.mystique.manifest.oms" and "fc.mystique.manifest.store." 
• The document, configured in the ACCOUNT context, is a specific JSON structure that includes sections like App-Level Configuration, Route-Level Configuration, and Local Development Options. Each web app defined within an account has a unique URL, and the Manifest guides app development, covering aspects like navigation, screen layouts, data sources, and user actions. 
• Manifest updates can be done through Console/settings or directly via the API, with the ability to partition the document for manageability.

• Overview
• Prerequisites
• Installation
• Next Steps

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.

• For SSO to work, you need to establish a connection between your Corporate IdP and our vendor IdP. Once the relationship is established then your password policies and MFA configuration will be used during user authentication in Fluent.

• It is possible to use the generic SAML configuration to add an external identity provider that follows the SAML standard
• This page provides a guide on how to configure an external identity provider via SAML configuration.

• The UX Framework in the Fluent platform automatically checks for configured manifests in Account settings. If none exist, the Fluent web app defaults to loading using baseline manifests within the platform, ensuring a seamless and standardized user experience.
• To customize the main web app manifest or specific fragments, users should follow the naming convention, with the setting name for the main web app manifest file.
• It is recommended to override the main manifest only when adding or removing fragments; otherwise, users can efficiently modify specific fragments by overriding them individually.

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

• Corporate IdP
• Fluent IdP & API Users

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.  

• Typical tasks and activities involved in Ready for Launch
  • Configuration Analysis
  • Inventory Management Analysis
  • Workflow Analysis
  • Custom Plugin Analysis
  • Integration Analysis

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.

• The Kickoff stage covers the introduction to the Ready for Launch process and the initial project & solution overview.
• The Design Review stage covers a detailed presentation of the solution by the partner and the review of the implementation by Fluent Commerce.
• The Launch Gate stage covers the presentation of the final solution and performance test results as well as the confirmation of the desired launch date. After a final review, Fluent Commerce provides the production go-live approval.

• Often you might need to display JSON payload on the Admin Console
• You can use a mustache helper, or you can display individual values with deep references

• This guide is about displaying HTTP(S) links in Admin Console.
• This can be achieved through a Mystique configuration.
• Store a HTTP(S) link to a document e.g. packing slip as an attribute against an entity.
• Display the attribute as a clickable link in the Admin Console.

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

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

Carriers configuration contains:

• Carriers List page
• Carrier Details page

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

• The Admin section helps in managing users, retailers, settings, etc.
• It contains some or all of the following: Retailers, Carriers, Users, Roles and Permissions, and Settings.

• This guide will walk you through configuring the main sections of the Pack Wizard: Unpacked Items, Packed Items, Rejected Items, and the scanner, enabling you to tailor it to your specific requirements.
• The default configuration does not include a list of parcel types with predefined dimensions. It only displays basic details of the items being packed (such as image, product name, and reference) and allows users to select from four predefined reasons for rejecting items.

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

• Overview
• Severity Definitions
• Service Level - Response and Resolution
• Service Level - Availability
• Issue Submission Process

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

• Overview
• Severity Definitions
• Service Level - Response and Resolution
• Service Level - Availability
• Issue Submission Process

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

• Support Policy - Fluent OMS

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

• Support Policy - Fluent OMS

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.

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.

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)

• Usage of the Platform and all related Products are subject to the Platform limits, data limits and acceptable use policy set out or referred to in this document.
•  Read this together with your Agreement/Order Form relating to the Platform. 
• Platform limits (for each type of Account) apply in aggregate across all applicable Accounts referred to in your Order Form.  

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.

• Usage of the Platform and all related Products are subject to the Platform limits, data limits and acceptable use policy set out or referred to in this document.
• Read this together with your Agreement/Order Form relating to the Platform. 
• Platform limits (for each type of Account) apply in aggregate across all applicable Accounts referred to in your Order Form.  

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)

• Usage of the Platform and all related Products are subject to the Platform limits, data limits and acceptable use policy set out or referred to in this document.
•  Read this together with your Agreement/Order Form relating to the Platform. 
• Platform limits (for each type of Account) apply in aggregate across all applicable Accounts referred to in your Order Form.  

• User action capability is used to create a Refund against an Order. Order workflow should be extended to have a rule to capture appeasement requests and then process them by looking up the billing account of that customer and creating a credit memo of that refund amount. 
• It is possible to configure Appeasement functionality via UI and via Postman.

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

• The GraphQL request size is limited to 2MB
• There is no validation on any of the GraphQL fields (except for enums)
• The GraphQL query complexity is limited and checked in accordance with the Query Complexity Calculation Algorithm (11,111 Total Complexity is Max)

The Fluent Store Web App brings Order Management capabilities to the in-store experience, enabling Retailers to transform their existing Stores into fulfillment and distribution centers, optimizing costs and enhancing the customer experience.

Direct Inventory Updates are one of the two reference ways to send last-on-hand inventory updates into your inventory workflows. Direct Inventory Updates are best used when you have a small volume of inventory updates (maximum of 1000 updates).

Returns OMS configuration contains:

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

• Create a return in Fluent OMS
• View returns from all retailers associated with the logged-in user
• View detailed information about a return
• View detailed information about how a return was fulfilled

• The Pack Slips can be customized using an HTML template.
• This guide outlines the setup and fragment modifications required for generated PDF customization.

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.

• Store Associates can choose which fulfillment to pack next, optimizing the packing process based on operational needs.
• Fulfillments are organized into two tabs—Awaiting Pack and Packed Fulfillments—providing a clear overview of the packing stages.
• A badge displays the number of fulfillments awaiting packing, helping Associates manage their tasks efficiently.
• Store Associates can allocate items to specific parcels, add or remove parcels, set dimensions and weight, and reject items.
• The integrated barcode scanner speeds up the packing process by quickly and accurately identifying parcels and items.

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

• Provide a good understanding of the following topic:
  • Module Artifacts/Metadata
  • Rules
  • Workflows
  • Settings
  • Web App Manifests
  • Transactions
  • UI Components

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

• Stores are transformed into efficient fulfillment centers, ensuring a seamless customer experience through optimized order fulfillment and superior inventory control.
• With configurations for all Locations, Stores, Warehouses, and Networks, the app provides a comprehensive toolkit, enabling retailers to manage their entire ecosystem.

The Fluent Big Inventory Web App simplifies inventory management with key features like the Feeds Dashboard, Products, and Inventory sections. Gain real-time insights into feeds, efficiently manage products, and ensure robust inventory control. Whether tracking sources, managing stores, or accessing comprehensive insights, this app delivers a seamless user experience for optimal business value.

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.

• The Fluent Big Inventory Web App offers a comprehensive suite of functionality.
• With dedicated sections for Sources, Products, Inventory, Stores, Insights, and Admin, the web-based interface provides users with a holistic toolset, allowing them to observe and track integrated sources, manage product catalogues, exercise precise control over inventory, oversee individual and networked store locations, monitor system events comprehensively, and efficiently administer the entire inventory availability system for a seamless and valuable user experience.

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

• List of Deprecated Platform components: A detailed list of all the Platform components (from foundational services and frameworks to distinct products and features) that are currently in the deprecation phase, including their respective versions.
• End of Service Dates: Key dates post-deprecation, until which we will continue to offer limited support (such as security patches or critical fixes) for the component.
• End of Life Dates: Specific dates indicating when deprecated products/services will no longer be available or supported.
• Support and Transition Guidance 

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

• List of Deprecated Platform components: A detailed list of all the Platform components (from foundational services and frameworks to distinct products and features) that are currently in the deprecation phase, including their respective versions.
• End of Service Dates: Key dates post-deprecation, until which we will continue to offer limited support (such as security patches or critical fixes) for the component.
• End of Life Dates: Specific dates indicating when deprecated products/services will no longer be available or supported.
• Support and Transition Guidance 

Admin section helps in managing users, carriers, and retailers and contains the following configurations.

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.

• The reports provided enable a user to understand an account Inventory Position Update and Inventory Position Change usage for selected periods of time
• These usage metrics are split into two different reports so the user can analyze the metric that is most important

• Verify Compatibility: Ensure your existing account meets all prerequisites for enabling Fluent Store.
• Follow Step-by-Step Guide: Adhere to the provided instructions to enable Fluent Store on your account seamlessly.
• Utilize Support Resources: Refer to the official documentation and support channels for any issues or queries.

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

• Comprehensive Discovery: Ensure thorough gathering of business requirements and precise backlog generation to set a solid foundation for the project.
• Robust Testing: Conduct System Integration Testing (SIT), Performance Testing, and User Acceptance Testing (UAT) to validate all aspects of the solution.
• Client Involvement: Engage clients early, especially before UAT, to familiarize them with the user interfaces and gather their feedback.
• Successful Launch: Execute a meticulous production deployment, including data staging and validation testing, to ensure a smooth 'go live' transition.

The customer Collections feature is applicable to the Click and Collect fulfilments. This feature enables the store users to confirm the orders collected by customers in-store.

This guide is designed to help you implement the enhanced

`attributes`

`attributes`

• Flexible Attribute Structure: The

  `attributes`

  object supports any combination of key-value pairs, including complex JSON structures and arrays. This flexibility allows you to customize the data sent in your inventory payloads to meet specific business needs.
• Recommended Attributes: Certain key attributes, such as

  `expectedOn`

  ,

  `storageAreaRef`

  , and

  `condition`

  , are automatically integrated into our platform’s workflows. These fields will be directly updated in the inventory quantity associated with the incoming record, facilitating seamless integration with existing fields.
• Custom Attribute Availability: Any custom attributes that you include in the

  `attributes`

  object will be available in workflows via

  `inventoryPosition.inventoryQuantity.attributes.<fieldname>`

  . This enables you to incorporate custom data into rule-based processes or other logic tailored to your business requirements.
• ISO 8601 Date Format: For any date-related attributes, it is recommended to use the ISO 8601 format (e.g.,

  `YYYY-MM-DDTHH:MM:SSZ`

  ) to ensure consistency and proper handling within the system.
• Integration with Workflows: The system is designed to handle both recommended and custom attributes, making them accessible within the workflow context. This ensures that you can leverage these attributes in custom rules and other logic, depending on the specific needs of your implementation.
• Extensibility: While the table of recommended attributes provides a useful starting point, you are encouraged to extend the

  `attributes`

  object with any additional fields relevant to your business processes. The flexibility of this structure allows for robust customization.

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

• Key features of Fluent Store
• Benefits to Retailers
• Module dependencies
• Technical Information (Browser, Device, and Language support)
• Data model
• Further Reading

• This guide covers setting up a fresh new Adobe Connector in the below-required systems:
  •  Fluent OMS information details (account credentials, client secret, etc.)
  • Adobe Commerce
• This guide does not cover:
  • The standard setup of Fluent OMS, this guide is explicitly for the Fluent Adobe Connector configuration.
  • Detail on how to migrate an existing Adobe Commerce to use Fluent OMS.
• Please get in touch with Fluent Expert Services for guidance on any migration.

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.

• The Mystique manifest configures icons, cards, and template strings. Icons come from React Icons. 
• Cards have common fields, and template strings allow dynamic values. Dynamic attributes (standard, image, component) offer flexibility based on conditions. 
• Additional options like TextOptions and ImageOptions provide styling choices.

• This guide shows you how to seamlessly switch Retailers within the Fluent Order Management System web app.
• This guide is aimed at multi-retailer Admin users.

• Understanding the default Order and Fulfilment Types
• Users with SETTING_VIEW, SETTING_CREATE, and SETTING_UPDATE permissions can add new order and fulfilment types to Fluent Store.
• A guide to add a new Order Type to customise the Fluent Store
• A guide to adding a new Fulfilment Type to customise the Fluent Store

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!

• There are several channels to reach out to get help, such as the community #partner_support slack channel, our support ticket system, or via email, depending on the help you need.
• To get help quickly, reach out via the appropriate channel and supply as much context as possible.

•  OOTB, the create wave button on Fluent Store will always be displayed whether there are pending fulfilments or not.
• It’s possible to only display the button when there are pending waves when a condition is added.

Developers can add new components to OMX via the registries.

There are three available:

• Component Registry - for standard in-page components
• Field Registry - for interactive form field components
• Template Registry - for adding new template helpers

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

• The following topic covered when comes to designing workflows:
  • Workflow Boundaries
  • Workflow Patterns
  • Flow Control
  • Cross-Retailer
  • Cross-Workflow
  • Workflow Versioning
  • Defining Rulesets
  • Workflow Settings

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.

• A webhook is a way for Orchestrated Workflow Logic to call back to an external application.
• Fluent Commerce provides some standard webhooks as Rules within the Rule Library for common third-party integrations.
• Since the payload and HTTP request cannot be customised, it is rarely necessary to implement a custom rule to send a webhook

• It’s possible to add settings to a workflow via Json in order to improve the performance and the functionality of the workflow.

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

• Explore the Workflow Settings available

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

• Overview
• Severity Definitions
• Service Level - Response and Resolution
• Service Level - Availability
• Issue Submission Process

A topic on how to run Inventory batches in the OMS. 

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 Fluent Web app's Inventory module offers a comprehensive suite of capabilities, including inventory visibility, allocation, total stock quantity (stock on hand), inventory status, available-to-promise levels, and strategically implemented buffers to prevent product overselling.
• The module is equipped with various configurations, such as Inventory Catalogues, Control Groups, Virtual Catalogues, Cross-Catalogue Views, and Location Inventory Views, providing users with versatile tools to tailor their inventory management approach according to specific business needs and scenarios.

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.

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

• Inventory Feeds will export a view of inventory data from the Fluent platform into a Customer environment
• The schedule of the export is configurable based on the Customer requirements
• The exported data is ready to be synced with any further systems within a Customer ecosystem to provide real time inventory availability

List of Fluent Commerce sub-processors.

• The list below contains sub-processors for Fluent Commerce's generally available products and services
• This list is effective as of 15 February 2022

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.

• Available to Sell (ATS) is the quantity of inventory that is immediately available in stock and can be sold to customers. It is usually calculated based on the stock on hand and safety stock buffers.  
• Available-to-Promise (ATP) is the quantity of a product that a company can promise to deliver to customers by a specific date based on the current inventory levels, incoming inventory, production schedules, and outstanding orders.

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 document describes the best practice for onboarding and offboarding users.

• A common practice on how to manage SSO user for the following process:  
  • User Onboarding
  • User Off-boarding

• A new Workflow creation requires the correct permissions for the user, and a valid workflow JSON file (schema,

  `entityType`

  and statuses/rulesets).

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

• For security purposes, Fluent Commerce cryptographically signs each webhook request with a private key before sending it to the target endpoint.
• Every webhook request from Fluent contains two custom headers

  `flex.signature`

  (MD5withRSA) and

  `fluent-signature`

  (SHA512withRSA). 
• You can use standard cryptography (e.g. in Node) or built-in Java functions to verify webhook calls.

• After following this guide a user will be able to create a new Inventory Feed
• The output from this feed can be used to supply inventory availability data to any system
• Additional steps will outline optional configuration that can be applied to Inventory Feeds

• A step-by-step guide on how to add a custom help menu to the header to serve as inspiration for other custom components that can be added

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.

• Core components are highly extensible through configuration; check if your requirements can be met by updating the manifest or component properties (props in the configuration).

• `DynamicAttribute`

  values in core components allow for the creation of small, specialized sub-components that enhance functionality.
• Wrapper components can be used to modify existing components' props or styles, enabling more complex customizations beyond basic configurations.
• Context components can override default data handling by performing additional queries, but be cautious as this can impact performance.

The UX framework provides some "component primitives" that can be used to build more complex components on top. The advantage of this is that these utility components:

• provide a consistent look and feel
• update according to theme options
• enable mobile responsiveness

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.

• Foundation Components, such as Page Components which form the base of a screen
• Content Components for displaying data and media
• Layout Components for structuring pages
• Interaction Components for capturing user input, and 
• Field Components which are automatically rendered in User Action forms.

• It’s possible to enhance Service Point to show order items from the current order on the collection screen.
• This can be achieved by adding a specific setting and making sure that the user’s role has the appropriate permissions.

• step-by-step guide on how to install modules into your OMS sandbox

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.

• IDs are generated by the Fluent platform and are guaranteed to be unique at the time of creation. 
• Refs are typically values passed in via third-party integrations and should represent the IDs from external systems.
• Despite the system not enforcing the uniqueness of refs, it is highly recommended to have unique refs for all entities. Every ref should be unique within it's nearest container, for example Retailer refs need to be unique across all . Catalogue or Account.
• If your refs are not unique then there are API's that will not work as expected. This means that our reference modules may not work as expected if you set ref's as non-unique values.

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.

• Component SDK provides a collection of React hooks to allow custom components to access the core UX framework functionality.
• The useAuth can access user session information.
• The useEnv can access the current environment details.
• The useI18n can access the global language to translate static labels
• The useSetting / getSettings can access the current account setting values.
• The useQuery/getQuery and useRest/getRest to retrieve data from OMS.
• The useData hook provides direct access to the page query response and variables.

A best practice guide of creating customer entity.

• A user guide on how to manage customer entities in OMS.
• Best practice guide on creating Customer entity in OMS before the createOrder mutation.
• Relationship between user entity and customer entity.

• Settings Template

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.

• Handler Prioritization: Customize execution order by assigning priorities during startup.
• Message Handling Protocols: Follow specific rules for retries, dead letter queue forwarding, and managing multiple items within a message.
• Implementation Guidelines: Adhere to guidelines, use annotations like @HandlerInfo and @Component, and configure routes. Extensibility is seen in job handlers, configuration handlers, and product availability enrichments.
• Receiving External Messages: Support diverse methods, including HTTP requests with authentication filters and external listeners like SQS and Kafka. Custom controllers enhance authentication through the SDK's security module.

• Predefined Filters: Provide a way to access commonly used search parameters with a single click, enhancing the user experience.
• User Efficiency: Predefined filters are designed to save time and streamline workflows.
• Customization: Users may have the ability to create and save their own filters for recurrent use (via manual Manifest changing).
• Consistency: Predefined filters ensure that the same criteria are used for searching, leading to consistent results.
• Learning Curve: New users can quickly become proficient in finding the information they need due to the intuitive nature of predefined filters.
• Integration: These features should seamlessly integrate with the user interface for maximum effectiveness.

Fluent Commerce is a flexible platform with two core components: the UX component for rendering UI and the Workflow Framework responsible for order processes. The platform comes with a range of SDKs for custom development and a set of reference modules.

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.  

• Code-free configuration through the Manifest document.
• Dynamic user management experience.
• Configurable left-navigation menu items.
• Dynamic views, labels, and fields based on configuration and GraphQL queries.
• Dynamic and contextual user actions based on workflow configuration.
• Create and edit all entities, including non-workflow entities.
• Customise UIs to meet specific business needs and processes.
• Configure contextual actions based on roles and process states.

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

• Provides an overview of Store Waves, including orders awaiting pick, in-progress orders, and completed waves.
• Configurable dashboard tiles and tabs for real-time store performance and bottleneck visibility.
• Supports configuring Pick & Pack SLAs, collection reminders, and exception management.

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

• Key Features on how to configure the Pick Screen
• Lis of common Use Cases
• Template Configuration details

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

• Ensure Wave Dispatch User Action is configured in the Location Store Workflow.
• Utilize Wizard Page components from the Component Library.
• Activate Pack screen when Wave is in PACK state.

• Understanding the Market: Recognizing the importance of Cash on Delivery (CoD) in markets like India, where it is a preferred payment method.
• Global Adaptability: The workflow's design serves a global audience, providing a template that can be customised for regions where upfront payment is not the norm.
• Seamless Integration: Ensuring the CoD process is smoothly incorporated into the existing order journey to enhance customer experience.
• Operational Efficiency: Streamlining the CoD transaction to ensure quick and secure payment collection at the point of delivery.

General Principles and the Features of the SDK

• General Principles
• Features of the SDK
• Developer setup

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.  

• Dynamic user management experience.
• Configurable left-navigation menu items.
• Dynamic views, labels, and fields based on configuration and GraphQL queries.
• Dynamic and contextual user actions based on workflow configuration.
• Ability to create and edit all entities, including non-workflow entities.
• Customise UIs to meet specific business needs and processes.
• Ability to configure contextual actions based on roles and process states.
• Enables centralised management of orders, products, inventory, fulfillments, and locations.

• Using Chrome developer tools and IDEA Webstorm to debug Fluent component SDK
• This article will only work for Chrome desktop browser

Getting Started Guide for Component SDK

• Download the Component SDK
• Developer setup requirement
• Component SDK Unit testing example

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.

• A step-by-step guide to enable reference return functionality.
  • Settings setup
  • Create & Assign the Instore Return Role
  • Workflow Configuration (Order, returnOrder and Billing)
  • Manifest Changes for Fluent Store and Fluent OMS

• To enable cancelling orders via the UI the cancel order ruleset needs to be used
• Update the mystique manifest to show the list action.

• Order Revision implementation can be done either from the UI or via Postman.
• This implementation requires workflow changes and adding a few specific settings. The detailed process is covered in this article.

• Order Revision User Guide

• step by step to teach you how to add order attribute values into the PACK screen in STORE APP
• the byName function will allow OMS to display the specific attribute value on the UI.

• Address Validation: Ensure that the address entered by the user is valid and correctly formatted to avoid shipping issues.
• Default Address: Allow customers to set a default address for a quicker checkout process.
• Edit Capability: Provide an option for users to edit customer address details in case of errors or changes.
• User Experience: Design the add and edit address process to be user-friendly and accessible, with clear instructions and error messages.

• Quick Search Functionality: Enables users to find information rapidly by typing keywords or phrases.
• User Efficiency: Quick search is designed to save time and streamline workflows.
• Learning Curve: New users can quickly become proficient in finding the information they need due to the intuitive nature of quick search.
• Integration: These features should seamlessly integrate with the user interface for maximum effectiveness.

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.

• Extend Knowledge Content does not form part of the Fluent Order Management Platform or its Documentation.
• Extend Knowledge Content showcases the ‘art of the possible’ when using the Fluent Order Management Platform’s many extensibility features and tools to enable a range of use cases that cannot otherwise be met using the standard capabilities of the Fluent Order Management Platform.
• Use of the Extend Knowledge Content is governed by the Extend Knowledge Terms and Conditions.

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.

• Retries & Exponential Back-offs

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.

• Overview
• Operations
• Models

• Extend the Order Module schema
• Modify the Rule for Return Order creation and the Order Workflow Return Order Ruleset
• Update the Order Management Manifest

• This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
• This idea/solution will provide a new feature where the Store User can take a photo of the returning item and attach it as part of the returnOrder entity.
• The source code will not be provided in this article.

• This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
• This idea/solution will provide a new feature where the Store User can enter the rejection reason code during the Pick Confirm Process.
• This feature allows specifying the rejection reason for fulfillment on the picking step of wave processing. The user can select the rejection reason code when the picked item list is confirmed as the first step of wave processing.

• This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
• This idea/solution will provide a new feature where the Store User can enter the rejection reason code during the Pick Confirm Process.
• This feature allows customer service to reroute an existing

  `fulfilment`

  to a specific location that can fulfill the order.

• This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
• This idea/solution will provide an extended new feature where the Store User can validate the Customer ID during the Customer Collection Process.
• New custom UI components and rules are needed to capture the user input and confirm the selected articles in the UI user Action screen.  Then, the store/business can track and trace the proof of the shopper's collection.
• Due to security reasons, the shopper's sensitive personal information should not be stored within Fluent OMS. Therefore, the proof of collection should be stored at a third-party storage.

• This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
• This idea/solution will provide an extended new feature where the Store User can update the Store inventory through the UI to ensure the OMS has the most accurate product inventory.
• New custom UI component and rules to capture the user input in the UI user Action screen. Then, the backend will create a new Inventory Quantity entity and update the Inventory Position and the downstream workflow.

• Comprehensive Data Entry: Ensure that all necessary customer information is captured accurately to create a complete profile. This includes personal details, contact information, and any specific requirements or preferences.
• Validation and Verification: Implement validation checks to prevent errors during the data entry process. Verify that mandatory fields are not left blank.
• User Experience: Design the customer creation process to be user-friendly. Provide clear instructions and feedback during the process to enhance the user's experience and minimize the likelihood of errors.

• Data Modification: Ensure that users can modify customer data, including the ability to correct typos in existing information.
• Error Handling: Implement error handling procedures in case the edit fails or invalid data is submitted.
• User Experience: Aim for a seamless and intuitive editing process to minimize the risk of user errors.

• Properties of CUSTOM_PICK_LIST_SORT_CONFIG Setting

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.

• Overview
• Network Properties
• What you can do with Network
• Response on Failures

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

• Return Transaction Properties
• What you can do with Transaction
• Response on Failures

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

• Order Transaction Properties
• What you can do with Order Transaction
• Response on Failures

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.

• Setting Properties
• What you can do with the Settings API
• Response on Failures

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.

• SKU Properties
• What you can do with SKU
• Response on Failures

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.

• Order API is used to create an order in the system. 
• Customer and Products information should be available.
• Order details like, order items, transaction details, fulfilment choice, customer and delivery information are all required to create an order.

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.

• A product can have multiple SKUs associated with it and will have one or more categories associated.
• The properties available in the Product entity which can be updated and retrieved through the APIs.

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.

• Order Item Properties
• What you can do with Order Item
• Response on Failures

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.

• Overview
• Operations
• Models

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.

• Overview
• Inventory Batch Properties
• What you can do with Inventory Batch
• Response on Failures

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

• Fulfillment Options Properties
• What you can do with Fulfillment Options
• FulfilmentOptions.FulfilmentOptionsAddress
• InventoryPosition.ProposedFulfilment.Item
• Attribute
• FulfilmentOptions.UnfulfilledItem
• FulfilmemntPlan
• FulfilmentPlan.Fulfilment
• FulfilmentPlan.Fulfilment.FulfilmentItem
• Exception
• Response on Failures

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.

• Fulfilment Properties
• What you can do with Fulfilment
• Response on Failures

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.

• Consignment Properties
• What you can do with Consignment
• Response on Failures

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.

• Comment Properties
• What you can do with Comment
• Response on Failures

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

• Category Batch Properties
• What you can do with the Category Batch API
• Respose on Failures

• Step-by-step configuration guide to enable Returns functionality in ServicePoint.
• The configurations include the following:
  • User Role assignments
  • Settings
  • workflows

• A Client Business Requirement:
  • The returnOrder created by Store Staff must require a Manager’s Approval
  • 2-step process to ensure the customer is refunding the right products/amount. This is done through workflow and roles/permissions modifications.

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.

• The properties are available in the Return object
• This Return object can be updated and retrieved through the API

• Drawers can be added in any mystique components by modifying the mystique manifest.
• The drawer’s custom data source can be defined via queries and variables.

• A setting can be added or modified directly via UI.
• A new setting requires its name, context, the identifier of the context, the value, and the value type.

• A Workflow can be updated as long as the user has the right permissions.
• A Workflow can be updated via the IMPORT/EXPORT button or via API.

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.

• Connect SDK helps partners and customers quickly start building ad hoc connectors with consistency, better security, and short implementation time.
• A deployed Connect SDK-based integration simplifies middleware setup and support 
• It offers incredible flexibility in building synchronous and asynchronous endpoints with a common credential, logging, and configuration interface
• In regards to hosting responsibility, any connector built using Connect SDK is cloud-agnostic, and the integration layer is still owned and maintained by the solution integrator, becoming part of the project codebase.

• The Connector SDK generates a blank Maven starting project for your custom integrations.

The Rules SDK is a Java based software development kit, which provides Java developers with a toolkit for creating custom Rules for the Fluent OMX Workflow Framework.

The Workflow Framework is a highly configurable and extendable part of the Fluent OMX Platform, which facilitates orchestration of business logic for the Fluent Order Management System.

• A step-by-step guide to deploy your custom Rules Plugin and run the project.
• A fully setup and functioning Fluent Account is required.
• An API User with the 

  `DEVELOPER`

   role (Note: If using a Training Account, the Account Admin already has this role applied)

• A step-by-Step guide to creating your first custom Rule to log "Hello World"

• A step-by-step guide to creating Rule SDK Plugin Project.
• The Rules SDK comes with a Maven Archetype for generating a new Rules Plugin Project, and a handy script file to run the project generation steps.
• A fully setup and functioning Fluent Account is required as of this activity.

• Step-by-step guide to setup Rule SDK in your local Environment. 

Retrieve an order by

`id`

• Sample query on how to use flags as part of the query parameter

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

• Sample GraphQL query that extracts inventory position, variant product, virtual position and virtual aggregate position. 

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

• Query sample on extract virtual position by updatedOn

Sample Product Queries that can be used on a daily basis

• Sample Queries on the following:
  • Variant Product (SKU) by Reference
  • Variant Product (SKU) by Details
  • Variant Products (SKU)

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

• An actual example of a GraphQL query on the following:
  • Inventory Position by Details
  • Inventory Position by Reference
  • Inventory Positions
  • Inventory Quantity Updated

The GraphQL Plugin for IntelliJ provides useful features for working with GraphQL:

• Schema Introspection
• Auto-complete
• Syntax highlighting and validation
• Query and Mutation execution

• Collection of GraphQL samples handy for accessing Fluent OMS

The 

`run`

• Rules are the smallest building block for logic, it is important to remember that this method should be implemented to perform 1 simple task
• You may not need all of these steps within your Rule. Some rules produce an action without a condition. Some rules do not need to query additional data. Make sure your Rule is as lean as possible, and simple to read.
• The Rubix Plugin SDK provides a useful Util class to facilitate validation: RuleUtils
• You can retrieve the data by using Context / Entity
• Typically, a Rule will produce an output action.

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

• As per standard industry practices, rules should be tested as part of the development cycle, on the developer's local machine.
• Testing on Sandbox after local testing has been completed.

• the best approaches to debugging your custom rules and plugins
• Debugging locally in your IDE can be done as per standard Java practice while running rules in Unit Tests or with the TestExecutor.
• Debugging on Sandbox - The primary mechanism for debugging on a deployed environment is by activity tracking or Orchestration Audit Events. You can easily query these for any context via the Event API, or the Admin Console.

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.

• There are 4 types of Actions available to produce from a Rule:

  • `SendEventAction`

  • `MutateAction`

  • `WebhookAction`

  • `LogAction`

Accessing the Workflow Builder

• The Workflow Builder UI is accessible through the Admin Console (not available on Fluent OMS).
•  In order to add or edit an existing WF from the UI, you would need to have the right permissions. 

This section provides Rules SDK reference and guidelines for Writing Rules.

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)

• Examples of how to display date time format in both OMS webapp and Admin Console

• Open Postman, click Import, then choose "Upload Files" in the dialog box.
• Upload the GraphQL SDL File named

  `fluent-graphql.graphql`

  .
• Confirm settings, including "Include deprecated fields," and click Import; a success message confirms installation in the APIs tab.

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.

• Fluent Big Inventory Capability and Features include:
  • Fluent Big Inventory Web App
  • Intelligent Inventory Processing
  • Enterprise Inventory Availability
  • Available to Promise Data

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.

• Included Services and Frameworks:
  • Orchestration Engine, APIs, Logging, SSO, Cloud Infrastructure
  • Workflow, UX and Connect Frameworks 

• The Fluent Big Inventory Web app is pre-configured with certain standard functions. 
• The IPU and IPC reports functionality is not a part of the default configuration. 
• This guide will enable users to configure the web app to display the IPU/IPC reports.

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.

• Fulfilment Options entity retrieves and identifies the Fulfillment option for the proposed order. A Fulfilment Options call returns multiple plans for how an order might be fulfilled, such as ETA and pricing information. 
• Fulfilment Plan entity identifies the strategy to be used to fulfil an order. A fulfilment plan may identify multiple fulfillments to complete an order.

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.

• Cloud-native, high availability, scale-on-demand workflow execution.
• Pre-built, customizable workflows delivering capabilities across each of the Fluent App domains.
• Rich Rule Library containing reusable rules across each of the Fluent Apps.
• Software Development Kit (SDK) and Developer Tooling, enabling the implementation of custom rules and integrations.
• Business Tools to manage, configure, and implement workflow and process automation.

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

• Configuration of user interfaces via the UI Builder
• Configuration of workflows Workflow Builder
• Configuration of system integrations via Connector Builder
• Custom Rules (workflows), UI features, and integration are also possible via Rules SDK, Components SDK, and Connect SDK.

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.

• Connect Framework: Connector Builder, Connector Library, and Integrations Guidelines
• Configuration of system integrations via the Connector Builder.
• Custom integrations are achieved via Connect SDK.

• This guide explains how to enable Store Associates to select Fulfillments to add to a Wave in Fluent Store. 
• Once this capability is enabled in Fluent Store, Store Associates can filter and select Fulfilments (including by custom attributes) to be added to a new Wave.
• This guide will require knowledge of how to configure your manifest and workflow. If you wish to extend this functionality even further, you'll need to be able to compose rules.

• Inventory Feed runs can be individually tracked for their status and data about the run
• A user will know how to analyse Inventory Feed Runs from this guide

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.

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.

• Fluent Big Inventory is made up of multiple services
  • Intelligent Inventory Processing
  • Enterprise Inventory Availability
  • Available to Promise Data
• Each service includes a range of features detailed below

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.

• Feature Benefits: Utilize colourful dots to easily identify and prioritize different statuses.
• Status Color Palette: Use recommended hex codes to customize dot colours for optimal status indication.
• Configuration Guide: Follow step-by-step instructions to implement coloured status dots in your system. notify and prioritize different statuses.
• Default Settings: The system defaults to a grey colour for statuses that are not configured, ensuring consistency across various status indicators.
• Customization: Hex codes allow for full customization of dot colours to match your company's branding or to signify specific statuses.
• Visual Prioritization: Assign colours to statuses based on the level of urgency or importance, aiding in quick decision-making.
• Colour System Best Practices: Refer to the detailed best practices in the Colour section to effectively apply theming and enhance user experience.

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.

• How it Works
• Workflow Engine Architecture
• Workflow Builder
• Rules SDK
• Key Concepts of the Workflow Engine

• Quick Example of how to use GraphQL mutation

  `removeUserRolesFromUser`

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

• Settings are leveraged to enable/disable specific features in the platform.   
• Settings are set in a specific context (Account, Retailer, Location/Agent).

Fluent Store's configurable dashboard displays key information about orders and fulfilment and their statuses. It helps in-store staff monitor orders waiting for pick-up and plan the pick-and-pack process, and also provides visibility to retail managers, allowing analysis of performance at a store level. Tiles display fulfilment quantities and their statuses.  For example, a tile may display the total count of fulfilments in 'Awaiting Pick' status (Orders Awaiting Pick) for one day (or more) at a specific location. Tiles are clickable, navigating to a separate page showing data for that tile.

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.

• Layout
• Fulfilment Details page

• Local development uses localstack to emulate AWS services
• AWS CLI Configuration is optional
• IntelliJ and Eclipse / STS  Setup in local environment

• Fulfilment Options page
• Further Reading

• Fulfilment Options page
• Further Reading

createFinancialTransaction GraphQL mutation Example

• createFinancialTransaction GraphQL mutation Example

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.

• `Type`

  : Understand the different types of users; ADMIN, RETAILER, API, and AGENT
• User Status: Be aware of the user status options, ACTIVE and INACTIVE, which reflect the user's current accessibility.
• Filtering Users: Utilize the filter component to efficiently search for users based on various criteria like username, status, creation date, and type.
• Roles and Permissions: Assign roles to users to manage permissions within the system, ensuring each user has the appropriate level of access.
• Paging Control: Utilize the paging controls at the bottom of the Users table to navigate between pages and manage the number of entries displayed per page, with options for 10, 25, or 100 entries.
• Deprecation Notice: Be aware that certain user types such as AGENT, SUPPORT, and others have been deprecated and should not be used for new users.

• When creating or editing roles, ensure to define permissions accurately to maintain system security.
• Follow the best practices for naming conventions and role descriptions for easier management and clarity.
• Test role changes in a controlled environment before applying them to the live system to avoid unintended access issues.

Every GraphQL operation is currently protected by Permissions. 

• Permissions Naming Convention: Queries and mutations are governed by permissions named after the entity and operation type, such as ENTITY_VIEW or ENTITY_CREATE.
• Nested and Partial Mutations: Nested mutations require separate permissions, and partial mutations are not permitted—if one fails, the entire operation fails.
• Plugin Management: Access to plugin management is controlled through specific Plugin Permissions.
• Error Handling: Operations attempted without proper permissions will result in an error code (C0020E) and require contacting support to resolve permission issues.

This page describes how Event Execution works.

• When an Orchestration Event is received by the Rubix Orchestration Engine, it initiates the Execution Context. The Execution Context includes the event and the entity specified by the event.
• Rubix will locate the Ruleset within the workflow that matches the signature of the event.

• This guide shows you how to seamlessly switch Store Locations within the Fluent Store web app
• This guide is aimed at In-Store users

• Location context switcher allows you to switch the location without having to log off and back in with the specific credentials. This is feasible as long as the user permissions are configured accordingly. 
• The context switcher requires a few manifest modifications, which are detailed in the article below. 

•  A typical scenario where the EAN 13 barcode (e.g.,

  `0123456789123`

  ) and sometimes the barcode on the physical product might not include the leading 0. So when the product gets scanned, it will return

  `123456789123`

  rather than

  `0123456789123`

  , and the Pick screen will not be able to find the product from the pick list.
• We can utilize product attributes to include possible barcodes and to include fields.

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.

• Benefits
• Video Overview
• Key Features
• Further Reading

• Login into Fluent Web Apps
• Multi-Factor Authentication
• Session Timeout

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.

• Adaptability: The process is responsive, ensuring a seamless experience on screens of varying sizes. Customization options are available through UI configuration or creating new components.
• Process Stages: The wave process involves creating a wave, picking order items, packing them, and booking carriers.Prioritization logic is applied based on factors such as expiration dates, order types, or delivery types.
• Efficient Picking: Picking orders is initiated by creating a wave, followed by selecting orders and using a user-friendly PICK component.Confirmation of picked items involves a final review, confirmation, and automatic rejection of unpicked items.
• Completion Process: The wave-picking process leads to the completion of fulfilling online orders in-store, providing a streamlined approach to order fulfillment.

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

• Federated IdP data storage

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.

• An identity provider (IdP) is a service that stores and manages digital identities
• 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.

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.

• providing a guideline of designing your Rule within Fluent
• It is important to keep the best practices and design principles in mind when designing your rules.
• understand types of analogies when come to building rules

• A step-by-step guide to update your plugin Project for SDK 17+

Roles & Permissions configuration contains:

• Roles & permissions page
• Role Details page

• Roles & permissions page
• Role Details page

Don't hesitate to reach out if you feel stuck or are unsure what best practices apply for your setup. 

• Converting JSON Introspection to SDL allows for a human-readable format of GraphQL schema, which is essential for documentation and understanding the API structure.
• Tools such as GraphQL Voyager and Apollo Studio can automate the conversion process, providing a visual representation and SDL output without manual coding.
• Understanding the structure of the introspection query result is crucial for manually converting the JSON to SDL, should automated tools not be available or suitable.

• Prerequisites
• Steps to Follow

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.

• Mutations in GraphQL are used for creating, updating, or deleting data, and are crucial for any operation that changes server-side information.
• Create mutations always generate data with a "CREATED" status, which can trigger orchestration events for workflow processes.
• Update mutations require mandatory parameters to uniquely identify and modify existing data entries.

• It is possible to use the generic SAML configuration to add an external identity provider that follows the SAML standard. 
• Steps to configure an external identity provider via SAML configuration

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

• GraphQL Error Code Format
• GraphQL Client Error Codes
• GraphQL Server Error Codes

• The article offers a step-by-step configuration for setting up Fluent OMS session timeout specifically tailored for Single Sign-On (SSO) users.
• It focuses on configuring session timeout within Fluent OMS while utilizing Azure as the external Identity Provider (IDP).

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 migration plan outlines a methodical approach to incorporate Single Sign-On (SSO) functionality into Fluent OMS, addressing pre-cutover tasks including environment setup, user data validation, and partner collaboration for IDP integration.
• During the cutover phase, the strategy emphasizes executing user migration, activating SSO, and conducting rigorous testing to validate system integrity, ensuring a seamless transition for users to the enhanced Fluent OMS experience.

• Configure Fluent OMS session timeout for SSO users with external IDPs (Okta)

• To aid with the picking process, Users can download a printable pick list that details the items required to complete the outstanding fulfilments. Customisable via a setting, the custom pick list allows developers to define their own fields and layouts to create a more efficient picking process.
• Enabling the Custom Pick List

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.

• The Insights module is a comprehensive repository providing full information about system Events, representing occurrences and triggers that prompt actions or log activities within the Fluent Platform.
• With a user-friendly configuration, the module enables efficient interaction through the Events Search Form, providing filtered event searches and responsive Events Search Results. The Event Details Drawer ensures users can seamlessly access detailed event information without losing search results or experiencing delays in page navigation.

• Detect Inventory problems or anomalies with the Total Failures card on the Sources Dashboard.
• Identify the specific failure events with advanced filtering on the Events page. 
• Understand the what, where, and why of the event failure by using the Event Details Drawer.

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.

• Fluent Commerce uses a multi-tenant architecture with microservices for order management and resource pooling. 
• The architecture is managed at two tiers: Application Services and Databases, with deployment across multiple availability zones for reliability and scalability. 
• Databases are deployed in a Multi-Availability Zone, with a hot standby for each database. 
• Fluent Commerce uses a "Blue-Green" deployment methodology, with automatic checks and rollbacks during deployments.

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.

• Common Authentication Token: Both Platform REST and Domain GraphQL APIs utilize a shared authentication token, ensuring a unified authentication approach.
• Platform REST APIs: Various Platform-level APIs, including Event, Workflow, Job, Plugin, and User Action APIs, are implemented in REST format with version 4.1.
• GraphQL API Advantages: The actively supported GraphQL API offers significant benefits over REST, while deprecated Domain-based REST APIs are in maintenance mode for existing clients, with documentation available for reference.

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

• Mystique Components
• Add/Edit Entities
• Configure Dynamic UIs
• Configure Search or Listing Pages
• Configure Detail Pages
• Add Attributes to Mystique Components

An Event represents something that has, will, or is happening within the system.

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.

• Mustache.js Templating: The UX framework utilizes mustache.js for templating, which automatically escapes HTML characters. This is important for preventing XSS (Cross-Site Scripting) attacks and ensuring data is displayed as intended.
• Unescaping Variables: To display special characters properly, such as ampersands, you must unescape variables using triple mustaches, e.g.,

  `{{{variable}}}`

  , or the

  `&`

  symbol in the variable tag, e.g.,

  `{{&variable}}`

  .
• Correct Display of Values: Escaping or unescaping variables correctly is crucial for the accurate representation of data within the UX. This ensures that special characters are rendered as intended, maintaining the integrity of the information displayed to users.