Fluent Commerce Docs

Content in this track:

Content in this track: Setup and Configuration - Configuring Modules

How-to Guide

Authors:

Ian McMillan, Ankit Mehta, Anita Gu

Changed on:

30 Aug 2026

Key Points

Ensure all module dependencies are identified and installed before starting the configuration process.
Review the module documentation thoroughly to understand configuration options and requirements.
Test module configurations in a staging environment to verify functionality before deploying to production.
Document the configuration steps and settings for future reference and troubleshooting.

Prerequisites

Setup and Configuration - Setting Up Your Account

Steps

Overview

Now that you have created your B2C Retailer with the Fluent CLI, its time to configure the essential modules.

What are reference modules?

Reference Modules are downloadable assets provided by Fluent Commerce designed to provide reference artifacts that you can use to create your own solutions. While Extensions contain entire solutions within themselves, Reference Modules provide Domain Artifacts that can be used to speed up building your solutions.Before modules can be installed on your retailer, they must be configured to match your specific business requirements. Module configuration is the critical step that bridges the gap between generic, out-of-the-box functionality and your retailer's unique operational needs.Now that you've successfully created your retailer using the Fluent CLI, you're ready to configure the core modules that will power order management and inventory operations for this retailer. The Order and Inventory modules are two of the most critical Reference Modules in Fluent Commerce, they form the operational backbone that enables order routing, fulfillment planning, and real-time inventory visibility across your business.

Generate the configuration files

Let's generate your configuration files

Run the following commands to generate the configuration files for the Order and Inventory Modules.

`fluent module config order --retailer b2c --profile <your profile>`

`fluent module config inventory --retailer b2c --profile <your profile>`This will produce new module configuration files in the current working directory:

module.config.b2c.order.json
module.config.b2c.inventory.json

These files contain all the settings for your modules. Next, you'll customize them to match your business requirements.

Populate the configuration files

Populate each file with the relevant information (provided below)

Check the Retailer ID

If you are creating this Retailer on a fresh Account, the Retailer ID is likely 1, however, please check the Retailer ID of the Retailer you created in the previous step, and update the below configurations appropriately.

Look at the configurations below. You'll see `[[retailer.id]]` in several places. Replace every instance with your actual retailer ID (for example: `RJT_1`). Remove the brackets they're just placeholders.

`
`

If you do not know the retailer id, then you can run the following command to get your retailer id for your retailer: `fluent retailer list from the CLI.`

Order Config for Sample B2C Retailer set up:

1{
2   "default:system.rejected.location.ref": "RJT_[[retailer.id]]",
3   "default:inventory.catalogue.ref": "DEFAULT:[[retailer.id]]",
4   "default:inventory.retailer.id": "[[retailer.id]]",
5   "default:carrier.ref": "DEFAULT_CARRIER:[[retailer.id]]",
6   "default:label.url": "DEMO_UK_RoyalMail_Label.pdf",
7   "workflow:order:cc:network.ref": "B2C_CC_[[retailer.id]]",
8   "workflow:order:cc:virtual.catalogue.ref": "BASE:[[retailer.id]]",
9   "workflow:order:cc:sourcing.profile.ref": "CC_DEFAULT_[[retailer.id]]",
10   "workflow:order:hd:network.ref": "B2C_HD_[[retailer.id]]",
11   "workflow:order:hd:virtual.catalogue.ref": "BASE:[[retailer.id]]",
12   "workflow:order:hd:sourcing.profile.ref": "HD_DEFAULT_[[retailer.id]]",
13   "workflow:order:multi:network.ref": "B2C_BASE_[[retailer.id]]",
14   "workflow:order:multi:virtual.catalogue.ref": "BASE:[[retailer.id]]",
15   "workflow:order:multi:sourcing.profile.ref": "MULTI_DEFAULT_[[retailer.id]]"
16}

Inventory Config for Sample B2C Retailer set up:

1{
2    "default:product.catalogue.ref": "PC:MASTER:[[retailer.id]]",
3    "default:product.catalogue.type": "MASTER",
4    "default:inventory.catalogue.ref": "DEFAULT:[[retailer.id]]",
5    "default:inventory.catalogue.type": "DEFAULT",
6    "default:inventory.retailer.id": "[[retailer.id]]",
7    "default:virtual.catalogue.base.ref": "BASE:[[retailer.id]]",
8    "default:virtual.catalogue.aggregate.ref": "ATS:[[retailer.id]]",
9    "default:inventory.change.event.name": "InventoryChanged"
10}

Install the Reference Modules

Install the reference modules by running the following commands in the terminal

Core Reference Module:
``fluent module install core --retailer b2c --profile cli-b2c``
Fulfilment Reference Module:
``fluent module install fulfilment --retailer b2c --profile cli-b2c``
Order Reference Module with our configuration:
``fluent module install order --config module.config.b2c.order.json --retailer b2c --profile cli-b2c``
Inventory Reference Module with our configuration:
``fluent module install inventory --config module.config.b2c.inventory.json --retailer b2c --profile cli-b2c``

The Reference Modules are now installed on the Account for Retailer ``b2c``.

Configuring the Sample B2C Data Module

Run the following command:

``fluent module config https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data/latest --retailer b2c --profile cli-b2c``

Modify your module.config.b2c.b2c-sample-data.json file, as per the sample below, then install the Sample B2C Data Module:

``fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data/latest --config module.config.b2c.b2c-sample-data.json --retailer b2c --profile cli-b2c``

Sample B2C Data Config for Sample B2C Retailer set up:

1{
2  "default:product.catalogue.ref": "PC:MASTER:[[retailer.id]]",
3  "default:product.catalogue.type": "MASTER",
4  "default:inventory.catalogue.ref": "DEFAULT:[[retailer.id]]",
5  "default:inventory.catalogue.type": "DEFAULT",
6  "default:inventory.catalogue.control.group.ref": "BASE:[[retailer.id]]",
7  "default:virtual.catalogue.base.ref": "BASE:[[retailer.id]]",
8  "default:virtual.catalogue.base.type": "BASE",
9  "default:virtual.catalogue.base.control.group.ref": "BASE:[[retailer.id]]",
10  "default:virtual.catalogue.aggregate.ref": "ATS:[[retailer.id]]",
11  "default:virtual.catalogue.aggregate.type": "AGGREGATE",
12  "default:virtual.catalogue.aggregate.control.group.ref": "AGGREGATE:[[retailer.id]]",
13  "default:carrier.ref": "DEFAULT_CARRIER:[[retailer.id]]",
14  "default:cc.network.ref": "B2C_CC_[[retailer.id]]",
15  "default:hd.network.ref": "B2C_HD_[[retailer.id]]",
16  "default:multi.network.ref": "B2C_BASE_[[retailer.id]]"
17}

Configuring and installing the Sample Data Inventory Module

Wait 10 Minutes!

Due to Fluent Platform Caches, you should wait 10 minutes after creating a new Inventory Catalogue before installing the Inventory Data Module! Otherwise, the inventory batches/events will not be processed into the catalogues.

Run the following commands to create the configuration files for the Sample B2C Data Inventory Module.

Configure the Sample B2C Data Inventory Module:
``fluent module config https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data-inventory/latest --retailer b2c --profile cli-b2c``
Install the Sample B2C Data Inventory Module:
``fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data-inventory/latest --config module.config.b2c.b2c-sample-data-inventory.json --retailer b2c --profile cli-b2c``

Note

The configuration file is pre-populated with a value to disable Batch pre-processing on the Account. This is applicable for the Training environment, however, you should not disable this on other Accounts.

Knowledge Tracks Related To This Topic

Setup and Configuration

Introduction to Setup and Configuration

Learning: Setup & Configuration - Platform Foundations

Setup and Configuration - Setting Up Your Account

Setup and Configuration - Configuring Modules

Setup and Configuration - Testing Your Account Setup

Content in this track:

Introduction to Setup and Configuration

Learning: Setup & Configuration - Platform Foundations

Setup and Configuration - Setting Up Your Account

Setup and Configuration - Configuring Modules

Setup and Configuration - Testing Your Account Setup

End Of Track

Setup and Configuration - Configuring Modules

Setup and Configuration - Configuring Modules

Key Points

Prerequisites

Setup and Configuration - Setting Up Your Account

Steps

Overview

Generate the configuration files

Populate the configuration files

Order Config for Sample B2C Retailer set up:

Inventory Config for Sample B2C Retailer set up:

Install the Reference Modules

Configuring the Sample B2C Data Module

Sample B2C Data Config for Sample B2C Retailer set up:

Configuring and installing the Sample Data Inventory Module

Ian McMillan

Contributors:

Knowledge Tracks Related To This Topic

Building Blocks

By Type

Helpful Resources

Quick Links