GetLocationsForNetwork

Rule

Changed on:

28 Nov 2023

Overview

The rule finds the locations with a required status in network and sends event.

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

Retrieves the locations in network {networkRef} which are in status {locationStatuses}. Sends event {eventName}.

Accepts

ORDER
FULFILMENT_OPTIONS

Actions

This rule finds the locations with statuses defined in parameter locationStatuses for the network and forwards the input event with name eventName and containing location attributes.

Rule parameters

Parameter	Description
eventName	The event name triggered by this rule.
locationStatuses	The location statuses which will be considered.
virtualCatalogueRef	The network reference for which the locations will be retrieved.

Event attributes

This rule does not directly identify any event attributes.

Exceptions

This rule does not explicitly identify any exceptions.

Configuration example

1{
2  "name":"<ACCOUNTID>.order.GetLocationsForNetwork",
3  "props": {
4    "eventName":"UPDATE_ORDER",
5    "networkRef":"1645182721307_HD",
6    "locationStatuses":"ACTIVE"
7  }
8}

Language: json

Version History

2023-08-04

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.