Fluent Commerce Logo
Docs
Help & Feedback

Latest Rule Library Changes

Rules are used within a Workflow to define when; or if, something should happen. They help translate business logic into your OMS setup.

SendEventOnFulfilmentInventoryUpdate

RuleSends an event to inventory positions based on the fulfillment update type:
  • Reserve when inventory is reserved 
  • Cancel when inventory is unreserved
  • Confirm when a pick is confirmed 
Each event includes: 
  • The configured inventory quantity types (for example, `RESERVED`, `SALE`, `CORRECTION`)
  • The current on-hand value of the inventory position, so downstream workflows can accurately detect real stock changes

ForwardIfOnHandChanged

RuleForwards the configured event when the inventory position’s on-hand value changes.The rule compares the current on-hand value with the newly calculated on-hand value and forwards the event only when these values differ.

SendEventToProcessUnfulfilableFulfilment

RuleSends an event to act on fulfillments that have been assigned to a system-rejected location. This rule checks if the fulfillment's source matches the configured system-rejected location reference and triggers the specified event if they match.

ChangeStateForUnfulfilableFulfilment (Superseded)

RuleThe rule matches the incoming fulfilment's from address location ref to the system rejected location ref provided in the input parameter and if it matches, changes the fulfilment status.Superseded
This approach is still supported but no longer recommended for new implementations. It has been replaced by a more scalable alternative that aligns with Fluent’s product direction and will benefit from future enhancements.Fluent recommends using the `SendEventToProcessUnfulfilableFulfilment` and `SetState` rules instead.

ChangeStateGQL (Superseded)

RuleChanges the state of any type of incoming entity to the status provided in the input parameter using the generic update status mutation in GraphQL. It changes the state of the `event.entityType` to `status` using GraphQL.Superseded
This approach is still supported but no longer recommended for new implementations. It has been replaced by a more scalable alternative that aligns with Fluent’s product direction and will benefit from future enhancements.Fluent recommends using the `SetState` Rule instead.

CreateRejectedFulfilment

RuleCreate a System Rejected Fulfillment for Unfulfilled Items that can not be fulfilled.

CreatePartialFulfilmentWithSourcingProfile

RuleCreate Partial Fulfillment(s) using the specified Sourcing Profile.

CreateFulfilmentWithSourcingProfile

RuleCreate Fulfillment(s) using the specified Sourcing Profile.

UpdateRevisedOrderAttribute

RuleUpdate original Order attribute with link to new revised Order reference.

ApplyThresholdControlsToInventoryPosition

RuleApply Threshold Controls to an Inventory Position and determine its status.

ApplyThresholdControlsToVirtualPosition

RuleApply Threshold Controls to a Virtual Position and determine its status.

CalculateOnHand

RuleCalculates the onHand value of an inventory position using inventory quantities filtered by statuses {filterStatuses} and types {filterTypes}, and then send the event {eventName}

CreateAggregateVirtualPosition

RuleCreate an Aggregate Virtual Position, calculate its Available-to-Sell (ATS) quantity, and send an event.Aggregate Virtual Position ATS calculation is based on the associated Inventory Positions Stock on Hand (SOH) quantities and the applied Controls.The associated Inventory Positions are defined with:
  • The given Product Reference
  • The list of Locations for the given Network (the first Network assigned to the Virtual Catalog)
  • The specified Inventory Position Statuses

CreateBaseVirtualPosition

RuleCreates a base virtual position and sends the event `{eventName}`

CreateBaseVirtualPositionIfNotPresent

RuleChecks if a Virtual Position does not exist, if the Virtual Position does not exist it will create a new Virtual Position with the matching attributes

CreateCategory

RuleCreates a category based on the information passed in the event

CreateDeltaInventoryQuantities

RuleCreate an Inventory Quantity(ies) for the specified Inventory Position.

CreateInventoryPosition

RuleCreate an inventory position based on the incoming event attributes

CreateFulfilmentInventoryQuantity

RuleCreate inventory quantity of type {inventoryQuantityType} using event attributes, or set default type as {defaultType}, condition as {defaultCondition} and storageRef as {defaultStorageAreaRef}

