UpdateCategory
RuleRules are designed to be building blocks for workflow logic.
Changed on:
12 Aug 2025
Overview
Update a category based on the information provided in the event| Plugin Name | Inventory Reference Module |
|---|---|
| Namespace | [[account.id]].globalinventory |
- Product Catalogue workflow
- Inventory Catalogue workflow
- Control Group workflow
- Virtual Catalogue workflow
UI Description
Update a category based on the information provided in the event
Accepts
- CATEGORY
Actions
- This rule produces a MutationAction that will update an existing category.
Rule parameters
This rule has no Input Parameters.
Event attributes
Main Event Attributes
| Parameter | Description | Data Type | Required? |
| ref | The ref of the category | String | Required |
| type | The type of the category | String | Required |
| name | The name of the category | String | Required |
| parentCategory | The ref of the parent category | String | Optional |
| childCategories | A list of child category references | [String] | Optional |
| summary | A brief summary of the category | String | Optional |
| attribute | Extra attributes that may be used as part of this category. See the table below for the definition | [Attribute] | Optional |
Attribute type sub-attribute
| Parameter | Description | Data Type | Required? |
| name | The ref of the category | String | Required |
| type | The type of the category | String | Required E.g STRING, INTEGER, BOOLEAN, OBJECT |
| value | The name of the category | String | Required |
Exceptions
EventAttributeNotFoundException is thrown when event attribute
`{ref}` is missingConfiguration example
1{
2 "name": "FLUENTRETAIL.globalinventory.UpdateCategory"
3}Detailed Technical Description
All the event attributes of the incoming event are parsed/deserialized into a "Category" object which has the following structure:An example JSON payload that represents the event attributes of an incoming event: