Docs

Search

Help & Feedback

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Platform

APIs (GraphQL, Core, Authentication, Event, and Batch), Legal Resources, SLAs, Platform Limits, Cloud Architecture, Environments, Entities, Objects, and Attributes.

Beta Materials Terms and Conditions (v1.0)

Essential knowledgeThese Beta Materials terms and conditions supplement your current agreement with Fluent Commerce and govern all ‘beta’, ‘innovation or innovation lab‘, ‘experimental’, ‘preview’ and any other ‘early’ features, including platform-based or downloadable data, software, documentation or other materials.

Read these T&Cs before using any Beta Materials. Do not use if you don't agree. Obtain authorisation from your company as needed.
Beta Materials are provided on an "as-is" basis for experimentation and feedback and use is at your own risk.
We may modify or remove access to or ask you to cease using Beta Materials at any time without notice and at our discretion.

Overview of Data Subject Removal API

Essential knowledge

The Fluent Commerce platform supports GDPR's Right To Forget in regard to a customer's PII data
Users can submit Data Subject Removal requests to anonymize entities stored in Fluent platform containing a customer's data with the GraphQL API
This documents provides an overview of the Data Subject Removal process and GraphQL capabilities

The Data Subject Removal API supports GDPR compliance by anonymizing customer PII data stored in the Fluent Commerce platform.
An asynchronous, event-driven pipeline ensures scalable and fault-tolerant processing of anonymization requests.
The API allows bulk requests, with individual items progressing through statuses such as CREATED, PENDING, RUNNING, COMPLETED, and FAILED.
GraphQL permissions are required for creating and viewing Data Subject Removal requests, ensuring secure access.

Webhooks Frequently Asked Questions

Essential knowledgeThis page contains frequently asked questions about Fluent Webhooks. Due to the nature of being a cloud-hosted application, there are some restrictions in place regarding IP Whitelisting and Authentication that frequently come up.

Static IP Whitelisting: Fluent Commerce's cloud setup doesn't allow for static IP whitelisting due to the potential for IP address changes caused by scaling or architectural adjustments, as well as AWS or GCP's own IP address alterations.
Authentication Measures: Instead of relying on IP Access Control Lists, Fluent Commerce employs strong authentication measures for webhook requests, including cryptographic signing with a private key and verification using a public key to ensure the request's legitimacy and integrity.
IP-Based Restrictions: Implementing IP-based restrictions, such as whitelisting or IP ranges, is not recommended due to the dynamic nature of IP addresses in the cloud setup, which can lead to high exposure levels and difficulty in implementation.
Alternative Approaches for Access Control: Instead of IP-based restrictions, companies can utilize firewall/networking equipment or reverse proxies to restrict access based on incoming HTTP request details, or configure unique, specific static URLs for incoming traffic to filter and accept connections securely.

Migrating from a multi-tenant to single-tenant environment

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

What are Fluent OMS Entities? (Entity)

Essential knowledgeA 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.
Entities have types and subtypes, types are rigidly defined, subtypes are more flexible.

Connect SDK - Frequently Asked Questions

Essential knowledgeFrequently Asked Questions on Connect SDK

How will a connector built using Connect SDK fit if I already have middleware?
I am unfamiliar with dockers and Localstack, which are used in reference solutions and connect SDK walkthroughs. What are they, and where do I learn more about them?
Can we test the webhook endpoint exposed by Connect SDK locally? If so, how to do so?
We don’t use AWS in our organization. How can I deploy connectors on GCP or Azure?

GraphQL API Error Codes Overview

Essential knowledgeThis document explains the GraphQL Error Codes used by Fluent Commerce.

Understand the Error Code structure: Each code follows the Prefix + 4-digit Code + Suffix format (e.g., C0001E), which instantly reveals the source (Client/Server/Third-party) and type (Error/Warning) of the issue
Quick diagnosis and resolution: Error Codes are grouped by category and purpose, helping developers diagnose and resolve issues faster without deep debugging or guesswork
Self- vs. support-resolvable issues:
- Codes with a C prefix usually point to issues clients can fix on their own
- While S prefixed Codes may require platform support

Fluent Products and Core Capabilities

Essential knowledgeThis article provides a comprehensive exploration of Fluent Commerce's platform, detailing its critical components and functionalities that enable seamless order management and omnichannel fulfillment. It highlights how features like automated order orchestration, global inventory visibility, and integration tools drive operational efficiency and enhance customer experiences.

Explains how automated order orchestration utilizes APIs and webhooks to map optimal fulfillment paths
Understand how real time global inventory visibility prevents stockouts and significantly reduces order cancellations
Explore essential omnichannel capabilities including Ship from Store and Click & Collect (BOPIS)

