Change Types

Changes describe data modifications in the Audit Log Change History API. Changes are used in the changes field of the Record representation.

Representations

Change

A Change represents the differences in the resource between one version and the next. They are not identical to the actual Update Actions sent to the platform.

All Change representations share the following properties and have additional properties depending on the type of change:

  • type - String
    A unique discriminator value to reliably deserialize the data type
  • previousValue - ChangeValue - (optional, omitted for example on creations)
  • nextValue - ChangeValue
  • change - String
    An identifier for the type of modification that - where possible - is kept similar to the Update Action it relates to. Not a unique identfier for the data structure; for example, the setDescription change can occur with a localized and non-localized representation. Change History Records can be filtered by this value using the changes query parameter. This field can take the following values (grouped by Resource Type):
    • For Cart Discounts: changeCartPredicate, changeIsActive, changeName, changeRequiresDiscountCode, changeSortOrder, changeStackingMode, changeTarget, changeValue, setCustomField, setCustomType, setDescription, setKey, setValidFrom, setValidFromAndUntil, setValidUntil
    • For Categories: addAsset, changeAssetName, changeAssetOrder, changeName, changeOrderHint, changeParent, changeSlug, removeAsset, setAssetCustomField, setAssetCustomType, setAssetDescription, setAssetKey, setAssetSources, setAssetTags, setCustomField, setCustomType, setDescription, setExternalId, setKey, setMetaDescription, setMetaKeywords, setMetaTitle
    • For Channels: changeDescription, changeKey, changeName, changeReviewRatingStatistics, setAddress, setCustomField, setCustomType, setGeoLocation, setRoles
    • For Customers: addAddress, addBillingAddressId, addShippingAddressId, changeAddress, changeEmail, removeAddress, removeBillingAddressId, removeShippingAddressId, setCompanyName, setCustomField, setCustomType, setCustomerGroup, setCustomerNumber, setDateOfBirth, setDefaultBillingAddress, setDefaultShippingAddress, setExternalId, setFirstName, setKey, setLastName, setLocale, setMiddleName, setPassword, setSalutation, setStores, setTitle, setVatId, verifyEmail
    • For Customer Groups: changeName, setCustomField, setCustomType, setKey
    • For Discount Codes: changeCartDiscounts, changeGroups, changeIsActive, setCartPredicate, setCustomField, setCustomType, setDescription, setMaxApplications, setMaxApplicationsPerCustomer, setName, setValidFrom, setValidFromAndUntil, setValidUntil
    • For Inventories: changeQuantity, setCustomField, setCustomType, setExpectedDelivery, setRestockableInDays, setSupplyChannel
    • For Orders: addDelivery, addItemShippingAddress, addParcelToDelivery, addPayment, addReturnInfo, changeOrderState, changePaymentState, changeShipmentState, removeDelivery, removeItemShippingAddress, removeParcelFromDelivery, removePayment, setBillingAddress, setCustomField, setCustomLineItemCustomField, setCustomLineItemCustomType, setCustomLineItemShippingDetails, setCustomType, setCustomerEmail, setCustomerId, setDeliveryAddress, setDeliveryItems, setLineItemCustomField, setLineItemCustomType, setLineItemShippingDetails, setLocale, setOrderNumber, setParcelItems, setParcelMeasurements, setParcelTrackingData, setReturnPaymentState, setReturnShipmentState, setShippingAddress, setStore, transitionCustomLineItemState, transitionLineItemState, transitionState, updateItemShippingAddress, updateSyncInfo
    • For Payments: addInterfaceInterChange, addTransChange, changeAmountPlanned, changeTransChangeInterChangeId, changeTransChangeState, changeTransChangeTimestamp, setAnonymousId, setCustomField, setCustomType, setCustomer, setInterfaceId, setKey, setMethodInfoInterface, setMethodInfoMethod, setMethodInfoName, setStatusInterfaceCode, setStatusInterfaceText, transitionState
    • For Products: addAsset, addExternalImage, addPrice, addToCategory, addVariant, changeAssetName, changeAssetOrder, changeMasterVariant, changeName, changePrice, changeReviewRatingStatistics, changeSlug, publish, removeAsset, removeFromCategory, removeImage, removePrice, removeVariant, setAssetCustomField, setAssetCustomType, setAssetDescription, setAssetKey, setAssetSources, setAssetTags, setAttribute, setCategoryOrderHint, setDescription, setDiscountedPrice, setImageLabel, setKey, setMetaDescription, setMetaKeywords, setMetaTitle, setProductPriceCustomField, setProductPriceCustomType, setProductVariantKey, setSearchKeywords, setSku, setTaxCategory, setVariantAvailability, transitionState, unpublish
    • For Product Discounts: changeIsActive, changeName, changePredicate, changeSortOrder, changeValue, setDescription, setKey, setValidFrom, setValidFromAndUntil, setValidUntil
    • For Product Types: addAttributeDefinition, addLocalizedEnumValue, addPlainEnumValue, changeAttributeConstraint, changeAttributeName, changeAttributeOrderByName, changeDescription, changeEnumKey, changeInputHint, changeIsSearchable, changeLabel, changeLocalizedEnumValueLabel, changeName, changePlainEnumValueLabel, removeAttributeDefinition, removeEnumValues, setInputTip, setKey
    • For Reviews: setAuthorName, setCustomField, setCustomType, setCustomer, setKey, setLocale, setRating, setTarget, setText, setTitle, transitionState
    • For Shopping Lists: addLineItem, addTextLineItem, changeLineItemQuantity, changeLineItemsOrder, changeName, changeTextLineItemName, changeTextLineItemQuantity, changeTextLineItemsOrder, removeLineItem, removeTextLineItem, setAnonymousId, setCustomField, setCustomType, setCustomer, setDeleteDaysAfterLastModification, setDescription, setKey, setLineItemCustomField, setLineItemCustomType, setSlug, setTextLineItemCustomField, setTextLineItemCustomType, setTextLineItemDescription
    • For States: changeInitial, changeKey, changeType, removeRoles, setDescription, setName, setRoles, setTransitions, addRoles
    • For Stores: setDistributionChannels, setLanguages, setName
    • For Tax Categories: addTaxRate, changeName, removeTaxRate, setDescription, setKey
    • For Types: addEnumValue, addFieldDefinition, addLocalizedEnumValue, changeEnumValueLabel, changeEnumValueOrder, changeFieldDefinitionOrder, changeInputHint, changeKey, changeLabel, changeLocalizedEnumValueLabel, changeLocalizedEnumValueOrder, changeName, removeFieldDefinition, setDescription
    • For Zones: addLocation, changeName, removeLocation, setDescription, setKey

