UpdateCategoriesForVariantProduct

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Rule

Changed on:

13 Nov 2023

Overview

Adds or removes categories from the 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:

Product Catalogue workflow
Inventory Catalogue workflow
Control Group workflow
Virtual Catalogue workflow

Inventory Reference Module

The Inventory Module includes the following areas:

Product Catalog workflow
Inventory Catalog workflow
Control Group workflows
Virtual Catalog workflows

UI Description

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

Accepts

PRODUCT

Actions

This rule produces a MutationAction that will remove all the categories from the variant product except categories provided as part of the event attribute {categoryRef}. If one or more of the categories provided in the event attributes are not already linked to this variant product they will be added to this product. This number of MutationActions produced in this rule depends on the categories in the event attributes. There will be a MutationAction if one or more categories are to be added and another MutationAction if there are one or more categories to be removed from product

Rule parameters

This rule has no Input Parameters.

Event attributes

Parameter	Description	Data Type	Required?
ref	The ref of the product	String	Required
categoryRefs	The list of categories that will be linked to this variant product	[String]	Optional

Exceptions

If the event attribute

`{ref}`

is null or empty, an EventAttributeNotFoundException will be thrown

Configuration example

1{
2  "name": "FLUENTRETAIL.globalinventory.UpdateCategoriesForVariantProduct"
3}

Language: json

Detailed Technical Description

This rule queries all the categories linked to this variant product using the

`{ref}`

event attribute (as product ref) and

`{rootEntityRef}`

value (as the product catalogue ref) from the incoming event. It then calculates the difference between the categories provided in the incoming event attribute

`{categoryRefs}`

and the ones already linked to the variant product and updates the variant product only to leave the categories received through the event attribute

`{categoryRefs}`

linked. This means that some categories that are already linked may be removed and new categories may be linked to the variant product.

Note - The categoryRefs work to the below logic:

- Any other categories that are already linked to this variant product but are not in this list will be removed.

- Any new category/categories (not already linked to this product) will be added

- If the {categoryRefs} is empty, all the categories that are already linked to this product will be removed

- If the {categoryRefs} list is the same as the category list of the product, there will be no update (no changes to existing categories of the product)

- If the {categoryRefs} is null, there will be no update (no changes to existing categories of the product)

Version History

2023-08-03

v2.0.0

refers to the plugin