Change types that represent data modifications made to the Shipping Methods entity.

Change types

Add Shipping Rate

Change triggered by the Add ShippingRate update action.
type​
String​
"ShippingMethodAddShippingRateChange"
change​
String​
"addShippingRate"
zone​

Zone to which the ShippingRate was added.

nextValue​

Value after the change.

Add Zone

Change triggered by the Add Zone update action.
type​
String​
"ShippingMethodAddZoneChange"
change​
String​
"addZone"
nextValue​

Value after the change.

Change Active

Change triggered by the Change Active update action.
type​
String​
"ShippingMethodChangeActiveChange"
change​
String​
"changeActive"
previousValue​
Boolean​

Value before the change.

nextValue​
Boolean​

Value after the change.

Change Is Default

Change triggered by the Change IsDefault update action.
type​
String​
"ShippingMethodChangeIsDefaultChange"
change​
String​
"changeIsDefault"
previousValue​
Boolean​

Value before the change.

nextValue​
Boolean​

Value after the change.

Change Name

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

Value before the change.

nextValue​
String​

Value after the change.

Change Tax Category

Change triggered by the Change TaxCategory update action.
type​
String​
"ShippingMethodChangeTaxCategoryChange"
change​
String​
"changeTaxCategory"
previousValue​

Value before the change.

nextValue​

Value after the change.

Remove Shipping Rate

Change triggered by the Remove ShippingRate update action.
type​
String​
"ShippingMethodRemoveShippingRateChange"
change​
String​
"removeShippingRate"
zone​

Zone from which the ShippingRate was removed.

previousValue​

Value before the change.

Remove Zone

Change triggered by the Remove Zone update action.
type​
String​
"ShippingMethodRemoveZoneChange"
change​
String​
"removeZone"
previousValue​

Value before the change.

Set Custom Field

Change triggered by the Set Custom Field update action.
Change triggered by the Set CustomField update action.
type​
String​
"ShippingMethodSetCustomFieldChange"
change​
String​
"setCustomField"
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 Custom Type

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

Value before the change.

nextValue​

Value after the change.

Set Key

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

Value before the change.

nextValue​
String​

Value after the change.

Set Localized Description

Change triggered by the Set Localized Description update action.
type​
String​
"ShippingMethodSetLocalizedDescriptionChange"
change​
String​
"setLocalizedDescription"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Localized Name

Change triggered by the Set Localized Name update action.
type​
String​
"ShippingMethodSetLocalizedNameChange"
change​
String​
"setLocalizedName"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Predicate

Change triggered by the Set Predicate update action.
type​
String​
"ShippingMethodSetPredicateChange"
change​
String​
"setPredicate"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

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.