Each Change may contain additional fields that add further information such as fieldName and valueKey in ChangeEnumValueLabelChange. Below is the list of all Changes.

List of Changes

AddAddressChange

AddAddressChange

type
String
"AddAddressChange"
change
String
"addAddress"

Update action for setAddress action.

nextValue
Address
previousValue
Address

AddAssetChange

type
String
"AddAssetChange"
change
String
"addAsset"

Update action for addAsset

nextValue
Asset
previousValue
Asset

AddAttributeDefinitionChange

type
String
"AddAttributeDefinitionChange"
change
String
"addAttributeDefinition"

Update action for addAttributeDefinition on product types

nextValue
AttributeDefinition

AddBillingAddressIdChange

type
String
"AddBillingAddressIdChange"
change
String
"addBillingAddressId"

Update action for addBillingAddressId action on customers.

nextValue
Array of String
previousValue
Array of String
address
Address

AddChannelRolesChange

type
String
"AddChannelRolesChange"
change
String
"addRoles"
previousValue
Array of ChannelRole
nextValue
Array of ChannelRole

AddCustomLineItemChange

type
String
"AddCustomLineItemChange"
change
String
"addCustomLineItem"

Update action for adding and removing custom line items

nextValue
CustomLineItem
previousValue
CustomLineItem

AddDeliveryChange

type
String
"AddDeliveryChange"
change
String
"addDelivery"

Update action for addDelivery

previousValue

AddDiscountCodeChange

type
String
"AddDiscountCodeChange"
change
String
"addDiscountCode"

Update action for addDiscountCode

nextValue
DiscountCodeInfo

AddEnumValueChange

type
String
"AddEnumValueChange"
change
String
"addEnumValue"

Update action for addEnumValue on types

fieldName
String

The name of the field/attribute definition updated.

nextValue

AddExternalImageChange

type
String
"AddExternalImageChange"
change
String
"addExternalImage"

Update actions for adding an external image

catalogData
String
previousValue
Array of Image
nextValue
Array of Image

AddFieldDefinitionChange

