Authors:
Fluent Commerce, Kirill Gaiduk
Changed on:
16 Sept 2024
The Inventory Reference Module is the foundation for inventory related implementations. It provides reference Workflows for inventory ingestion and processing. Extensible by design, use this Module as a base to build a solution to the needs of your customers.
Before attempting to set up the Inventory Module, it is recommended that you complete the following Training modules:
To get started with the Inventory Module a Sandbox or Production Account requires:
The below settings enable the Orchestration Engine (Rubix), Inventory and Inventory Batch processing.
Setting Name | User Type | Value |
RETAILER | TRUE | |
ACCOUNT | TRUE | |
ACCOUNT | TRUE | |
ACCOUNT | TRUE |
These settings enable the advanced functionality used by the Inventory Module.
Once you have completed the Pre-requisites above, you are ready to download and install the Module.
Follow the steps described in the Reference Module Installation Guide, using the detailed guidance for Module Workflows setup with variables and Configuration of the Inventory Module with rule properties that are provided below.
Within each workflow, there are levels of configuration that are needed to ensure the workflows work for the specific implementation. Below are outlines per the ruleset/rule of what needs to be updated for each workflow. Additionally, there is a range of configurations that make it possible to tailor the workflows to a specific retailer's requirements.
Please ensure all
`[[retailer.id]]`
`[[account.id]]`
Ensure that
`[[product.catalogue.type]]`
Ruleset | Rule | Configuration required |
UpdateProductStatus | Ensure the variables
|
Ensure that
`[[inventory.catalogue.type]]`
Ruleset | Rule | Configuration required |
| This ruleset placeholder should match the event name produced by the Inventory Batch.
| |
BatchInventoryPositionCreate | Ensure the variable
| |
NotifyVirtualCatalogues | The Reference Workflow comes with 2 example rules each pointing to different variable of Virtual Catalogue. This must be updated with 1 instance of the rule NotifyVirtualCatalogueOnNetworkMatch for each Virtual Catalogue in the Retailer's data setup. The variables are:
| |
UpdateProductInventoryPositions | Ensure the variable
| |
UpdateLocationInventoryPositions | Ensure the variable
| |
VerifyLocationStatusOnProductStatusChange | Ensure the variable
| |
VerifyProductStatusOnLocationStatusChange | Ensure the variable
|
The Virtual Catalogue Workflows have no specific updates required other than the globally applicable
`[[retailer.id]]`
`[[account.id]]`
Ruleset | Rule | Configuration required |
CheckControlChange | For the BASE Control Group Workflow: update the variable
For the AGGREGATE Control Group Workflow: make similar updates for the variables
|
Within the Inventory Module, there are also a range of possible configurations which are shared below. Please, check and apply any that are applicable to your Retailer. This is by no means exhaustive and there are more configuration capabilities available.
The below table details all the rules that can be configured.
Ruleset | Rule | What can be configured? |
BatchInventoryQuantityCreate, BatchInventoryPositionUpdate | The
| |
CalculateOnHand, CalculateOnHandForFulfilment | The
|
The below table details all the rules that can be configured.
Ruleset | Rule | What can be configured? |
UpdateProductStatus | This rule can be duplicated to send events to different Inventory Catalogues and different Retailers from a single trigger. Duplicate the whole rule and ensure the
|
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.