RuleRules are designed to be building blocks for workflow logic.
Changed on:
12 Aug 2025
Overview
Update a variant product based on the information provided in the event
Plugin Name
Inventory Reference Module
Namespace
[[account.id]].globalinventory
The Inventory Reference Module is the foundation for inventory related implementations. It provides reference Workflows for inventory ingestion and processing. Extensible by design, use this Module as a base to build a solution to the needs of your customers.The Inventory Module includes the following areas:
Update a variant product based on the information provided in the event
Accepts
PRODUCT
Actions
This rule produces a MutationAction that will update a variant product with provided values
Rule parameters
This rule has no Input Parameters.
Event attributes
This rule uses all the event attributes to update a variant product. Note that some attributes represent complex types and their definitions follow the main event attribute definition.
Main Event Attributes
Parameter
Description
Data Type
Required?
ref
The ref of the product
String
Required
type
The type of the product
String
Required
name
The name of the product
String
Required
gtin
The gtin of the product
String
Required
standardProductRef
The ref of the parent Standard Product
String
Optional
categoryRefs
A list of string category references
[String]
Optional
summary
A brief summary of the product
String
Optional
prices
A list of prices. See the below table for its attributes
[Price]
Optional
taxType
Tax type of this product. See the below table for its attributes
Tax
Optional
attributes
Extra attributes that may be used as part of this product. See the table below for the definition
[Attribute]
Optional
Price sub-attribute
Parameter
Description
Data Type
Required?
type
The type of the price
String
Required
currency
The currency of the price
String
Required E.g. EUR, AUD
value
The value of the price
Floating Point
Required
Tax type sub-attribute
Parameter
Description
Data Type
Required?
country
The country of this tax type
String
Required
group
The tax group
String
Required
tariff
The tariff of this tax type
String
Required
Attribute type sub-attribute
Parameter
Description
Data Type
Required?
name
The name of the attribute
String
Required
type
The type of the attribute
String
Required E.g. STRING, INTEGER, BOOLEAN, OBJECT
value
The value of the attribute
JSON or scalar
Required
Exceptions
If any of the required main attribute fields are null or missing, an EventAttributeNotFoundException will be thrown
All the event attributes of the incoming event are parsed/deserialized into a "Product" object which has the following structureAn example JSON payload that represents the event attributes of an incoming eventThis rule parses/deserializes all the event attributes into a Product object outlined above. It then creates a "variant product mutation" request using all the event attribute values. The `{entityRef}` value of the incoming event is used as the product catalogue reference of the variant product being created.