type
String
"AddFieldDefinitionChange"
change
String
"addFieldDefinition"

Update action for addFieldDefinition on payments

nextValue
FieldDefinition

AddInterfaceInteractionChange

type
String
"AddInterfaceInteractionChange"
change
String
"addInterfaceInteraction"

Update action for addInterfaceInteraction on payments

AddItemShippingAddressesChange

type
String
"AddItemShippingAddressesChange"
change
String
"addItemShippingAddress"

Update action for addItemShippingAddress

nextValue
Address
previousValue
Address

AddLocalizedEnumValueChange

type
String
"AddLocalizedEnumValueChange"
change
String
"addLocalizedEnumValue"

Update action for addLocalizedEnumValue on types

fieldName
String

The name of the field definition updated.

attributeName
String

The name of the attribute updated.

AddLocationChange

type
String
"AddLocationChange"
change
String
"addLocation"

Update action for addLocation on zones

previousValue
Location
nextValue
Location

AddOrderLineItemChange

type
String
"AddOrderLineItemChange"
change
String
"addLineItem"
previousValue
LineItem
nextValue
LineItem

AddParcelToDeliveryChange

type
String
"AddParcelToDeliveryChange"
change
String
"addParcelToDelivery"

Update action for addParcelToDelivery

deliveryId
String
nextValue
Parcel

AddPaymentChange

type
String
"AddPaymentChange"
change
String
"addPayment"

Update action for addPayment & removePayment

nextValue
PaymentInfo
previousValue
PaymentInfo

AddPlainEnumValueChange

type
String
"AddPlainEnumValueChange"
change
String
"addPlainEnumValue"

Update action for addPlainEnumValue on product types

attributeName
String

The name of the attribute updated.

nextValue

AddPriceChange

type
String
"AddPriceChange"
change
String
"addPrice"

Update action for adding prices

catalogData
String
priceId
String
nextValue
Price

AddReturnInfoChange

type
String
"AddReturnInfoChange"
change
String
"addReturnInfo"

Update action for addReturnInfo

nextValue
ReturnInfo

AddShippingAddressIdChange

type
String
"AddShippingAddressIdChange"
change
String
"addShippingAddressId"

Update action for addShippingAddressId action on customers.

nextValue
Array of String
previousValue
Array of String
address
Address

AddShoppingListLineItemChange

type
String
"AddShoppingListLineItemChange"
change
String
"addLineItem"
previousValue
LineItem
nextValue
LineItem

AddStateRolesChange

type
String
"AddStateRolesChange"
change
String
"addRoles"
previousValue
Array of StateRole
nextValue
Array of StateRole

AddTaxRateChange

type
String
"AddTaxRateChange"
change
String
"addTaxRate"

Update action for addTaxRate on tax categories

nextValue
TaxRate

AddTextLineItemChange

type
String
"AddTextLineItemChange"
change
String
"addTextLineItem"
nextValue
TextLineItem

AddToCategoryChange

type
String
"AddToCategoryChange"
change
String
"addToCategory"

Update action for addToCategory

category
Reference
previousValue
Array of Reference
nextValue
Array of Reference

AddTransactionChange

type
String
"AddTransactionChange"
change
String
"addTransaction"

Update action for addTransaction on payments

nextValue
Transaction

AddVariantChange

type
String
"AddVariantChange"
change
String
"addVariant"

Update action for addVariant

catalogData
String
previousValue
Variant
nextValue
Variant

ChangeAddressChange

type
String
"ChangeAddressChange"
change
String
"changeAddress"

Update action changeAddress action.

nextValue
Address
previousValue
Address

ChangeAmountAuthorizedChange

type
String
"ChangeAmountAuthorizedChange"
change
String
"changeAmountAuthorized"

Internal Update action for changeAmountAuthorized

previousValue
Money
nextValue
Money

ChangeAmountPlannedChange

type
String
"ChangeAmountPlannedChange"
change
String
"changeAmountPlanned"
previousValue
Money
nextValue
Money

ChangeAssetNameChange

type
String
"ChangeAssetNameChange"
change
String
"changeAssetName"

Update action for changeAssetName

nextValue
LocalizedString
previousValue
LocalizedString

ChangeAssetOrderChange

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

ChangeAttributeConstraintChange

type
String
"ChangeAttributeConstraintChange"
change
String
"changeAttributeConstraint"
attributeName
String

name of the updated attribute

