Latest Rule Library Changes

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

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

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

Create 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

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

Checks 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

Creates a category based on the information passed in the event

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

Create an inventory position based on the incoming event attributes

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

Create an inventory quantity based on the incoming event attributes

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

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

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

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

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

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

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

Forward the incoming event with event name {eventName}.

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

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

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

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

This article covers the following topics: 

• Supported Entities: `VIRTUAL_POSITION`
• This rule produces a `SendEventAction`
• Rule Parameters
• Event Attributes
• Exceptions
• Configuration Example
• Detailed Technical Description

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

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

Forwards 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

Forward the event {eventName} if the inventory position onHand value has changed

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

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

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

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

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

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

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

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

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

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

Conditionally 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).

Conditionally 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).

Conditionally 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).

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

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

Send 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.

Resets the virtual position

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

Send event {inventoryConfirmationEvent} if inventory is confirmed, or send {inventoryReserveEvent} if inventory is reserved, or {inventoryCancelEvent} if inventory is cancelled, to inventory position and include inventory quantities of type {inventoryQuantityTypes} in event attribute.

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

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

Update 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

Updates a base virtual position

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

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

Update a category based on the information provided in the event

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

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

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

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

Update a standard product using the information provided in the event

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

Create or Update an Inventory Quantity.

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

Validates the incoming category event

Validates the incoming product payload

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

Validates the incoming standard product payload

Validates the incoming variant product event payload

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

Allocates 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.

Sends 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.

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

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

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

The 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.

The 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.

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

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

The 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.

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

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

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

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

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

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

The rule creates a demo consignment.

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

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

The 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.

The 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.

The 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.

The 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.

The rule creates an Invoice for the order.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The 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.

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

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

The 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.

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

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

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

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

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

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

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

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

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

The rule sends event to all fulfilment choices.

The rule sends an event to all fulfilments.

This 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.

The rule sends an event to the related articles.

The rule sends an event to the related fulfilment.

The rule sends event to the associated fulfilment choice.

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

The rule sends an event for the associated Order.

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

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

The 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.

The 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.

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

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

The 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.

The 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.

The 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.

The 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.

The 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.

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

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

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

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

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

The 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.

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

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

The rule updates fulfilment type field.

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

The rule updates original order attribute with link to new revised order reference.

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

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

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

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

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

The 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.

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

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

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

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

Conditionally 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`.

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

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

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

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

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

The rule changes the state of the incoming entity to the status provided in the input parameter using the generic update status mutation in GraphQL.

Allocates 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.