Fluent Commerce Logo
Docs
Help & Feedback

All Extend Content

Browse all Extend Content

Enable Return Order with Exchange in Fluent OMS

How-to Guide
  • Eligibility & Conditions – Clearly define the conditions under which an item can be exchanged, such as time limits, product conditions, and receipt requirements.
  • Exchange Process – Outline the step-by-step process, including how customers initiate an exchange, return shipping details, and replacement timelines.
  • Inventory & Availability – Ensure the desired replacement item is in stock and provide alternatives if it's unavailable.
  • Refund vs. Exchange Policy – Specify whether price differences will be refunded or charged.
  • Customer Communication – Keep customers informed at every stage with order tracking, confirmation emails, and support availability.

Adding a State to your Workflow with User Action

How-to Guide
  • It’s possible to add a new state to an existing workflow by adding a new status to the `Statuses array` of the workflow JSON.
  • Create a simple User Action to allow the user to change the status.

Cash on Delivery workflow action

How-to Guide
  • Understanding the Market: Recognizing the importance of Cash on Delivery (CoD) in markets like India, where it is a preferred payment method.
  • Global Adaptability: The workflow's design serves a global audience, providing a template that can be customised for regions where upfront payment is not the norm.
  • Seamless Integration: Ensuring the CoD process is smoothly incorporated into the existing order journey to enhance customer experience.
  • Operational Efficiency: Streamlining the CoD transaction to ensure quick and secure payment collection at the point of delivery.

Install Fluent Modules into your sandbox

How-to Guide
  • step-by-step guide on how to install modules into your OMS sandbox

Implementing Locker Collection

How-to Guide
  • A simple way to illustrate how to enable the locker collection option in the Click & Collect workflow
  • Illustrates a way to expose the locker information to the order sales channel via the Fulfilment Options workflow
  • Access to the lockers is assumed via the carrier company delivering to the locker location (i.e. there is no hardware integration)

Image capture of Returned Goods during Return

How-to Guide
  • This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
  • This idea/solution will provide a new feature where the Store User can take a photo of the returning item and attach it as part of the returnOrder entity.
  • The source code will not be provided in this article.

Build a Webhooks Monitoring Dashboard

How-to Guide
  • For Frontend Configurators (JSON) of the Fluent OMX UX Framework with access to a small custom component
  • Enable a visual Webhooks Monitoring Dashboard in the Fluent OMS (or any other Fluent web app)
  • How to add a new page to the Insights section
  • How to query the Event API for Webhook Audit Events
  • How to use the `devrel.provider.rest` component to display information from the Fluent REST APIs using standard the standard UX Component Library
  • Access specific attributes by name (even when they contain spaces!)
  • How to conditionally color code a specific table column
  • How to display a details drawer from a list
  • How to display contextual Webhook information on the Order Details screen

OMS Web App: Search order by ID using the Rules SDK

How-to Guide
  • This is the use case where users can look up OMS orders using order ID.
  • Typically, the `orderById` GraphQL query is used to look up an order by ID. However, only one order can be searched at a time, and there is no wildcard search.
  • This article provides an alternative approach that allows users to search for orders by ID or even with a wildcard, leveraging the new `ref2` field on the order entity included in the Enhanced Order Lookup and Tagging Capabilities release.

Fluent OMS WebApp UI: Getting Orders by Product Status

How-to Guide
  • A simple guide to add product status as part of the order search filter.
  • This feature will utilize OOTB components, so it does not require any custom components.

Create a Simple List Page in OMS Webapp

How-to Guide
  • A simple guide to creating an OMS webapp page from scratch

Create Order Wizard

How-to Guide
  • The 'Create Order' wizard streamlines the order creation process by guiding users through each step, reducing the chances of errors, and ensuring all necessary information is captured.
  • It provides a user-friendly interface that simplifies complex order configurations, making it accessible for users with varying levels of technical expertise.
  • The wizard includes validation checks at each step, ensuring that all entered data is accurate and complete before proceeding to the next step.

