Change Types

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

Difference between the previous and next version of a resource represented by 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

Only present if expand is set to true.

name
String

Name of the Custom Field.

value
Any
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

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

type
String
"lineItems"
predicate
String

ChangeTargetCustomLineItemsChangeValue

type
String
"customLineItems"
predicate
String

ChangeTargetShippingChangeValue

type
String
"shipping"

ChangeTargetMultiBuyLineItemsChangeValue

type
String
"multiBuyLineItems"
predicate
String
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

Units of a (Custom) Line Item that triggered the discount application.

targetPattern
Array of PatternComponent

Units of (Custom) Line Items 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
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

totalNet

Total net price of the Order.

totalGross

Total gross price of the Order.

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

ChangeBuyerAssignableChange

Change triggered by the Change BuyerAssignable update action.

type
String
"ChangeBuyerAssignableChange"
change
String
"changeBuyerAssignable"
previousValue
Boolean

Value before the change.

nextValue
Boolean

Value after the change.

SetNameChange

Change triggered by the Set Name update action.

type
String
"SetNameChange"
change
String
"setName"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetPermissionsChange

Change triggered by the Set Permissions, Add Permission, and Remove Permission update actions.

type
String
"SetPermissionsChange"
change
String
"setPermissions"
previousValue
Array of Permission

Value before the change.

nextValue
Array of Permission

Value after the change.

Business Units

AddAssociateChange

Change triggered by the Add Associate update action.

type
String
"AddAssociateChange"
change
String
"addAssociate"
nextValue

Value after the change.

AddInheritedAssociateChange

Change triggered by the Add Associate update action on a parent of a Business Unit in cases where inheritance applies.

type
String
"AddInheritedAssociateChange"
change
String
"addInheritedAssociate"
nextValue

Value after the change.

ChangeAssociateChange

Change triggered by the Change Associate update action.

type
String
"ChangeAssociateChange"
change
String
"changeAssociate"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeInheritedAssociateChange

Change triggered by the Change Associate update action on a parent of a Business Unit in cases where inheritance applies.

type
String
"ChangeInheritedAssociateChange"
change
String
"changeInheritedAssociate"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeAssociateModeChange

Change triggered by the Change Associate Mode update action.

type
String
"ChangeAssociateModeChange"
change
String
"changeAssociateMode"
previousValue

Value before the change.

Value after the change.

ChangeParentUnitChange

Change triggered by the Change Parent Unit update action.

type
String
"ChangeParentUnitChange"
change
String
"changeParentUnit"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeStatusChange

Change triggered by the Change Status update action.

type
String
"ChangeStatusChange"
change
String
"changeStatus"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveAssociateChange

Change triggered by the Remove Associate update action.

type
String
"RemoveAssociateChange"
change
String
"removeAssociate"
previousValue

Value before the change.

RemoveInheritedAssociateChange

Change triggered by the Remove Associate update action on a parent of a Business Unit in cases where inheritance applies.

type
String
"RemoveInheritedAssociateChange"
change
String
"removeInheritedAssociate"
previousValue

The value before the change.

SetAddressCustomFieldChange

Change triggered by the Set Address Custom Field update action.

type
String
"SetAddressCustomFieldChange"
change
String
"setAddressCustomField"
address

Address which was extended.

name
String

Name of the Custom Field.

customTypeId
String

id of the referenced Type.

previousValue
Any

Value before the change.

nextValue
Any

Value after the change.

SetAddressCustomTypeChange

Change triggered by the Set Address Custom Type update action.

type
String
"SetAddressCustomTypeChange"
change
String
"setAddressCustomType"
address

Address which was extended.

previousValue

Value before the change.

nextValue

Value after the change.

SetStoreModeChange

Change triggered by the Set Store Mode update action.

type
String
"SetStoreModeChange"
change
String
"setStoreMode"
previousValue

Value before the change.

nextValue

Value after the change.

SetContactEmailChange

Change triggered by the Set Contact Email update action.

type
String
"SetContactEmailChange"
change
String
"setContactEmail"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

Cart Discounts

ChangeCartPredicateChange

Change triggered by the Change Cart Predicate update action.

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:

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:

type
String
"ChangeLocalizedNameChange"
change
String
"changeName"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeRequiresDiscountCodeChange

Change triggered by the Change Requires DiscountCode update action.

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:

type
String
"ChangeSortOrderChange"
change
String
"changeSortOrder"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

ChangeStackingModeChange

Change triggered by the Change Stacking Mode update action.

type
String
"ChangeStackingModeChange"
change
String
"changeStackingMode"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeTargetChange

Change triggered by the Change Target update action.

type
String
"ChangeTargetChange"
change
String
"changeTarget"
previousValue

Value before the change.

Value after the change.

ChangeValueChange

Change triggered by the following update actions:

type
String
"ChangeValueChange"
change
String
"changeValue"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetLocalizedDescriptionChange

Change triggered by the following update actions:

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:

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:

type
String
"SetValidFromAndUntilChange"
change
String
"setValidFromAndUntil"
previousValue

Value before the change.

nextValue

Value after the change.

SetValidUntilChange

Change triggered by the following update actions:

type
String
"SetValidUntilChange"
change
String
"setValidUntil"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

Categories

AddAssetChange

Change triggered by the following update actions:

type
String
"AddAssetChange"
change
String
"addAsset"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeAssetNameChange

Change triggered by the following update actions:

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:

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:

type
String
"ChangeLocalizedNameChange"
change
String
"changeName"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeOrderHintChange

Change triggered by the Change OrderHint update action.

type
String
"ChangeOrderHintChange"
change
String
"changeOrderHint"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

ChangeParentChange

Change triggered by the Change Parent update action.

type
String
"ChangeParentChange"
change
String
"changeParent"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeSlugChange

Change triggered by the following update actions:

type
String
"ChangeSlugChange"
change
String
"changeSlug"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveAssetChange

Change triggered by the following update actions:

type
String
"RemoveAssetChange"
change
String
"removeAsset"
previousValue

Value before the change.

SetAssetCustomFieldChange

Change triggered by the following update actions:

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:

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:

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:

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:

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.

SetAssetTagsChange

Change triggered by the following update actions:

type
String
"SetAssetTagsChange"
change
String
"setAssetTags"
previousValue
Array of String

Value before the change.

nextValue
Array of String

Value after the change.

asset

Information about the updated Asset.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetLocalizedDescriptionChange

Change triggered by the following update actions:

type
String
"SetLocalizedDescriptionChange"
change
String
"setDescription"
previousValue

Value before the change.

nextValue

Value after the change.

SetExternalIdChange

Change triggered by the following update actions:

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:

type
String
"SetMetaDescriptionChange"
change
String
"setMetaDescription"
previousValue

Value before the change.

nextValue

Value after the change.

SetMetaKeywordsChange

Change triggered by the following update actions:

type
String
"SetMetaKeywordsChange"
change
String
"setMetaKeywords"
previousValue

Value before the change.

nextValue

Value after the change.

SetMetaTitleChange

Change triggered by the following update actions:

type
String
"SetMetaTitleChange"
change
String
"setMetaTitle"
previousValue

Value before the change.

nextValue

Value after the change.

Channels

ChangeLocalizedDescriptionChange

Change triggered by the Change Description update action.

type
String
"ChangeLocalizedDescriptionChange"
change
String
"changeDescription"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeKeyChange

Change triggered by the following update actions:

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:

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

Change triggered by the Set Address update action.

type
String
"SetAddressChange"
change
String
"setAddress"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetGeoLocationChange

Change triggered by the Set GeoLocation update action.

type
String
"SetGeoLocationChange"
change
String
"setGeoLocation"
previousValue

Value before the change.

nextValue

Value after the change.

SetChannelRolesChange

Change triggered by the Set Roles update action.

type
String
"SetChannelRolesChange"
change
String
"setRoles"
previousValue
Array of ChannelRoleEnum

Value before the change.

nextValue
Array of ChannelRoleEnum

Value after the change.

AddChannelRolesChange

Change triggered by the Add Roles update action.

type
String
"AddChannelRolesChange"
change
String
"addRoles"
previousValue
Array of ChannelRoleEnum

Value before the change.

nextValue
Array of ChannelRoleEnum

Value after the change.

RemoveChannelRolesChange

Change triggered by the Remove Roles update action.

type
String
"RemoveChannelRolesChange"
change
String
"removeRoles"
previousValue
Array of ChannelRoleEnum

Value before the change.

nextValue
Array of ChannelRoleEnum

Value after the change.

Custom Objects

AddPropertyChange

Change triggered by the Update CustomObject request when a new property is added.

type
String
"AddPropertyChange"
change
String
"addProperty"
nextValue
Any

Value after the change.

path
String

Path to the new property that was added.

RemovePropertyChange

Change triggered by the Update CustomObject request when an existing property is removed.

type
String
"RemovePropertyChange"
change
String
"removeProperty"
previousValue
Any

Value before the change.

path
String

Path to the property that was removed.

SetPropertyChange

Change triggered by the Update CustomObject request when an existing property is updated.

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

Change triggered by the Update CustomObject request when a value of a property is updated.

type
String
"SetValueChange"
change
String
"setValue"
previousValue
Any

Value before the change.

nextValue
Any

Value after the change.

Customers

AddAddressChange

Change triggered by the Add Address update action.

type
String
"AddAddressChange"
change
String
"addAddress"
nextValue

Value after the change.

AddBillingAddressIdChange

Change triggered by the Add Billing Address ID update action.

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

Change triggered by the Add Shipping Address ID update action.

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

Change triggered by the Change Address update action.

type
String
"ChangeAddressChange"
change
String
"changeAddress"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeEmailChange

Change triggered by the Change Email update action.

type
String
"ChangeEmailChange"
change
String
"changeEmail"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

RemoveAddressChange

Change triggered by the Remove Address update action.

type
String
"RemoveAddressChange"
change
String
"removeAddress"
previousValue

Value before the change.

RemoveBillingAddressIdChange

Change triggered by the Remove Billing Address ID update action.

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

Change triggered by the Remove Shipping Address ID update action.

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

Change triggered by the Set Company Name update action.

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:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomerGroupChange

Change triggered by the Set CustomerGroup update action.

type
String
"SetCustomerGroupChange"
change
String
"setCustomerGroup"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomerNumberChange

Change triggered by the Set Customer Number update action.

type
String
"SetCustomerNumberChange"
change
String
"setCustomerNumber"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetDateOfBirthChange

Change triggered by the Set Date of Birth update action.

type
String
"SetDateOfBirthChange"
change
String
"setDateOfBirth"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetDefaultBillingAddressChange

Change triggered by the Set Default Billing Address update action.

type
String
"SetDefaultBillingAddressChange"
change
String
"setDefaultBillingAddress"
previousValue

Value before the change.

nextValue

Value after the change.

SetDefaultShippingAddressChange

Change triggered by the Set Default Shipping Address update action.

type
String
"SetDefaultShippingAddressChange"
change
String
"setDefaultShippingAddress"
previousValue

Value before the change.

nextValue

Value after the change.

SetExternalIdChange

Change triggered by the following update actions:

type
String
"SetExternalIdChange"
change
String
"setExternalId"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetFirstNameChange

Change triggered by the Set First Name update action.

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

Change triggered by Set Last Name update action.

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:

type
String
"SetLocaleChange"
change
String
"setLocale"
previousValue

Value before the change.

nextValue

Value after the change.

SetMiddleNameChange

Change triggered by the Set Middle Name update action.

type
String
"SetMiddleNameChange"
change
String
"setMiddleName"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetSalutationChange

Change triggered by the Set Salutation update action.

type
String
"SetSalutationChange"
change
String
"setSalutation"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetStoresChange

Change triggered by the Set Stores update action.

type
String
"SetStoresChange"
change
String
"setStores"
previousValue
Array of Reference

Value before the change.

nextValue
Array of Reference

Value after the change.

SetTitleChange

Change triggered by the following update actions:

type
String
"SetTitleChange"
change
String
"setTitle"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetVatIdChange

Change triggered by the Set Vat ID update action.

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

Change triggered by the Set AuthenticationMode update action.

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:

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:

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:

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

Change triggered by the Change CartDiscounts update action.

type
String
"ChangeCartDiscountsChange"
change
String
"changeCartDiscounts"
previousValue
Array of Reference

Value before the change.

nextValue
Array of Reference

Value after the change.

ChangeGroupsChange

Change triggered by the Change Groups update action.

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:

type
String
"ChangeIsActiveChange"
change
String
"changeIsActive"
previousValue
Boolean

Value before the change.

nextValue
Boolean

Value after the change.

SetCartPredicateChange

Change triggered by the Set Cart Predicate update action.

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:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetLocalizedDescriptionChange

Change triggered by the following update actions:

type
String
"SetLocalizedDescriptionChange"
change
String
"setDescription"
previousValue

Value before the change.

nextValue

Value after the change.

SetLocalizedNameChange

Change triggered by the following update actions:

type
String
"SetLocalizedNameChange"
change
String
"setName"
previousValue

Value before the change.

nextValue

Value after the change.

SetMaxApplicationsChange

Change triggered by the Set Max Applications update action.

type
String
"SetMaxApplicationsChange"
change
String
"setMaxApplications"
previousValue
Int

Value before the change.

nextValue
Int

Value after the change.

SetMaxApplicationsPerCustomerChange

Change triggered by the Set Max Applications Per Customer update action.

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:

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:

type
String
"SetValidFromAndUntilChange"
change
String
"setValidFromAndUntil"
previousValue

Value before the change.

nextValue

Value after the change.

SetValidUntilChange

Change triggered by the following update actions:

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

Change triggered by the Change Quantity update action.

type
String
"ChangeQuantityChange"
change
String
"changeQuantity"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetExpectedDeliveryChange

Change triggered by the Set ExpectedDelivery update action.

type
String
"SetExpectedDeliveryChange"
change
String
"setExpectedDelivery"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetRestockableInDaysChange

Change triggered by the Set RestockableInDays update action.

type
String
"SetRestockableInDaysChange"
change
String
"setRestockableInDays"
previousValue
Int

Value before the change.

nextValue
Int

Value after the change.

SetSupplyChannelChange

Change triggered by the Set SupplyChannel update action.

type
String
"SetSupplyChannelChange"
change
String
"setSupplyChannel"
previousValue

Value before the change.

nextValue

Value after the change.

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

Change triggered by the Add Delivery update action.

type
String
"AddDeliveryChange"
change
String
"addDelivery"
previousValue

Value before the change.

nextValue

Value after the change.

AddItemShippingAddressesChange

Change triggered by the following update actions:

type
String
"AddItemShippingAddressesChange"
change
String
"addItemShippingAddress"
previousValue

Value before the change.

nextValue

Value after the change.

AddParcelToDeliveryChange

Change triggered by the following update actions:

type
String
"AddParcelToDeliveryChange"
change
String
"addParcelToDelivery"
nextValue

Value after the change.

deliveryId
String

id of the Delivery to which the Parcel was added.

AddPaymentChange

Change triggered by the following update actions:

type
String
"AddPaymentChange"
change
String
"addPayment"
previousValue

Value before the change.

nextValue

Value after the change.

AddReturnInfoChange

Change triggered by the following update actions:

type
String
"AddReturnInfoChange"
change
String
"addReturnInfo"
nextValue

Value after the change.

ChangeOrderStateChange

Change triggered by the following update actions:

type
String
"ChangeOrderStateChange"
change
String
"changeOrderState"
previousValue

Value before the change.

nextValue

Value after the change.

ChangePaymentStateChange

Change triggered by the following update actions:

type
String
"ChangePaymentStateChange"
change
String
"changePaymentState"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeShipmentStateChange

Change triggered by the following update actions:

type
String
"ChangeShipmentStateChange"
change
String
"changeShipmentState"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveDeliveryItemsChange

Change triggered by the Remove Delivery update action.

type
String
"RemoveDeliveryItemsChange"
change
String
"removeDelivery"
previousValue

Value before the change.

RemoveItemShippingAddressesChange

Change triggered by the Remove Item Shipping Address update action.

type
String
"RemoveItemShippingAddressesChange"
change
String
"removeItemShippingAddress"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveParcelFromDeliveryChange

Change triggered by the following update actions:

type
String
"RemoveParcelFromDeliveryChange"
change
String
"removeParcelFromDelivery"
previousValue

Value before the change.

deliveryId
String

id of the Delivery from which the Parcel was removed.

RemovePaymentChange

Change triggered by the following update actions:

type
String
"RemovePaymentChange"
change
String
"removePayment"
previousValue

Value before the change.

nextValue

Value after the change.

SetBillingAddressChange

Change triggered by the following update actions:

type
String
"SetBillingAddressChange"
change
String
"setBillingAddress"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomFieldChange

Change triggered by the following update actions:

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:

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:

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:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomerEmailChange

Change triggered by the following update actions:

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:

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:

type
String
"SetDeliveryAddressChange"
change
String
"setDeliveryAddress"
previousValue

Value before the change.

nextValue

Value after the change.

deliveryId
String

id of the updated Delivery.

SetDeliveryItemsChange

Change triggered by the following update actions:

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:

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

sku or key of the ProductVariant.

SetOrderLineItemCustomTypeChange

Change triggered by the following update actions:

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

sku or key of the ProductVariant.

SetLineItemShippingDetailsChange

Change triggered by the following update actions:

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:

type
String
"SetLocaleChange"
change
String
"setLocale"
previousValue

Value before the change.

nextValue

Value after the change.

SetOrderNumberChange

Change triggered by the following update actions:

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:

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:

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:

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:

type
String
"SetReturnPaymentStateChange"
change
String
"setReturnPaymentState"
previousValue

Value before the change.

nextValue

Value after the change.

SetReturnShipmentStateChange

Change triggered by the following update actions:

type
String
"SetReturnShipmentStateChange"
change
String
"setReturnShipmentState"
previousValue

Value before the change.

nextValue

Value after the change.

SetShippingAddressChange

Change triggered by the following update actions:

type
String
"SetShippingAddressChange"
change
String
"setShippingAddress"
previousValue

Value before the change.

nextValue

Value after the change.

SetStoreChange

Change triggered by the following update actions:

type
String
"SetStoreChange"
change
String
"setStore"
previousValue

Value before the change.

nextValue

Value after the change.

TransitionCustomLineItemStateChange

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

type
String
"TransitionLineItemStateChange"
change
String
"transitionLineItemState"
previousValue
Array of ItemState

Value before the change.

nextValue
Array of ItemState

Value after the change.

lineItemId
String

id of the updated LineItem.

stateId
String

id of the State involved in the transition.

TransitionStateChange

Change triggered by the following update actions:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

UpdateSyncInfoChange

Change triggered by the following update actions:

type
String
"UpdateSyncInfoChange"
change
String
"updateSyncInfo"
nextValue

Value after the change.

channelId
String

id of the updated Channel.

SetLineItemProductKeyChange

type
String
"SetLineItemProductKeyChange"
change
String
"setLineItemProductKey"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

lineItem

Name of the Product the Line Item is based on.

lineItemId
String

id of the updated LineItem.

variant
String

sku or key of the updated ProductVariant.

SetOrderTaxedPriceChange

type
String
"SetOrderTaxedPriceChange"
change
String
"setOrderTaxedPrice"
previousValue

Value before the change.

nextValue

Value after the change.

taxMode

SetShippingRateInputChange

Change triggered by the Set Shipping Rate Input update action.

type
String
"SetShippingRateInputChange"
change
String
"setShippingRateInput"

Value before the change.

Value after the change.

SetShippingMethodTaxRateChange

Change triggered by the Set ShippingMethod TaxRate update action.

type
String
"SetShippingMethodTaxRateChange"
change
String
"setShippingMethodTaxRate"
previousValue

Value before the change.

nextValue

Value after the change.

taxMode

"External"

SetShippingMethodTaxAmountChange

Change triggered by the Set ShippingMethod TaxAmount update action.

type
String
"SetShippingMethodTaxAmountChange"
change
String
"setShippingMethodTaxAmount"

Value before the change.

Value after the change.

taxMode

"ExternalAmount"

SetShippingMethodChange

Change triggered by the Set ShippingMethod update action.

type
String
"SetShippingMethodChange"
change
String
"setShippingMethod"
previousValue

Value before the change.

Value after the change.

SetOrderTotalTaxChange

Change triggered by the Set OrderTotalTax update action.

type
String
"SetOrderTotalTaxChange"
change
String
"setOrderTotalTax"
previousValue

Value before the change.

nextValue

Value after the change.

taxMode

"ExternalAmount"

SetLineItemTotalPriceChange

Change triggered by the Set LineItemTotalPrice update action.

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

Change triggered by the Set LineItemTaxRate update action.

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

sku or key of the ProductVariant.

taxMode

"External"

SetLineItemTaxedPriceChange

type
String
"SetLineItemTaxedPriceChange"
change
String
"setLineItemTaxedPrice"
previousValue

Value before the change.

nextValue

Value after the change.

lineItem

Name of the Product the Line Item is based on.

lineItemId
String

id of the updated LineItem.

SetLineItemTaxAmountChange

Change triggered by the Set LineItem TaxAmount update action.

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

sku or key of the ProductVariant.

taxMode

"ExternalAmount"

SetLineItemPriceChange

Change triggered by the Set LineItem Price update action.

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

Change triggered by the Set LineItem DistributionChannel update action.

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

sku or key of the updated ProductVariant.

SetCustomShippingMethodChange

Change triggered by the Set Custom ShippingMethod update action.

type
String
"SetCustomShippingMethodChange"
change
String
"setCustomShippingMethod"

Value before the change.

Value after the change.

SetCustomLineItemTaxRateChange

Change triggered by the Set CustomLineItem TaxRate update action.

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

Change triggered by the Set CustomLineItem TaxAmount update action.

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

Change triggered by the Set CustomLineItem Money update action.

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

Change triggered by the Set Country update action.

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

Change triggered by the Remove Parcel From Delivery update action.

type
String
"RemoveOrderLineItemChange"
change
String
"removeLineItem"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveDiscountCodeChange

Change triggered by the Remove DiscountCode update action.

type
String
"RemoveDiscountCodeChange"
change
String
"removeDiscountCode"
previousValue

Value before the change.

RemoveCustomLineItemChange

Change triggered by the Remove CustomLineItem update action.

type
String
"RemoveCustomLineItemChange"
change
String
"removeCustomLineItem"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeTaxRoundingModeChange

Change triggered by the Change Tax RoundingMode update action.

type
String
"ChangeTaxRoundingModeChange"
change
String
"changeTaxRoundingMode"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeTaxModeChange

Change triggered by the Change TaxMode update action.

type
String
"ChangeTaxModeChange"
change
String
"changeTaxMode"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeTaxCalculationModeChange

Change triggered by the Change TaxCalculationMode update action.

type
String
"ChangeTaxCalculationModeChange"
change
String
"changeTaxCalculationMode"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeLineItemQuantityChange

Change triggered by the Change LineItem Quantity update action.

type
String
"ChangeLineItemQuantityChange"
change
String
"changeLineItemQuantity"
previousValue
Int

Value before the change.

nextValue
Int

Value after the change

lineItem

Name of the Product the updated Line Item is based on.

lineItemId
String

id of the updated LineItem.

ChangeCustomLineItemQuantityChange

Change triggered by the Change CustomLineItem Quantity update action.

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

Change triggered by the Add CustomLineItem update action.

type
String
"AddCustomLineItemChange"
change
String
"addCustomLineItem"
previousValue

Value before the change.

nextValue

Value after the change.

AddDiscountCodeChange

Change triggered by the Add DiscountCode update action.

type
String
"AddDiscountCodeChange"
change
String
"addDiscountCode"
nextValue

Value after the change.

AddOrderLineItemChange

Change triggered by the Add LineItem update action.

type
String
"AddOrderLineItemChange"
change
String
"addLineItem"
previousValue

Value before the change.

nextValue

Value after the change.

SetOrderTotalPriceChange

Change triggered automatically due to a user-initiated change.

type
String
"SetOrderTotalPriceChange"
change
String
"setOrderTotalPrice"
previousValue

Value before the change.

nextValue

Value after the change.

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

sku or key of the updated ProductVariant.

SetLineItemDiscountedPricePerQuantityChange

type
String
"SetLineItemDiscountedPricePerQuantityChange"
change
String
"setLineItemDiscountedPricePerQuantity"

Value before the change.

Value after the change.

lineItem

Name of the Product the Line Item is based on.

variant
String

sku or key of the updated ProductVariant.

SetLineItemDiscountedPriceChange

type
String
"SetLineItemDiscountedPriceChange"
change
String
"setLineItemDiscountedPrice"
previousValue

Value before the change.

Value after the change.

lineItem

Name of the Product the Line Item is based on.

variant
String

sku or key of the updated ProductVariant.

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

type
String
"SetShippingInfoPriceChange"
change
String
"setShippingInfoPrice"
previousValue

Value before the change.

nextValue

Value after the change.

SetShippingRateChange

type
String
"SetShippingRateChange"
change
String
"setShippingRate"
previousValue

Value before the change.

nextValue

Value after the change.

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:

type
String
"SetPurchaseOrderNumberChange"
change
String
"setPurchaseOrderNumber"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

Payments

AddInterfaceInteractionChange

Change triggered by the Add InterfaceInteraction update action.

type
String
"AddInterfaceInteractionChange"
change
String
"addInterfaceInteraction"

Value after the change.

AddTransactionChange

Change triggered by the Add Transaction update action.

type
String
"AddTransactionChange"
change
String
"addTransaction"
nextValue

Value after the change.

ChangeAmountPlannedChange

Change triggered by the Change AmountPlanned update action.

type
String
"ChangeAmountPlannedChange"
change
String
"changeAmountPlanned"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeTransactionInteractionIdChange

Change triggered by the Change TransactionInteractionId update action.

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

Change triggered by the Change TransactionState update action.

type
String
"ChangeTransactionStateChange"
change
String
"changeTransactionState"
previousValue

Value before the change.

nextValue

Value after the change.

transaction

Holds information about the updated Transaction.

ChangeTransactionTimestampChange

Change triggered by the Change TransactionTimestamp update action.

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:

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:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomerChange

Change triggered by the following update actions:

type
String
"SetCustomerChange"
change
String
"setCustomer"
previousValue

Value before the change.

nextValue

Value after the change.

SetInterfaceIdChange

Change triggered by the Set InterfaceId update action.

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

Change triggered by the Set MethodInfoInterface update action.

type
String
"SetMethodInfoInterfaceChange"
change
String
"setMethodInfoInterface"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetMethodInfoMethodChange

Change triggered by the Set MethodInfoInterface update action.

type
String
"SetMethodInfoMethodChange"
change
String
"setMethodInfoMethod"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetMethodInfoNameChange

Change triggered by the Set MethodInfoName update action.

type
String
"SetMethodInfoNameChange"
change
String
"setMethodInfoName"
previousValue

Value before the change.

nextValue

Value after the change.

SetStatusInterfaceCodeChange

Change triggered by the Set StatusInterfaceCode update action.

type
String
"SetStatusInterfaceCodeChange"
change
String
"setStatusInterfaceCode"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetStatusInterfaceTextChange

Change triggered by the Set StatusInterfaceText update action.

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:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeAmountAuthorizedChange

Change triggered automatically due to a user-initiated change.

type
String
"ChangeAmountAuthorizedChange"
change
String
"changeAmountAuthorized"
previousValue

Value before the change.

nextValue

Value after the change.

Products

AddAssetChange

Change triggered by the following update actions:

type
String
"AddAssetChange"
change
String
"addAsset"
previousValue

Value before the change.

nextValue

Value after the change.

AddExternalImageChange

Change triggered by the Add External Image update action.

type
String
"AddExternalImageChange"
change
String
"addExternalImage"
previousValue
Array of Image

Value before the change.

nextValue
Array of Image

Value after the change.

catalogData
String

AddPriceChange

Change triggered by the Add Price update action.

type
String
"AddPriceChange"
change
String
"addPrice"
nextValue

Value after the change.

catalogData
String
priceId
String

id of the Embedded Price.

AddToCategoryChange

Change triggered by the Add to Category update action.

type
String
"AddToCategoryChange"
change
String
"addToCategory"
previousValue
Array of Reference

Value before the change.

nextValue
Array of Reference

Value after the change.

category

Category to which the Product was added.

AddVariantChange

Change triggered by the Add ProductVariant update action.

type
String
"AddVariantChange"
change
String
"addVariant"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

ChangeAssetNameChange

Change triggered by the following update actions:

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:

type
String
"ChangeAssetOrderChange"
change
String
"changeAssetOrder"
previousValue
Array of LocalizedString

Value before the change.

nextValue
Array of LocalizedString

Value after the change.

ChangeMasterVariantChange

Change triggered by the Change Master Variant update action.

type
String
"ChangeMasterVariantChange"
change
String
"changeMasterVariant"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

ChangeLocalizedNameChange

Change triggered by the following update actions:

type
String
"ChangeLocalizedNameChange"
change
String
"changeName"
previousValue

Value before the change.

nextValue

Value after the change.

ChangePriceChange

Change triggered by the Change Price update action.

type
String
"ChangePriceChange"
change
String
"changePrice"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String
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:

type
String
"ChangeSlugChange"
change
String
"changeSlug"
previousValue

Value before the change.

nextValue

Value after the change.

PublishChange

Change triggered by the Publish update action.

type
String
"PublishChange"
change
String
"publish"

RemoveAssetChange

Change triggered by the following update actions:

type
String
"RemoveAssetChange"
change
String
"removeAsset"
previousValue

Value before the change.

RemoveFromCategoryChange

Change triggered by the Remove from Category update action.

type
String
"RemoveFromCategoryChange"
change
String
"removeFromCategory"
previousValue
Array of Reference

Value before the change.

nextValue
Array of Reference

Value after the change.

category

Category from which the Product was removed.

RemoveImageChange

Change triggered by the Remove Image update action.

type
String
"RemoveImageChange"
change
String
"removeImage"
previousValue
Array of Image

Value before the change.

nextValue
Array of Image

Value after the change.

catalogData
String

RemovePriceChange

Change triggered by the Remove Embedded Price update action.

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

Change triggered by the Remove ProductVariant update action.

type
String
"RemoveVariantChange"
change
String
"removeVariant"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

SetAssetCustomTypeChange

Change triggered by the following update actions:

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:

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:

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:

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:

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.

SetAssetTagsChange

Change triggered by the following update actions:

type
String
"SetAssetTagsChange"
change
String
"setAssetTags"
previousValue
Array of String

Value before the change.

nextValue
Array of String

Value after the change.

asset

Information about the updated Asset.

SetAttributeChange

Change triggered by the Set Attribute update action.

type
String
"SetAttributeChange"
change
String
"setAttribute"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

SetCategoryOrderHintChange

Change triggered by the Set Category Order Hint update action.

type
String
"SetCategoryOrderHintChange"
change
String
"setCategoryOrderHint"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String
categoryId
String

id of the updated Category.

SetLocalizedDescriptionChange

Change triggered by the following update actions:

type
String
"SetLocalizedDescriptionChange"
change
String
"setDescription"
previousValue

Value before the change.

nextValue

Value after the change.

SetDiscountedPriceChange

Change triggered by the Set Discounted Embedded Price update action.

type
String
"SetDiscountedPriceChange"
change
String
"setDiscountedPrice"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String
variant
String

sku or key of the updated ProductVariant.

priceId
String

id of the Embedded Price.

SetImageLabelChange

Change triggered by the Set Image Label update action.

type
String
"SetImageLabelChange"
change
String
"setImageLabel"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

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:

type
String
"SetMetaDescriptionChange"
change
String
"setMetaDescription"
previousValue

Value before the change.

nextValue

Value after the change.

SetMetaKeywordsChange

Change triggered by the following update actions:

type
String
"SetMetaKeywordsChange"
change
String
"setMetaKeywords"
previousValue

Value before the change.

nextValue

Value after the change.

SetMetaTitleChange

Change triggered by the following update actions:

type
String
"SetMetaTitleChange"
change
String
"setMetaTitle"
previousValue

Value before the change.

nextValue

Value after the change.

SetProductPriceCustomFieldChange

Change triggered by the Set Price CustomField update action.

type
String
"SetProductPriceCustomFieldChange"
change
String
"setProductPriceCustomField"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

SetProductPriceCustomTypeChange

Change triggered by the Set Price Custom Type update action.

type
String
"SetProductPriceCustomTypeChange"
change
String
"setProductPriceCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

SetProductVariantKeyChange

Change triggered by the Set ProductVariant Key update action.

type
String
"SetProductVariantKeyChange"
change
String
"setProductVariantKey"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

catalogData
String

SetSearchKeywordsChange

Change triggered by the Set SearchKeywords update action.

type
String
"SetSearchKeywordsChange"
change
String
"setSearchKeywords"
previousValue

Value before the change.

nextValue

Value after the change.

catalogData
String

SetSkuChange

Change triggered by the Set SKU update action.

type
String
"SetSkuChange"
change
String
"setSku"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

catalogData
String

SetTaxCategoryChange

Change triggered by the Set TaxCategory update action.

type
String
"SetTaxCategoryChange"
change
String
"setTaxCategory"
previousValue

Value before the change.

nextValue

Value after the change.

SetVariantAvailabilityChange

Change triggered automatically when an InventoryEntry associated with a Product changes.

type
String
"SetVariantAvailabilityChange"
change
String
"setVariantAvailability"
previousValue

Value before the change.

Value after the change.

catalogData
String
variant
String

sku or key of the ProductVariant.

TransitionStateChange

Change triggered by the following update actions:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

UnpublishChange

Change triggered by the Unpublish update action.

type
String
"UnpublishChange"
change
String
"unpublish"

SetPricesChange

Change triggered by the Set Prices update action.

type
String
"SetPricesChange"
change
String
"setPrices"
previousValue
Array of Price

Value before the change.

nextValue
Array of Price

Value after the change.

catalogData
String
variant
String

sku or key of the ProductVariant.

MoveImageToPositionChange

Change triggered by the Move image to position update action.

type
String
"MoveImageToPositionChange"
change
String
"moveImageToPosition"
previousValue
Array of Image

Value before the change.

nextValue
Array of Image

Value after the change.

catalogData
String

Product Discounts

ChangeIsActiveChange

Change triggered by the following update actions:

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:

type
String
"ChangeLocalizedNameChange"
change
String
"changeName"
previousValue

Value before the change.

nextValue

Value after the change.

ChangePredicateChange

Change triggered by the Change Predicate update action.

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:

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:

type
String
"ChangeValueChange"
change
String
"changeValue"
previousValue

Value before the change.

nextValue

Value after the change.

SetLocalizedDescriptionChange

Change triggered by the following update actions:

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:

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:

type
String
"SetValidFromAndUntilChange"
change
String
"setValidFromAndUntil"
previousValue

Value before the change.

nextValue

Value after the change.

SetValidUntilChange

Change triggered by the following update actions:

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:

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:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetProductCountChange

Change triggered automatically by the Add Product or Remove Product update action.

type
String
"SetProductCountChange"
change
String
"setProductCount"
previousValue
Int

Value before the change.

nextValue
Int

Value after the change.

SetVariantSelectionChange

Change triggered by the Set Variant Selection update action.

type
String
"SetVariantSelectionChange"
change
String
"setVariantSelection"
previousValue

Value before the change.

Value after the change.

product

Reference to the updated Product.

AddProductChange

Change triggered by the Add Product update action.

type
String
"AddProductChange"
change
String
"addProduct"
nextValue

Value after the change.

variantSelection

The Product Variants included in the Product Selection.

RemoveProductChange

Change triggered by the Remove Product update action.

type
String
"RemoveProductChange"
change
String
"removeProduct"
previousValue

Value before the change.

Product Types

AddAttributeDefinitionChange

Change triggered by the Add Attribute Definition update action.

type
String
"AddAttributeDefinitionChange"
change
String
"addAttributeDefinition"
nextValue

Value after the change.

AddLocalizedEnumValueChange

Change triggered by the following update actions:

type
String
"AddLocalizedEnumValueChange"
change
String
"addLocalizedEnumValue"

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

Change triggered by the Add PlainEnumValue to AttributeDefinition update action.

type
String
"AddPlainEnumValueChange"
change
String
"addPlainEnumValue"

Value after the change.

attributeName
String

Name of the updated AttributeDefinition.

ChangeAttributeConstraintChange

Change triggered by the Change AttributeDefinition AttributeConstraint update action.

type
String
"ChangeAttributeConstraintChange"
change
String
"changeAttributeConstraint"
previousValue

Value before the change.

Value after the change.

attributeName
String

Name of the updated AttributeDefinition.

ChangeAttributeOrderByNameChange

Change triggered by the Change the order of AttributeDefinitions update action.

type
String
"ChangeAttributeOrderByNameChange"
change
String
"changeAttributeOrderByName"
previousValue
Array of String

Value before the change.

nextValue
Array of String

Value after the change.

ChangeDescriptionChange

Change triggered by the Change Description update action.

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:

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

Change triggered by the Change AttributeDefinition IsSearchable update action.

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:

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:

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:

type
String
"ChangeNameChange"
change
String
"changeName"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

ChangePlainEnumValueLabelChange

Change triggered by the Change the label of an EnumValue update action.

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

Change triggered by the Remove AttributeDefinition update action.

type
String
"RemoveAttributeDefinitionChange"
change
String
"removeAttributeDefinition"
previousValue

Value before the change.

RemoveEnumValuesChange

Change triggered by the Remove EnumValues from AttributeDefinition update action.

type
String
"RemoveEnumValuesChange"
change
String
"removeEnumValues"
previousValue

Value before the change.

attributeName
String

Name of the updated AttributeDefinition.

RemoveLocalizedEnumValuesChange

Change triggered by the Remove EnumValues from AttributeDefinition update action.

type
String
"RemoveLocalizedEnumValuesChange"
change
String
"removeEnumValues"
previousValue

Value before the change.

attributeName
String

Name of the updated AttributeDefinition.

SetInputTipChange

Change triggered by the Set AttributeDefinition InputTip update action.

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

Change triggered by the Change Quote Request State update action.

type
String
"ChangeQuoteRequestStateChange"
change
String
"changeQuoteRequestState"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

TransitionStateChange

Change triggered by the following update actions:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

Quotes

ChangeQuoteStateChange

Change triggered by the Change Quote State update action.

type
String
"ChangeQuoteStateChange"
change
String
"changeQuoteState"
previousValue

Value before the change.

nextValue

Value after the change.

RequestQuoteRenegotiationChange

Change triggered by the Request Quote Renegotiation update action.

type
String
"RequestQuoteRenegotiationChange"
change
String
"requestQuoteRenegotiation"
previousValue

Value before the change.

nextValue

Value after the change.

buyerComment
String

Message from the Buyer regarding the Quote renegotiation request.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

TransitionStateChange

Change triggered by the following update actions:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

Reviews

SetAuthorNameChange

Change triggered by the Set Author Name update action.

type
String
"SetAuthorNameChange"
change
String
"setAuthorName"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomerChange

Change triggered by the following update actions:

type
String
"SetCustomerChange"
change
String
"setCustomer"
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.

SetLocaleChange

Change triggered by the following update actions:

type
String
"SetLocaleChange"
change
String
"setLocale"
previousValue

Value before the change.

nextValue

Value after the change.

SetRatingChange

Change triggered by the Set Rating update action.

type
String
"SetRatingChange"
change
String
"setRating"
previousValue
Int

Value before the change.

nextValue
Int

Value after the change.

SetTargetChange

Change triggered by the Set Target update action.

type
String
"SetTargetChange"
change
String
"setTarget"
previousValue

Value before the change.

nextValue

Value after the change.

SetTextChange

Change triggered by the Set Text update action.

type
String
"SetTextChange"
change
String
"setText"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetTitleChange

Change triggered by the following update actions:

type
String
"SetTitleChange"
change
String
"setTitle"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

TransitionStateChange

Change triggered by the following update actions:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

Shopping Lists

AddShoppingListLineItemChange

Change triggered by the Add ShoppingListLineItem update action.

type
String
"AddShoppingListLineItemChange"
change
String
"addLineItem"
previousValue

Value before the change.

nextValue

Value after the change.

AddTextLineItemChange

Change triggered by the Add TextLineItem update action.

type
String
"AddTextLineItemChange"
change
String
"addTextLineItem"
nextValue

Value after the change.

ChangeShoppingListLineItemQuantityChange

Change triggered by the Change ShoppingListLineItem Quantity update action.

type
String
"ChangeShoppingListLineItemQuantityChange"
change
String
"changeLineItemQuantity"
previousValue
Int

Value before the change.

nextValue
Int

Value after the change.

Holds information about the updated Shopping List Line Item.

ChangeShoppingListLineItemsOrderChange

Change triggered by the Change ShoppingListLineItems Order update action.

type
String
"ChangeShoppingListLineItemsOrderChange"
change
String
"changeLineItemsOrder"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeLocalizedNameChange

Change triggered by the following update actions:

type
String
"ChangeLocalizedNameChange"
change
String
"changeName"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeTextLineItemNameChange

Change triggered by the Change TextLineItem Name update action.

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

Change triggered by the Change TextLineItem Quantity update action.

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

Change triggered by the Change TextLineItems Order update action.

type
String
"ChangeTextLineItemsOrderChange"
change
String
"changeTextLineItemsOrder"
previousValue
Array of TextLineItemValue

Value before the change.

nextValue
Array of TextLineItemValue

Value after the change.

RemoveShoppingListLineItemChange

Change triggered by the Remove ShoppingListLineItem update action.

type
String
"RemoveShoppingListLineItemChange"
change
String
"removeLineItem"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveTextLineItemChange

Change triggered by the Remove TextLineItem update action.

type
String
"RemoveTextLineItemChange"
change
String
"removeTextLineItem"
previousValue

Value before the change.

nextValue

Value after the change.

SetAnonymousIdChange

Change triggered by the following update actions:

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:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetCustomerChange

Change triggered by the following update actions:

type
String
"SetCustomerChange"
change
String
"setCustomer"
previousValue

Value before the change.

nextValue

Value after the change.

SetDeleteDaysAfterLastModificationChange

Change triggered by the Set DeleteDaysAfterLastModification update action.

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:

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

Change triggered by the Set ShoppingListLineItem Custom Field update action.

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.

Holds information about the updated Shopping List Line Item.

SetShoppingListLineItemCustomTypeChange

Change triggered by the Set ShoppingListLineItem Custom Type update action.

type
String
"SetShoppingListLineItemCustomTypeChange"
change
String
"setLineItemCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

Holds information about the updated Shopping List Line Item.

SetSlugChange

Change triggered by the Set Slug update action.

type
String
"SetSlugChange"
change
String
"setSlug"
previousValue

Value before the change.

nextValue

Value after the change.

SetTextLineItemCustomFieldChange

Change triggered by the Set TextLineItem CustomField update action.

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

Change triggered by the Set TextLineItem Custom Type update action.

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

Change triggered by the Set TextLineItem Description update action.

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

Change triggered by the following update actions:

type
String
"SetStoreChange"
change
String
"setStore"
previousValue

Value before the change.

nextValue

Value after the change.

SetLineItemDeactivatedAtChange

type
String
"SetLineItemDeactivatedAtChange"
change
String
"setLineItemDeactivatedAt"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

Holds information about the updated Shopping List Line Item.

States

ChangeInitialChange

Change triggered by the Change initial State update action.

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:

type
String
"ChangeKeyChange"
change
String
"changeKey"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

ChangeStateTypeChange

Change triggered by the Change State Type update action.

type
String
"ChangeStateTypeChange"
change
String
"changeType"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveStateRolesChange

Change triggered by the Remove State roles update action.

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:

type
String
"SetLocalizedDescriptionChange"
change
String
"setDescription"
previousValue

Value before the change.

nextValue

Value after the change.

SetLocalizedNameChange

Change triggered by the following update actions:

type
String
"SetLocalizedNameChange"
change
String
"setName"
previousValue

Value before the change.

nextValue

Value after the change.

SetStateRolesChange

Change triggered by the Set State roles update action.

type
String
"SetStateRolesChange"
change
String
"setRoles"
previousValue
Array of StateRoleEnum

Value before the change.

nextValue
Array of StateRoleEnum

Value after the change.

SetTransitionsChange

Change triggered by the Set Transitions update action.

type
String
"SetTransitionsChange"
change
String
"setTransitions"
previousValue
Array of Reference

Value before the change.

nextValue
Array of Reference

Value after the change.

AddStateRolesChange

Change triggered by the Add State roles update action.

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:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

Staged Quotes

ChangeStagedQuoteStateChange

Change triggered by the ChangeStagedQuoteState update action.

type
String
"ChangeStagedQuoteStateChange"
change
String
"changeStagedQuoteState"
previousValue

Value before the change.

nextValue

Value after the change.

SetSellerCommentChange

Change triggered by the Set Seller Comment update action.

type
String
"SetSellerCommentChange"
change
String
"setSellerComment"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

SetValidToChange

Change triggered by the Set Valid To update action.

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:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

TransitionStateChange

Change triggered by the following update actions:

type
String
"TransitionStateChange"
change
String
"transitionState"
previousValue

Value before the change.

nextValue

Value after the change.

Stores

AddProductSelectionChange

Change triggered by the Add Product Selection update action.

type
String
"AddProductSelectionChange"
change
String
"addProductSelection"
previousValue

ChangeProductSelectionActiveChange

Change triggered by the Change Product Selection Active update action.

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

Change triggered by the Remove Product Selection update action.

type
String
"RemoveProductSelectionChange"
change
String
"removeProductSelection"
previousValue

Value before the change.

SetDistributionChannelsChange

Change triggered by the Set Distribution Channels update action.

type
String
"SetDistributionChannelsChange"
change
String
"setDistributionChannels"
previousValue
Array of Reference

Value before the change.

nextValue
Array of Reference

Value after the change.

SetLanguagesChange

Change triggered by Set Languages update action.

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:

type
String
"SetLocalizedNameChange"
change
String
"setName"
previousValue

Value before the change.

nextValue

Value after the change.

SetProductSelectionsChange

Change triggered by the Set Product Selections update action.

type
String
"SetProductSelectionsChange"
change
String
"setProductSelections"
previousValue

Value before the change.

nextValue

Value after the change.

SetSupplyChannelsChange

Change triggered by the Set Supply Channels update action.

type
String
"SetSupplyChannelsChange"
change
String
"setSupplyChannels"
previousValue
Array of Reference

Value before the change.

nextValue
Array of Reference

Value after the change.

SetCustomFieldChange

Change triggered by the following update actions:

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:

type
String
"SetCustomTypeChange"
change
String
"setCustomType"
previousValue

Value before the change.

nextValue

Value after the change.

SetCountriesChange

Change triggered by the Set Countries update action.

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

Change triggered by the Add TaxRate update action.

type
String
"AddTaxRateChange"
change
String
"addTaxRate"
nextValue

Value after the change.

ChangeNameChange

Change triggered by the following update actions:

type
String
"ChangeNameChange"
change
String
"changeName"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

RemoveTaxRateChange

Change triggered by the Remove TaxRate update action.

type
String
"RemoveTaxRateChange"
change
String
"removeTaxRate"
previousValue

Value before the change.

SetDescriptionChange

Change triggered by the following update actions:

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

AddEnumValueChange

Change triggered by the Add EnumValue to FieldDefinition update action.

type
String
"AddEnumValueChange"
change
String
"addEnumValue"
nextValue

Value after the change.

fieldName
String

Name of the updated FieldDefinition.

AddFieldDefinitionChange

Change triggered by the Add FieldDefinition update action.

type
String
"AddFieldDefinitionChange"
change
String
"addFieldDefinition"
nextValue

Value after the change.

AddLocalizedEnumValueChange

Change triggered by the following update actions:

type
String
"AddLocalizedEnumValueChange"
change
String
"addLocalizedEnumValue"

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

Change triggered by the Change EnumValue Label update action.

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

Change triggered by the Change the order of EnumValues update action.

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

Change triggered by the Change the order of FieldDefinitions update action.

type
String
"ChangeFieldDefinitionOrderChange"
change
String
"changeFieldDefinitionOrder"
previousValue

Value before the change.

nextValue

Value after the change.

ChangeInputHintChange

Change triggered by the following update actions:

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:

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:

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:

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:

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:

type
String
"ChangeLocalizedNameChange"
change
String
"changeName"
previousValue

Value before the change.

nextValue

Value after the change.

RemoveFieldDefinitionChange

Change triggered by the Remove FieldDefinition update action.

type
String
"RemoveFieldDefinitionChange"
change
String
"removeFieldDefinition"
previousValue

Value before the change.

SetLocalizedDescriptionChange

Change triggered by the following update actions:

type
String
"SetLocalizedDescriptionChange"
change
String
"setDescription"
previousValue

Value before the change.

nextValue

Value after the change.

Zones

AddLocationChange

Change triggered by the Add Location update action.

type
String
"AddLocationChange"
change
String
"addLocation"
nextValue

Value after the change.

ChangeNameChange

Change triggered by the following update actions:

type
String
"ChangeNameChange"
change
String
"changeName"
previousValue
String

Value before the change.

nextValue
String

Value after the change.

RemoveLocationChange

Change triggered by the Remove Location update action.

type
String
"RemoveLocationChange"
change
String
"removeLocation"
previousValue

Value before the change.

SetDescriptionChange

Change triggered by the following update actions:

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.