Fluent Commerce Logo
Docs
Sign In

SearchInventoryAtLocationsForFulfilmentChoice

Rule

Changed on:

29 Nov 2023

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{{accountId}}.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

Parameter

Description

eventName

The event name triggered by the rule

virtualCatalogueRef

The virtual catalogue which will be used

Event attributes

Parameter

Description

Data Type

Required?

fulfilmentChoiceRef

Reference to the fulfilment choice

String

Required

locations

The list of locations from network

List of Strings

Required

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}

Language: json

Version History

2023-08-03

v1.0.0

refers to plugin

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.

Fluent Logo