previousValue
AttributeConstraintEnum
nextValue
AttributeConstraintEnum

ChangeAttributeOrderByNameChange

type
String
"ChangeAttributeOrderByNameChange"
change
String
"changeAttributeOrderByName"

Update action for changeAttributeOrderByName on product types

previousValue
Array of String
nextValue
Array of String

ChangeCartDiscountsChange

type
String
"ChangeCartDiscountsChange"
change
String
"changeCartDiscounts"

Shape of the action for changeCartDiscounts

previousValue
Array of Reference
nextValue
Array of Reference

ChangeCartPredicateChange

type
String
"ChangeCartPredicateChange"
change
String
"changeCartPredicate"

Shape of the action for changeCartPredicate

previousValue
String
nextValue
String

ChangeCustomLineItemQuantityChange

type
String
"ChangeCustomLineItemQuantityChange"
change
String
"changeCustomLineItemQuantity"

Update action for changeCustomLineItemQuantity

customLineItem
LocalizedString
customLineItemId
String
nextValue
Int
previousValue
Int

ChangeDescriptionChange

type
String
"ChangeDescriptionChange"
change
String
"changeDescription"

Shape of the action for changeDescription

previousValue
String
nextValue
String

ChangeEmailChange

type
String
"ChangeEmailChange"
change
String
"changeEmail"

Shape of the action for changeEmail

previousValue
String
nextValue
String

ChangeEnumValueLabelChange

type
String
"ChangeEnumValueLabelChange"
change
String
"changeEnumValueLabel"

Update action for changeEnumValueLabel on types

fieldName
String

The name of the field definition updated.

valueKey
String

Key of the values that was updated

previousValue
String
nextValue
String

ChangeEnumValueOrderChange

type
String
"ChangeEnumValueOrderChange"
change
String
"changeEnumValueOrder"

Update action for changeEnumValueOrder on types

fieldName
String

The name of the field/attribute definition updated.

nextValue
Array of EnumValue
previousValue
Array of EnumValue

ChangeFieldDefinitionOrderChange

type
String
"ChangeFieldDefinitionOrderChange"
change
String
"changeFieldDefinitionOrder"

Update action for changeFieldDefinitionOrder on types

previousValue
nextValue

ChangeGroupsChange

type
String
"ChangeGroupsChange"
change
String
"changeGroups"

Update action for changeGroups on stores

previousValue
Array of String
nextValue
Array of String

ChangeInitialChange

type
String
"ChangeInitialChange"
change
String
"changeInitial"

Shape of the action for changeInitial

previousValue
Boolean
nextValue
Boolean

ChangeInputHintChange

type
String
"ChangeInputHintChange"
change
String
"changeInputHint"

Update action for changeInputHint on product types and types

fieldName
String

The name of the field definition updated.

attributeName
String

The name of the attribute updated.

nextValue
TextInputHint
previousValue
TextInputHint

ChangeIsActiveChange

type
String
"ChangeIsActiveChange"
change
String
"changeIsActive"

Shape of the action for changeIsActive

previousValue
Boolean
nextValue
Boolean

ChangeIsSearchableChange

type
String
"ChangeIsSearchableChange"
change
String
"changeIsSearchable"

Update action for changeIsSearchable on product types

attributeName
String

The name of the updated attribute.

nextValue
Boolean
previousValue
Boolean

ChangeKeyChange

type
String
"ChangeKeyChange"
change
String
"changeKey"

Shape of the action for changeKey

previousValue
String
nextValue
String

ChangeLabelChange

type
String
"ChangeLabelChange"
change
String
"changeLabel"

Update action for changeLabel on product types and types

fieldName
String

The name of the field definition to update (types).

attributeName
String

The name of the attribute definition to update (product-type).

nextValue
LocalizedString
previousValue
LocalizedString

ChangeLineItemQuantityChange

type
String
"ChangeLineItemQuantityChange"
change
String
"changeLineItemQuantity"

Update action for changeLineItemQuantity

lineItem
LocalizedString
lineItemId
String
nextValue
Int

The amount of a LineItem in the cart. Must be a positive integer.

previousValue
Int

The amount of a LineItem in the cart. Must be a positive integer.

ChangeLocalizedDescriptionChange

type
String
"ChangeLocalizedDescriptionChange"
change
String
"changeDescription"

Shape of the action for changeDescription

previousValue
LocalizedString
nextValue
LocalizedString

