Author:
Fluent Commerce
Changed on:
31 Oct 2024
The Fluent OMS module is pre-configured with certain standard functions that allow the interface to manage orders, product availability, inventory, and order fulfilment and serve as a starting point for your projects.
The default UX templates are hosted on the platform, so there is no need to create the manifest settings yourself unless you need to customize the existing baseline configuration.
`https://<ACCOUNT_ID>.<ENVIRONMENT>.apps.fluentcommerce.com/oms`
The Fluent OMS app is available on the following URL:
`https://<ACCOUNT_ID>.sandbox.apps.fluentcommerce.com/oms/`
Enter your existing retailer username and password that you have been using to access the Webapps OMS.
Additional Information
Before you start using Fluent OMS on your account in production, we would highly recommend the following actions:
You must have an existing FluentCommerce Account with at least one Retailer setup to be able to configure Fluent OMS.
Should you wish to tailor the Fluent OMS app for Client specific needs, you should override the default Fluent OMS template by adding your own manifest to the Account Settings.
By default, the UX Framework will check to see if there are any manifests configured in the Account settings. If no settings exist, Fluent OMS will be loaded using the baseline manifests within the platform.
The setting name for the main web app manifest file should match the following convention:
`fc.mystique.manifest.<web-app-name>`
Fragment manifest names are not enforced, however, typically use the following convention:
`fc.mystique.manifest.<web-app-name>.fragment.<fragment-name>`
Should you wish to customize any part of the default Fluent OMS web app, you can override the relevant manifest by copying the base manifest fragment into an account setting, and then modify it.
To access the baseline manifests, see the table below:
Manifest Category | Available Template Links |
OMS | |
Dashboards | |
Order Management | |
Availability | |
Products | |
Inventory | |
Stores | |
Insights | |
Admin |
For details on how to configure the components and the manifest document, see the Config Guide and the Component Library.
It is recommended to use a text editor that provides JSON syntax highlighting and validation to modify the JSON values, before saving in an Account setting.
Some suggested editors / IDEs include:
Manifest documents should be stored as a JSON Setting in the Account context. Settings can be created and updated in either of the following ways:
An example setting:
Field | Sample Value |
Name |
|
Type | JSON |
JSON Value |
|
Context | ACCOUNT |
Context ID | 0 |
When loading the web app in the browser, the UX Framework identifies if there are any referenced manifest settings on the account, and overrides the baseline manifests to load your tailored configuration.
You may also wish to add completely new fragments to your web app. To do this, you will need to override the main web app manifest and add a new reference route to the manifest setting.
Read more about configuring Reference Routes here.
The Workflow Builder can still be accessed in the existing Admin Console web app. You can login with the same credentials as before and use the Workflow Builder.
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.