SelectProposedFulfilmentForFulfilmentChoice

Rule

Changed on:

2 Jan 2024

Overview

The rule selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilments in the specified excluded fulfilments statuses.

Plugin Name	Order 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.

Order Reference Module

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

Selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilments in statuses “excludedFulfilmentStatuses”. Sends event “eventName”.

Accepts

FULFILMENT_CHOICE

Actions

Selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilments in excluded fulfilments statuses. Sends event with proper event name to further rule in workflow.

Rule parameters

Parameter	Description
eventName	The event name triggered by this rule
excludedFulfilmentStatuses	The list of excluded fulfilment statuses

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
virtualPositions	The list of virtual positions for fulfilmentChoice	List of Strings	Optional

Exceptions

This rule does not directly throw any exception.

Configuration example

1{
2  "name": "<ACCOUNTID>.order.SelectProposedFulfilmentForFulfilmentChoice",
3    "props": {
4        "eventName": "ProcessOrder",
5        "excludedFulfilmentStatuses": "fulfilmentStatuses"
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.