ChangeLocalizedEnumValueLabelChange

type
String
"ChangeLocalizedEnumValueLabelChange"
change
String
"changeLocalizedEnumValueLabel"

Update action for changeLocalizedEnumValueLabel on types

fieldName
String

The name of the field definition updated.

attributeName
String

The name of the attribute updated.

valueKey
String

Key of the values that was updated

previousValue
LocalizedString
nextValue
LocalizedString

ChangeLocalizedEnumValueOrderChange

type
String
"ChangeLocalizedEnumValueOrderChange"
change
String
"changeLocalizedEnumValueOrder"

Update action for changeLocalizedEnumValueOrder on types and product types

fieldName
String

The name of the field definition updated.

attributeName
String

The name of the attribute updated.

nextValue
previousValue

ChangeLocalizedNameChange

type
String
"ChangeLocalizedNameChange"
change
String
"changeName"

Shape of the action for changeName

previousValue
LocalizedString
nextValue
LocalizedString

ChangeMasterVariantChange

type
String
"ChangeMasterVariantChange"
change
String
"changeMasterVariant"

Update action for changeMasterVariant

catalogData
String
previousValue
Variant
nextValue
Variant

ChangeNameChange

type
String
"ChangeNameChange"
change
String
"changeName"

Shape of the action for changeName

previousValue
String
nextValue
String

ChangeOrderHintChange

type
String
"ChangeOrderHintChange"
change
String
"changeOrderHint"

Shape of the action for changeOrderHint

previousValue
String
nextValue
String

ChangeOrderStateChange

type
String
"ChangeOrderStateChange"
change
String
"changeOrderState"

Update action for changeOrderState

nextValue
OrderState
previousValue
OrderState

ChangeParentChange

type
String
"ChangeParentChange"
change
String
"changeParent"

Shape of the action for changeParent

previousValue
Reference
nextValue
Reference

ChangePaymentStateChange

type
String
"ChangePaymentStateChange"
change
String
"changePaymentState"

Update action for changePaymentState

nextValue
PaymentState
previousValue
PaymentState

ChangePlainEnumValueLabelChange

type
String
"ChangePlainEnumValueLabelChange"
change
String
"changePlainEnumValueLabel"

Update action for changePlainEnumValueLabel on types

attributeName
String

The name of the attribute updated.

valueKey
String

Key of the values that was updated

previousValue
String
nextValue
String

ChangePlainEnumValueOrderChange

type
String
"ChangePlainEnumValueOrderChange"
change
String
"changePlainEnumValueOrder"

Update action for changePlainEnumValueOrder on product types

attributeName
String

The name of the attribute updated.

nextValue
Array of EnumValue
previousValue
Array of EnumValue

ChangePredicateChange

type
String
"ChangePredicateChange"
change
String
"changePredicate"

Shape of the action for changePredicate

previousValue
String
nextValue
String

ChangePriceChange

type
String
"ChangePriceChange"
change
String
"changePrice"

Update action for changing prices

catalogData
String
priceId
String
previousValue
Price
nextValue
Price

ChangeQuantityChange

Update action for changeQuantity on inventories

type
String
"ChangeQuantityChange"
change
String
"changeQuantity"

ChangeRequiresDiscountCodeChange

type
String
"ChangeRequiresDiscountCodeChange"
change
String
"changeRequiresDiscountCode"

Shape of the action for changeRequiresDiscountCode

previousValue
Boolean
nextValue
Boolean

ChangeReviewRatingStatisticsChange

type
String
"ChangeReviewRatingStatisticsChange"
change
String
"changeReviewRatingStatistics"

Update action for changeReviewRatingStatistics

nextValue
ReviewRatingStatistics
previousValue
ReviewRatingStatistics

ChangeShipmentStateChange

type
String
"ChangeShipmentStateChange"
change
String
"changeShipmentState"

Update action for changeShipmentState

nextValue
ShipmentState
previousValue
ShipmentState

ChangeShoppingListLineItemQuantityChange

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

ChangeShoppingListLineItemsOrderChange

type
String
"ChangeShoppingListLineItemsOrderChange"
change
String
"changeLineItemsOrder"
previousValue
nextValue

ChangeSlugChange

type
String
"ChangeSlugChange"
change
String
"changeSlug"

Shape of the action for changeSlug

previousValue
LocalizedString
nextValue
LocalizedString

ChangeSortOrderChange

