Fluent Commerce Docs

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 is also used for integration, the following 2 APIs provide Integration and Batch loading capabilities:

Event API
Job API (Batch)

Workflow Framework

The 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 50 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 382 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 Management System and any external system.

API Authentication

Edited 70 days ago

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.

REST API Error Codes Overview

Edited 53 days ago

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

REST Event API

Edited 274 days ago

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

Job API

Edited 148 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 634 days ago

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

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

User Action API

Edited 633 days ago

The API provides the framework to interact with via the ServicePoint and 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 633 days ago

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