OMS Competitive Landscape and Fluent’s Market Leadership

Essential knowledgeFluent Commerce redefines the OMS landscape by combining enterprise-grade capabilities with modern agility, as highlighted in the Forrester Wave report. With a cloud-native, API-first architecture, Fluent empowers global retailers to overcome traditional limitations and drive scalable growth.

Fluent's market leadership and enterprise scale using the Forrester Wave report
The traditional trade off between rigid out of the box platforms and expensive custom builds
Fluent's distinct advantages: cloud native, modular, API first, and eventdriven architecture

What is an OMS and why does it matter?

Essential knowledgeA modern Order Management System (OMS) is a centralized platform that manages orders from creation to fulfillment, ensuring real-time inventory accuracy and seamless omnichannel integration. It drives business value by optimizing operational efficiency, reducing costs, and enabling scalable growth through intelligent automation and flexible fulfillment options.

Definition of an OMS as a platform that manages order from creation to fulfillment
The failure of legacy OMS systems
Core operational benefits of an OMS: speed, accuracy, consistency, and flexibility
How an OMS drives business value by accelerating profitable growth and reducing operational complexity

Workflow Orchestration

Essential knowledgeLearn how implementing partners can configure Fluent Commerce workflow orchestration to build the operational blueprint governing order sourcing, fulfillment, and customer service.
Learning this will help resolve operational inefficiencies by automating the order lifecycle and fulfillment routing, which directly reduces costs, improves productivity, and enhances the end customer delivery experience.

Learn how to configure operational blueprints and utilize individual rule sets
Understand the core engine capabilities that enable automatic stock level assessment and distribution center selection
Learn how to apply automation to maximize workflow orchestration efficiency

Value Selling for Fluent OMS

Essential knowledgeTo teach readers to shift sales conversations from technical features to measurable business outcomes tailored to the specific priorities of different stakeholder personas.

How to pitch measurable business outcomes and real world impact rather than technical features.
Understand value propositions tailored to specific stakeholder personas, such as the CIO, CMO, and Head of Logistics.
How to quantify platform value using metrics like lower Total Cost of Ownership (TCO) and faster deployment times.

BigDecimal Precision & Rounding Principles

Essential knowledgeThis document defines the core principles for using `BigDecimal` in monetary and high-precision calculations. After reading, developers can apply the appropriate constructors, division rules, and rounding strategies to ensure consistent numeric representation across services, APIs, and storage. These principles reduce defects caused by floating-point arithmetic, undefined division, rounding errors, and incorrect value comparisons.

Monetary calculations rely on deterministic precision across all services.
Precision is preserved using `NUMERIC` (DB), `BigDecimal` (Java), and (`unscaledValue`, `scale`) (API).
Division requires explicit scale and rounding to avoid runtime exceptions.
Most defects originate from constructing from `double`, confusing scale vs precision, or misusing `equals()`.

Plugin API

Essential knowledgeThe Plugin API provides methods for uploading, installing, and viewing Plugins.A Plugin Bundle represents a collection of rules for a retailer that is uploaded and installed into Rubix for use in workflows. They can be developed and installed through the use of the Fluent SDK.

An explanation of each endpoint to use plugin API for Fluent OMS

Authentication and Single sign-on (SSO)

Essential knowledgeAuthentication in Fluent Web Apps is managed through PingOne, which serves as the central identity hub. It hosts the Fluent Identity Provider (Fluent IdP) and integrates with Corporate Identity Providers (Corporate IdPs) such as Azure AD, Okta, and Google Workspace. PingOne authenticates users, issues tokens, and enforces access and security policies across all environments.

SSO is supported only in the OMX framework.
PingOne serves as the central identity platform managing all authentication requests.
Fluent IdP (hosted in PingOne) handles Admin and API users.
Corporate IdPs authenticate business users via SAML or OIDC.
Once SSO is enabled, direct username/password login to Fluent Web Apps is disabled.
Each Fluent account has its own PingOne environment where authentication and policy configurations are stored.

Order management - Orchestration Engine and Cloud Infrastructure

Essential knowledgeThis topic describes the cloud native nature of the Fluent platform

Scalable
Secure
Versionless software
Zero downtime

Workflow Event Execution

Essential knowledgeIn this module you'll learn about how events are executed on the Fluent platform.

A workflow represents the journey of a root entity, and related sub-entities, through various stages in its lifecycle. These stages are represented by statuses.
Rulesets are collections of rules forming tasks within a process, dictating movement from one state to another based on business logic.
When an orchestration event is received, the Workflow Engine loads the associated workflow and searches for a matching ruleset based on event name, entity type, subtype, and status. Matched rulesets are executed, and may produce additional events to trigger further rulesets in sequence.