CreateInventoryQuantity

RuleCreate an inventory quantity based on the incoming event attributes

CreateStandardProduct

RuleCreate a standard product based on the information provided in the event

CreateVariantProduct

RuleCreate a variant product based on the information provided in the event

DownToCategory

RuleForward the incoming event with event name {eventName} to the category entity with the provided ref

DownToInventoryPosition

RuleSend an event to the inventory position specified in event attributes from the inventory catalogue

DownToInventoryPositionIfExists

RuleForward event `{eventName}` if the inventory position exists.

DownToProduct

RuleForward the incoming event with event name {eventName} to the product entity with the provided ref.

DownToVirtualPositionIfExists

RuleSends event {eventName} to the virtual position if a Virtual Position does exist

Forward

RuleForward the incoming event with event name {eventName}.

ForwardIfCategoryExists

RuleForwards the event with name {eventName} if the category exists.

ForwardIfCategoryNotExists

RuleForwards the event with name {eventName} if the category does not exist.

ForwardIfIncomingAttributeEquals

RuleForward the incoming event with the event name `{eventName}` if event attribute key `{attributeKey}` has value `{attributeValue}`.

ForwardIfInventoryPositionNotExists

RuleForward event {eventName} if the inventory position does NOT exist.

ForwardIfInventoryPositionStatusEquals

RuleThis article covers the following topics: 
  • Supported Entities: `VIRTUAL_POSITION`
  • This rule produces a `SendEventAction`
  • Rule Parameters
  • Event Attributes
  • Exceptions
  • Configuration Example
  • Detailed Technical Description

ForwardIfInventoryQuantityOfTypeExists

RuleConditionally trigger another Ruleset when the Inventory Position and Quantity of the specified type exist.

ForwardIfInventoryQuantityOfTypeNotExists

RuleConditionally trigger another Ruleset when the Inventory Quantity of the specified type does NOT exist.

ForwardIfLocationStatusEquals

RuleForwards an event if the location has a different status compared to the inventory position and the location status is the same as the given {status} in the input parameters

ForwardIfProductStatusEquals

RuleSend an event {eventName} if the status of the product in the product catalogue with ref {productCatalogueRef} has the current status of {status}.

ForwardIfStandardProductExists

RuleForwards the event with name {eventName} if the Standard Product exists.

ForwardIfStandardProductNotExists

RuleForwards the event with name {eventName} if the Standard Product does not exist.

ForwardIfVariantProductExists

RuleForwards the event with name {eventName} if the Variant Product exists.

ForwardIfVariantProductNotExists

RuleForwards the event with name {eventName} if the Variant Product does not exist.

ForwardIfVirtualPositionNotExists

RuleForwards the event {eventName} if the virtual position does not exist

LoadInventoryPosition

RuleForward event `{eventName}` (inline event) with the attribute 'inventoryPositionExists' set to true or false if the inventory position exists or not respectively.

LoadInventoryPositionData

RuleSend an inline event including the `inventoryPositionExists` flag indicating whether the corresponding Inventory Position exists or not.This Rule is a simplified version of the `LoadInventoryPosition` rule, excluding the logic for:
  • Retrieving Inventory Quantity data of type `LAST_ON_HAND` in status `ACTIVE` or `CREATED`
  • Setting and forwarding the `inventoryQuantityExists` flag (true or false)

LoadProductAndLocationStatus

RuleForward event {eventName} (inline event) with the attribute "productStatus" and "locationStatus" if the product and location exist.

LoadVirtualPositionAndVirtualCatalogueDetails

RuleLoads the virtual position details and then sends an event {eventName}

NotifyInventoryCatalogueForProduct

RuleSend {eventName} event with productRef attribute to the {inventoryCatalogueRef} inventory catalogue with retailer id {retailerId}

NotifyVirtualCataloguesOnNetworksMatch

RuleConditionally send an event (or multiple events) to Virtual Catalog(s), which passed the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

NotifyVirtualCataloguesByRefsOnNetworksMatch

RuleConditionally send an event (or multiple events) to the Virtual Catalog(s) specified by their References, which passed the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