type
String
"ChangeSortOrderChange"
change
String
"changeSortOrder"

Shape of the action for changeSortOrder

previousValue
String
nextValue
String

ChangeStackingModeChange

type
String
"ChangeStackingModeChange"
change
String
"changeStackingMode"

Update action for changeStackingMode on cart discounts

nextValue
StackingMode
previousValue
StackingMode

ChangeStateTypeChange

type
String
"ChangeStateTypeChange"
change
String
"changeType"

Update action for changeType on state

previousValue
StateType
nextValue
StateType

ChangeTargetChange

type
String
"ChangeTargetChange"
change
String
"changeTarget"

Update action for changeTarget on cart discounts

nextValue
ChangeTargetChangeValue
previousValue
ChangeTargetChangeValue

ChangeTextLineItemNameChange

type
String
"ChangeTextLineItemNameChange"
change
String
"changeTextLineItemName"

Update action for changeTextLineItemName

textLineItem
nextValue
LocalizedString
previousValue
LocalizedString

ChangeTaxCalculationModeChange

type
String
"ChangeTaxCalculationModeChange"
change
String
"changeTaxCalculationMode"

Shape of the action for changeTaxCalculationMode

previousValue
TaxCalculationMode
nextValue
TaxCalculationMode

ChangeTaxModeChange

type
String
"ChangeTaxModeChange"
change
String
"changeTaxMode"

Shape of the action for changeTaxMode

previousValue
TaxMode
nextValue
TaxMode

ChangeTaxRoundingModeChange

type
String
"ChangeTaxRoundingModeChange"
change
String
"changeTaxRoundingMode"

Shape of the action for changeTaxRoundingMode

previousValue
RoundingMode
nextValue
RoundingMode

ChangeTextLineItemQuantityChange

type
String
"ChangeTextLineItemQuantityChange"
change
String
"changeTextLineItemQuantity"
textLineItem
previousValue
Int
nextValue
Int

ChangeTextLineItemsOrderChange

type
String
"ChangeTextLineItemsOrderChange"
change
String
"changeTextLineItemsOrder"
previousValue
nextValue

ChangeTransactionInteractionIdChange

type
String
"ChangeTransactionInteractionIdChange"
change
String
"changeTransactionInteractionId"

Update action for changeTransactionInteractionId on payments

nextValue
String
previousValue
String

ChangeTransactionStateChange

type
String
"ChangeTransactionStateChange"
change
String
"changeTransactionState"

Update action for changeTransactionState on payments

nextValue
TransactionState
previousValue
TransactionState

ChangeTransactionTimestampChange

type
String
"ChangeTransactionTimestampChange"
change
String
"changeTransactionTimestamp"

Update action for changeTransactionTimestamp on payments

nextValue
String
previousValue
String

ChangeValueChange

type
String
"ChangeValueChange"
change
String
"changeValue"

Update action for changeValue on cart discounts and product discounts

nextValue
ChangeValueChangeValue
previousValue
ChangeValueChangeValue

MoveImageToPositionChange

type
String
"MoveImageToPositionChange"
change
String
"moveImageToPosition"

Update actions for moving images

catalogData
String
previousValue
Array of Image
nextValue
Array of Image

PublishChange

type
String
"PublishChange"
change
String
"publish"

RemoveAddressChange

type
String
"RemoveAddressChange"
change
String
"removeAddress"

Update action for removeAddress action.

previousValue
Address

RemoveAssetChange

type
String
"RemoveAssetChange"
change
String
"removeAsset"

Update action for removeAsset

previousValue
Asset

RemoveAttributeDefinitionChange

type
String
"RemoveAttributeDefinitionChange"
change
String
"removeAttributeDefinition"

Update action for removeAttributeDefinition on product types

previousValue
AttributeDefinition

RemoveBillingAddressIdChange

type
String
"RemoveBillingAddressIdChange"
change
String
"removeBillingAddressId"

Update action for removeBillingAddressId action on customers.

nextValue
Array of String
previousValue
Array of String
address
Address

RemoveChannelRolesChange

type
String
"RemoveChannelRolesChange"
change
String
"removeRoles"
previousValue
Array of ChannelRole
nextValue
Array of ChannelRole

RemoveCustomLineItemChange

type
String
"RemoveCustomLineItemChange"
change
String
"removeCustomLineItem"

Update action for adding and removing custom line items

nextValue
CustomLineItem
previousValue
CustomLineItem