Workflow API

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

This API method supports the creation or update of a Workflow within the Fluent Platform.
This API method validates the body of the request to ensure that the structure of the Workflow is correct.
Requests containing invalid Workflows will respond with an error.

User Lockouts: What to Expect After Too Many Failed Login Attempts

Essential knowledgeThis article explains what happens when an account is temporarily locked due to multiple failed login attempts, whether caused by a user entering the wrong password or an integration using outdated credentials.After reading this article, you will understand:

What triggers a username lockout in Fluent
How the lockout works
What actions users and integration owners should take

Key Points to Know:

Lockouts are temporary (15 minutes).
Applies to both web console users and API clients.
A lockout is enforced even if the correct password is entered after the threshold is reached.

Accounts are locked after multiple failed login attempts ( 5 attempts).
Lockouts are specific to the username with failed login attempts
The lockout period is 15 minutes, starting from the last failed attempt.
Lockouts apply across all login methods (web, API, scripts) using the same username.
During a lockout for a given username:
- All logins (even with correct credentials) will return an error
- The error message will be exactly the same as providing an incorrect username and password (even with correct credentials)
The login screen and error messages will clearly reflect lockout status.
Technical users maintaining integration code should ensure their code does not retry authentication more than 5 times.
Avoid account sharing between UI users and integrations to prevent cross-impact.
Contact Support if you're locked out and need urgent access.

Fluent Platform Integrations and Connections

Essential knowledgeFluent platform functionalities are designed to be flexible by integrating with other APIs and Connectors and provides a real time view of the Inventory to the sales channels, enables integration with Warehouse Management Systems (WMS), carrier services, ERPs, etc.

Some common interfaces, and the information shared between these interfaces and the Fluent Platform
GraphQL, and understand its benefits over REST APIs.
Events API, Inventory Batches, Webhooks, and Connectors

SSO Cutover Planning and Execution

Essential knowledgeThe SSO Cutover Planning and Execution details the essential steps for migrating and transitioning to SSO in Fluent. The specifics may differ based on the client's implementation of Fluent. It is advisable to have discussions with your partner and the Expert Services contact to gain further clarification.

Necessary prerequisites for migration and cutover
Planning the user migration
Availability during cutover
SSO Activation and Testing

REST API

Essential knowledgeThe Fluent Platform provides and number of REST APIs for interacting with the platform.These differ from the primary GraphQL APIs which primarily cover domain entities. This section provides access to the REST based Platform APIs reference documentation.

The REST APIs provide platform level capability, such as Authentication, Integration, and Workflow Framework setup
This does not include deprecated v4.1 Domain-based REST APIs
See GraphQL for current domain-based entities and APIs

GraphQL API

Essential knowledgeThe Fluent GraphQL API provides powerful access to data, integration, and orchestration-driven business logic. It provides an opportunity to streamline and optimize requests to the Fluent Order Management platform in a way that is more flexible than the REST-based API.

Schema Documentation
Benefits of GraphQL
Why Did We Choose GraphQL?
Differences Between REST and GraphQL-based APIs

REST API Error Codes Overview

Essential knowledgeFluent REST API returns specific HTTP Error Codes which may vary depending on the API endpoint and are explained in this document.

Categorization by HTTP Status Code: The errors are organized by standard HTTP status codes (e.g., 400, 401, 403, etc.), which helps developers quickly understand the type of issue
Coverage of Common Scenarios: The examples span a range of typical failure conditions, from authentication issues to plugin errors and timeouts, offering a practical reference for API consumers

Integrate and Connect Labs

Essential knowledgeThe labs in this article will walk you through the following scenarios: GraphQL Introspection and Sending a Webhook

Postman Configuration for auto-complete
Access to mockable.io

Core Google Cloud Platform (GCP) Components Supporting Fluent Commerce

Essential knowledgeFluent integrates key Google Cloud Platform (GCP) services to enhance scalability, performance, and security across its infrastructure. By leveraging Compute & Serverless, Data & Storage, Networking & Delivery, and Security & Compliance solutions, Fluent ensures a reliable and efficient cloud environment.

Google Cloud Platform components used by Fluent fall into the Compute & Serverless, Data & Storage, Networking & Delivery, and Security & Compliance categories
Compute & Serverless: Run workloads with virtual machines (GCE), Kubernetes (GKE), and event-driven functions (Cloud Functions).
Data & Storage: Store and analyze data with Cloud Storage, BigQuery, Cloud SQL, and Cloud Spanner.
Networking & Delivery: Speed up content with Cloud CDN and balance traffic efficiently with Cloud Load Balancer.
Security & Compliance: Protect workloads with IAM, Cloud KMS, Secret Manager, and Audit Logs.

