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 typepreviousValue
- ChangeValue - (optional, omitted for example on creations)nextValue
- ChangeValuechange
- 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, thesetDescription
change can occur with a localized and non-localized representation. Change History Records can be filtered by this value using thechanges
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 Custom Objects:
addProperty
,removeProperty
,setProperty
,setValue
- 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
- For Cart Discounts:
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
type String | "AddAddressChange" |
change String | "addAddress" Update action for |
nextValue Address | |
previousValue Address |
AddAssetChange
type String | "AddAssetChange" |
change String | "addAsset" Update action for |
nextValue Asset | |
previousValue Asset |
AddAttributeDefinitionChange
type String | "AddAttributeDefinitionChange" |
change String | "addAttributeDefinition" Update action for |
nextValue AttributeDefinition |
AddBillingAddressIdChange
type String | "AddBillingAddressIdChange" |
change String | "addBillingAddressId" Update action for |
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 |
nextValue | |
previousValue |
AddDiscountCodeChange
type String | "AddDiscountCodeChange" |
change String | "addDiscountCode" Update action for |
nextValue DiscountCodeInfo |
AddEnumValueChange
type String | "AddEnumValueChange" |
change String | "addEnumValue" Update action for |
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 |
nextValue FieldDefinition |
AddInterfaceInteractionChange
type String | "AddInterfaceInteractionChange" |
change String | "addInterfaceInteraction" Update action for |
nextValue |
AddItemShippingAddressesChange
type String | "AddItemShippingAddressesChange" |
change String | "addItemShippingAddress" Update action for |
nextValue Address | |
previousValue Address |
AddLocalizedEnumValueChange
type String | "AddLocalizedEnumValueChange" |
change String | "addLocalizedEnumValue" Update action for |
fieldName String | The name of the field definition updated. |
attributeName String | The name of the attribute updated. |
nextValue |
AddLocationChange
type String | "AddLocationChange" |
change String | "addLocation" Update action for |
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 |
deliveryId String | |
nextValue Parcel |
AddPaymentChange
type String | "AddPaymentChange" |
change String | "addPayment" Update action for |
nextValue PaymentInfo | |
previousValue PaymentInfo |
AddPlainEnumValueChange
type String | "AddPlainEnumValueChange" |
change String | "addPlainEnumValue" Update action for |
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 |
AddPropertyChange
type String | "AddPropertyChange" |
change String | "addProperty" Update action for |
path String | Value path to the property that was added |
nextValue Any |
AddReturnInfoChange
type String | "AddReturnInfoChange" |
change String | "addReturnInfo" Update action for |
nextValue ReturnInfo |
AddShippingAddressIdChange
type String | "AddShippingAddressIdChange" |
change String | "addShippingAddressId" Update action for |
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 |
nextValue TaxRate |
AddTextLineItemChange
type String | "AddTextLineItemChange" |
change String | "addTextLineItem" |
nextValue TextLineItem |
AddToCategoryChange
type String | "AddToCategoryChange" |
change String | "addToCategory" Update action for |
category Reference | |
previousValue Array of Reference | |
nextValue Array of Reference |
AddTransactionChange
type String | "AddTransactionChange" |
change String | "addTransaction" Update action for |
nextValue Transaction |
AddVariantChange
type String | "AddVariantChange" |
change String | "addVariant" Update action for |
catalogData String | |
previousValue Variant | |
nextValue Variant |
ChangeAddressChange
type String | "ChangeAddressChange" |
change String | "changeAddress" Update action |
nextValue Address | |
previousValue Address |
ChangeAmountPlannedChange
type String | "ChangeAmountPlannedChange" |
change String | "changeAmountPlanned" |
previousValue Money | |
nextValue Money |
ChangeAssetNameChange
type String | "ChangeAssetNameChange" |
change String | "changeAssetName" Update action for |
asset | |
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 |
previousValue Array of String | |
nextValue Array of String |
ChangeCartDiscountsChange
type String | "ChangeCartDiscountsChange" |
change String | "changeCartDiscounts" Shape of the action for |
previousValue Array of Reference | |
nextValue Array of Reference |
ChangeCartPredicateChange
type String | "ChangeCartPredicateChange" |
change String | "changeCartPredicate" Shape of the action for |
previousValue String | |
nextValue String |
ChangeCustomLineItemQuantityChange
type String | "ChangeCustomLineItemQuantityChange" |
change String | "changeCustomLineItemQuantity" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
nextValue Int | |
previousValue Int |
ChangeDescriptionChange
type String | "ChangeDescriptionChange" |
change String | "changeDescription" Shape of the action for |
previousValue String | |
nextValue String |
ChangeEmailChange
type String | "ChangeEmailChange" |
change String | "changeEmail" Shape of the action for |
previousValue String | |
nextValue String |
ChangeEnumValueLabelChange
type String | "ChangeEnumValueLabelChange" |
change String | "changeEnumValueLabel" Update action for |
fieldName String | The name of the field definition updated. |
valueKey String | Key of the values that was updated |
previousValue String | |
nextValue String |
ChangeEnumValueOrderChange
ChangeFieldDefinitionOrderChange
type String | "ChangeFieldDefinitionOrderChange" |
change String | "changeFieldDefinitionOrder" Update action for |
previousValue Array of FieldDefinitionOrderValue | |
nextValue Array of FieldDefinitionOrderValue |
ChangeGroupsChange
type String | "ChangeGroupsChange" |
change String | "changeGroups" Update action for |
previousValue Array of String | |
nextValue Array of String |
ChangeInitialChange
type String | "ChangeInitialChange" |
change String | "changeInitial" Shape of the action for |
previousValue Boolean | |
nextValue Boolean |
ChangeInputHintChange
type String | "ChangeInputHintChange" |
change String | "changeInputHint" Update action for |
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 |
previousValue Boolean | |
nextValue Boolean |
ChangeIsSearchableChange
type String | "ChangeIsSearchableChange" |
change String | "changeIsSearchable" Update action for |
attributeName String | The name of the updated attribute. |
nextValue Boolean | |
previousValue Boolean |
ChangeKeyChange
type String | "ChangeKeyChange" |
change String | "changeKey" Shape of the action for |
previousValue String | |
nextValue String |
ChangeLabelChange
type String | "ChangeLabelChange" |
change String | "changeLabel" Update action for |
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 |
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 |
previousValue LocalizedString | |
nextValue LocalizedString |
ChangeLocalizedEnumValueLabelChange
type String | "ChangeLocalizedEnumValueLabelChange" |
change String | "changeLocalizedEnumValueLabel" Update action for |
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 |
fieldName String | The name of the field definition updated. |
attributeName String | The name of the attribute updated. |
nextValue Array of LocalizedEnumValue | |
previousValue Array of LocalizedEnumValue |
ChangeLocalizedNameChange
type String | "ChangeLocalizedNameChange" |
change String | "changeName" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
ChangeMasterVariantChange
type String | "ChangeMasterVariantChange" |
change String | "changeMasterVariant" Update action for |
catalogData String | |
previousValue Variant | |
nextValue Variant |
ChangeNameChange
type String | "ChangeNameChange" |
change String | "changeName" Shape of the action for |
previousValue String | |
nextValue String |
ChangeOrderHintChange
type String | "ChangeOrderHintChange" |
change String | "changeOrderHint" Shape of the action for |
previousValue String | |
nextValue String |
ChangeOrderStateChange
type String | "ChangeOrderStateChange" |
change String | "changeOrderState" Update action for |
nextValue OrderState | |
previousValue OrderState |
ChangeParentChange
type String | "ChangeParentChange" |
change String | "changeParent" Shape of the action for |
previousValue Reference | |
nextValue Reference |
ChangePaymentStateChange
type String | "ChangePaymentStateChange" |
change String | "changePaymentState" Update action for |
nextValue PaymentState | |
previousValue PaymentState |
ChangePlainEnumValueLabelChange
type String | "ChangePlainEnumValueLabelChange" |
change String | "changePlainEnumValueLabel" Update action for |
attributeName String | The name of the attribute updated. |
valueKey String | Key of the values that was updated |
previousValue String | |
nextValue String |
ChangePlainEnumValueOrderChange
ChangePredicateChange
type String | "ChangePredicateChange" |
change String | "changePredicate" Shape of the action for |
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" |
nextValue | |
previousValue |
ChangeRequiresDiscountCodeChange
type String | "ChangeRequiresDiscountCodeChange" |
change String | "changeRequiresDiscountCode" Shape of the action for |
previousValue Boolean | |
nextValue Boolean |
ChangeReviewRatingStatisticsChange
type String | "ChangeReviewRatingStatisticsChange" |
change String | "changeReviewRatingStatistics" Update action for |
nextValue ReviewRatingStatistics | |
previousValue ReviewRatingStatistics |
ChangeShipmentStateChange
type String | "ChangeShipmentStateChange" |
change String | "changeShipmentState" Update action for |
nextValue ShipmentState | |
previousValue ShipmentState |
ChangeShoppingListLineItemQuantityChange
type String | "ChangeShoppingListLineItemQuantityChange" |
change String | "changeLineItemQuantity" |
lineItem | |
previousValue Int | |
nextValue Int |
ChangeShoppingListLineItemsOrderChange
type String | "ChangeShoppingListLineItemsOrderChange" |
change String | "changeLineItemsOrder" |
previousValue Array of ShoppingListLineItemValue | |
nextValue Array of ShoppingListLineItemValue |
ChangeSlugChange
type String | "ChangeSlugChange" |
change String | "changeSlug" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
ChangeSortOrderChange
type String | "ChangeSortOrderChange" |
change String | "changeSortOrder" Shape of the action for |
previousValue String | |
nextValue String |
ChangeStackingModeChange
type String | "ChangeStackingModeChange" |
change String | "changeStackingMode" Update action for |
nextValue StackingMode | |
previousValue StackingMode |
ChangeStateTypeChange
type String | "ChangeStateTypeChange" |
change String | "changeType" Update action for |
previousValue StateType | |
nextValue StateType |
ChangeTargetChange
type String | "ChangeTargetChange" |
change String | "changeTarget" Update action for |
nextValue ChangeTargetChangeValue | |
previousValue ChangeTargetChangeValue |
ChangeTextLineItemNameChange
type String | "ChangeTextLineItemNameChange" |
change String | "changeTextLineItemName" Update action for |
textLineItem | |
nextValue LocalizedString | |
previousValue LocalizedString |
ChangeTaxCalculationModeChange
type String | "ChangeTaxCalculationModeChange" |
change String | "changeTaxCalculationMode" Shape of the action for |
previousValue TaxCalculationMode | |
nextValue TaxCalculationMode |
ChangeTaxModeChange
type String | "ChangeTaxModeChange" |
change String | "changeTaxMode" Shape of the action for |
previousValue TaxMode | |
nextValue TaxMode |
ChangeTaxRoundingModeChange
type String | "ChangeTaxRoundingModeChange" |
change String | "changeTaxRoundingMode" Shape of the action for |
previousValue RoundingMode | |
nextValue RoundingMode |
ChangeTextLineItemQuantityChange
type String | "ChangeTextLineItemQuantityChange" |
change String | "changeTextLineItemQuantity" |
textLineItem | |
previousValue Int | |
nextValue Int |
ChangeTextLineItemsOrderChange
type String | "ChangeTextLineItemsOrderChange" |
change String | "changeTextLineItemsOrder" |
previousValue Array of TextLineItemValue | |
nextValue Array of TextLineItemValue |
ChangeTransactionInteractionIdChange
type String | "ChangeTransactionInteractionIdChange" |
change String | "changeTransactionInteractionId" Update action for |
transaction | |
nextValue String | |
previousValue String |
ChangeTransactionStateChange
type String | "ChangeTransactionStateChange" |
change String | "changeTransactionState" Update action for |
transaction | |
nextValue TransactionState | |
previousValue TransactionState |
ChangeTransactionTimestampChange
type String | "ChangeTransactionTimestampChange" |
change String | "changeTransactionTimestamp" Update action for |
transaction | |
nextValue String | |
previousValue String |
ChangeValueChange
type String | "ChangeValueChange" |
change String | "changeValue" Update action for |
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 |
previousValue Address |
RemoveAssetChange
type String | "RemoveAssetChange" |
change String | "removeAsset" Update action for |
previousValue Asset |
RemoveAttributeDefinitionChange
type String | "RemoveAttributeDefinitionChange" |
change String | "removeAttributeDefinition" Update action for |
previousValue AttributeDefinition |
RemoveBillingAddressIdChange
type String | "RemoveBillingAddressIdChange" |
change String | "removeBillingAddressId" Update action for |
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 |
previousValue Delivery |
RemoveDiscountCodeChange
type String | "RemoveDiscountCodeChange" |
change String | "removeDiscountCode" Update action for |
previousValue DiscountCodeInfo |
RemoveEnumValuesChange
type String | "RemoveEnumValuesChange" |
change String | "removeEnumValues" Update action for |
attributeName String | The name of the attribute updated. |
previousValue |
RemoveFieldDefinitionChange
type String | "RemoveFieldDefinitionChange" |
change String | "removeFieldDefinition" Update action for |
previousValue FieldDefinition |
RemoveFromCategoryChange
type String | "RemoveFromCategoryChange" |
change String | "removeFromCategory" Update action for |
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 |
nextValue Address | |
previousValue Address |
RemoveLocalizedEnumValuesChange
type String | "RemoveLocalizedEnumValuesChange" |
change String | "removeEnumValues" Update action for |
attributeName String | The name of the attribute updated. |
previousValue |
RemoveLocationChange
type String | "RemoveLocationChange" |
change String | "removeLocation" Update action for |
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 |
deliveryId String | |
previousValue Parcel |
RemovePaymentChange
type String | "RemovePaymentChange" |
change String | "removePayment" Update action for |
nextValue PaymentInfo | |
previousValue PaymentInfo |
RemovePriceChange
type String | "RemovePriceChange" |
change String | "removePrice" Update action for removing prices |
catalogData String | |
priceId String | |
previousValue Price | |
nextValue Price |
RemovePropertyChange
type String | "RemovePropertyChange" |
change String | "removeProperty" Update action for |
path String | Value path to the property that was removed |
previousValue Any |
RemoveShippingAddressIdChange
type String | "RemoveShippingAddressIdChange" |
change String | "removeShippingAddressId" Update action for |
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 |
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 |
catalogData String | |
previousValue Variant | |
nextValue Variant |
SetAddressChange
type String | "SetAddressChange" |
change String | "setAddress" Update action for |
nextValue Address | |
previousValue Address |
SetAnonymousIdChange
type String | "SetAnonymousIdChange" |
change String | "setAnonymousId" Shape of the action for |
previousValue String | |
nextValue String |
SetApplicationVersionChange
type String | "SetApplicationVersionChange" |
change String | "setApplicationVersion" Internal Update action for |
previousValue Int | |
nextValue Int |
SetAssetCustomFieldChange
type String | "SetAssetCustomFieldChange" |
change String | "setAssetCustomField" Update action for |
name String | |
customTypeId String | |
asset | |
nextValue Any | |
previousValue Any |
SetAssetCustomTypeChange
type String | "SetAssetCustomTypeChange" |
change String | "setAssetCustomType" Update action for |
asset | |
nextValue CustomFields | |
previousValue CustomFields |
SetAssetDescriptionChange
type String | "SetAssetDescriptionChange" |
change String | "setAssetDescription" Update action for |
asset | |
nextValue LocalizedString | |
previousValue LocalizedString |
SetAssetKeyChange
type String | "SetAssetKeyChange" |
change String | "setAssetKey" Update action for |
asset | |
nextValue String | |
previousValue String |
SetAssetSourcesChange
type String | "SetAssetSourcesChange" |
change String | "setAssetSources" Update action for |
asset | |
nextValue Array of AssetSource | |
previousValue Array of AssetSource |
SetAttributeChange
type String | "SetAttributeChange" |
change String | "setAttribute" Update action for |
catalogData String | |
previousValue Object | |
nextValue Object |
SetBillingAddressChange
type String | "SetBillingAddressChange" |
change String | "setBillingAddress" Update action for |
nextValue Address | |
previousValue Address |
SetCartPredicateChange
type String | "SetCartPredicateChange" |
change String | "setCartPredicate" Shape of the action for |
previousValue String | |
nextValue String |
SetCategoryOrderHintChange
type String | "SetCategoryOrderHintChange" |
change String | "setCategoryOrderHint" Update action for |
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 |
previousValue String | |
nextValue String |
SetCountryChange
type String | "SetCountryChange" |
change String | "setCountry" Update action for |
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 |
name String | |
customLineItem LocalizedString | |
customLineItemId String | |
nextValue Any | |
previousValue Any |
SetCustomLineItemCustomTypeChange
type String | "SetCustomLineItemCustomTypeChange" |
change String | "setCustomLineItemCustomType" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
nextValue CustomFields | |
previousValue CustomFields |
SetCustomLineItemMoneyChange
type String | "SetCustomLineItemMoneyChange" |
change String | "setCustomLineItemMoney" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
nextValue Money | |
previousValue Money |
SetCustomLineItemShippingDetailsChange
type String | "SetCustomLineItemShippingDetailsChange" |
change String | "setCustomLineItemShippingDetails" Update action for |
customLineItemId String | |
nextValue ItemShippingDetails | |
previousValue ItemShippingDetails |
SetCustomLineItemTaxAmountChange
type String | "SetCustomLineItemTaxAmountChange" |
change String | "setCustomLineItemTaxAmount" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
taxMode TaxMode | |
nextValue TaxRate | |
previousValue TaxRate |
SetCustomLineItemTaxCategoryChange
type String | "SetCustomLineItemTaxCategoryChange" |
change String | "setCustomLineItemTaxCategory" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
nextValue Reference | |
previousValue Reference |
SetCustomLineItemTaxRateChange
type String | "SetCustomLineItemTaxRateChange" |
change String | "setCustomLineItemTaxRate" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
taxMode TaxMode | |
nextValue TaxRate | |
previousValue TaxRate |
SetCustomLineItemTaxedPriceChange
type String | "SetCustomLineItemTaxedPriceChange" |
change String | "setCustomLineItemTaxedPrice" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
nextValue Money | |
previousValue Money |
SetCustomLineItemTotalPriceChange
type String | "SetCustomLineItemTotalPriceChange" |
change String | "setCustomLineItemTotalPrice" Update action for |
customLineItem LocalizedString | |
customLineItemId String | |
nextValue Money | |
previousValue Money |
SetCustomShippingMethodChange
type String | "SetCustomShippingMethodChange" |
change String | "setCustomShippingMethod" Update action for |
nextValue | |
previousValue |
SetCustomTypeChange
type String | "SetCustomTypeChange" |
change String | "setCustomType" Update action for setting a custom type |
nextValue CustomFields | |
previousValue CustomFields |
SetCustomerChange
type String | "SetCustomerChange" |
change String | "setCustomer" Shape of the action for |
previousValue Reference | |
nextValue Reference |
SetCustomerEmailChange
type String | "SetCustomerEmailChange" |
change String | "setCustomerEmail" Shape of the action for |
previousValue String | |
nextValue String |
SetCustomerGroupChange
type String | "SetCustomerGroupChange" |
change String | "setCustomerGroup" Shape of the action for |
previousValue Reference | |
nextValue Reference |
SetCustomerIdChange
type String | "SetCustomerIdChange" |
change String | "setCustomerId" Shape of the action for |
previousValue String | |
nextValue String |
SetCustomerNumberChange
type String | "SetCustomerNumberChange" |
change String | "setCustomerNumber" Shape of the action for |
previousValue String | |
nextValue String |
SetDateOfBirthChange
type String | "SetDateOfBirthChange" |
change String | "setDateOfBirth" Shape of the action for |
previousValue String | |
nextValue String |
SetDefaultBillingAddressChange
type String | "SetDefaultBillingAddressChange" |
change String | "setDefaultBillingAddress" Update action for |
nextValue Address | |
previousValue Address |
SetDefaultShippingAddressChange
type String | "SetDefaultShippingAddressChange" |
change String | "setDefaultShippingAddress" Update action for |
nextValue Address | |
previousValue Address |
SetDeleteDaysAfterLastModificationChange
type String | "SetDeleteDaysAfterLastModificationChange" |
change String | "setDeleteDaysAfterLastModification" Shape of the action for |
previousValue Int | |
nextValue Int |
SetDeliveryAddressChange
type String | "SetDeliveryAddressChange" |
change String | "setDeliveryAddress" Update action for |
deliveryId String | |
nextValue Address | |
previousValue Address |
SetDeliveryItemsChange
type String | "SetDeliveryItemsChange" |
change String | "setDeliveryItems" Update action for |
deliveryId String | |
nextValue Array of DeliveryItem | |
previousValue Array of DeliveryItem |
SetDescriptionChange
type String | "SetDescriptionChange" |
change String | "setDescription" Shape of the action for |
previousValue String | |
nextValue String |
SetDiscountedPriceChange
type String | "SetDiscountedPriceChange" |
change String | "setDiscountedPrice" Update action for |
catalogData String | |
variant String | |
priceId String | |
previousValue Price | |
nextValue Price |
SetDistributionChannelsChange
type String | "SetDistributionChannelsChange" |
change String | "setDistributionChannels" Shape of the action for |
previousValue Array of Reference | |
nextValue Array of Reference |
SetExpectedDeliveryChange
type String | "SetExpectedDeliveryChange" |
change String | "setExpectedDelivery" Shape of the action for |
previousValue String | |
nextValue String |
SetExternalIdChange
type String | "SetExternalIdChange" |
change String | "setExternalId" Shape of the action for |
previousValue String | |
nextValue String |
SetFirstNameChange
type String | "SetFirstNameChange" |
change String | "setFirstName" Shape of the action for |
previousValue String | |
nextValue String |
SetGeoLocationChange
type String | "SetGeoLocationChange" |
change String | "setGeoLocation" Update action for |
nextValue GeoLocation | |
previousValue GeoLocation |
SetImageLabelChange
type String | "SetImageLabelChange" |
change String | "setImageLabel" Update action for |
catalogData String | |
previousValue Image | |
nextValue Image |
SetInputTipChange
type String | "SetInputTipChange" |
change String | "setInputTip" Update action for |
attributeName String | The name of the updated attribute. |
nextValue LocalizedString | |
previousValue LocalizedString |
SetInterfaceIdChange
type String | "SetInterfaceIdChange" |
change String | "setInterfaceId" Shape of the action for |
previousValue String | |
nextValue String |
SetIsValidChange
type String | "SetIsValidChange" |
change String | "setIsValid" Shape of the action for |
previousValue Boolean | |
nextValue Boolean |
SetKeyChange
type String | "SetKeyChange" |
change String | "setKey" Shape of the action for |
previousValue String | |
nextValue String |
SetLanguagesChange
type String | "SetLanguagesChange" |
change String | "setLanguages" Update action for |
previousValue Array of String | |
nextValue Array of String |
SetLastNameChange
type String | "SetLastNameChange" |
change String | "setLastName" Shape of the action for |
previousValue String | |
nextValue String |
SetLineItemDiscountedPriceChange
type String | "SetLineItemDiscountedPriceChange" |
change String | "setLineItemDiscountedPrice" Update action for |
lineItem LocalizedString | |
variant String | |
nextValue DiscountedLineItemPrice | |
previousValue DiscountedLineItemPrice |
SetLineItemDiscountedPricePerQuantityChange
type String | "SetLineItemDiscountedPricePerQuantityChange" |
change String | "setLineItemDiscountedPricePerQuantity" Update action for |
lineItem LocalizedString | |
variant String | |
nextValue DiscountedLineItemPriceForQuantity | |
previousValue DiscountedLineItemPriceForQuantity |
SetLineItemDistributionChannelChange
type String | "SetLineItemDistributionChannelChange" |
change String | "setLineItemDistributionChannel" Update action for |
lineItem LocalizedString | |
variant String | |
nextValue Reference | |
previousValue Reference |
SetLineItemPriceChange
type String | "SetLineItemPriceChange" |
change String | "setLineItemPrice" Update action for |
lineItem LocalizedString | |
nextValue Price | |
previousValue Price |
SetLineItemProductSlugChange
type String | "SetLineItemProductSlugChange" |
change String | "setLineItemProductSlug" Update action for |
lineItem LocalizedString | |
variant String | |
nextValue LocalizedString | |
previousValue LocalizedString |
SetLineItemShippingDetailsChange
type String | "SetLineItemShippingDetailsChange" |
change String | "setLineItemShippingDetails" Update action for |
lineItemId String | |
nextValue ItemShippingDetails | |
previousValue ItemShippingDetails |
SetLineItemTaxAmountChange
type String | "SetLineItemTaxAmountChange" |
change String | "setLineItemTaxAmount" Update action for |
lineItem LocalizedString | |
variant String | |
taxMode TaxMode | |
nextValue TaxRate | |
previousValue TaxRate |
SetLineItemTaxRateChange
type String | "SetLineItemTaxRateChange" |
change String | "setLineItemTaxRate" Update action for |
lineItem LocalizedString | |
variant String | |
taxMode TaxMode | |
nextValue TaxRate | |
previousValue TaxRate |
SetLineItemTaxedPriceChange
type String | "SetLineItemTaxedPriceChange" |
change String | "setLineItemTaxedPrice" Update action for |
lineItem LocalizedString | |
lineItemId String | |
nextValue TaxedItemPrice | |
previousValue TaxedItemPrice |
SetLineItemTotalPriceChange
type String | "SetLineItemTotalPriceChange" |
change String | "setLineItemTotalPrice" Update action for |
lineItem LocalizedString | |
nextValue Money | |
previousValue Money |
SetLocaleChange
type String | "SetLocaleChange" |
change String | "setLocale" Update action for |
previousValue Locale | A locale of IETF language tag. |
nextValue Locale | A locale of IETF language tag. |
SetLocalizedDescriptionChange
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
SetMaxApplicationsChange
type String | "SetMaxApplicationsChange" |
change String | "setMaxApplications" Shape of the action for |
previousValue Int | |
nextValue Int |
SetMaxApplicationsPerCustomerChange
type String | "SetMaxApplicationsPerCustomerChange" |
change String | "setMaxApplicationsPerCustomer" Shape of the action for |
previousValue Int | |
nextValue Int |
SetMetaDescriptionChange
type String | "SetMetaDescriptionChange" |
change String | "setMetaDescription" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
SetMetaKeywordsChange
type String | "SetMetaKeywordsChange" |
change String | "setMetaKeywords" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
SetMetaTitleChange
type String | "SetMetaTitleChange" |
change String | "setMetaTitle" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
SetMethodInfoInterfaceChange
type String | "SetMethodInfoInterfaceChange" |
change String | "setMethodInfoInterface" Shape of the action for |
previousValue String | |
nextValue String |
SetMethodInfoMethodChange
type String | "SetMethodInfoMethodChange" |
change String | "setMethodInfoMethod" Shape of the action for |
previousValue String | |
nextValue String |
SetMethodInfoNameChange
type String | "SetMethodInfoNameChange" |
change String | "setMethodInfoName" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
SetMiddleNameChange
type String | "SetMiddleNameChange" |
change String | "setMiddleName" Shape of the action for |
previousValue String | |
nextValue String |
SetNameChange
type String | "SetNameChange" |
change String | "setName" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
SetOrderLineItemCustomFieldChange
type String | "SetOrderLineItemCustomFieldChange" |
change String | "setLineItemCustomField" Update action for |
customTypeId String | |
name String | |
variant String | |
lineItem LocalizedString | |
nextValue Any | |
previousValue Any |
SetOrderLineItemCustomTypeChange
type String | "SetOrderLineItemCustomTypeChange" |
change String | "setLineItemCustomType" Update action for |
lineItem LocalizedString | |
variant String | |
nextValue CustomFields | |
previousValue CustomFields |
SetOrderNumberChange
type String | "SetOrderNumberChange" |
change String | "setOrderNumber" Shape of the action for |
previousValue String | |
nextValue String |
SetOrderTaxedPriceChange
type String | "SetOrderTaxedPriceChange" |
change String | "setOrderTaxedPrice" Update action for |
taxMode TaxMode | |
nextValue TaxedItemPrice | |
previousValue TaxedItemPrice |
SetOrderTotalPriceChange
type String | "SetOrderTotalPriceChange" |
change String | "setOrderTotalPrice" Update action for |
nextValue Money | |
previousValue Money |
SetOrderTotalTaxChange
type String | "SetOrderTotalTaxChange" |
change String | "setOrderTotalTax" Update action for |
taxMode TaxMode | |
nextValue Money | |
previousValue Money |
SetParcelItemsChange
type String | "SetParcelItemsChange" |
change String | "setParcelItems" Update action for |
parcel | |
nextValue Array of DeliveryItem | |
previousValue Array of DeliveryItem |
SetParcelMeasurementsChange
type String | "SetParcelMeasurementsChange" |
change String | "setParcelMeasurements" Update action for |
parcel | |
nextValue ParcelMeasurements | |
previousValue ParcelMeasurements |
SetParcelTrackingDataChange
type String | "SetParcelTrackingDataChange" |
change String | "setParcelTrackingData" Update action for |
parcel | |
nextValue TrackingData | |
previousValue TrackingData |
SetPricesChange
type String | "SetPricesChange" |
change String | "setPrices" Update action for |
catalogData String | |
variant String | |
previousValue Array of Price | |
nextValue Array of Price |
SetProductPriceCustomFieldChange
type String | "SetProductPriceCustomFieldChange" |
change String | "setProductPriceCustomField" Update action for |
catalogData String | |
previousValue CustomFields | |
nextValue CustomFields |
SetProductPriceCustomTypeChange
type String | "SetProductPriceCustomTypeChange" |
change String | "setProductPriceCustomType" Update action for |
catalogData String | |
previousValue CustomFields | |
nextValue CustomFields |
SetProductVariantKeyChange
type String | "SetProductVariantKeyChange" |
change String | "setProductVariantKey" Update action for |
catalogData String | |
previousValue String | |
nextValue String |
SetPropertyChange
type String | "SetPropertyChange" |
change String | "setProperty" Update action for |
path String | Value path to the property that was changed |
nextValue Any | |
previousValue Any |
SetRatingChange
type String | "SetRatingChange" |
change String | "setRating" Shape of the action for |
previousValue Int | |
nextValue Int |
SetReservationsChange
type String | "SetReservationsChange" |
change String | "setReservations" Update action for |
nextValue Array of Reservation | |
previousValue Array of Reservation |
SetRestockableInDaysChange
type String | "SetRestockableInDaysChange" |
change String | "setRestockableInDays" Shape of the action for |
previousValue Int | |
nextValue Int |
SetReturnPaymentStateChange
type String | "SetReturnPaymentStateChange" |
change String | "setReturnPaymentState" Update action for |
nextValue ReturnPaymentState | |
previousValue ReturnPaymentState |
SetReturnShipmentStateChange
type String | "SetReturnShipmentStateChange" |
change String | "setReturnShipmentState" Update action for |
nextValue ReturnShipmentState | |
previousValue ReturnShipmentState |
SetSalutationChange
type String | "SetSalutationChange" |
change String | "setSalutation" Shape of the action for |
previousValue String | |
nextValue String |
SetSearchKeywordsChange
type String | "SetSearchKeywordsChange" |
change String | "setSearchKeywords" Update action for |
catalogData String | |
previousValue SearchKeywords | |
nextValue SearchKeywords |
SetShippingAddressChange
type String | "SetShippingAddressChange" |
change String | "setShippingAddress" Update action for |
nextValue Address | |
previousValue Address |
SetShippingInfoPriceChange
type String | "SetShippingInfoPriceChange" |
change String | "setShippingInfoPrice" Update action for |
nextValue Money | |
previousValue Money |
SetShippingInfoTaxedPriceChange
type String | "SetShippingInfoTaxedPriceChange" |
change String | "setShippingInfoTaxedPrice" Update action for |
nextValue TaxedPrice | |
previousValue TaxedPrice |
SetShippingMethodChange
type String | "SetShippingMethodChange" |
change String | "setShippingMethod" Update action for |
nextValue | |
previousValue |
SetShippingMethodTaxAmountChange
type String | "SetShippingMethodTaxAmountChange" |
change String | "setShippingMethodTaxAmount" Update action for |
taxMode TaxMode | |
nextValue Object | |
previousValue Object |
SetShippingMethodTaxRateChange
type String | "SetShippingMethodTaxRateChange" |
change String | "setShippingMethodTaxRate" Update action for |
taxMode TaxMode | |
nextValue TaxRate | |
previousValue TaxRate |
SetShippingRateChange
type String | "SetShippingRateChange" |
change String | "setShippingRate" Update action for |
nextValue Money | |
previousValue Money |
SetShippingRateInputChange
type String | "SetShippingRateInputChange" |
change String | "setShippingRateInput" Update action for |
nextValue SetCartClassificationShippingRateInputValue | SetCartScoreShippingRateInputValue | |
previousValue SetCartClassificationShippingRateInputValue | SetCartScoreShippingRateInputValue |
SetShoppingListLineItemCustomFieldChange
type String | "SetShoppingListLineItemCustomFieldChange" |
change String | "setLineItemCustomField" Update action for |
name String | |
customTypeId String | |
lineItem | |
nextValue Any | |
previousValue Any |
SetShoppingListLineItemCustomTypeChange
type String | "SetShoppingListLineItemCustomTypeChange" |
change String | "setLineItemCustomType" Update action for |
lineItem | |
nextValue CustomFields | |
previousValue CustomFields |
SetSkuChange
type String | "SetSkuChange" |
change String | "setSku" Update action for |
catalogData String | |
previousValue String | |
nextValue String |
SetSlugChange
type String | "SetSlugChange" |
change String | "setSlug" Shape of the action for |
previousValue LocalizedString | |
nextValue LocalizedString |
SetStateRolesChange
type String | "SetStateRolesChange" |
change String | "setRoles" |
previousValue Array of StateRole | |
nextValue Array of StateRole |
SetStatusInterfaceCodeChange
type String | "SetStatusInterfaceCodeChange" |
change String | "setStatusInterfaceCode" Shape of the action for |
previousValue String | |
nextValue String |
SetStatusInterfaceTextChange
type String | "SetStatusInterfaceTextChange" |
change String | "setStatusInterfaceText" Shape of the action for |
previousValue String | |
nextValue String |
SetStoreChange
type String | "SetStoreChange" |
change String | "setStore" Shape of the action for |
previousValue Reference | |
nextValue Reference |
SetStoresChange
type String | "SetStoresChange" |
change String | "setStores" Shape of the action for |
previousValue Array of Reference | |
nextValue Array of Reference |
SetSupplyChannelChange
type String | "SetSupplyChannelChange" |
change String | "setSupplyChannel" Shape of the action for |
previousValue Reference | |
nextValue Reference |
SetSupplyChannelsChange
type String | "SetSupplyChannelsChange" |
change String | "setSupplyChannels" Shape of the action for |
previousValue Array of Reference | |
nextValue Array of Reference |
SetTargetChange
type String | "SetTargetChange" |
change String | "setTarget" Shape of the action for |
previousValue Reference | |
nextValue Reference |
SetTaxCategoryChange
type String | "SetTaxCategoryChange" |
change String | "setTaxCategory" Shape of the action for |
previousValue Reference | |
nextValue Reference |
SetTextChange
type String | "SetTextChange" |
change String | "setText" Shape of the action for |
previousValue String | |
nextValue String |
SetTextLineItemCustomFieldChange
type String | "SetTextLineItemCustomFieldChange" |
change String | "setTextLineItemCustomField" Update action for |
name String | |
customTypeId String | |
textLineItem | |
nextValue Any | |
previousValue Any |
SetTextLineItemCustomTypeChange
type String | "SetTextLineItemCustomTypeChange" |
change String | "setTextLineItemCustomType" Update action for |
textLineItem | |
nextValue CustomFields | |
previousValue CustomFields |
SetTextLineItemDescriptionChange
type String | "SetTextLineItemDescriptionChange" |
change String | "setTextLineItemDescription" |
textLineItem | |
previousValue LocalizedString | |
nextValue LocalizedString |
SetTitleChange
type String | "SetTitleChange" |
change String | "setTitle" Shape of the action for |
previousValue String | |
nextValue String |
SetTransitionsChange
type String | "SetTransitionsChange" |
change String | "setTransitions" Shape of the action for |
previousValue Array of Reference | |
nextValue Array of Reference |
SetValidFromAndUntilChange
type String | "SetValidFromAndUntilChange" |
change String | "setValidFromAndUntil" |
previousValue | |
nextValue |
SetValidFromChange
type String | "SetValidFromChange" |
change String | "setValidFrom" Shape of the action for |
previousValue String | |
nextValue String |
SetValidUntilChange
type String | "SetValidUntilChange" |
change String | "setValidUntil" Shape of the action for |
previousValue String | |
nextValue String |
SetValueChange
type String | "SetValueChange" |
change String | "setValue" Update action for |
nextValue Any | |
previousValue Any |
SetVariantAvailabilityChange
type String | "SetVariantAvailabilityChange" |
change String | "setVariantAvailability" Update action for |
catalogData String | |
variant String | |
previousValue ProductVariantAvailability | |
nextValue ProductVariantAvailability |
SetVatIdChange
type String | "SetVatIdChange" |
change String | "setVatId" Shape of the action for |
previousValue String | |
nextValue String |
ShippingMethodChangeValue
id String | |
name String |
TransitionCustomLineItemStateChange
type String | "TransitionCustomLineItemStateChange" |
change String | "transitionCustomLineItemState" Update action for |
lineItemId String | |
stateId String | |
nextValue Array of ItemState | |
previousValue Array of ItemState |
TransitionLineItemStateChange
type String | "TransitionLineItemStateChange" |
change String | "transitionLineItemState" Update action for |
lineItemId String | |
stateId String | |
nextValue Array of ItemState | |
previousValue Array of ItemState |
TransitionStateChange
type String | "TransitionStateChange" |
change String | "transitionState" Shape of the action for |
previousValue Reference | |
nextValue Reference |
UnknownChange
type String | "UnknownChange" |
change String | |
previousValue Any | |
nextValue Any |
UnpublishChange
type String | "UnpublishChange" |
change String | "unpublish" |
UpdateSyncInfoChange
type String | "UpdateSyncInfoChange" |
change String | "updateSyncInfo" Update action for |
channelId String | |
nextValue SyncInfo |
VerifyEmailChange
type String | "VerifyEmailChange" |
change String | "verifyEmail" |
Change Values
AssetChangeValue
id String | |
name LocalizedString |
ChangeTargetCustomLineItemsChangeValue
Shape of the value for cart discounts line item and custom line items target.
type String | "customLineItems" |
predicate String |
ChangeTargetLineItemsChangeValue
Shape of the value for cart discounts line item target.
type String | "lineItems" |
predicate String |
ChangeTargetMultiBuyCustomLineItemsChangeValue
Shape of the value for cart discounts multiBuyCustomLineItems target.
type String | "multiBuyCustomLineItems" |
predicate String | |
triggerQuantity Int | Quantity of line items that need to be present in order to trigger an application of this discount. |
discountedQuantity Int | Quantity of line items that are discounted per application of this discount. |
maxOccurrence Int | Maximum number of applications of this discount. |
selectionMode SelectionMode |
ChangeTargetMultiBuyLineItemsChangeValue
Shape of the value for cart discounts multiBuyLineItems target.
type String | "multiBuyLineItems" |
predicate String | |
triggerQuantity Int | Quantity of line items that need to be present in order to trigger an application of this discount. |
discountedQuantity Int | Quantity of line items that are discounted per application of this discount. |
maxOccurrence Int | Maximum number of applications of this discount. |
selectionMode SelectionMode |
ChangeTargetShippingChangeValue
Shape of the value for cart discounts shipping target.
type String | "shipping" |
ChangeValueAbsoluteChangeValue
Shape of the value for cart discounts absolute value.
type String | "absolute" |
money Array of Money |
ChangeValueExternalChangeValue
Shape of the value for product discounts external value.
type String | "external" |
ChangeValueGiftLineItemChangeValue
Shape of the value for cart discounts gift line item value.
type String | "giftLineItem" |
product Reference | |
variantId Int | |
supplyChannel Reference | |
distributionChannel Reference |
ChangeValueRelativeChangeValue
Shape of the value for cart discounts relative value.
type String | "relative" |
permyriad Int |
CustomFieldExpandedValue
Only available if expand
is set to true
name String | Name of a custom field. |
value Any | |
label LocalizedString |
CustomShippingMethodChangeValue
name String |
DeliveryChangeValue
items Array of DeliveryItem | |
address Address | |
parcels Array of Parcel |
SetCartClassificationShippingRateInputValue
Shape of the cart classification shipping input rate value.
key String | |
type String | "Classification" |
label LocalizedString |
SetCartScoreShippingRateInputValue
Shape of the cart score shipping input rate value.
type String | "Score" |
score Int |
EnumValue
key String | |
label String |
FieldDefinitionOrderValue
Shape of the value for action changeFieldDefinitionOrder
name String | |
label LocalizedString |
InventoryQuantityValue
quantityOnStock Int | |
availableQuantity Int |
LocalizedEnumValue
key String | |
label LocalizedString |
ParcelChangeValue
id String | |
createdAt String |
ShippingMethodChangeValue
id String | |
name String |
ShoppingListLineItemValue
id String | |
name LocalizedString | |
variantId Int |
TextLineItemValue
id String | |
name LocalizedString |
TransactionChangeValue
id String | |
interactionId String | |
timestamp String |
ValidFromAndUntilValue
Shape of the value for setValidFromAndUntil
action
validFrom String | |
validUntil String |