Channels Change Types

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

Change types

Add Channel Roles

Change triggered by the Add Roles update action.
type​
String​
"AddChannelRolesChange"
change​
String​
"addRoles"
previousValue​
Array of ChannelRoleEnum​

Value before the change.

nextValue​
Array of ChannelRoleEnum​

Value after the change.

Change Key

Change triggered by the Change Key update action.
type​
String​
"ChangeKeyChange"
change​
String​
"changeKey"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Change Localized Description

Change triggered by the Change Description update action.
type​
String​
"ChangeLocalizedDescriptionChange"
change​
String​
"changeDescription"
previousValue​

Value before the change.

nextValue​

Value after the change.

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.

Remove Channel Roles

Change triggered by the Remove Roles update action.
type​
String​
"RemoveChannelRolesChange"
change​
String​
"removeRoles"
previousValue​
Array of ChannelRoleEnum​

Value before the change.

nextValue​
Array of ChannelRoleEnum​

Value after the change.

Set Address

Change triggered by the Set Address update action.
type​
String​
"SetAddressChange"
change​
String​
"setAddress"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Address Custom Field

Change triggered by the Set Address Custom Field update action.
type​
String​
"SetAddressCustomFieldChange"
change​
String​
"setAddressCustomField"
address​
Address which was extended.
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Address Custom Type

Change triggered by the Set Address Custom Type update action.
type​
String​
"SetAddressCustomTypeChange"
change​
String​
"setAddressCustomType"
address​
Address which was extended.
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Channel Roles

Change triggered by the Set Roles update action.
type​
String​
"SetChannelRolesChange"
change​
String​
"setRoles"
previousValue​
Array of ChannelRoleEnum​

Value before the change.

nextValue​
Array of ChannelRoleEnum​

Value after the change.

addedItems​
Array of ChannelRoleEnum​

Elements added to the array.

removedItems​
Array of ChannelRoleEnum​

Elements removed from the array.

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 Geo Location

Change triggered by the Set GeoLocation update action.
type​
String​
"SetGeoLocationChange"
change​
String​
"setGeoLocation"
previousValue​

Value before the change.

nextValue​

Value after the change.