Validate Customer ID at Pickup

How-to Guide
  • This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
  • This idea/solution will provide an extended new feature where the Store User can validate the Customer ID during the Customer Collection Process.
  • New custom UI components and rules are needed to capture the user input and confirm the selected articles in the UI user Action screen.  Then, the store/business can track and trace the proof of the shopper's collection.
  • Due to security reasons, the shopper's sensitive personal information should not be stored within Fluent OMS. Therefore, the proof of collection should be stored at a third-party storage.

Enable entering of Rejection Reason Code during pick confirm in Fluent Store

How-to Guide
  • This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
  • This idea/solution will provide a new feature where the Store User can enter the rejection reason code during the Pick Confirm Process.
  • This feature allows specifying the rejection reason for fulfillment on the picking step of wave processing. The user can select the rejection reason code when the picked item list is confirmed as the first step of wave processing.

Fluent Store Dashboard: new dashboard tile based on fulfilment expiry time

How-to Guide
  • A guide to extend Fluent STORE UI capabilities to allow the store users to have a better visibility on the fulfilments by expiry time.
  • The use case where the store staff would like to see number of fulfilments for the next 2 hours so that they can plan their pick and pack process accordingly. 
  • One of the solutions is by using OOTB component and manifest to display the fulfilments number based on the expiry time.  Hence, there are no custom rules nor custom component is required for this solution.
  • Here are the steps to archive the outcome:
    • Create a new screen in fluent Store
    • Create dashboard tiles

Enable Home Delivery shipping label in Dispatch stage of Fluent STORE

How-to Guide
  • Typically, the HD shipping label is generated by the nominated carrier company or carrier aggregator.  The label URL is then stored in OMS for printing. 
  • This guide will take you through the setup to allow the store users to print the shipping label from Fluent STORE. 

Enable location store users to update store hours

How-to Guide
  • Each location has an opening hours setup that can be used for store activities. One activity could be during the fulfillment allocation phase, where the fulfillment expiry time for a store is calculated, giving store staff sufficient time to process the order before it expires.
  • Since opening hours can change week by week, we have created this guide to showcase how you can enable Store Managers to make these changes directly in the Fluent Store Web App.

Extended Component To Handle Order Item Cancellation

How-to Guide
  • Supports full or partial cancellation of order line items based on remaining quantity.
  • Extended UI component enforces cancellation reason and visualises cancellable quantity.
  • Rule/Rule set updates to cancelledQuantity are required but not covered in this document.

OMX Webapp UI - Search order by customer phone number or email

How-to Guide
  • This is an enhanced feature that allows users (e.g., Customer Service Representatives) to look up customer orders by using either the customer's email address or phone number. 
  • This feature can be achieved by configuration in the setting manifest without any custom components nor custom rules.
  • This article will provide the following:
    • code snippet of the search Order by Customer phone/email manifest
    • Language settings
    • Display the page on the left panel menu by adding a code snippet in the setting: `fc.mystique.manifest.oms` 

Create a custom Click and Collect pack label

How-to Guide
  • The CC pack label on the Fluent Store can be customised via an HTML template.
  • This guide will take you through the setup and fragment changes required to customise the pack label.
  • The printed pack label can then be attached to the paper bag or parcel ready for customer collection in-store.
  • Enhancements can be made to the reference label content. For example, the client's logo or an additional barcode for scanning purposes can be included.

Create a Template helper to display the createdOn date in a specific time zone

How-to Guide
  • This article provides an example on how to create a simple template helper which can be used in the mystique manifest.
  • With this template helper, the user is able to see the order in "local" created date/time.  For example, the order was placed at Adelaide and the customer service representative in Sydney would like to see the order date time in Adelaide time zone.
  • Here are the steps to implement the template helper by using Component SDK:
    • Create a new function in component SDK
    • Import and register the template in index.tsx
    • Add the template to the mystique manifest in the setting

