Fluent Commerce Docs

Docs

Search

Help & Feedback

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Content in this track:

Fluent Platform Integrations and Connections

APIs Overview

GraphQL API

REST API

GraphQL (GQL) Mutations

API Authentication

API Retries and Exponential Back-offs

Authentication Token Expiry

API Error Codes

Webhooks

Webhooks Frequently Asked Questions

Webhook Receivers

commercetools - Send Payload to External webhook

commercetools - Receive External webhook

Connect SDK - Fluent Webhooks Integration

Build a Webhooks Monitoring Dashboard

End Of Track

Content in this track: REST API

Essential knowledge

Author:

Lesley Dean

Changed on:

3 June 2025

Overview

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

Key points

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

Authentication

API Users will need to authenticate using the Authentication API:

Authentication API

For SSO related topics, see Authentication & SSO for details.

Integration

While GraphQL is also used for integration, the following 2 APIs provide Workflow Integration and Batch loading capabilities:

Event API
Job API (Batch)

Workflow Framework

The Workflow Framework APIs provide the following capabilities:

Plugin Management
- Install, Activate, and Status Check
- Rule Library and documentation
User Actions
- Get available User Actions for a given entity state
Workflows
- Search
- Get Latest
- Get by version
- Create new

Workflow Framework APIs:

For outgoing integration, see Webhooks Overview for details.

Related content

Fluent Platform Integrations

Edited 53 days ago

A collection of articles about the standard integration methods with the Fluent platform and guidelines to achieve optimal outcomes.

Understand the integration methods available with the Fluent Platform, including using APIs and Connectors.
Become familiar with the different types of APIs: Fluent GraphQL API, REST API, Authentication API, Event API, and Job API.
Learn how to utilise standard webhooks provided by Fluent Commerce, including their signing and validation processes and the public keys used.
Gain knowledge on integrating webhooks using the Fluent Connect SDK.

Connect SDK Overview

Edited 566 days ago

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.

API Authentication

Edited 48 days ago

APIs use authorization to ensure that client requests access data securely. This involves authenticating the sender of a request and verifying that they have permission to access or manipulate the relevant data. The authentication request returns a bearer token that can be used in subsequent API calls to confirm authentication.This guide covers the complete OAuth 2.0 authentication flow, including credential management, token lifecycle, and security best practices for production environments.

REST API Error Codes Overview

Edited 237 days ago

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

REST Event API

Edited 174 days ago

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.

Job API

Edited 332 days ago

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

Plugin API

Edited 818 days ago

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

User Action API

Edited 817 days ago

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

Workflow API

Edited 142 days ago

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

Lesley Dean

Lesley Dean

Knowledge Tracks Related To This Topic

Fluent Platform Integrations

Fluent Platform Integrations and Connections

GraphQL (GQL) Mutations

API Authentication

API Retries and Exponential Back-offs

Authentication Token Expiry

API Error Codes

Webhooks Frequently Asked Questions

Webhook Receivers

commercetools - Send Payload to External webhook

commercetools - Receive External webhook

Connect SDK - Fluent Webhooks Integration

Build a Webhooks Monitoring Dashboard

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.