Interface Mapping

Essential knowledgeThe Interface mapping document should clearly define what data will be exchanged between OMS and the external systems (e.g. middleware or eCom).

The aim of the Interface Mapping document should keep it as simple as possible;

Plugin Structure & JS GraphQL

Essential knowledgeIn this module, you will learn about a Plugin Project structure and JS GraphQL within the Plugin Project. You will also learn how to modify and run a JS GraphQL query.

Installed SDK
GQL Basics

Introduction to GraphQL

Essential knowledgeIn this lesson, we'll look at the benefits of using GraphQL, as well as explore the differences between GraphQL and REST based APIs. We will also look at some examples of a GraphQL query and a GraphQL mutation.

Introduction to GraphQL
Differences to REST
Benefits of using GraphQL
Basic structure of a query
A GraphQL mutation
Types of common integrations that use GraphQL

Getting Help with Support & Operations

Essential knowledgeThe support process at Fluent Commerce relies on integration partners to handle initial investigations for issues related to custom implementations. If platform-related problems are identified, partners must escalate them via a JIRA support ticket. Additionally, Fluent Commerce offers Expert Services for guidance during the design, implementation, and support phases.

Partner Responsibility: Handle initial investigations of custom rules and configurations.
Platform Issues: Escalate confirmed platform-related problems via JIRA with detailed logs.
Fluent Expert Services: Consultants assist with complex issues during implementation and support.
First-Time Partners: Fluent Expert Services provides additional support for new implementation partners.
Customer Success Manager: Partners can seek guidance on using Expert Services.

Support & Operations Activities

Essential knowledgeThis lesson covers key operational activities in Fluent Commerce, including Plugin Management, Workflow Versioning, and Audit Events. You’ll learn how to manage Fluent plugins, version workflows, and utilize audit events to debug and analyze processes within the Fluent platform.

Plugin Management: Upload, activate, and manage plugin versions via Plugin API.
Workflow Versions: Submit, view, and retrieve versions for effective workflow management.
Event Categories: Includes snapshots, rulesets, rules, actions, and exceptions.
Event Viewing: Access audit data via Event API, Event Search, or Fluent OMS Activity tab.

Support & Operations Tools

Essential knowledgeFluent OMS and Postman are key tools for managing and troubleshooting the Fluent Commerce platform. Fluent OMS provides a web-based interface for managing orders, inventory, and workflows, while Postman facilitates advanced debugging and custom queries using GraphQL. Together, they help identify and resolve issues like stuck orders or workflow interruptions.

OMS Application: Manage orders, inventory, and workflows in one place.
OMS Dashboard: Monitor entity statuses (orders, fulfillment, etc.).
Postman Queries: Use GraphQL to query or correct data.
Issue Investigation: Identify stuck orders using order states and filters.
Workflow Re-triggering: Reset and restart workflows using the Events API.

Introduction to Support & Operations

Essential knowledgeThis training introduces the tools and activities used in Fluent Commerce Support and Operations processes. You’ll learn how to use Fluent OMS and Postman for troubleshooting, identify common issues like stuck orders, and learn to resolve them effectively.

Fluent OMS: Navigate and use built-in tools for issue resolution.
Postman Queries: Run custom API queries for debugging.
Stuck Orders: Learn to identify orders that are not processing.

API, Integration, and Connectors

Essential knowledgeAPI, Integration, and ConnectorsThis lesson covers the various integrations and connections with the Fluent platform.

Fluent is designed to integrate flexibly with other API's and connectors
Fluent provides connectivity via Rest and GraphQL API's
Webhooks provide outbound connectivity from Fluent

Fluent Commerce Fundamentals

Essential knowledgeThis 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

GraphQL Operations

Essential knowledgeGraphQL 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

Corporate Identity Provider (IdP) Integration

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

Ready for Launch Process

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

GraphQL Query Limits

Essential knowledgeThe 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)

Understanding IDs and Refs in GraphQL Entities

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

API Retries and Exponential Back-offs

Essential knowledgeExponential 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

GraphQL Reference

Essential knowledgeThese docs were generated by graphql-docs. Just starting out with GraphQL? Check out GraphQL's official documentation!

The schema docs are generated as part of a product release process and therefore are up-to-date.

Platform Services and Frameworks (version 1.0)

Essential knowledgeThe 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

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