NotifyVirtualCataloguesByTypesOnNetworksMatch

RuleConditionally send an event (or multiple events) to Virtual Catalog(s) specified by their Types, which passed the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).

ProducePositionEventsForLocation

RuleSend a scheduled event to each inventory position using the locationRef from the event attributes.

ProducePositionEventsForProduct

RuleSend scheduled event to each inventory position using the productRef from the event attributes.

ProduceVirtualPositionEventsForControlUpdate

RuleSend an event {eventName} to each virtual position in the catalogue which is impacted by the control update. Only VariantProduct/Location and VariantProduct control changes are considered.

ResetBaseVirtualPosition

RuleResets the virtual position

SendEventGQL

RuleSend an event {eventName} for the (current entity)

SendEventToAllInventoryQuantities

RuleSend an event {eventName} to inventory quantities of type {inventoryQuantityTypes} using event attributes

SplitDeltasAndDownToInventoryPosition

RuleNotifies the inventory positions of the incoming deltas with event `{eventName}`

UpdateAggregateVirtualPosition

RuleUpdate an Aggregate Virtual Position and calculate its Available-to-Sell (ATS) quantity.Aggregate Virtual Position ATS calculation is based on the associated Inventory Positions Stock on Hand (SOH) quantities and the applied Controls.The associated Inventory Positions are defined with:
  • The given Product Reference
  • The list of Locations for the given Network (the first Network assigned to the Virtual Catalog)
  • The specified Inventory Position Statuses

UpdateBaseVirtualPosition

RuleUpdates a base virtual position

UpdateCategoriesForStandardProduct

RuleAdds or removes categories from the standard product based on the information provided in the event

UpdateCategoriesForVariantProduct

RuleAdds or removes categories from the variant product based on the information provided in the event

UpdateCategory

RuleUpdate a category based on the information provided in the event

UpdateControlValue

RuleUpdates the value of a control with the event attribute value.

UpdateInventoryQuantitiesStatus

RuleUpdates the status of inventory quantities to status {status} which belong to the inventory position and are of type {filterTypes} and in statuses {filterStatuses}

UpdateInventoryQuantity

RuleUpdates an inventory quantity of type {type} using the event attributes.

UpdateOnHand

RuleUpdate the onHand value of the Inventory Position according to the event attribute {InventoryPositionOnHandCalculated}

UpdateStandardProduct

RuleUpdate a standard product using the information provided in the event

UpdateVariantProduct

RuleUpdate a variant product based on the information provided in the event

UpsertInventoryQuantity

RuleCreate or Update an Inventory Quantity.

ValidateCategoriesExist

RuleValidates the incoming category event for the existence of the parent and child categories

ValidateIncomingCategory

RuleValidates the incoming category event

ValidateIncomingProduct

RuleValidates the incoming product payload

ValidateProductCategoriesExist

RuleValidate the incoming Product event to confirm that the given Categories already exist.

ValidateStandardProduct

RuleValidates the incoming standard product payload

ValidateVariantProduct

RuleValidates the incoming variant product event payload

CreateWaveByExpiry

RuleCreate a wave from fulfilments in statuses `{status}`, prioritizing those with the earliest expiry.

AllocateConfirmedItemsByFulfilmentExpiry

RuleAllocates picked items to all Fulfilments in the Wave. Priortizing the Fulfilments expiring first and not in specified statuses. Secondly, notifies Fulfilments with the specified event name.

NotifyFulfilmentsInWave

RuleSends an event to all Fulfilments in a Wave. Optionally, it can also send each event with a list of Articles and their dimensions, such as length, width, height, and weight.

CreateWaveByFulfilmentIds

RuleThe CreateWaveByFulfilmentIds takes a list of Fulfillments and creates a Wave with them.

AddFulfilmentTypeAttributeToFulfilment

RuleThe rule adds an attribute with name `FULFILMENTTYPE` to incoming fulfilment with value based on the fulfilment type.

AddFulfilmentTypeAttributeToFulfilmentByFulfilmentChoice

RuleThe rule adds an attribute with name `FulfilmentType` to incoming fulfilment with value based on the fulfilment type.

CalculateLocationsDistances

RuleThe rule calculates distances, in meters, from each location to the order delivery address based on the incoming longitude/latitude. Sends event with attributes containing calculated distances.

CancelAllFulfilmentsForOrder

RuleThe rule changes the status of all fulfilments associated with the incoming order entity to `CANCELLED` and updates fulfilment item's filled quantity and rejected quantity.

CancelFulfilment

RuleThe rule changes the status of the incoming fulfilment to 'CANCELLED' and updates fulfilment item's filled and rejected quantities.

ChangeOrderDeliveryAddress

RuleThe rule changes the order delivery address and creates a comment for the order.

ConfirmFulfilmentItems

RuleThe rule updates the fulfillment items with the quantity details using the quantity details from the items received in the event attribute.

CopyAttributesFromFulfilmentToArticle

RuleThe rule copies all the attributes from the parent fulfilment onto the article entity in the incoming event.

CreateArticlesForFulfilment

RuleThe rule creates one or more articles for the Fulfilment in the incoming event.

CreateBillingAccount

RuleThe rule creates customer’s Billing Account with billing account reference.

CreateCreditMemoForRevisedOrder

RuleThe rule creates a CreditMemo for the BillingAccount using the supplied revised order details and the old order as well.

CreateCreditMemoFromAppeasement

RuleThe rule creates a CreditMemo for the BillingAccount using the supplied Order details.

CreateDemoConsignment

RuleThe rule creates a demo consignment.Creates a demo consignment with label {"PROP_LABEL_URL"} and carrier {"PROP_CARRIER_REF"}.

CreateFinancialTransaction

RuleThe rule processes a payment event and creates a financial transaction.

CreateFulfilment

RuleThe rule creates fulfilment based on the incoming proposed fulfilment, excluding fulfilments in specified statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateFulfilmentForFulfilmentChoice

RuleThe rule creates a fulfilment based on the incoming proposed fulfilment, excluding fulfilments in specified statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateFulfilmentForFulfilmentChoiceForUnfulfillableItems

RuleThe rule creates a rejected fulfilment for order items that could not be fulfilled (no inventory) based on location. The rule processes only fulfilments that are in accepted statuses and not in rejected statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateFulfilmentForUnfulfillableItems

RuleThe rule creates `SYSTEM_REJECTED` fulfilments for unfulfillable items using a location ref provided in input parameters. It uses a mathematical calculation on counts of all fulfilments by dividing them into 2 different groups depending on their statuses i.e. accepted statuses and rejected statuses. If the `fulfilmentType` parameter is not empty then a fulfilment with this type will be created.

CreateInvoiceForOrder

RuleThe rule creates an Invoice for the order.

CreateParcelsForFulfilment

RuleThis rule is executed to create articles based on the items packed into parcels.

CreateReturnOrderFromOrder

RuleThe rule creates a return entity. The return entity is then used to initiate the process of order items return.

CreateRevisedOrder

RuleThe rule creates a revised order based on the revised order attributes passed in the event.

EvaluateFulfilmentsForAddressChange

RuleThe rule defines whether the address change is major based on the address fields that have been modified.

FilterLocationsByRadius

RuleThe rule finds locations which are outside the radius provided in the event attribute.

ForwardEventByFulfilmentChoiceType

RuleThe rule sends an event with a proper name if the fulfilment choice has a definite type.

ForwardEventsWithFulfilmentChoiceReference

RuleThe rule sends event to all fulfilment choices with definite reference.

ForwardEventWithDeliveryAddressCoordinates

RuleThe rule forwards the input event with coordinates of the order delivery address.

ForwardEventWithDeliveryAddressCoordinatesByType

RuleThe rule forwards the event containing the longitude & latitude of the delivery address if fulfilment choice has definite delivery type.

ForwardEventWithPickupLocationCoordinates

RuleThe rule forwards the input event with coordinates of the pickup location.

ForwardEventWithPickupLocationCoordinatesByType

RuleThe rule forwards the event containing the longitude & latitude of the pickup location if the fulfilment choice has definite delivery type.

ForwardIfDeliveryAddressNotPresent