RemoveDeliveryItemsChange

type
String
"RemoveDeliveryItemsChange"
change
String
"removeDelivery"

Update action for removeDelivery

previousValue
Delivery

RemoveDiscountCodeChange

type
String
"RemoveDiscountCodeChange"
change
String
"removeDiscountCode"

Update action for removeDiscountCode

previousValue
DiscountCodeInfo

RemoveEnumValuesChange

type
String
"RemoveEnumValuesChange"
change
String
"removeEnumValues"

Update action for removeEnumValues on product types

attributeName
String

The name of the attribute updated.

previousValue

RemoveFieldDefinitionChange

type
String
"RemoveFieldDefinitionChange"
change
String
"removeFieldDefinition"

Update action for removeFieldDefinition on payments

previousValue
FieldDefinition

RemoveFromCategoryChange

type
String
"RemoveFromCategoryChange"
change
String
"removeFromCategory"

Update action for addToCategory

category
Reference
previousValue
Array of Reference
nextValue
Array of Reference

RemoveImageChange

type
String
"RemoveImageChange"
change
String
"removeImage"

Update actions for removing images

catalogData
String
previousValue
Array of Image
nextValue
Array of Image

RemoveItemShippingAddressesChange

type
String
"RemoveItemShippingAddressesChange"
change
String
"removeItemShippingAddress"

Update action for removeItemShippingAddress

nextValue
Address
previousValue
Address

RemoveLocalizedEnumValuesChange

type
String
"RemoveLocalizedEnumValuesChange"
change
String
"removeEnumValues"

Update action for removeEnumValues on product types

attributeName
String

The name of the attribute updated.

previousValue

RemoveLocationChange

type
String
"RemoveLocationChange"
change
String
"removeLocation"

Update action for removeLocation on zones

previousValue
Location
nextValue
Location

RemoveOrderLineItemChange

type
String
"RemoveOrderLineItemChange"
change
String
"removeLineItem"
previousValue
LineItem
nextValue
LineItem

RemoveParcelFromDeliveryChange

type
String
"RemoveParcelFromDeliveryChange"
change
String
"removeParcelFromDelivery"

Update action for removeParcelFromDelivery

deliveryId
String
previousValue
Parcel

RemovePaymentChange

type
String
"RemovePaymentChange"
change
String
"removePayment"

Update action for addPayment & removePayment

nextValue
PaymentInfo
previousValue
PaymentInfo

RemovePriceChange

type
String
"RemovePriceChange"
change
String
"removePrice"

Update action for removing prices

catalogData
String
priceId
String
previousValue
Price
nextValue
Price

RemoveShippingAddressIdChange

type
String
"RemoveShippingAddressIdChange"
change
String
"removeShippingAddressId"

Update action for removeShippingAddressId action on customers.

nextValue
Array of String
previousValue
Array of String
address
Address

RemoveShoppingListLineItemChange

type
String
"RemoveShoppingListLineItemChange"
change
String
"removeLineItem"
previousValue
LineItem
nextValue
LineItem

RemoveStateRolesChange

type
String
"RemoveStateRolesChange"
change
String
"removeRoles"
previousValue
Array of StateRole
nextValue
Array of StateRole

RemoveTaxRateChange

type
String
"RemoveTaxRateChange"
change
String
"removeTaxRate"

Update action for removeTaxRate on tax categories

previousValue
TaxRate
nextValue
TaxRate

RemoveTextLineItemChange

type
String
"RemoveTextLineItemChange"
change
String
"removeTextLineItem"
previousValue
TextLineItem
nextValue
TextLineItem

RemoveVariantChange

type
String
"RemoveVariantChange"
change
String
"removeVariant"

Update action for removeVariant

catalogData
String
previousValue
Variant
nextValue
Variant

SetAddressChange

type
String
"SetAddressChange"
change
String
"setAddress"

Update action for setAddress action.

nextValue
Address
previousValue
Address

SetAnonymousIdChange

type
String
"SetAnonymousIdChange"
change
String
"setAnonymousId"

Shape of the action for setAnonymousId

previousValue
String
nextValue
String

SetApplicationVersionChange

type
String
"SetApplicationVersionChange"
change
String
"setApplicationVersion"

Internal Update action for setApplicationVersion

previousValue
Int
nextValue
Int

SetAssetCustomFieldChange

type
String
"SetAssetCustomFieldChange"
change
String
"setAssetCustomField"

