Categories Change Types

Change types that represent data modifications made to the Categories entity.

Change types

Add Asset

Change triggered by the Add Asset update action.
type​
String​
"AddAssetChange"
change​
String​
"addAsset"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Change Asset Name

Change triggered by the Change Asset Name update action.
type​
String​
"ChangeAssetNameChange"
change​
String​
"changeAssetName"
previousValue​

Value before the change.

nextValue​

Value after the change.

asset​

Information about the updated Asset.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Change Asset Order

Change triggered by the Change Asset Order update action.
type​
String​
"ChangeAssetOrderChange"
change​
String​
"changeAssetOrder"
previousValue​
Array of LocalizedString​

Value before the change.

nextValue​
Array of LocalizedString​

Value after the change.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Change Localized Name

Change triggered by the Change Name update action.
type​
String​
"ChangeLocalizedNameChange"
change​
String​
"changeName"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

This field is only present if the change is related to the Product entity.

Change Order Hint

Change triggered by the Change OrderHint update action.
type​
String​
"ChangeOrderHintChange"
change​
String​
"changeOrderHint"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Change Parent

Change triggered by the Change Parent update action.
type​
String​
"ChangeParentChange"
change​
String​
"changeParent"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Slug

Change triggered by the Change Slug update action.
type​
String​
"ChangeSlugChange"
change​
String​
"changeSlug"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

Remove Asset

Change triggered by the Remove Asset update action.
type​
String​
"RemoveAssetChange"
change​
String​
"removeAsset"
previousValue​

Value before the change.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Ancestors

This change is initiated by background processes after the Change Parent update action is performed.
type​
String​
"SetAncestorsChange"
change​
String​
"setAncestors"
addedItems​
Array of Reference​

Elements added to the array.

removedItems​
Array of Reference​

Elements removed from the array.

previousValue​
Array of Reference​

Value before the change.

nextValue​
Array of Reference​

Value after the change.

Set Asset Custom Field

Change triggered by the Set Asset CustomField update action.
type​
String​
"SetAssetCustomFieldChange"
change​
String​
"setAssetCustomField"
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
asset​

Information about the updated Asset.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Asset Custom Type

Change triggered by the Set Asset Custom Type update action.
type​
String​
"SetAssetCustomTypeChange"
change​
String​
"setAssetCustomType"
previousValue​

Value before the change.

nextValue​

Value after the change.

asset​

Information about the updated Asset.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Asset Description

Change triggered by the Set Asset Description update action.
type​
String​
"SetAssetDescriptionChange"
change​
String​
"setAssetDescription"
previousValue​

Value before the change.

nextValue​

Value after the change.

asset​

Information about the updated Asset.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Asset Key

Change triggered by the Set Asset Key update action.
type​
String​
"SetAssetKeyChange"
change​
String​
"setAssetKey"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

asset​

Information about the updated Asset.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Asset Sources

type​
String​
"SetAssetSourcesChange"
change​
String​
"setAssetSources"
previousValue​
Array of AssetSource​

Value before the change.

nextValue​
Array of AssetSource​

Value after the change.

asset​

Information about the updated Asset.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Asset Tags

type​
String​
"SetAssetTagsChange"
change​
String​
"setAssetTags"
previousValue​
Array of String​

Value before the change.

nextValue​
Array of String​

Value after the change.

asset​

Information about the updated Asset.

catalogData​
String​

Product data that was updated.

variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Custom Field

Change triggered by the Set Custom Field update action.
type​
String​
"SetCustomFieldChange"
change​
String​
"setCustomField"
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.

Set Custom Type

Change triggered by the Set Custom Type update action.
type​
String​
"SetCustomTypeChange"
change​
String​
"setCustomType"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set External ID

type​
String​
"SetExternalIdChange"
change​
String​
"setExternalId"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Key

type​
String​
"SetKeyChange"
change​
String​
"setKey"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Localized Description

type​
String​
"SetLocalizedDescriptionChange"
change​
String​
"setDescription"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

This field is only present if the change is related to the Product entity.

Set Meta Description

Change triggered by the Set Meta Description update action.
type​
String​
"SetMetaDescriptionChange"
change​
String​
"setMetaDescription"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

Set Meta Keywords

Change triggered by the Set Meta Keywords update action.
type​
String​
"SetMetaKeywordsChange"
change​
String​
"setMetaKeywords"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

Set Meta Title

Change triggered by the Set Meta Title update action.
type​
String​
"SetMetaTitleChange"
change​
String​
"setMetaTitle"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

Set Stores

Change triggered by the Set Stores update action.
type​
String​
"SetStoresChange"
change​
String​
"setStores"
previousValue​
Array of Reference​

Value before the change.

nextValue​
Array of Reference​

Value after the change.

addedItems​
Array of KeyReference​

Elements added to the array.

removedItems​
Array of KeyReference​

Elements removed from the array.