Fluent Commerce Logo
Docs
Help & Feedback
Sign In

REST API

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.


Related content

GraphQL API
Edited 169 days ago

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

Connect SDK Overview
Edited 173 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.

Webhooks
Edited 107 days ago

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.

Lesley Dean

Lesley Dean

Knowledge Tracks Related To This Topic

Fluent Platform Integrations
  • APIs Overview
  • GraphQL API
  • REST API
  • GraphQL (GQL) Mutations
  • Authentication API
  • API Retries and Exponential Back-offs
  • Authentication Token Expiry
  • 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
    • Building Blocks
    Building Blocks
    Packages & Modules
    UI Components
    Workflows
    Settings
    Interface Contracts
    Rules
    By Type
    All Types
    Knowledge Tracks
    Extend Knowledge
    Glossary
    How-to Guides
    Sitemap
    Topics
    Use Cases
    Helpful Resources
    Platform Limits
    Support Policy
    Service Level Agreement (SLA) - Enterprise
    Deprecation Policy
    Extend Knowledge Content – Terms and Conditions
    System and Organization Controls (SOC) 3 Report
    Data Privacy Addendum
    Security Policy
    Quick Links
    For Partners
    Customer Resources
    Webinars and Events
    eLearning

    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