RuleThe rule forwards the input event if the order’s delivery address is not present.

ForwardIfDeliveryAddressPresent

RuleThe rule forwards the input event if the order’s delivery address is present.

ForwardIfFulfilmentChoiceCoordinatesNotPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address longitude and latitude are invalid.

ForwardIfFulfilmentChoiceCoordinatesPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address longitude and latitude are valid.

ForwardIfFulfilmentChoiceDeliveryAddressNotPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address is invalid.

ForwardIfFulfilmentChoiceDeliveryAddressPresent

RuleThe rule forwards the input event if the fulfilment choice delivery address is present.

ForwardIfMaxSplitLimitNotReached

RuleThe rule forwards the input event if the split limit is not reached for the order, excluding fulfilment with one of the given statuses.

ForwardIfMaxSplitLimitReached

RuleThe rule forwards the input event if the split limit is reached for the order, excluding fulfilment with one of the given statuses.

ForwardIfOrderCoordinatesNotPresent

RuleThe rule forwards the input event if coordinates of the order delivery address do not exist.

ForwardIfOrderCoordinatesPresent

RuleThe rule forwards the input event if coordinates of the order delivery address exist.

ForwardIfPickupLocationNotValid

RuleThe rule sends an event if the pickup location is not part of the network specified or doesn’t match the specified location status. 

ForwardIfPickupLocationValid

RuleThe rule sends an event if the pickup location is part of the network specified and matches the specified location status. 

ForwardIfProposedFulfilmentNotPresent

RuleThis rule forwards the input event if a proposed fulfilment is not present.

ForwardIfProposedFulfilmentPresent

RuleThe rule forwards the input event if a proposed fulfilment is present.

ForwardIfUnfilfilledItemsExist

RuleThe rule forwards the input event if unfulfilled items exist in the order, excluding fulfilment with one of the given statuses.

ForwardIfUnfulfilledItemsExistInFulfilmentChoice

RuleThe rule forwards the event with the proper event name if fulfilment statuses are not from the provided list and there are unfulfilled items in the fulfilment choice.

GetLocationsForNetwork

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

RejectFulfilment

RuleThe rule rejects a fulfilment by updating the rejected quantities of all fulfilment items to the requested quantities.

ResolveFulfilmentChoiceCoordinates

RuleThe rule resolves the longitude and latitude of the fulfilment choice delivery address. It sends specific event depending on whether the coordinates could be resolved or not.

ResolveOrderCoordinates

RuleThe rule determines the longitude and latitude of an order based on the delivery address.

ScheduleFulfilmentCreationForDeliverAfter

RuleThe rule schedules an event based on the Shipment’s Delivery From date (fulfilment choice’s `deliverAfter` date).

ScheduleFulfilmentExpiry

RuleThis rule sets an expiry time for the incoming fulfilment and schedules a `FulfilmentExpiry` event.

ScheduleFulfilmentExpiryNow

RuleThe rule sets an expiry time for the incoming fulfilment based on the location’s `Pick&PackTimeLimit` and schedules a "FulfilmentExpiry" event.

ScheduleFulfilmentReleaseForDeliverAfter

RuleThe rule schedules an event based on the Shipment’s Delivery From date (fulfillment choice’s `deliverAfter` date).

SearchInventoryAtLocations

RuleThe rule searches inventory based on the incoming event information using virtual catalogue reference.

SearchInventoryAtLocationsForFulfilmentChoice

RuleThe rule searches inventory based on the incoming event information using virtual catalogue with virtual catalogue ref, and sends event.

SelectProposedFulfilment

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

SelectProposedFulfilmentForFulfilmentChoice

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

SendEventForAllFulfilmentChoices

RuleThe rule sends event to all fulfilment choices.

SendEventForAllFulfilments

RuleThe rule sends an event to all fulfilments.

SendEventForAppeasementToBillingAccount

RuleThis rule sends an event to the billing workflow from an order workflow with a customer's billing account information and refund information to create a credit memo of type Credit with the refund amount for the order.

SendEventForArticles

RuleThe rule sends an event to the related articles.

SendEventForFulfilment

