Fluent Commerce Logo
Docs

SearchInventoryAtLocationsForFulfilmentChoice

Rule

Changed on:

8 Aug 2025

Overview

The rule searches inventory based on the incoming event information using virtual catalogue with virtual catalogue ref, and sends event.
Plugin NameOrder Reference Module
Namespace[[account.id]].order
The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.

UI Description

Searches inventory based on the incoming event information using virtual catalogue with ref “virtualCatalogueRef”. Sends event “eventName”.

Accepts

  • FULFILMENT_CHOICE

Actions

  • Sends event with proper event name if inventory was found.

Rule parameters

ParameterDescription
eventNameThe event name triggered by the rule
virtualCatalogueRefThe virtual catalogue which will be used

Event attributes

ParameterDescriptionData TypeRequired?
fulfilmentChoiceRefReference to the fulfilment choiceStringRequired
locationsThe list of locations from networkList of StringsRequired

Exceptions

This rule does not directly throw any exception.

Configuration example

1{
2   "name": "<ACCOUNTID>.order.SearchInventoryAtLocationsForFulfilmentChoice",
3    "props": {
4        "eventName": "ProcessOrder",
5        "virtualCatalogueRef": "virtualCatalogue"
6    }
7}

Version History

2023-08-03

v1.0.0

refers to plugin