Update action for setAssetCustomField

name
String
customTypeId
String
nextValue
Any
previousValue
Any

SetAssetCustomTypeChange

type
String
"SetAssetCustomTypeChange"
change
String
"setAssetCustomType"

Update action for setAssetCustomType

nextValue
CustomFields
previousValue
CustomFields

SetAssetDescriptionChange

type
String
"SetAssetDescriptionChange"
change
String
"setAssetDescription"

Update action for setAssetDescription

nextValue
LocalizedString
previousValue
LocalizedString

SetAssetKeyChange

type
String
"SetAssetKeyChange"
change
String
"setAssetKey"

Update action for setAssetKey

nextValue
String
previousValue
String

SetAssetSourcesChange

type
String
"SetAssetSourcesChange"
change
String
"setAssetSources"

Update action for setAssetSources

nextValue
Array of AssetSource
previousValue
Array of AssetSource

SetAssetTagsChange

type
String
"SetAssetTagsChange"
change
String
"setAssetTags"

Update action for setAssetTags

nextValue
Array of String
previousValue
Array of String

SetAttributeChange

type
String
"SetAttributeChange"
change
String
"setAttribute"

Update action for setAttribute

catalogData
String
previousValue
Object
nextValue
Object

SetAuthorNameChange

type
String
"SetAuthorNameChange"
change
String
"setAuthorName"

Shape of the action for setAuthorName

previousValue
String
nextValue
String

SetBillingAddressChange

type
String
"SetBillingAddressChange"
change
String
"setBillingAddress"

Update action for setBillingAddress

nextValue
Address
previousValue
Address

SetCartPredicateChange

type
String
"SetCartPredicateChange"
change
String
"setCartPredicate"

Shape of the action for setCartPredicate

previousValue
String
nextValue
String

SetCategoryOrderHintChange

type
String
"SetCategoryOrderHintChange"
change
String
"setCategoryOrderHint"

Update action for setCategoryOrderHint

catalogData
String
categoryId
String
previousValue
CategoryOrderHints
nextValue
CategoryOrderHints

SetChannelRolesChange

type
String
"SetChannelRolesChange"
change
String
"setRoles"
previousValue
Array of ChannelRole
nextValue
Array of ChannelRole

SetCompanyNameChange

type
String
"SetCompanyNameChange"
change
String
"setCompanyName"

Shape of the action for setCompanyName

previousValue
String
nextValue
String

SetCountryChange

type
String
"SetCountryChange"
change
String
"setCountry"

Update action for setCountry

previousValue
CountryCode

A two-digit country code as per ISO 3166-1 alpha-2.

nextValue
CountryCode

A two-digit country code as per ISO 3166-1 alpha-2.

SetCustomFieldChange

type
String
"SetCustomFieldChange"
change
String
"setCustomField"

Update action for setting a custom field

name
String

Custom field name

customTypeId
String
nextValue
Any
previousValue
Any

SetCustomLineItemCustomFieldChange

type
String
"SetCustomLineItemCustomFieldChange"
change
String
"setCustomLineItemCustomField"

Update action for setCustomLineItemCustomField

name
String
customLineItem
LocalizedString
nextValue
Any
previousValue
Any

SetCustomLineItemCustomTypeChange

type
String
"SetCustomLineItemCustomTypeChange"
change
String
"setCustomLineItemCustomType"

Update action for setCustomLineItemCustomType

customLineItem
LocalizedString
nextValue
CustomFields
previousValue
CustomFields

SetCustomLineItemMoneyChange

type
String
"SetCustomLineItemMoneyChange"
change
String
"setCustomLineItemMoney"

Update action for setCustomLineItemMoney

customLineItem
LocalizedString
customLineItemId
String
nextValue
Money
previousValue
Money

SetCustomLineItemShippingDetailsChange

type
String
"SetCustomLineItemShippingDetailsChange"
change
String
"setCustomLineItemShippingDetails"

Update action for setCustomLineItemShippingDetails

customLineItemId
String
nextValue
ItemShippingDetails
previousValue
ItemShippingDetails

SetCustomLineItemTaxAmountChange

type
String
"SetCustomLineItemTaxAmountChange"
change
String
"setCustomLineItemTaxAmount"

Update action for setCustomLineItemTaxAmount

customLineItem
LocalizedString
customLineItemId
String
taxMode
TaxMode
nextValue