RuleThe rule sends an event to the related fulfilment.

SendEventForFulfilmentChoice

RuleThe rule sends event to the associated fulfilment choice.

SendEventForFulfilmentChoiceOnVerifyingRejections

RuleThis rule triggers an event to the fulfillment choice if no items were rejected during the Pack step.

SendEventForOrder

RuleThe rule sends an event for the associated Order.

SendEventForOrderOnVerifyingRejections

RuleThis rule triggers an event for the order when no items were rejected during the packing process.

SendEventForRevisedOrderToBillingAccount

RuleThe rule sends an event to the billing workflow with billing account information and entity information

SendEventOnVerifyingAllArticleStates

RuleThe rule sends event to the entity from the incoming event on verifying if all the articles of the incoming entity are in any of the given statuses.

SendEventOnVerifyingAllArticleStatesByFulfilmentChoice

RuleThe rule sends event to the entity from the incoming event if all the articles of the incoming entity are in one of the given statuses.

SendEventOnVerifyingAllFulfilmentChoiceStates

RuleThe rule sends event if all fulfilment choices of entityType have statuses from the specified list.

SendEventOnVerifyingAllFulfilmentStates

RuleThe rule verifies if all fulfilments for order are in defined statuses. If yes then send an event to order, else no processing.

SendEventOnVerifyingAllFulfilmentStatesByFulfilmentChoice

RuleThe rule verifies if all fulfillments for fulfilment choice are in given status. If yes, then it sends an event to the fulfilment choice, else no processing.

SendEventOnVerifyingAllOrderItemsProcessed

RuleThe rule sends an event to current Order when for all items in the Order, sum of `filledQty` of fulfilments in defined statuses, `rejectedQty` of fulfilments in defined statuses and `requestedQty` of fulfilments in defined statuses matches the `requestedQty` of the Items in the Order.

SendEventOnVerifyingAnyFulfilmentStates

RuleThe rule verifies if any fulfilment in the incoming order is in one of the given statuses in the input parameter. If yes then the rule will send an event to order, otherwise no processing is done.

SendEventOnVerifyingAttributeValue

RuleThe rule sends and event with the name specified in the input parameter in case the incoming entity has an attribute name and value that matches with the name and value provided in the input parameters. Otherwise, a no match event is sent.

SendEventOnVerifyingConsignment

RuleThe rule verifies if the incoming consignment entity has the label URL and the consignment status from input parameter is a success or failure and sends an event.

SendEventToFulfilmentOnVerifyingFulfilmentChoiceStatus

RuleThe rule sends an event to the incoming fulfilment entity if the fulfilment choice is in any of the statuses provided in input parameter.

SendEventOnVerifyingNoParcels

RuleThis rule is executed when no items are packed into parcels and all items are rejected.

SendEventToFulfilmentOnVerifyingOrderStatus

RuleThe rule sends an event to the incoming fulfilment entity if the parent order is in any of the statuses provided in input parameter.

SendEventOnVerifyingParcelsComplete

RuleThis rule triggers an event when items are packed into parcels without rejection.

SendEventOnVerifyingParcelsPartiallyComplete

RuleThis rule is executed when both packed items and rejections are present.

SendEventToUpdateInventoryQuantity

RuleThe rule triggers inventory re-calculation event with event name provided in the input parameter with +/-ve quantities of each item on the basis of the type of operation.

SetFulfilmentItemRejections

RuleThis rule is executed to update item quantities and record rejection reasons when items are rejected.

UpdateFulfilmentChoiceCoordinates

RuleThe rule updates longitude and latitude of the fulfilment choice delivery address based on the incoming event information.

UpdateFulfilmentType

RuleThe rule updates fulfilment type field.

UpdateOrderCoordinates

RuleThe rule updates the longitude and latitude of the order based on the incoming event information received from the ResolveOrderCoordinates rule.This rule works only if the order comes without coordinates. The ResolveOrderCoordinates rule resolves the coordinates and sends the event with latitude and longitude. After that, the UpdateOrderCoordinates rule gets coordinates from the event and updates the delivery address with coordinates.

UpdateOrderItemAttribute

