Fluent Commerce Logo
Docs
Sign In
Essential knowledge

Author:

Lesley Dean

Changed on:

5 July 2024

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:

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:

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.


Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo