Fluent Commerce Logo
Docs
Help & Feedback

Bootstrap an account using the Fluent CLI

How-to Guide

Authors:

Marco Heuer, Ankit Mehta

Changed on:

4 Nov 2025

Key Points

  • Create a profile
  • Create a retailer
  • Configure and Install the Fluent Reference Modules
  • Configure and Install the Extension Data module
  • Validate the Account setup

Steps

Step arrow right iconPrerequisites

Step arrow right iconCreate a Profile

Before you can use the Fluent CLI, you will need to create a Profile for the Account you intend to interact with:`fluent profile create cli-sample --id <ACCOUNT_ID> --base-url https://<account_id>.sandbox.api.fluentretail.com --username <account_id>_admin --password <password> --client-secret <client_secret>`Make sure you replace the placeholders above with the relevant Account information.

Step arrow right iconCreate a Retailer

Next, create a sample Retailer on the Account:`fluent retailer create sample --email sample@test.com --profile cli-sample`

Step arrow right iconConfigure Reference Modules

The Order and Inventory Modules require configuration to be provided to the install. To generate the configuration files, run the following commands:`fluent module config order --retailer sample --profile cli-sample``fluent module config inventory --retailer sample --profile cli-sample`This will produce new module configuration files in the current working directory:
  • module.config.sample.order.json
  • module.config.sample.inventory.json
You will need to open each of these in a text editor to populate the relevant information. Since we are providing a Sample Data Module, we know the setup we’re creating, and can populate these files with the following information.Order Config for Sample Retailer set up:Inventory Config for Sample Retailer set up:

Step arrow right iconInstall Reference Modules

You’re now ready to install each of the Reference Modules.
  • Install the Core Reference Module: `fluent module install core --retailer sample --profile cli-sample`
  • Install the Fulfilment Reference Module: `fluent module install fulfilment --retailer sample --profile cli-sample`
  • Install the Order Reference Module with our configuration: `fluent module install order --config module.config.sample.order.json --retailer sample --profile cli-sample`
  • Install the Inventory Reference Module with our configuration: `fluent module install inventory --config module.config.sample.inventory.json --retailer sample --profile cli-sample`
The Reference Modules are now installed on the Account for `sample` Retailer.

Step arrow right iconConfigure and Install the Extension Data Module

Once the Account is ready with the Reference Modules, it's time to create assets like settings, users, locations, products, etc using an extension data module. You have a choice to either follow one of the recipes to create your own configuration: Or you can use a predefined setup for a B2C scenario with a small set of products and inventory positions:`fluent module config https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data/latest --retailer sample --profile cli-sample``fluent module config https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data-inventory/latest --retailer sample --profile cli-sample`This will produce new module configuration files in the current working directory:
  • module.config.sample.b2c-sample-data.json
  • module.config.sample.b2c-sample-data-inventory.json
You will need to open each of these in a text editor to populate the relevant information. Since we are providing a Sample Data Module, we know the set up we’re creating, and can populate these files with the following information:You do not need to update the `module.config.sample.b2c-sample-data-inventory.json` for a non-production account. Keep the batch preprocessing flag on `false`.Next we can install both modules:`fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data/latest --config module.config.sample.b2c-sample-data.json --retailer sample --profile cli-sample`Now wait 10mins for internal catalog caches to clear and then proceed with loading inventory. This wait is only needed the first time the inventory catalogues are created.`fluent module install https://downloads.fluentcommerce.com/v1.0.0/modules/fcx/b2c-sample-data-inventory/latest --config module.config.sample.b2c-sample-data-inventory.json --retailer sample --profile cli-sample`

Step arrow right iconTest your Account Setup

Now that you have completed the set up of the Account and Retailer, let’s test it out.Note: The below validation steps may only work if the Extension Data Module is setup completely (including the products, locations, settings, etc)We’ve added a Profile Export capability for a Postman Environment File which can be used with the Postman Collection provided in the Sample B2C Project postman folder.
  • Export the Profile for Postman: `fluent profile export cli-sample --format postman --retailer sample` This will create a new Postman Environment File in the current working directory.
    • Open the Postman Environment File and copy the password for the sample Retailer Admin User.
  • Open the Fluent OMS web app in a browser, and log in to the Fluent OMS web app: `https://<account_id>.sandbox.apps.fluentcommerce.com/oms/`
    • Take a look around at the following areas to see the data created (as per the configured Extension Data Module):
      • Retailers
      • Carriers
      • Users
      • Roles
      • Settings
      • Locations
      • Networks
      • Product Catalogues (Including Products & Categories)
      • Inventory Catalogue
      • Virtual Catalogues
      • Control Groups
  • Import the Environment File and CLI Test Collection into Postman
    • Authenticate the Account Admin User
      • Run the “Get Plugin Rules” request. Click on the “Visualize” tab in the response window to view the Installed Plugins and Rules library.
    • Authenticate the Retailer Admin User
      • View the installed Workflows
      • Create a Customer
      • Create a CC Order (Dependent on Product / Inventory Feeds)
      • Create a HD Order (Dependent on Product / Inventory Feeds)
  • Return to the Fluent OMS web app, and view the new Orders, and the Inventory Reservations
  • Open the Fluent Store web app: `https://<account_id>.sandbox.apps.fluentcommerce.com/store/`
    • Log in with username / password: <LocationRef> / <LocationPassword>
      Note: Replace the 1 with the relevant Retailer Id, should this not be the first Retailer in the Account.
    • Create a Wave, and complete the Pick, Pack, Dispatch process
      Note: You can see the Order and Fulfilment statuses change for each step in Fluent OMS
    • Collect the Articles using the Customer Collection and Carrier Collection Screens
    • The Orders should now be completed

Related content

Getting Started with the Fluent CLI
Edited 33 days ago
Fluent CLI Reference
Edited 116 days ago
The Fluent CLI provides command line tooling for interacting with Fluent Accounts and Modules.UsageThe Fluent CLI is activated by typing the keyword `fluent` into a terminal command line, followed by a Command, Subcommand, Argument, and Options:`fluent <command> <subcommand> <argument> [options]`
  • The `<command>` will refer to a noun (or “a thing”).
  • The `<subcommand>` will refer to a verb (or action).
  • The `<argument>` is the primary required name of the “thing” identified by the `<command>`.
  • The `[options]` may include required or optional additional parameters to be used by the `<command>` and `<subcommand>`.
Marco Heuer

Marco Heuer

Contributors:
Ankit Mehta
Building Blocks
Building Blocks
Packages & Modules
All UI Components
Workflows
Settings
Interface Contracts
All Rules
By Type
All Types
Knowledge Tracks
Extend Knowledge
Glossary
All 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
Certifications
Training Resources
Knowledge Tracks
Builders Portal
Product Update Newsletter
Industry Blogs & Events Newsletter
Trust Center Portal

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Fluent Logo