RuleThe rule provides the foundation to update the order Item attribute with the previously identified returnable quantity amount.

ValidateAppeasementAmount

RuleThe rule validates that appeasement amount does not exceed the original total order price.

ValidateOrderDeliveryAddress

RuleThe rule verifies the delivery address of the order, sets the address coordinates accordingly and sends out an event.

ValidateReturnQty

RuleThe rule provides the foundation to validate that the return request is valid.

ValidateRevisedOrder

RuleThe rule validates the revised order request before canceling the existing order.

VerifyBillingAccount

RuleThe rule verifies billing account existence, sends event to the billing account workflow, or creates billing account if none found, before the return is initiated.

VerifyingFulfilmentItems

RuleThe rule verifies the quantity of items fulfilled in the incoming fulfilment entity and sends the corresponding event when it matches the quantity from the input parameter.

ScheduleEvent

RuleSend an event to trigger another Ruleset for the same entity after a specified amount of time has passed.

SendWebhook

RuleSend an Event payload to an external system, defined by a Setting configuration.

IfPropertyIsBetween

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is between the provided values.

IfPropertyIsLessThan

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is less than the provided value.

IfPropertyIsGreaterThan

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is greater than the provided value.An example of this includes pushing an Order through a fraud-check flow only when the `totalPrice` field is greater than `100`.

IfPropertyIsNotPresent

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is null.This is typically used as an "else" case for the IfPropertyIsPresent Rule.

IfPropertyIsPresent

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute is not null.

IfPropertyNotEquals

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute does not match the provided value.This is typically used as an "else" case for the IfPropertyEquals Rule.

SendEvent

RuleSend an event to trigger another Ruleset for the same entity.

SetState

RuleChange the Status of the current Entity to the value provided.

IfPropertyEquals

RuleConditionally trigger another Ruleset when the specified Entity field or Event attribute matches the provided value.

SplitInventoryUpdates (Deprecated)

RuleNotifies the inventory positions of the incoming updates with event {eventName}

NotifyVirtualCatalogueOnNetworkMatch

RuleConditionally send an event to the Virtual Catalog (specified by its Reference) if it passes the "Network-Match-Check".A Virtual Catalog passes the "Network-Match-Check" when its Network(s) finds a match with a given Inventory Position Location Network(s).The `Rule NotifyVirtualCataloguesByRefsOnNetworksMatch` is a newer version of the `NotifyVirtualCatalogueOnNetworkMatch`. Moving forward, please use the `NotifyVirtualCataloguesByRefsOnNetworksMatch` instead of the `NotifyVirtualCatalogueOnNetworkMatch`.

AllocateConfirmedItemsByFulfilmentExpiry

RuleAllocates picked items to all fulfilments in the Wave. Priortising the fulfilments expiring first and not in specified statuses. Secondly, notifies Fulfilments with the specified event name.
Building Blocks
Building Blocks
Packages & Modules
All UI Components
Workflows
Settings
Interface Contracts
All Rules
By Type
All Types
Knowledge Tracks
Extend Knowledge
Glossary
All How-to Guides
Sitemap
Topics
Use Cases
Helpful Resources
Platform Limits
Support Policy
Service Level Agreement (SLA) - Enterprise
Deprecation Policy
Extend Knowledge Content – Terms and Conditions
System and Organization Controls (SOC) 3 Report
Data Privacy Addendum
Security Policy
Quick Links
For Partners
Customer Resources
Webinars and Events
Certifications
Training Resources
Knowledge Tracks
Builders Portal
Product Update Newsletter
Industry Blogs & Events Newsletter
Trust Center Portal

Copyright © 2024-2026 Fluent Retail Pty Ltd (trading as Fluent Commerce). Unless otherwise expressly stated in a current written agreement with Fluent Commerce or any of its affiliates or on any single page of the docs.fluentcommerce.com site, use of the materials on this site is strictly limited to viewing by individuals over 18 years old for legitimate commercially appropriate reasons; and any downloading, copying or other actions or uses of any kind or by any means of the materials on this site, including by artificial intelligence tools, is strictly prohibited. All other rights reserved.

Fluent Logo