Connector Contract

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Essential knowledge

Author:

Fluent Commerce

Changed on:

1 July 2024

Overview

Contracts are suggested design patterns provided by Fluent Commerce for common integration requirements.

Each contract documents a series of “flows” - request-response webhooks, events, and occasionally mutations - that represent the overall back and forth between Fluent and a third-party API.

Key points

Provides a customisable and reusable approach for respective module contracts
The contract can be extended to implement customer-specific requirements

Benefits of implementing the contract

Provides a customisable and reusable approach for respective module contracts.
Allows building connectors that are forward-compatible with future versions.

How can we extend the contract?

The contract can be extended to implement customer-specific requirements. Read more on how to extend the interface contract.

Connector Contract Integration Pattern

Note

Please note that the reference rules and workflows to support these interface contracts are planned to be developed in near future. Currently, the Partners/Clients would need to develop the interfaces so that this can be implemented using workflows
Fluent Connector flows are documented in the OpenAPI format. This means you can load them up in the Swagger Editor to visualize and interact with them.

Connector Contract

Overview

Key points

Benefits of implementing the contract

How can we extend the contract?

Connector Contract Integration Pattern

Fluent Commerce

Building Blocks

By Type

Helpful Resources

Quick Links