Custom UI Field Component on Add Network to Location user action

How-to Guide
  • This component simplifies the addition of networks to locations by providing an easy to use selector of available networks
  • The basic principles can be used in other scenarios where complex fields and values may be required

Enable quick access filters for users with a custom Predefined Filter component

How-to Guide
  • Predefined Filters: Provide a way to access commonly used search parameters with a single click, enhancing the user experience.
  • User Efficiency: Predefined filters are designed to save time and streamline workflows.
  • Customization: Users may have the ability to create and save their own filters for recurrent use (via manual Manifest changing).
  • Consistency: Predefined filters ensure that the same criteria are used for searching, leading to consistent results.
  • Learning Curve: New users can quickly become proficient in finding the information they need due to the intuitive nature of predefined filters.
  • Integration: These features should seamlessly integrate with the user interface for maximum effectiveness.

Display REST API Data in Standard Library Components

How-to Guide
  • For Frontend (React) Developers who are familiar with using the Fluent OMX Component SDK
  • Build a REST API Data Provider Component to enable the standard Component Library to render data from the Fluent Platform REST APIs
  • Learn how to override the data provided to components
  • Learn how to support template value props for dynamic input
  • Learn how to decorate the query results for enabling `byName` attributes access in the manifest

Add and Edit Customer Address by using custom UI component

How-to Guide
  • Address Validation: Ensure that the address entered by the user is valid and correctly formatted to avoid shipping issues.
  • Default Address: Allow customers to set a default address for a quicker checkout process.
  • Edit Capability: Provide an option for users to edit customer address details in case of errors or changes.
  • User Experience: Design the add and edit address process to be user-friendly and accessible, with clear instructions and error messages.

Quick Search in UI by using Custom UI Component

How-to Guide
  • Quick Search Functionality: Enables users to find information rapidly by typing keywords or phrases.
  • User Efficiency: Quick search is designed to save time and streamline workflows.
  • Learning Curve: New users can quickly become proficient in finding the information they need due to the intuitive nature of quick search.
  • Integration: These features should seamlessly integrate with the user interface for maximum effectiveness.

Configure extended address for Return Orders

How-to Guide
  • Extend the Order Module schema
  • Modify the Rule for Return Order creation and the Order Workflow Return Order Ruleset
  • Update the Order Management Manifest

Manual Fulfillment Reassignment

How-to Guide
  • This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
  • This idea/solution will provide a new feature where the Store User can enter the rejection reason code during the Pick Confirm Process.
  • This feature allows customer service to reroute an existing `fulfilment` to a specific location that can fulfill the order.

Manual Inventory Position Changes through the UI

How-to Guide
  • This article gives System Integrator (SI) Partners and Businesses a high-level idea of where new features can be built on top of the OMS reference solution to support the customer's requirement within Fluent OMS.
  • This idea/solution will provide an extended new feature where the Store User can update the Store inventory through the UI to ensure the OMS has the most accurate product inventory.
  • New custom UI component and rules to capture the user input in the UI user Action screen. Then, the backend will create a new Inventory Quantity entity and update the Inventory Position and the downstream workflow.

Create Customer via UI

How-to Guide
  • Comprehensive Data Entry: Ensure that all necessary customer information is captured accurately to create a complete profile. This includes personal details, contact information, and any specific requirements or preferences.
  • Validation and Verification: Implement validation checks to prevent errors during the data entry process. Verify that mandatory fields are not left blank.
  • User Experience: Design the customer creation process to be user-friendly. Provide clear instructions and feedback during the process to enhance the user's experience and minimize the likelihood of errors.

Edit Customer via UI

How-to Guide
  • Data Modification: Ensure that users can modify customer data, including the ability to correct typos in existing information.
  • Error Handling: Implement error handling procedures in case the edit fails or invalid data is submitted.
  • User Experience: Aim for a seamless and intuitive editing process to minimize the risk of user errors.
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