Products Change Types

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

Change types

on Product

Add To Category

Change triggered by the Add to Category update action.
type​
String​
"AddToCategoryChange"
change​
String​
"addToCategory"
previousValue​
Array of Reference​

Value before the change.

nextValue​
Array of Reference​

Value after the change.

category​

Category to which the Product was added.

catalogData​
String​

Product data that was updated.

Add Variant

Change triggered by the Add ProductVariant update action.
type​
String​
"AddVariantChange"
change​
String​
"addVariant"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

Change Last Variant ID

This change is initiated by background processes after the Add ProductVariant update action is performed.
type​
String​
"ChangeLastVariantIdChange"
change​
String​
"changeLastVariantId"
previousValue​
Int​

Value before the change.

nextValue​
Int​

Value after the change.

Change Localized Name

Change triggered by the Change Product 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 Master Variant

Change triggered by the Change Master Variant update action.
type​
String​
"ChangeMasterVariantChange"
change​
String​
"changeMasterVariant"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

Change Review Rating Statistics

This change is initiated by background processes after the Set Rating update action is performed.
type​
String​
"ChangeReviewRatingStatisticsChange"
change​
String​
"changeReviewRatingStatistics"
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 From Category

Change triggered by the Remove from Category update action.
type​
String​
"RemoveFromCategoryChange"
change​
String​
"removeFromCategory"
previousValue​
Array of Reference​

Value before the change.

nextValue​
Array of Reference​

Value after the change.

category​

Category from which the Product was removed.

catalogData​
String​

Product data that was updated.

Remove Variant

Change triggered by the Remove ProductVariant update action.
type​
String​
"RemoveVariantChange"
change​
String​
"removeVariant"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

Set Category Order Hint

Change triggered by the Set Category Order Hint update action.
type​
String​
"SetCategoryOrderHintChange"
change​
String​
"setCategoryOrderHint"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

categoryId​
String​
id of the updated Category.

Set Key

Change triggered by the Set Key update action.
type​
String​
"SetKeyChange"
change​
String​
"setKey"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Localized Description

Change triggered by the Set Description update action.
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 Price Mode

Change triggered by the Set PriceMode update action.
type​
String​
"SetPriceModeChange"
change​
String​
"setPriceMode"
previousValue​
ProductPriceModeEnum​

Value before the change.

nextValue​
ProductPriceModeEnum​

Value after the change.

Set Product Attribute

Change triggered by the Set Product Attribute update action.
type​
String​
"SetProductAttributeChange"
change​
String​
"setProductAttribute"
catalogData​
String​

Product data that was updated.

previousValue​

Value before the change.

nextValue​

Value after the change.

Set Search Keywords

Change triggered by the Set SearchKeywords update action.
type​
String​
"SetSearchKeywordsChange"
change​
String​
"setSearchKeywords"
previousValue​
SearchKeywords​

Value before the change.

nextValue​
SearchKeywords​

Value after the change.

catalogData​
String​

Product data that was updated.

Set Tax Category

Change triggered by the Set TaxCategory update action.
type​
String​
"SetTaxCategoryChange"
change​
String​
"setTaxCategory"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Variant Availability

This change is initiated by background processes after the Add Quantity, Remove Quantity, or Change Quantity update action is performed.
type​
String​
"SetVariantAvailabilityChange"
change​
String​
"setVariantAvailability"
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.

Transition State

type​
String​
"TransitionStateChange"
change​
String​
"transitionState"
previousValue​

Value before the change.

nextValue​

Value after the change.

on ProductVariant

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.

Add External Image

Change triggered by the Add External Image update action.
type​
String​
"AddExternalImageChange"
change​
String​
"addExternalImage"
previousValue​
Array of Image​

Value before the change.

nextValue​
Array of Image​

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 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 Price

Change triggered by the Change Price update action.
type​
String​
"ChangePriceChange"
change​
String​
"changePrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

catalogData​
String​

Product data that was updated.

priceId​
String​
id of the Embedded Price.
variant​
String​

Identifier of the updated Product Variant.

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

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.

Remove Image

Change triggered by the Remove Image update action.
type​
String​
"RemoveImageChange"
change​
String​
"removeImage"
previousValue​
Array of Image​

Value before the change.

nextValue​
Array of Image​

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.

Set Attribute

Change triggered by the Set Attribute update action.
type​
String​
"SetAttributeChange"
change​
String​
"setAttribute"
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.

Set Prices

Change triggered by the Set Prices update action.
type​
String​
"SetPricesChange"
change​
String​
"setPrices"
previousValue​
Array of Price​

Value before the change.

nextValue​
Array of Price​

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.

addedItems​
Array of Price​

Elements added to the array.

removedItems​
Array of Price​

Elements removed from the array.

Set Product Variant Key

Change triggered by the Set ProductVariant Key update action.
type​
String​
"SetProductVariantKeyChange"
change​
String​
"setProductVariantKey"
previousValue​
String​

Value before the change.

nextValue​
String​

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.

Set SKU

Change triggered by the Set SKU update action.
type​
String​
"SetSkuChange"
change​
String​
"setSku"
previousValue​
String​

Value before the change.

nextValue​
String​

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.

on Embedded Price

Set Discounted Price

Change triggered by the Set Discounted Embedded Price update action.
type​
String​
"SetDiscountedPriceChange"
change​
String​
"setDiscountedPrice"
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.

priceId​
String​
id of the Embedded Price.
price​
Embedded Price of the ProductVariant.

Set Price Key

Change triggered by the Set Price Key update action.
type​
String​
"SetPriceKeyChange"
change​
String​
"setPriceKey"
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.

priceId​
String​
id of the Embedded Price.
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Product Price Custom Field

Change triggered by the Set Price CustomField update action.
type​
String​
"SetProductPriceCustomFieldChange"
change​
String​
"setProductPriceCustomField"
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.

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

Set Product Price Custom Type

Change triggered by the Set Price Custom Type update action.
type​
String​
"SetProductPriceCustomTypeChange"
change​
String​
"setProductPriceCustomType"
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.

priceId​
String​
id of the Embedded Price.

on Asset

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.

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.

on Image

Move Image To Position

Change triggered by the Move image to position update action.
type​
String​
"MoveImageToPositionChange"
change​
String​
"moveImageToPosition"
previousValue​
Array of Image​

Value before the change.

nextValue​
Array of Image​

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.

Set Image Label

Change triggered by the Set Image Label update action.
type​
String​
"SetImageLabelChange"
change​
String​
"setImageLabel"
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.

on publish workflow

Publish

Change triggered when:

  • ProductCatalogData published transitions from false to true.
  • Any update action updates the current catalog (using staged=false) and the resulting Product is in a published state.
For better traceability of the Publish update action, use the ProductPublished Message.
type​
String​
"PublishChange"
change​
String​
"publish"

Revert Staged Changes

Change triggered by the Revert Staged Changes update action.
type​
String​
"RevertStagedChangesChange"
change​
String​
"revertStagedChanges"

Revert Staged Variant Changes

Change triggered by the Revert Staged Variant Changes update action.
type​
String​
"RevertStagedVariantChangesChange"
change​
String​
"revertStagedVariantChanges"

Unpublish

Change triggered when ProductCatalogData published transitions from true to false.
For better traceability of the Unpublish update action, use the ProductUnpublished Message.
type​
String​
"UnpublishChange"
change​
String​
"unpublish"