Fluent Commerce Logo
Docs
Sign In

SelectProposedFulfilment

Rule

Changed on:

2 Jan 2024

Overview

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

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

Selects a proposed fulfilment based on the inventory found in the incoming event excluding fulfilment in statuses defined in {excludedFulfilmentStatuses} parameter. Sends event {eventName}.

Accepts

  • ORDER

Actions

  • This rule forwards the input event eventName with proposedFulfilment attributes.

Rule parameters

Parameter

Description

eventName

The name of event triggered by this rule.

excludedFulfilmentStatuses

The list of excluded fulfilment statuses.

Event attributes

Parameter

Description

Data Type

Required?

locations

The list of locations from network

List of Strings

Required

virtualPositions

The list of virtual positions for fulfilmentChoice

List of Strings (JSON)

Optional

Exceptions

This rule does not explicitly identify any exceptions.

Configuration example

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