Change types
on Product
Add To Category
typeString | "AddToCategoryChange" |
changeString | "addToCategory" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
category | Category to which the Product was added. |
catalogDataString | Product data that was updated.
|
Add Variant
typeString | "AddVariantChange" |
changeString | "addVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Change Last Variant ID
typeString | "ChangeLastVariantIdChange" |
changeString | "changeLastVariantId" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
Change Localized Name
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Master Variant
typeString | "ChangeMasterVariantChange" |
changeString | "changeMasterVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Change Review Rating Statistics
typeString | "ChangeReviewRatingStatisticsChange" |
changeString | "changeReviewRatingStatistics" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Slug
typeString | "ChangeSlugChange" |
changeString | "changeSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Remove From Category
typeString | "RemoveFromCategoryChange" |
changeString | "removeFromCategory" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
category | Category from which the Product was removed. |
catalogDataString | Product data that was updated.
|
Remove Variant
typeString | "RemoveVariantChange" |
changeString | "removeVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Set Category Order Hint
typeString | "SetCategoryOrderHintChange" |
changeString | "setCategoryOrderHint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
categoryIdString | id of the updated Category. |
Set Key
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
Set Localized Description
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Meta Description
typeString | "SetMetaDescriptionChange" |
changeString | "setMetaDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Set Meta Keywords
typeString | "SetMetaKeywordsChange" |
changeString | "setMetaKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Set Meta Title
typeString | "SetMetaTitleChange" |
changeString | "setMetaTitle" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Set Price Mode
typeString | "SetPriceModeChange" |
changeString | "setPriceMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Product Attribute
typeString | "SetProductAttributeChange" |
changeString | "setProductAttribute" |
catalogDataString | Product data that was updated.
|
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Search Keywords
typeString | "SetSearchKeywordsChange" |
changeString | "setSearchKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
Set Tax Category
Set Variant Availability
typeString | "SetVariantAvailabilityChange" |
changeString | "setVariantAvailability" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Transition State
on ProductVariant
Add Asset
typeString | "AddAssetChange" |
changeString | "addAsset" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Add External Image
typeString | "AddExternalImageChange" |
changeString | "addExternalImage" |
previousValueArray of Image | Value before the change. |
nextValueArray of Image | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Change Asset Order
typeString | "ChangeAssetOrderChange" |
changeString | "changeAssetOrder" |
previousValueArray of LocalizedString | Value before the change. |
nextValueArray of LocalizedString | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Change Price
typeString | "ChangePriceChange" |
changeString | "changePrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
priceIdString | id of the Embedded Price. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Remove Asset
typeString | "RemoveAssetChange" |
changeString | "removeAsset" |
previousValue | Value before the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Remove Image
typeString | "RemoveImageChange" |
changeString | "removeImage" |
previousValueArray of Image | Value before the change. |
nextValueArray of Image | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Attribute
typeString | "SetAttributeChange" |
changeString | "setAttribute" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Prices
typeString | "SetPricesChange" |
changeString | "setPrices" |
previousValueArray of Price | Value before the change. |
nextValueArray of Price | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
addedItemsArray of Price | Elements added to the array. |
removedItemsArray of Price | Elements removed from the array. |
Set Product Variant Key
typeString | "SetProductVariantKeyChange" |
changeString | "setProductVariantKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set SKU
typeString | "SetSkuChange" |
changeString | "setSku" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | 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
typeString | "SetDiscountedPriceChange" |
changeString | "setDiscountedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
price | Embedded Price of the ProductVariant. |
Set Price Key
typeString | "SetPriceKeyChange" |
changeString | "setPriceKey" |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
Set Product Price Custom Field
typeString | "SetProductPriceCustomFieldChange" |
changeString | "setProductPriceCustomField" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
customTypeIdString | id of the referenced Type. |
nameString | Name of the Custom Field. |
Set Product Price Custom Type
typeString | "SetProductPriceCustomTypeChange" |
changeString | "setProductPriceCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
on Asset
Change Asset Name
typeString | "ChangeAssetNameChange" |
changeString | "changeAssetName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Asset Custom Field
typeString | "SetAssetCustomFieldChange" |
changeString | "setAssetCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Asset Custom Type
typeString | "SetAssetCustomTypeChange" |
changeString | "setAssetCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Asset Description
typeString | "SetAssetDescriptionChange" |
changeString | "setAssetDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Asset Key
typeString | "SetAssetKeyChange" |
changeString | "setAssetKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Asset Sources
typeString | "SetAssetSourcesChange" |
changeString | "setAssetSources" |
previousValueArray of AssetSource | Value before the change. |
nextValueArray of AssetSource | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | 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
typeString | "MoveImageToPositionChange" |
changeString | "moveImageToPosition" |
previousValueArray of Image | Value before the change. |
nextValueArray of Image | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
Set Image Label
typeString | "SetImageLabelChange" |
changeString | "setImageLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | 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
publishedtransitions fromfalsetotrue. - Any update action updates the current catalog (using
staged=false) and the resulting Product is in a published state.
typeString | "PublishChange" |
changeString | "publish" |
Revert Staged Changes
typeString | "RevertStagedChangesChange" |
changeString | "revertStagedChanges" |
Revert Staged Variant Changes
typeString | "RevertStagedVariantChangesChange" |
changeString | "revertStagedVariantChanges" |
Unpublish
typeString | "UnpublishChange" |
changeString | "unpublish" |