Changes describe data modifications in the Audit Log Change History API.
Representations
Representations are JSON objects submitted or received as payload to API requests or responses.
Change
previousValue
(omitted, for example, on creations) and nextValue
of the associated change. A Change can also contain extra fields that provide further information.They are not identical to the actual update actions sent.
type String | Unique discriminator value to reliably deserialize the data type. |
change String | Type of change on a resource that is similar to the update action it relates to, where possible.
It is not a unique identifier for the data structure, for example, the
setDescription change can occur with a localized and non-localized representation.Records can be filtered by this value using the changes query parameter. |
ChangeValue
AssetChangeValue
id String | id of the Asset. |
name | Name of the Asset. |
CustomFieldExpandedValue
expand
is set to true
.name String | Name of the Custom Field. |
value Any | CustomFieldValue based on the FieldType. |
label | User-defined label of the Custom Field. |
CustomShippingMethodChangeValue
name String | Name of the Custom ShippingMethod. |
DeliveryChangeValue
items Array of DeliveryItem | Line Items or Custom Line Items shipped in the Delivery. |
address | Address to which the parcels are delivered. |
parcels Array of Parcel | Parcels included in the Delivery. |
ParcelChangeValue
id String | id of the Parcel. |
createdAt String | Date and time (UTC) the Parcel was created. |
ShippingMethodChangeValue
id String | id of the ShippingMethod. |
name String | Name of the ShippingMethod. |
TransactionChangeValue
id String | id of the Transaction. |
interactionId String | Identifier used by the interface that manages the Transaction (usually the PSP). |
timestamp String | Date and time (UTC) the Transaction took place. |
ChangeValueChangeValue
Indicates how a Cart or Product is discounted:
- ChangeValueAbsoluteChangeValue for Cart or Product discounted by an absolute value
- ChangeValueRelativeChangeValue for Cart or Product discounted by a relative value
- ChangeValueGiftLineItemChangeValue for free Line Item added as a gift to the Cart
- ChangeValueExternalChangeValue for Product discounted by an external service
ChangeValueAbsoluteChangeValue
type String | "absolute" |
money Array of Money | Money values in different currencies. |
ChangeValueRelativeChangeValue
type String | "relative" |
permyriad Int | Fraction (per ten thousand) the price is reduced by. For example, 1000 results in a 10% price reduction. |
ChangeValueGiftLineItemChangeValue
type String | "giftLineItem" |
product | Reference to a Product. |
variantId Int | id of the ProductVariant. |
supplyChannel | Channel with ChannelRoleEnum InventorySupply . |
distributionChannel | Channel with ChannelRoleEnum ProductDistribution . |
ChangeValueExternalChangeValue
type String | "external" |
ChangeTargetChangeValue
Indicates the segment of the Cart that is discounted:
- ChangeTargetLineItemsChangeValue for LineItems
- ChangeTargetCustomLineItemsChangeValue for CustomLineItems
- ChangeTargetShippingChangeValue for ShippingInfo
- ChangeTargetMultiBuyLineItemsChangeValue for MultiBuyLineItemsTarget
- ChangeTargetMultiBuyCustomLineItemsChangeValue for MultiBuyCustomLineItemsTarget
- ChangeTargetPatternChangeValue for CartDiscountPatternTarget
ChangeTargetLineItemsChangeValue
type String | "lineItems" |
predicate String | Valid LineItem target predicate. |
ChangeTargetCustomLineItemsChangeValue
type String | "customLineItems" |
predicate String |
ChangeTargetShippingChangeValue
type String | "shipping" |
ChangeTargetMultiBuyLineItemsChangeValue
type String | "multiBuyLineItems" |
predicate String | Valid LineItem target predicate. |
triggerQuantity Int | Quantity of Line Items that triggered the application of the discount. |
discountedQuantity Int | Quantity of Line Items discounted per application of this discount. |
maxOccurrence Int | Maximum number of times the discount is applicable. |
selectionMode | SelectionMode based on which particular Line Items were discounted. |
ChangeTargetMultiBuyCustomLineItemsChangeValue
type String | "multiBuyCustomLineItems" |
predicate String | |
triggerQuantity Int | Quantity of Custom Line Items that triggered the application of the discount. |
discountedQuantity Int | Quantity of Custom Line Items discounted per application of this discount. |
maxOccurrence Int | Maximum number of times the discount is applicable. |
selectionMode | SelectionMode based on which particular Custom Line Items were discounted. |
ChangeTargetPatternChangeValue
type String | "pattern" |
triggerPattern Array of PatternComponent | Defines the set of units of (Custom) Line Items in a Cart that triggered the discount application. |
targetPattern Array of PatternComponent | Defines the set of units of (Custom) Line Items in a Cart on which the Discount is applied. |
maxOccurrence Int | Maximum number of times the Discount applies on a Cart. If empty, the Discount applies indefinitely. |
selectionMode | Indicates which of the matching units of (Custom) Line Items were discounted. |
Embedded values
AttributeValue
name String | Name of the Attribute set. |
value Any | Value set for the Attribute determined by the AttributeType:
|
EnumValue
key String | Key of the value used as a programmatic identifier. |
label String | Descriptive label of the value. |
LocalizedEnumValue
key String | Key of the value used as a programmatic identifier. |
label | Descriptive localized label of the value. |
FieldDefinitionOrderValue
name String | Name of the FieldDefinition. |
label | Descriptive label of the field. |
InventoryQuantityValue
quantityOnStock Int | Overall amount of stock ( availableQuantity + reserved). |
availableQuantity Int | Available amount of stock ( quantityOnStock - reserved). |
ShoppingListLineItemValue
id String | id of the ShoppingListLineItem. |
name | Name of the corresponding Product the Product Variant belongs to. |
variantId Int | id of the ProductVariant the ShoppingListLineItem refers to. |
SetCartClassificationShippingRateInputValue
key String | Key of the value used as a programmatic identifier. |
type String | "Classification" |
label | Descriptive localized label of the value. |
SetCartScoreShippingRateInputValue
type String | "Score" |
score Int | Abstract value for categorizing a Cart. |
ShippingMethodTaxAmountChangeValue
taxedPrice | Taxed price for the Shipping Method based on taxRate . |
taxRate | Tax rate set externally for the Shipping Method. |
TaxedPrice
TextLineItemValue
id String | id of the TextLineItem. |
name | Name of the TextLineItem. |
ValidFromAndUntilValue
validFrom String | Date and time (UTC) from when the Discount is effective. |
validUntil String | Date and time (UTC) until when the Discount is effective. |
Type of Change
Associate Roles B2B
ChangeBuyerAssignableChange B2B
type String | "ChangeBuyerAssignableChange" |
change String | "changeBuyerAssignable" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
SetNameChange B2B
type String | "SetNameChange" |
change String | "setName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetPermissionsChange B2B
type String | "SetPermissionsChange" |
change String | "setPermissions" |
previousValue Array of Permission | Value before the change. |
nextValue Array of Permission | Value after the change. |
Business Units B2B
AddAssociateChange B2B
type String | "AddAssociateChange" |
change String | "addAssociate" |
nextValue | Value after the change. |
AddInheritedAssociateChange B2B
type String | "AddInheritedAssociateChange" |
change String | "addInheritedAssociate" |
nextValue | Value after the change. |
ChangeAssociateChange B2B
ChangeInheritedAssociateChange B2B
type String | "ChangeInheritedAssociateChange" |
change String | "changeInheritedAssociate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeAssociateModeChange B2B
type String | "ChangeAssociateModeChange" |
change String | "changeAssociateMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeParentUnitChange B2B
type String | "ChangeParentUnitChange" |
change String | "changeParentUnit" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeStatusChange B2B
type String | "ChangeStatusChange" |
change String | "changeStatus" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveAssociateChange B2B
type String | "RemoveAssociateChange" |
change String | "removeAssociate" |
previousValue | Value before the change. |
RemoveInheritedAssociateChange B2B
type String | "RemoveInheritedAssociateChange" |
change String | "removeInheritedAssociate" |
previousValue | The value before the change. |
SetAddressCustomFieldChange B2B
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. |
SetAddressCustomTypeChange B2B
type String | "SetAddressCustomTypeChange" |
change String | "setAddressCustomType" |
address | Address which was extended. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetStoreModeChange B2B
type String | "SetStoreModeChange" |
change String | "setStoreMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetContactEmailChange B2B
type String | "SetContactEmailChange" |
change String | "setContactEmail" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Cart Discounts
ChangeCartPredicateChange
type String | "ChangeCartPredicateChange" |
change String | "changeCartPredicate" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
type String | "ChangeIsActiveChange" |
change String | "changeIsActive" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeRequiresDiscountCodeChange
type String | "ChangeRequiresDiscountCodeChange" |
change String | "changeRequiresDiscountCode" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
ChangeSortOrderChange
Change triggered by the following update actions:
- Change Sort Order on Cart Discounts.
- Change Sort Order on Product Discounts.
type String | "ChangeSortOrderChange" |
change String | "changeSortOrder" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeStackingModeChange
type String | "ChangeStackingModeChange" |
change String | "changeStackingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTargetChange
type String | "ChangeTargetChange" |
change String | "changeTarget" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeValueChange
Change triggered by the following update actions:
- Change Value on Cart Discounts.
- Change Value on Product Discounts.
type String | "ChangeValueChange" |
change String | "changeValue" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
type String | "SetValidFromChange" |
change String | "setValidFrom" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
type String | "SetValidFromAndUntilChange" |
change String | "setValidFromAndUntil" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetValidUntilChange
Change triggered by the following update actions:
- Set Valid Until on Cart Discounts.
- Set Valid Until on Discount Codes.
- Set Valid Until on Product Discounts.
type String | "SetValidUntilChange" |
change String | "setValidUntil" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Categories
AddAssetChange
ChangeAssetNameChange
Change triggered by the following update actions:
- Change Asset Name on Categories.
- Change Asset Name on Products.
type String | "ChangeAssetNameChange" |
change String | "changeAssetName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
ChangeAssetOrderChange
Change triggered by the following update actions:
- Change Asset Order on Categories.
- Change Asset Order on Products.
type String | "ChangeAssetOrderChange" |
change String | "changeAssetOrder" |
previousValue Array of LocalizedString | Value before the change. |
nextValue Array of LocalizedString | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeOrderHintChange
type String | "ChangeOrderHintChange" |
change String | "changeOrderHint" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeParentChange
ChangeSlugChange
Change triggered by the following update actions:
- Change Slug on Categories.
- Change Slug on Products.
type String | "ChangeSlugChange" |
change String | "changeSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveAssetChange
Change triggered by the following update actions:
- Remove Asset on Categories.
- Remove Asset on Products.
type String | "RemoveAssetChange" |
change String | "removeAsset" |
previousValue | Value before the change. |
SetAssetCustomFieldChange
Change triggered by the following update actions:
- Set Asset CustomField on Categories.
- Set Asset CustomField on Products.
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. |
SetAssetCustomTypeChange
Change triggered by the following update actions:
- Set Asset Custom Type on Categories.
- Set Asset Custom Type on Products.
type String | "SetAssetCustomTypeChange" |
change String | "setAssetCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
SetAssetDescriptionChange
Change triggered by the following update actions:
- Set Asset Description on Categories.
- Set Asset Description on Products.
type String | "SetAssetDescriptionChange" |
change String | "setAssetDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
SetAssetKeyChange
Change triggered by the following update actions:
- Set Asset Key on Categories.
- Set Asset Key on Products.
type String | "SetAssetKeyChange" |
change String | "setAssetKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
asset | Information about the updated Asset. |
SetAssetSourcesChange
Change triggered by the following update actions:
- Set Asset Sources on Categories.
- Set Asset Sources on Products.
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. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetExternalIdChange
Change triggered by the following update actions:
- Set External ID on Categories.
- Set External ID on Customers.
type String | "SetExternalIdChange" |
change String | "setExternalId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetMetaDescriptionChange
Change triggered by the following update actions:
- Set Meta Description on Categories.
- Set Meta Description on Products.
type String | "SetMetaDescriptionChange" |
change String | "setMetaDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMetaKeywordsChange
Change triggered by the following update actions:
- Set Meta Keywords on Categories.
- Set Meta Keywords on Products.
type String | "SetMetaKeywordsChange" |
change String | "setMetaKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMetaTitleChange
Change triggered by the following update actions:
- Set Meta Title on Categories.
- Set Meta Title on Products.
type String | "SetMetaTitleChange" |
change String | "setMetaTitle" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Channels
ChangeLocalizedDescriptionChange
type String | "ChangeLocalizedDescriptionChange" |
change String | "changeDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeKeyChange
Change triggered by the following update actions:
- Change Key on Channels.
- Change State key on States.
- Change Key on Types.
type String | "ChangeKeyChange" |
change String | "changeKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeReviewRatingStatisticsChange
type String | "ChangeReviewRatingStatisticsChange" |
change String | "changeReviewRatingStatistics" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetAddressChange
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetGeoLocationChange
type String | "SetGeoLocationChange" |
change String | "setGeoLocation" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetChannelRolesChange
type String | "SetChannelRolesChange" |
change String | "setRoles" |
previousValue Array of ChannelRoleEnum | Value before the change. |
nextValue Array of ChannelRoleEnum | Value after the change. |
AddChannelRolesChange
type String | "AddChannelRolesChange" |
change String | "addRoles" |
previousValue Array of ChannelRoleEnum | Value before the change. |
nextValue Array of ChannelRoleEnum | Value after the change. |
RemoveChannelRolesChange
type String | "RemoveChannelRolesChange" |
change String | "removeRoles" |
previousValue Array of ChannelRoleEnum | Value before the change. |
nextValue Array of ChannelRoleEnum | Value after the change. |
Custom Objects PREMIUM
AddPropertyChange
type String | "AddPropertyChange" |
change String | "addProperty" |
nextValue Any | Value after the change. |
path String | Path to the new property that was added. |
RemovePropertyChange
type String | "RemovePropertyChange" |
change String | "removeProperty" |
previousValue Any | Value before the change. |
path String | Path to the property that was removed. |
SetPropertyChange
type String | "SetPropertyChange" |
change String | "setProperty" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
path String | Path to the property that was updated. |
SetValueChange
type String | "SetValueChange" |
change String | "setValue" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
Customers
AddAddressChange
type String | "AddAddressChange" |
change String | "addAddress" |
nextValue | Value after the change. |
AddBillingAddressIdChange
type String | "AddBillingAddressIdChange" |
change String | "addBillingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address added to billingAddressIds . |
AddShippingAddressIdChange
type String | "AddShippingAddressIdChange" |
change String | "addShippingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address added to shippingAddressIds . |
ChangeAddressChange
ChangeEmailChange
type String | "ChangeEmailChange" |
change String | "changeEmail" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
RemoveAddressChange
type String | "RemoveAddressChange" |
change String | "removeAddress" |
previousValue | Value before the change. |
RemoveBillingAddressIdChange
type String | "RemoveBillingAddressIdChange" |
change String | "removeBillingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address removed from billingAddressesIds . |
RemoveShippingAddressIdChange
type String | "RemoveShippingAddressIdChange" |
change String | "removeShippingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address removed from shippingAddressesIds . |
SetCompanyNameChange
type String | "SetCompanyNameChange" |
change String | "setCompanyName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerGroupChange
SetCustomerNumberChange
type String | "SetCustomerNumberChange" |
change String | "setCustomerNumber" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetDateOfBirthChange
type String | "SetDateOfBirthChange" |
change String | "setDateOfBirth" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetDefaultBillingAddressChange
SetDefaultShippingAddressChange
SetExternalIdChange
Change triggered by the following update actions:
- Set External ID on Categories.
- Set External ID on Customers.
type String | "SetExternalIdChange" |
change String | "setExternalId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetFirstNameChange
type String | "SetFirstNameChange" |
change String | "setFirstName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetLastNameChange
type String | "SetLastNameChange" |
change String | "setLastName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetLocaleChange
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
SetMiddleNameChange
type String | "SetMiddleNameChange" |
change String | "setMiddleName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetSalutationChange
type String | "SetSalutationChange" |
change String | "setSalutation" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetStoresChange
SetTitleChange
SetVatIdChange
type String | "SetVatIdChange" |
change String | "setVatId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
VerifyEmailChange
Change triggered by a Customer email verification.
type String | "VerifyEmailChange" |
change String | "verifyEmail" |
SetAuthenticationModeChange
type String | "SetAuthenticationModeChange" |
change String | "setAuthenticationMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Customer Groups
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
type String | "ChangeNameChange" |
change String | "changeName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Discount Codes
ChangeCartDiscountsChange
ChangeGroupsChange
type String | "ChangeGroupsChange" |
change String | "changeGroups" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
type String | "ChangeIsActiveChange" |
change String | "changeIsActive" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
SetCartPredicateChange
type String | "SetCartPredicateChange" |
change String | "setCartPredicate" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedNameChange
Change triggered by the following update actions:
- Set Name on Discount Codes.
- Set State Name on States.
- Set Name on Stores.
type String | "SetLocalizedNameChange" |
change String | "setName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMaxApplicationsChange
type String | "SetMaxApplicationsChange" |
change String | "setMaxApplications" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetMaxApplicationsPerCustomerChange
type String | "SetMaxApplicationsPerCustomerChange" |
change String | "setMaxApplicationsPerCustomer" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
type String | "SetValidFromChange" |
change String | "setValidFrom" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
type String | "SetValidFromAndUntilChange" |
change String | "setValidFromAndUntil" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetValidUntilChange
Change triggered by the following update actions:
- Set Valid Until on Cart Discounts.
- Set Valid Until on Discount Codes.
- Set Valid Until on Product Discounts.
type String | "SetValidUntilChange" |
change String | "setValidUntil" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetApplicationVersionChange
Change triggered automatically due to a user-initiated change.
type String | "SetApplicationVersionChange" |
change String | "setApplicationVersion" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
Inventories
ChangeQuantityChange
type String | "ChangeQuantityChange" |
change String | "changeQuantity" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetExpectedDeliveryChange
type String | "SetExpectedDeliveryChange" |
change String | "setExpectedDelivery" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetRestockableInDaysChange
type String | "SetRestockableInDaysChange" |
change String | "setRestockableInDays" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetSupplyChannelChange
SetReservationsChange
type String | "SetReservationsChange" |
change String | "setReservations" |
previousValue Array of Reservation | Value before the change. |
nextValue Array of Reservation | Value after the change. |
Orders
AddDeliveryChange
type String | "AddDeliveryChange" |
change String | "addDelivery" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddItemShippingAddressesChange
Change triggered by the following update actions:
- Add ItemShippingAddress on Orders.
- Add ItemShippingAddress on Staged Orders.
AddParcelToDeliveryChange
Change triggered by the following update actions:
- Add Parcel on Orders.
- Add Parcel on Staged Orders.
AddPaymentChange
Change triggered by the following update actions:
- Add Payment on Orders.
- Add Payment on Staged Orders.
type String | "AddPaymentChange" |
change String | "addPayment" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddReturnInfoChange
Change triggered by the following update actions:
- Add ReturnInfo on Orders.
- Add ReturnInfo on Staged Orders.
type String | "AddReturnInfoChange" |
change String | "addReturnInfo" |
nextValue | Value after the change. |
ChangeOrderStateChange
Change triggered by the following update actions:
- Change OrderState on Orders.
- Change OrderState on Staged Orders.
type String | "ChangeOrderStateChange" |
change String | "changeOrderState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangePaymentStateChange
Change triggered by the following update actions:
- Change PaymentState on Orders.
- Change PaymentState on Staged Orders.
type String | "ChangePaymentStateChange" |
change String | "changePaymentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeShipmentStateChange
Change triggered by the following update actions:
- Change ShipmentState on Orders.
- Change ShipmentState on Staged Orders.
type String | "ChangeShipmentStateChange" |
change String | "changeShipmentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveDeliveryItemsChange
type String | "RemoveDeliveryItemsChange" |
change String | "removeDelivery" |
previousValue | Value before the change. |
RemoveItemShippingAddressesChange
RemoveParcelFromDeliveryChange
Change triggered by the following update actions:
- Remove Parcel From Delivery on Orders.
- Remove Parcel From Delivery on Staged Orders.
RemovePaymentChange
Change triggered by the following update actions:
- Remove Payment on Orders.
- Remove Payment on Staged Orders.
type String | "RemovePaymentChange" |
change String | "removePayment" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetBillingAddressChange
Change triggered by the following update actions:
- Set Billing Address on Orders.
- Set Billing Address on Staged Orders.
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomLineItemCustomFieldChange
Change triggered by the following update actions:
- Set CustomLineItem Custom Type on Orders.
- Set CustomLineItem Custom Type on Staged Orders.
type String | "SetCustomLineItemCustomFieldChange" |
change String | "setCustomLineItemCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
SetCustomLineItemCustomTypeChange
Change triggered by the following update actions:
- Set CustomLineItem CustomField on Orders.
- Set CustomLineItem CustomField on Staged Orders.
type String | "SetCustomLineItemCustomTypeChange" |
change String | "setCustomLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
SetCustomLineItemShippingDetailsChange
Change triggered by the following update actions:
- Set CustomLineItem ShippingDetails on Orders.
- Set CustomLineItem ShippingDetails on Staged Orders.
type String | "SetCustomLineItemShippingDetailsChange" |
change String | "setCustomLineItemShippingDetails" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItemId String | id of the updated CustomLineItem. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerEmailChange
Change triggered by the following update actions:
- Set Customer Email on Orders.
- Set Customer Email on Staged Orders.
type String | "SetCustomerEmailChange" |
change String | "setCustomerEmail" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomerIdChange
Change triggered by the following update actions:
- Set Customer ID on Orders.
- Set Customer ID on Staged Orders.
type String | "SetCustomerIdChange" |
change String | "setCustomerId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetDeliveryAddressChange
Change triggered by the following update actions:
- Set DeliveryAddress on Orders.
- Set DeliveryAddress on Staged Orders.
SetDeliveryItemsChange
Change triggered by the following update actions:
- Set Delivery Items on Orders.
- Set Delivery Items on Staged Orders.
type String | "SetDeliveryItemsChange" |
change String | "setDeliveryItems" |
previousValue Array of DeliveryItem | Value before the change. |
nextValue Array of DeliveryItem | Value after the change. |
deliveryId String | id of the updated Delivery. |
SetOrderLineItemCustomFieldChange
Change triggered by the following update actions:
- Set LineItem CustomField on Orders.
- Set LineItem CustomField on Staged Orders.
type String | "SetOrderLineItemCustomFieldChange" |
change String | "setLineItemCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
customTypeId String | id of the referenced Type. |
name String | Name of the Custom Field. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
SetOrderLineItemCustomTypeChange
Change triggered by the following update actions:
- Set LineItem Custom Type on Orders.
- Set LineItem Custom Type on Staged Orders.
type String | "SetOrderLineItemCustomTypeChange" |
change String | "setLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
variant String |
SetLineItemShippingDetailsChange
Change triggered by the following update actions:
- Set LineItem ShippingDetails on Orders.
- Set LineItem ShippingDetails on Staged Orders.
type String | "SetLineItemShippingDetailsChange" |
change String | "setLineItemShippingDetails" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItemId String | id of the updated LineItem. |
SetLocaleChange
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
SetOrderNumberChange
Change triggered by the following update actions:
- Set Order Number on Orders.
- Set Order Number on Staged Order.
type String | "SetOrderNumberChange" |
change String | "setOrderNumber" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetParcelItemsChange
Change triggered by the following update actions:
- Set Parcel Items on Orders.
- Set Parcel Items on Staged Orders.
type String | "SetParcelItemsChange" |
change String | "setParcelItems" |
previousValue Array of DeliveryItem | Value before the change. |
nextValue Array of DeliveryItem | Value after the change. |
parcel | Information about the updated Parcel. |
SetParcelMeasurementsChange
Change triggered by the following update actions:
- SetParcelMeasurements on Orders.
- SetParcelMeasurements on Staged Orders.
type String | "SetParcelMeasurementsChange" |
change String | "setParcelMeasurements" |
previousValue | Value before the change. |
nextValue | Value after the change. |
parcel | Information about the updated Parcel. |
SetParcelTrackingDataChange
Change triggered by the following update actions:
- Set Parcel Tracking Data on Orders.
- Set Parcel Tracking Data on Staged Orders.
type String | "SetParcelTrackingDataChange" |
change String | "setParcelTrackingData" |
previousValue | Value before the change. |
nextValue | Value after the change. |
parcel | Information about the updated Parcel. |
SetReturnPaymentStateChange
Change triggered by the following update actions:
- Set PaymentShipmentState on Orders.
- Set PaymentShipmentState on Staged Orders.
type String | "SetReturnPaymentStateChange" |
change String | "setReturnPaymentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetReturnShipmentStateChange
Change triggered by the following update actions:
- Set ReturnShipmentState on Orders.
- Set ReturnShipmentState on Staged Orders.
type String | "SetReturnShipmentStateChange" |
change String | "setReturnShipmentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetShippingAddressChange
Change triggered by the following update actions:
- Set Shipping Address on Orders.
- Set Shipping Address on Staged Orders.
SetStoreChange
TransitionCustomLineItemStateChange
Change triggered by the following update actions:
type String | "TransitionCustomLineItemStateChange" |
change String | "transitionCustomLineItemState" |
previousValue Array of ItemState | Value before the change. |
nextValue Array of ItemState | Value after the change. |
lineItemId String | id of the updated CustomLineItem. |
stateId String | id of the State involved in the transition. |
TransitionLineItemStateChange
Change triggered by the following update actions:
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
UpdateSyncInfoChange
Change triggered by the following update actions:
- Update SyncInfo on Orders.
- Update SyncInfo on Staged Orders.
SetLineItemProductKeyChange
SetOrderTaxedPriceChange
type String | "SetOrderTaxedPriceChange" |
change String | "setOrderTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode | DisplayName: TaxMode |
SetShippingRateInputChange
type String | "SetShippingRateInputChange" |
change String | "setShippingRateInput" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetShippingMethodTaxRateChange
SetShippingMethodTaxAmountChange
type String | "SetShippingMethodTaxAmountChange" |
change String | "setShippingMethodTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode | "ExternalAmount" |
SetShippingMethodChange
type String | "SetShippingMethodChange" |
change String | "setShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetOrderTotalTaxChange
SetLineItemTotalPriceChange
type String | "SetLineItemTotalPriceChange" |
change String | "setLineItemTotalPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
SetLineItemTaxRateChange
type String | "SetLineItemTaxRateChange" |
change String | "setLineItemTaxRate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String | |
taxMode | "External" |
SetLineItemTaxedPriceChange
SetLineItemTaxAmountChange
type String | "SetLineItemTaxAmountChange" |
change String | "setLineItemTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String | |
taxMode | "ExternalAmount" |
SetLineItemPriceChange
type String | "SetLineItemPriceChange" |
change String | "setLineItemPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
SetLineItemDistributionChannelChange
type String | "SetLineItemDistributionChannelChange" |
change String | "setLineItemDistributionChannel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
SetCustomShippingMethodChange
type String | "SetCustomShippingMethodChange" |
change String | "setCustomShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomLineItemTaxRateChange
type String | "SetCustomLineItemTaxRateChange" |
change String | "setCustomLineItemTaxRate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
taxMode | "External" |
SetCustomLineItemTaxAmountChange
type String | "SetCustomLineItemTaxAmountChange" |
change String | "setCustomLineItemTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
taxMode | "ExternalAmount" |
SetCustomLineItemMoneyChange
type String | "SetCustomLineItemMoneyChange" |
change String | "setCustomLineItemMoney" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
SetCountryChange
type String | "SetCountryChange" |
change String | "setCountry" |
previousValue | Value before the change. Pattern:^[A-Z]{2}$ |
nextValue | Value after the change. Pattern:^[A-Z]{2}$ |
RemoveOrderLineItemChange
RemoveDiscountCodeChange
type String | "RemoveDiscountCodeChange" |
change String | "removeDiscountCode" |
previousValue | Value before the change. |
RemoveCustomLineItemChange
type String | "RemoveCustomLineItemChange" |
change String | "removeCustomLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTaxRoundingModeChange
type String | "ChangeTaxRoundingModeChange" |
change String | "changeTaxRoundingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTaxModeChange
ChangeTaxCalculationModeChange
type String | "ChangeTaxCalculationModeChange" |
change String | "changeTaxCalculationMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeLineItemQuantityChange
ChangeCustomLineItemQuantityChange
type String | "ChangeCustomLineItemQuantityChange" |
change String | "changeCustomLineItemQuantity" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
customLineItem | Name of the CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
AddCustomLineItemChange
type String | "AddCustomLineItemChange" |
change String | "addCustomLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddDiscountCodeChange
type String | "AddDiscountCodeChange" |
change String | "addDiscountCode" |
nextValue | Value after the change. |
AddOrderLineItemChange
SetOrderTotalPriceChange
SetCustomLineItemTaxedPriceChange
type String | "SetCustomLineItemTaxedPriceChange" |
change String | "setCustomLineItemTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
SetCustomLineItemTotalPriceChange
type String | "SetCustomLineItemTotalPriceChange" |
change String | "setCustomLineItemTotalPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
SetLineItemProductSlugChange
Change triggered automatically due to a user-initiated change.
type String | "SetLineItemProductSlugChange" |
change String | "setLineItemProductSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
variant String |
SetLineItemDiscountedPricePerQuantityChange
type String | "SetLineItemDiscountedPricePerQuantityChange" |
change String | "setLineItemDiscountedPricePerQuantity" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
SetLineItemDiscountedPriceChange
type String | "SetLineItemDiscountedPriceChange" |
change String | "setLineItemDiscountedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
SetCustomLineItemTaxCategoryChange
type String | "SetCustomLineItemTaxCategoryChange" |
change String | "setCustomLineItemTaxCategory" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String | id of the updated CustomLineItem. |
SetShippingInfoPriceChange
SetShippingRateChange
SetShippingInfoTaxedPriceChange
type String | "SetShippingInfoTaxedPriceChange" |
change String | "setShippingInfoTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetPurchaseOrderNumberChange
Change triggered by the following update actions:
- Set Purchase Order Number on Orders.
- Set Purchase Order Number on Staged Orders.
type String | "SetPurchaseOrderNumberChange" |
change String | "setPurchaseOrderNumber" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Payments PREMIUM
AddInterfaceInteractionChange
type String | "AddInterfaceInteractionChange" |
change String | "addInterfaceInteraction" |
nextValue | Value after the change. |
AddTransactionChange
type String | "AddTransactionChange" |
change String | "addTransaction" |
nextValue | Value after the change. |
ChangeAmountPlannedChange
ChangeTransactionInteractionIdChange
type String | "ChangeTransactionInteractionIdChange" |
change String | "changeTransactionInteractionId" |
previousValue String | Value after the change. |
nextValue String | Value before the change. |
transaction | Holds information about the updated Transaction. |
ChangeTransactionStateChange
type String | "ChangeTransactionStateChange" |
change String | "changeTransactionState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
transaction | Holds information about the updated Transaction. |
ChangeTransactionTimestampChange
type String | "ChangeTransactionTimestampChange" |
change String | "changeTransactionTimestamp" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
transaction | Holds information about the updated Transaction. |
SetAnonymousIdChange
Change triggered by the following update actions:
- Set AnonymousId on Payments.
- Set AnonymousId on Shopping Lists.
type String | "SetAnonymousIdChange" |
change String | "setAnonymousId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerChange
Change triggered by the following update actions:
- Set Customer on Payments.
- Set Customer on Reviews.
- Set Customer on Shopping Lists.
SetInterfaceIdChange
type String | "SetInterfaceIdChange" |
change String | "setInterfaceId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetMethodInfoInterfaceChange
type String | "SetMethodInfoInterfaceChange" |
change String | "setMethodInfoInterface" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetMethodInfoMethodChange
type String | "SetMethodInfoMethodChange" |
change String | "setMethodInfoMethod" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetMethodInfoNameChange
type String | "SetMethodInfoNameChange" |
change String | "setMethodInfoName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetStatusInterfaceCodeChange
type String | "SetStatusInterfaceCodeChange" |
change String | "setStatusInterfaceCode" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetStatusInterfaceTextChange
type String | "SetStatusInterfaceTextChange" |
change String | "setStatusInterfaceText" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Products
AddAssetChange
AddExternalImageChange
type String | "AddExternalImageChange" |
change String | "addExternalImage" |
previousValue Array of Image | Value before the change. |
nextValue Array of Image | Value after the change. |
catalogData String |
|
AddPriceChange
type String | "AddPriceChange" |
change String | "addPrice" |
nextValue | Value after the change. |
catalogData String |
|
priceId String | id of the Embedded Price. |
AddToCategoryChange
AddVariantChange
type String | "AddVariantChange" |
change String | "addVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
ChangeAssetNameChange
Change triggered by the following update actions:
- Change Asset Name on Categories.
- Change Asset Name on Products.
type String | "ChangeAssetNameChange" |
change String | "changeAssetName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
ChangeAssetOrderChange
Change triggered by the following update actions:
- Change Asset Order on Categories.
- Change Asset Order on Products.
type String | "ChangeAssetOrderChange" |
change String | "changeAssetOrder" |
previousValue Array of LocalizedString | Value before the change. |
nextValue Array of LocalizedString | Value after the change. |
ChangeMasterVariantChange
type String | "ChangeMasterVariantChange" |
change String | "changeMasterVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangePriceChange
type String | "ChangePriceChange" |
change String | "changePrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
priceId String | id of the Embedded Price. |
ChangeReviewRatingStatisticsChange
type String | "ChangeReviewRatingStatisticsChange" |
change String | "changeReviewRatingStatistics" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeSlugChange
Change triggered by the following update actions:
- Change Slug on Categories.
- Change Slug on Products.
type String | "ChangeSlugChange" |
change String | "changeSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
PublishChange
type String | "PublishChange" |
change String | "publish" |
RemoveAssetChange
Change triggered by the following update actions:
- Remove Asset on Categories.
- Remove Asset on Products.
type String | "RemoveAssetChange" |
change String | "removeAsset" |
previousValue | Value before the change. |
RemoveFromCategoryChange
RemoveImageChange
type String | "RemoveImageChange" |
change String | "removeImage" |
previousValue Array of Image | Value before the change. |
nextValue Array of Image | Value after the change. |
catalogData String |
|
RemovePriceChange
type String | "RemovePriceChange" |
change String | "removePrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
priceId String | id of the Embedded Price. |
RemoveVariantChange
type String | "RemoveVariantChange" |
change String | "removeVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
SetAssetCustomTypeChange
Change triggered by the following update actions:
- Set Asset Custom Type on Categories.
- Set Asset Custom Type on Products.
type String | "SetAssetCustomTypeChange" |
change String | "setAssetCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
SetAssetCustomFieldChange
Change triggered by the following update actions:
- Set Asset CustomField on Categories.
- Set Asset CustomField on Products.
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. |
SetAssetDescriptionChange
Change triggered by the following update actions:
- Set Asset Description on Categories.
- Set Asset Description on Products.
type String | "SetAssetDescriptionChange" |
change String | "setAssetDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
SetAssetKeyChange
Change triggered by the following update actions:
- Set Asset Key on Categories.
- Set Asset Key on Products.
type String | "SetAssetKeyChange" |
change String | "setAssetKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
asset | Information about the updated Asset. |
SetAssetSourcesChange
Change triggered by the following update actions:
- Set Asset Sources on Categories.
- Set Asset Sources on Products.
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. |
SetAttributeChange
type String | "SetAttributeChange" |
change String | "setAttribute" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
SetCategoryOrderHintChange
type String | "SetCategoryOrderHintChange" |
change String | "setCategoryOrderHint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
categoryId String | id of the updated Category. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetDiscountedPriceChange
type String | "SetDiscountedPriceChange" |
change String | "setDiscountedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
variant String | |
priceId String | id of the Embedded Price. |
SetImageLabelChange
type String | "SetImageLabelChange" |
change String | "setImageLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetMetaDescriptionChange
Change triggered by the following update actions:
- Set Meta Description on Categories.
- Set Meta Description on Products.
type String | "SetMetaDescriptionChange" |
change String | "setMetaDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMetaKeywordsChange
Change triggered by the following update actions:
- Set Meta Keywords on Categories.
- Set Meta Keywords on Products.
type String | "SetMetaKeywordsChange" |
change String | "setMetaKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMetaTitleChange
Change triggered by the following update actions:
- Set Meta Title on Categories.
- Set Meta Title on Products.
type String | "SetMetaTitleChange" |
change String | "setMetaTitle" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetProductPriceCustomFieldChange
type String | "SetProductPriceCustomFieldChange" |
change String | "setProductPriceCustomField" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
SetProductPriceCustomTypeChange
type String | "SetProductPriceCustomTypeChange" |
change String | "setProductPriceCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
SetProductVariantKeyChange
type String | "SetProductVariantKeyChange" |
change String | "setProductVariantKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
catalogData String |
|
SetSearchKeywordsChange
type String | "SetSearchKeywordsChange" |
change String | "setSearchKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
SetSkuChange
type String | "SetSkuChange" |
change String | "setSku" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
catalogData String |
|
SetTaxCategoryChange
SetVariantAvailabilityChange
type String | "SetVariantAvailabilityChange" |
change String | "setVariantAvailability" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogData String |
|
variant String |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
UnpublishChange
type String | "UnpublishChange" |
change String | "unpublish" |
SetPricesChange
type String | "SetPricesChange" |
change String | "setPrices" |
previousValue Array of Price | Value before the change. |
nextValue Array of Price | Value after the change. |
catalogData String |
|
variant String |
MoveImageToPositionChange
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 Discounts
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
type String | "ChangeIsActiveChange" |
change String | "changeIsActive" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangePredicateChange
type String | "ChangePredicateChange" |
change String | "changePredicate" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeSortOrderChange
Change triggered by the following update actions:
- Change Sort Order on Cart Discounts.
- Change Sort Order on Product Discounts.
type String | "ChangeSortOrderChange" |
change String | "changeSortOrder" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeValueChange
Change triggered by the following update actions:
- Change Value on Cart Discounts.
- Change Value on Product Discounts.
type String | "ChangeValueChange" |
change String | "changeValue" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
type String | "SetValidFromChange" |
change String | "setValidFrom" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
type String | "SetValidFromAndUntilChange" |
change String | "setValidFromAndUntil" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetValidUntilChange
Change triggered by the following update actions:
- Set Valid Until on Cart Discounts.
- Set Valid Until on Discount Codes.
- Set Valid Until on Product Discounts.
type String | "SetValidUntilChange" |
change String | "setValidUntil" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetIsValidChange
Change triggered automatically due to a user-initiated change.
type String | "SetIsValidChange" |
change String | "setIsValid" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
Product Selections
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetProductCountChange
type String | "SetProductCountChange" |
change String | "setProductCount" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetVariantSelectionChange
type String | "SetVariantSelectionChange" |
change String | "setVariantSelection" |
previousValue | Value before the change. |
nextValue | Value after the change. |
product | Reference to the updated Product. |
AddProductChange
type String | "AddProductChange" |
change String | "addProduct" |
nextValue | Value after the change. |
variantSelection | The Product Variants included in the Product Selection. |
RemoveProductChange
type String | "RemoveProductChange" |
change String | "removeProduct" |
previousValue | Value before the change. |
Product Types
AddAttributeDefinitionChange
type String | "AddAttributeDefinitionChange" |
change String | "addAttributeDefinition" |
nextValue | Value after the change. |
AddLocalizedEnumValueChange
Change triggered by the following update actions:
- Add LocalizableEnumValue to AttributeDefinition on Product Types.
- Add LocalizedEnumValue to FieldDefinition on Types.
type String | "AddLocalizedEnumValueChange" |
change String | "addLocalizedEnumValue" |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types. |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
AddPlainEnumValueChange
type String | "AddPlainEnumValueChange" |
change String | "addPlainEnumValue" |
nextValue | Value after the change. |
attributeName String | Name of the updated AttributeDefinition. |
ChangeAttributeConstraintChange
type String | "ChangeAttributeConstraintChange" |
change String | "changeAttributeConstraint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
attributeName String | Name of the updated AttributeDefinition. |
ChangeAttributeOrderByNameChange
type String | "ChangeAttributeOrderByNameChange" |
change String | "changeAttributeOrderByName" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
ChangeDescriptionChange
type String | "ChangeDescriptionChange" |
change String | "changeDescription" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeInputHintChange
Change triggered by the following update actions:
- Change AttributeDefinition InputHint on Product Types.
- Change InputHint on Types.
type String | "ChangeInputHintChange" |
change String | "changeInputHint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types. |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeIsSearchableChange
type String | "ChangeIsSearchableChange" |
change String | "changeIsSearchable" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
attributeName String | Name of the updated AttributeDefinition. |
ChangeLabelChange
Change triggered by the following update actions:
- Change AttributeDefinition Label on Product Types.
- Change FieldDefinition Label on Types.
type String | "ChangeLabelChange" |
change String | "changeLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types). |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeLocalizedEnumValueLabelChange
Change triggered by the following update actions:
- Change the label of a LocalizedEnumValue on Product Types.
- Change LocalizedEnumValue Label on Types.
type String | "ChangeLocalizedEnumValueLabelChange" |
change String | "changeLocalizedEnumValueLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types. |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
valueKey String | Key of the updated values. |
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
type String | "ChangeNameChange" |
change String | "changeName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangePlainEnumValueLabelChange
type String | "ChangePlainEnumValueLabelChange" |
change String | "changePlainEnumValueLabel" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
attributeName String | Name of the updated AttributeDefinition. |
valueKey String | Key of the updated values. |
RemoveAttributeDefinitionChange
type String | "RemoveAttributeDefinitionChange" |
change String | "removeAttributeDefinition" |
previousValue | Value before the change. |
RemoveEnumValuesChange
type String | "RemoveEnumValuesChange" |
change String | "removeEnumValues" |
previousValue | Value before the change. |
attributeName String | Name of the updated AttributeDefinition. |
RemoveLocalizedEnumValuesChange
type String | "RemoveLocalizedEnumValuesChange" |
change String | "removeEnumValues" |
previousValue | Value before the change. |
attributeName String | Name of the updated AttributeDefinition. |
SetInputTipChange
type String | "SetInputTipChange" |
change String | "setInputTip" |
previousValue | Value before the change. |
nextValue | Value after the change. |
attributeName String | Name of the updated AttributeDefinition. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Quote Requests
ChangeQuoteRequestStateChange
type String | "ChangeQuoteRequestStateChange" |
change String | "changeQuoteRequestState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Quotes
ChangeQuoteStateChange
type String | "ChangeQuoteStateChange" |
change String | "changeQuoteState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RequestQuoteRenegotiationChange
type String | "RequestQuoteRenegotiationChange" |
change String | "requestQuoteRenegotiation" |
previousValue | Value before the change. |
nextValue | Value after the change. |
buyerComment String |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Reviews PREMIUM
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerChange
Change triggered by the following update actions:
- Set Customer on Payments.
- Set Customer on Reviews.
- Set Customer on Shopping Lists.
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetLocaleChange
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
SetRatingChange
type String | "SetRatingChange" |
change String | "setRating" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetTargetChange
SetTextChange
type String | "SetTextChange" |
change String | "setText" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetTitleChange
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Shopping Lists PREMIUM
AddShoppingListLineItemChange
AddTextLineItemChange
type String | "AddTextLineItemChange" |
change String | "addTextLineItem" |
nextValue | Value after the change. |
ChangeShoppingListLineItemQuantityChange
type String | "ChangeShoppingListLineItemQuantityChange" |
change String | "changeLineItemQuantity" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
lineItem | Holds information about the updated Shopping List Line Item. |
ChangeShoppingListLineItemsOrderChange
type String | "ChangeShoppingListLineItemsOrderChange" |
change String | "changeLineItemsOrder" |
previousValue Array of ShoppingListLineItemValue | Value before the change. |
nextValue Array of ShoppingListLineItemValue | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTextLineItemNameChange
type String | "ChangeTextLineItemNameChange" |
change String | "changeTextLineItemName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
ChangeTextLineItemQuantityChange
type String | "ChangeTextLineItemQuantityChange" |
change String | "changeTextLineItemQuantity" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
ChangeTextLineItemsOrderChange
type String | "ChangeTextLineItemsOrderChange" |
change String | "changeTextLineItemsOrder" |
previousValue Array of TextLineItemValue | Value before the change. |
nextValue Array of TextLineItemValue | Value after the change. |
RemoveShoppingListLineItemChange
RemoveTextLineItemChange
type String | "RemoveTextLineItemChange" |
change String | "removeTextLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetAnonymousIdChange
Change triggered by the following update actions:
- Set AnonymousId on Payments.
- Set AnonymousId on Shopping Lists.
type String | "SetAnonymousIdChange" |
change String | "setAnonymousId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerChange
Change triggered by the following update actions:
- Set Customer on Payments.
- Set Customer on Reviews.
- Set Customer on Shopping Lists.
SetDeleteDaysAfterLastModificationChange
type String | "SetDeleteDaysAfterLastModificationChange" |
change String | "setDeleteDaysAfterLastModification" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetShoppingListLineItemCustomFieldChange
type String | "SetShoppingListLineItemCustomFieldChange" |
change String | "setLineItemCustomField" |
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. |
lineItem | Holds information about the updated Shopping List Line Item. |
SetShoppingListLineItemCustomTypeChange
type String | "SetShoppingListLineItemCustomTypeChange" |
change String | "setLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Holds information about the updated Shopping List Line Item. |
SetSlugChange
type String | "SetSlugChange" |
change String | "setSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetTextLineItemCustomFieldChange
type String | "SetTextLineItemCustomFieldChange" |
change String | "setTextLineItemCustomField" |
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. |
textLineItem | Holds information about the updated Text Line Item. |
SetTextLineItemCustomTypeChange
type String | "SetTextLineItemCustomTypeChange" |
change String | "setTextLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
SetTextLineItemDescriptionChange
type String | "SetTextLineItemDescriptionChange" |
change String | "setTextLineItemDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
SetStoreChange
SetLineItemDeactivatedAtChange
type String | "SetLineItemDeactivatedAtChange" |
change String | "setLineItemDeactivatedAt" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
lineItem | Holds information about the updated Shopping List Line Item. |
States PREMIUM
ChangeInitialChange
type String | "ChangeInitialChange" |
change String | "changeInitial" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
ChangeKeyChange
Change triggered by the following update actions:
- Change Key on Channels.
- Change State key on States.
- Change Key on Types.
type String | "ChangeKeyChange" |
change String | "changeKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeStateTypeChange
type String | "ChangeStateTypeChange" |
change String | "changeType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveStateRolesChange
type String | "RemoveStateRolesChange" |
change String | "removeRoles" |
previousValue Array of StateRoleEnum | Value before the change. |
nextValue Array of StateRoleEnum | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedNameChange
Change triggered by the following update actions:
- Set Name on Discount Codes.
- Set State Name on States.
- Set Name on Stores.
type String | "SetLocalizedNameChange" |
change String | "setName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetStateRolesChange
type String | "SetStateRolesChange" |
change String | "setRoles" |
previousValue Array of StateRoleEnum | Value before the change. |
nextValue Array of StateRoleEnum | Value after the change. |
SetTransitionsChange
AddStateRolesChange
type String | "AddStateRolesChange" |
change String | "addRoles" |
previousValue Array of StateRoleEnum | Value before the change. |
nextValue Array of StateRoleEnum | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Staged Quotes
ChangeStagedQuoteStateChange
type String | "ChangeStagedQuoteStateChange" |
change String | "changeStagedQuoteState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetSellerCommentChange
type String | "SetSellerCommentChange" |
change String | "setSellerComment" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidToChange
type String | "SetValidToChange" |
change String | "setValidTo" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Stores
AddProductSelectionChange
type String | "AddProductSelectionChange" |
change String | "addProductSelection" |
previousValue | |
nextValue |
ChangeProductSelectionActiveChange
type String | "ChangeProductSelectionActiveChange" |
change String | "changeProductSelectionActive" |
productSelection | Reference to the Product Selection which was changed. |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
RemoveProductSelectionChange
type String | "RemoveProductSelectionChange" |
change String | "removeProductSelection" |
previousValue | Value before the change. |
SetDistributionChannelsChange
SetLanguagesChange
type String | "SetLanguagesChange" |
change String | "setLanguages" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
SetLocalizedNameChange
Change triggered by the following update actions:
- Set Name on Discount Codes.
- Set State Name on States.
- Set Name on Stores.
type String | "SetLocalizedNameChange" |
change String | "setName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetProductSelectionsChange
type String | "SetProductSelectionsChange" |
change String | "setProductSelections" |
previousValue Array of ProductSelectionSetting | Value before the change. |
nextValue Array of ProductSelectionSetting | Value after the change. |
SetSupplyChannelsChange
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
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. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCountriesChange
type String | "SetCountriesChange" |
change String | "setCountries" |
previousValue Array of StoreCountry | Value before the change. |
nextValue Array of StoreCountry | Value after the change. |
Tax Categories
AddTaxRateChange
type String | "AddTaxRateChange" |
change String | "addTaxRate" |
nextValue | Value after the change. |
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
type String | "ChangeNameChange" |
change String | "changeName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
RemoveTaxRateChange
type String | "RemoveTaxRateChange" |
change String | "removeTaxRate" |
previousValue | Value before the change. |
SetDescriptionChange
Change triggered by the following update actions:
- Set Description on Tax Categories.
- Set Description on Zones.
type String | "SetDescriptionChange" |
change String | "setDescription" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Types PREMIUM
AddEnumValueChange
type String | "AddEnumValueChange" |
change String | "addEnumValue" |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition. |
AddFieldDefinitionChange
type String | "AddFieldDefinitionChange" |
change String | "addFieldDefinition" |
nextValue | Value after the change. |
AddLocalizedEnumValueChange
Change triggered by the following update actions:
- Add LocalizableEnumValue to AttributeDefinition on Product Types.
- Add LocalizedEnumValue to FieldDefinition on Types.
type String | "AddLocalizedEnumValueChange" |
change String | "addLocalizedEnumValue" |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types. |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeEnumValueLabelChange
type String | "ChangeEnumValueLabelChange" |
change String | "changeEnumValueLabel" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
fieldName String | Name of the updated FieldDefinition. |
valueKey String | Key of the updated values. |
ChangeEnumValueOrderChange
type String | "ChangeEnumValueOrderChange" |
change String | "changeEnumValueOrder" |
previousValue Array of EnumValue | Value before the change. |
nextValue Array of EnumValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition. |
ChangeFieldDefinitionOrderChange
type String | "ChangeFieldDefinitionOrderChange" |
change String | "changeFieldDefinitionOrder" |
previousValue Array of FieldDefinitionOrderValue | Value before the change. |
nextValue Array of FieldDefinitionOrderValue | Value after the change. |
ChangeInputHintChange
Change triggered by the following update actions:
- Change AttributeDefinition InputHint on Product Types.
- Change InputHint on Types.
type String | "ChangeInputHintChange" |
change String | "changeInputHint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types. |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeKeyChange
Change triggered by the following update actions:
- Change Key on Channels.
- Change State key on States.
- Change Key on Types.
type String | "ChangeKeyChange" |
change String | "changeKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeLabelChange
Change triggered by the following update actions:
- Change AttributeDefinition Label on Product Types.
- Change FieldDefinition Label on Types.
type String | "ChangeLabelChange" |
change String | "changeLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types). |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeLocalizedEnumValueLabelChange
Change triggered by the following update actions:
- Change the label of a LocalizedEnumValue on Product Types.
- Change LocalizedEnumValue Label on Types.
type String | "ChangeLocalizedEnumValueLabelChange" |
change String | "changeLocalizedEnumValueLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types. |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
valueKey String | Key of the updated values. |
ChangeLocalizedEnumValueOrderChange
Change triggered by the following update actions:
- Change the order of LocalizedEnumValues on Product Types.
- Change the order of LocalizedEnumValues on Types.
type String | "ChangeLocalizedEnumValueOrderChange" |
change String | "changeLocalizedEnumValueOrder" |
previousValue Array of LocalizedEnumValue | Value before the change. |
nextValue Array of LocalizedEnumValue | Value after the change. |
fieldName String | Name of the updated FieldDefinition; only present on changes to Types. |
attributeName String | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveFieldDefinitionChange
type String | "RemoveFieldDefinitionChange" |
change String | "removeFieldDefinition" |
previousValue | Value before the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Zones
AddLocationChange
type String | "AddLocationChange" |
change String | "addLocation" |
nextValue | Value after the change. |
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
type String | "ChangeNameChange" |
change String | "changeName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
RemoveLocationChange
type String | "RemoveLocationChange" |
change String | "removeLocation" |
previousValue | Value before the change. |
SetDescriptionChange
Change triggered by the following update actions:
- Set Description on Tax Categories.
- Set Description on Zones.
type String | "SetDescriptionChange" |
change String | "setDescription" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
UnknownChange
Change triggered when the format of changes on an entity is not identified by Audit Log.
type String | "UnknownChange" |
change String | Identifier for the type of modification. |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |