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, thesetDescriptionchange can occur with a localized and non-localized representation. Change History Records can be filtered by this value using thechangesquery 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
typeString | "AddAddressChange" |
changeString | "addAddress"Update action for |
nextValueAddress | |
previousValueAddress |
AddAssetChange
typeString | "AddAssetChange" |
changeString | "addAsset"Update action for |
nextValueAsset | |
previousValueAsset |
AddAttributeDefinitionChange
typeString | "AddAttributeDefinitionChange" |
changeString | "addAttributeDefinition"Update action for |
nextValueAttributeDefinition |
AddBillingAddressIdChange
typeString | "AddBillingAddressIdChange" |
changeString | "addBillingAddressId"Update action for |
nextValueArray of String | |
previousValueArray of String | |
addressAddress |
AddChannelRolesChange
typeString | "AddChannelRolesChange" |
changeString | "addRoles" |
previousValueArray of ChannelRole | |
nextValueArray of ChannelRole |
AddCustomLineItemChange
typeString | "AddCustomLineItemChange" |
changeString | "addCustomLineItem"Update action for adding and removing custom line items |
nextValueCustomLineItem | |
previousValueCustomLineItem |
AddDeliveryChange
typeString | "AddDeliveryChange" |
changeString | "addDelivery"Update action for |
nextValue | |
previousValue |
AddDiscountCodeChange
typeString | "AddDiscountCodeChange" |
changeString | "addDiscountCode"Update action for |
nextValueDiscountCodeInfo |
AddEnumValueChange
typeString | "AddEnumValueChange" |
changeString | "addEnumValue"Update action for |
fieldNameString | The name of the field/attribute definition updated. |
nextValue |
AddExternalImageChange
typeString | "AddExternalImageChange" |
changeString | "addExternalImage"Update actions for adding an external image |
catalogDataString | |
previousValueArray of Image | |
nextValueArray of Image |
AddFieldDefinitionChange
typeString | "AddFieldDefinitionChange" |
changeString | "addFieldDefinition"Update action for |
nextValueFieldDefinition |
AddInterfaceInteractionChange
typeString | "AddInterfaceInteractionChange" |
changeString | "addInterfaceInteraction"Update action for |
nextValue |
AddItemShippingAddressesChange
typeString | "AddItemShippingAddressesChange" |
changeString | "addItemShippingAddress"Update action for |
nextValueAddress | |
previousValueAddress |
AddLocalizedEnumValueChange
typeString | "AddLocalizedEnumValueChange" |
changeString | "addLocalizedEnumValue"Update action for |
fieldNameString | The name of the field definition updated. |
attributeNameString | The name of the attribute updated. |
nextValue |
AddLocationChange
typeString | "AddLocationChange" |
changeString | "addLocation"Update action for |
previousValueLocation | |
nextValueLocation |
AddOrderLineItemChange
typeString | "AddOrderLineItemChange" |
changeString | "addLineItem" |
previousValueLineItem | |
nextValueLineItem |
AddParcelToDeliveryChange
typeString | "AddParcelToDeliveryChange" |
changeString | "addParcelToDelivery"Update action for |
deliveryIdString | |
nextValueParcel |
AddPaymentChange
typeString | "AddPaymentChange" |
changeString | "addPayment"Update action for |
nextValuePaymentInfo | |
previousValuePaymentInfo |
AddPlainEnumValueChange
typeString | "AddPlainEnumValueChange" |
changeString | "addPlainEnumValue"Update action for |
attributeNameString | The name of the attribute updated. |
nextValue |
AddPriceChange
typeString | "AddPriceChange" |
changeString | "addPrice"Update action for adding prices |
catalogDataString | |
priceIdString | |
nextValuePrice |
AddPropertyChange
typeString | "AddPropertyChange" |
changeString | "addProperty"Update action for |
pathString | Value path to the property that was added |
nextValueAny |
AddReturnInfoChange
typeString | "AddReturnInfoChange" |
changeString | "addReturnInfo"Update action for |
nextValueReturnInfo |
AddShippingAddressIdChange
typeString | "AddShippingAddressIdChange" |
changeString | "addShippingAddressId"Update action for |
nextValueArray of String | |
previousValueArray of String | |
addressAddress |
AddShoppingListLineItemChange
typeString | "AddShoppingListLineItemChange" |
changeString | "addLineItem" |
previousValueLineItem | |
nextValueLineItem |
AddStateRolesChange
typeString | "AddStateRolesChange" |
changeString | "addRoles" |
previousValueArray of StateRole | |
nextValueArray of StateRole |
AddTaxRateChange
typeString | "AddTaxRateChange" |
changeString | "addTaxRate"Update action for |
nextValueTaxRate |
AddTextLineItemChange
typeString | "AddTextLineItemChange" |
changeString | "addTextLineItem" |
nextValueTextLineItem |
AddToCategoryChange
typeString | "AddToCategoryChange" |
changeString | "addToCategory"Update action for |
categoryReference | |
previousValueArray of Reference | |
nextValueArray of Reference |
AddTransactionChange
typeString | "AddTransactionChange" |
changeString | "addTransaction"Update action for |
nextValueTransaction |
AddVariantChange
typeString | "AddVariantChange" |
changeString | "addVariant"Update action for |
catalogDataString | |
previousValueVariant | |
nextValueVariant |
ChangeAddressChange
typeString | "ChangeAddressChange" |
changeString | "changeAddress"Update action |
nextValueAddress | |
previousValueAddress |
ChangeAmountPlannedChange
typeString | "ChangeAmountPlannedChange" |
changeString | "changeAmountPlanned" |
previousValueMoney | |
nextValueMoney |
ChangeAssetNameChange
typeString | "ChangeAssetNameChange" |
changeString | "changeAssetName"Update action for |
asset | |
nextValueLocalizedString | |
previousValueLocalizedString |
ChangeAssetOrderChange
typeString | "ChangeAssetOrderChange" |
changeString | "changeAssetOrder" |
previousValueArray of LocalizedString | |
nextValueArray of LocalizedString |
ChangeAttributeConstraintChange
typeString | "ChangeAttributeConstraintChange" |
changeString | "changeAttributeConstraint" |
attributeNameString | name of the updated attribute |
previousValueAttributeConstraintEnum | |
nextValueAttributeConstraintEnum |
ChangeAttributeOrderByNameChange
typeString | "ChangeAttributeOrderByNameChange" |
changeString | "changeAttributeOrderByName"Update action for |
previousValueArray of String | |
nextValueArray of String |
ChangeCartDiscountsChange
typeString | "ChangeCartDiscountsChange" |
changeString | "changeCartDiscounts"Shape of the action for |
previousValueArray of Reference | |
nextValueArray of Reference |
ChangeCartPredicateChange
typeString | "ChangeCartPredicateChange" |
changeString | "changeCartPredicate"Shape of the action for |
previousValueString | |
nextValueString |
ChangeCustomLineItemQuantityChange
typeString | "ChangeCustomLineItemQuantityChange" |
changeString | "changeCustomLineItemQuantity"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
nextValueInt | |
previousValueInt |
ChangeDescriptionChange
typeString | "ChangeDescriptionChange" |
changeString | "changeDescription"Shape of the action for |
previousValueString | |
nextValueString |
ChangeEmailChange
typeString | "ChangeEmailChange" |
changeString | "changeEmail"Shape of the action for |
previousValueString | |
nextValueString |
ChangeEnumValueLabelChange
typeString | "ChangeEnumValueLabelChange" |
changeString | "changeEnumValueLabel"Update action for |
fieldNameString | The name of the field definition updated. |
valueKeyString | Key of the values that was updated |
previousValueString | |
nextValueString |
ChangeEnumValueOrderChange
ChangeFieldDefinitionOrderChange
typeString | "ChangeFieldDefinitionOrderChange" |
changeString | "changeFieldDefinitionOrder"Update action for |
previousValueArray of FieldDefinitionOrderValue | |
nextValueArray of FieldDefinitionOrderValue |
ChangeGroupsChange
typeString | "ChangeGroupsChange" |
changeString | "changeGroups"Update action for |
previousValueArray of String | |
nextValueArray of String |
ChangeInitialChange
typeString | "ChangeInitialChange" |
changeString | "changeInitial"Shape of the action for |
previousValueBoolean | |
nextValueBoolean |
ChangeInputHintChange
typeString | "ChangeInputHintChange" |
changeString | "changeInputHint"Update action for |
fieldNameString | The name of the field definition updated. |
attributeNameString | The name of the attribute updated. |
nextValueTextInputHint | |
previousValueTextInputHint |
ChangeIsActiveChange
typeString | "ChangeIsActiveChange" |
changeString | "changeIsActive"Shape of the action for |
previousValueBoolean | |
nextValueBoolean |
ChangeIsSearchableChange
typeString | "ChangeIsSearchableChange" |
changeString | "changeIsSearchable"Update action for |
attributeNameString | The name of the updated attribute. |
nextValueBoolean | |
previousValueBoolean |
ChangeKeyChange
typeString | "ChangeKeyChange" |
changeString | "changeKey"Shape of the action for |
previousValueString | |
nextValueString |
ChangeLabelChange
typeString | "ChangeLabelChange" |
changeString | "changeLabel"Update action for |
fieldNameString | The name of the field definition to update (types). |
attributeNameString | The name of the attribute definition to update (product-type). |
nextValueLocalizedString | |
previousValueLocalizedString |
ChangeLineItemQuantityChange
typeString | "ChangeLineItemQuantityChange" |
changeString | "changeLineItemQuantity"Update action for |
lineItemLocalizedString | |
lineItemIdString | |
nextValueInt | The amount of a LineItem in the cart. Must be a positive integer. |
previousValueInt | The amount of a LineItem in the cart. Must be a positive integer. |
ChangeLocalizedDescriptionChange
typeString | "ChangeLocalizedDescriptionChange" |
changeString | "changeDescription"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
ChangeLocalizedEnumValueLabelChange
typeString | "ChangeLocalizedEnumValueLabelChange" |
changeString | "changeLocalizedEnumValueLabel"Update action for |
fieldNameString | The name of the field definition updated. |
attributeNameString | The name of the attribute updated. |
valueKeyString | Key of the values that was updated |
previousValueLocalizedString | |
nextValueLocalizedString |
ChangeLocalizedEnumValueOrderChange
typeString | "ChangeLocalizedEnumValueOrderChange" |
changeString | "changeLocalizedEnumValueOrder"Update action for |
fieldNameString | The name of the field definition updated. |
attributeNameString | The name of the attribute updated. |
nextValueArray of LocalizedEnumValue | |
previousValueArray of LocalizedEnumValue |
ChangeLocalizedNameChange
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
ChangeMasterVariantChange
typeString | "ChangeMasterVariantChange" |
changeString | "changeMasterVariant"Update action for |
catalogDataString | |
previousValueVariant | |
nextValueVariant |
ChangeNameChange
typeString | "ChangeNameChange" |
changeString | "changeName"Shape of the action for |
previousValueString | |
nextValueString |
ChangeOrderHintChange
typeString | "ChangeOrderHintChange" |
changeString | "changeOrderHint"Shape of the action for |
previousValueString | |
nextValueString |
ChangeOrderStateChange
typeString | "ChangeOrderStateChange" |
changeString | "changeOrderState"Update action for |
nextValueOrderState | |
previousValueOrderState |
ChangeParentChange
typeString | "ChangeParentChange" |
changeString | "changeParent"Shape of the action for |
previousValueReference | |
nextValueReference |
ChangePaymentStateChange
typeString | "ChangePaymentStateChange" |
changeString | "changePaymentState"Update action for |
nextValuePaymentState | |
previousValuePaymentState |
ChangePlainEnumValueLabelChange
typeString | "ChangePlainEnumValueLabelChange" |
changeString | "changePlainEnumValueLabel"Update action for |
attributeNameString | The name of the attribute updated. |
valueKeyString | Key of the values that was updated |
previousValueString | |
nextValueString |
ChangePlainEnumValueOrderChange
ChangePredicateChange
typeString | "ChangePredicateChange" |
changeString | "changePredicate"Shape of the action for |
previousValueString | |
nextValueString |
ChangePriceChange
typeString | "ChangePriceChange" |
changeString | "changePrice"Update action for changing prices |
catalogDataString | |
priceIdString | |
previousValuePrice | |
nextValuePrice |
ChangeQuantityChange
Update action for changeQuantity on inventories
typeString | "ChangeQuantityChange" |
changeString | "changeQuantity" |
nextValue | |
previousValue |
ChangeRequiresDiscountCodeChange
typeString | "ChangeRequiresDiscountCodeChange" |
changeString | "changeRequiresDiscountCode"Shape of the action for |
previousValueBoolean | |
nextValueBoolean |
ChangeReviewRatingStatisticsChange
typeString | "ChangeReviewRatingStatisticsChange" |
changeString | "changeReviewRatingStatistics"Update action for |
nextValueReviewRatingStatistics | |
previousValueReviewRatingStatistics |
ChangeShipmentStateChange
typeString | "ChangeShipmentStateChange" |
changeString | "changeShipmentState"Update action for |
nextValueShipmentState | |
previousValueShipmentState |
ChangeShoppingListLineItemQuantityChange
typeString | "ChangeShoppingListLineItemQuantityChange" |
changeString | "changeLineItemQuantity" |
lineItem | |
previousValueInt | |
nextValueInt |
ChangeShoppingListLineItemsOrderChange
typeString | "ChangeShoppingListLineItemsOrderChange" |
changeString | "changeLineItemsOrder" |
previousValueArray of ShoppingListLineItemValue | |
nextValueArray of ShoppingListLineItemValue |
ChangeSlugChange
typeString | "ChangeSlugChange" |
changeString | "changeSlug"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
ChangeSortOrderChange
typeString | "ChangeSortOrderChange" |
changeString | "changeSortOrder"Shape of the action for |
previousValueString | |
nextValueString |
ChangeStackingModeChange
typeString | "ChangeStackingModeChange" |
changeString | "changeStackingMode"Update action for |
nextValueStackingMode | |
previousValueStackingMode |
ChangeStateTypeChange
typeString | "ChangeStateTypeChange" |
changeString | "changeType"Update action for |
previousValueStateType | |
nextValueStateType |
ChangeTargetChange
typeString | "ChangeTargetChange" |
changeString | "changeTarget"Update action for |
nextValueChangeTargetChangeValue | |
previousValueChangeTargetChangeValue |
ChangeTextLineItemNameChange
typeString | "ChangeTextLineItemNameChange" |
changeString | "changeTextLineItemName"Update action for |
textLineItem | |
nextValueLocalizedString | |
previousValueLocalizedString |
ChangeTaxCalculationModeChange
typeString | "ChangeTaxCalculationModeChange" |
changeString | "changeTaxCalculationMode"Shape of the action for |
previousValueTaxCalculationMode | |
nextValueTaxCalculationMode |
ChangeTaxModeChange
typeString | "ChangeTaxModeChange" |
changeString | "changeTaxMode"Shape of the action for |
previousValueTaxMode | |
nextValueTaxMode |
ChangeTaxRoundingModeChange
typeString | "ChangeTaxRoundingModeChange" |
changeString | "changeTaxRoundingMode"Shape of the action for |
previousValueRoundingMode | |
nextValueRoundingMode |
ChangeTextLineItemQuantityChange
typeString | "ChangeTextLineItemQuantityChange" |
changeString | "changeTextLineItemQuantity" |
textLineItem | |
previousValueInt | |
nextValueInt |
ChangeTextLineItemsOrderChange
typeString | "ChangeTextLineItemsOrderChange" |
changeString | "changeTextLineItemsOrder" |
previousValueArray of TextLineItemValue | |
nextValueArray of TextLineItemValue |
ChangeTransactionInteractionIdChange
typeString | "ChangeTransactionInteractionIdChange" |
changeString | "changeTransactionInteractionId"Update action for |
transaction | |
nextValueString | |
previousValueString |
ChangeTransactionStateChange
typeString | "ChangeTransactionStateChange" |
changeString | "changeTransactionState"Update action for |
transaction | |
nextValueTransactionState | |
previousValueTransactionState |
ChangeTransactionTimestampChange
typeString | "ChangeTransactionTimestampChange" |
changeString | "changeTransactionTimestamp"Update action for |
transaction | |
nextValueString | |
previousValueString |
ChangeValueChange
typeString | "ChangeValueChange" |
changeString | "changeValue"Update action for |
nextValueChangeValueChangeValue | |
previousValueChangeValueChangeValue |
MoveImageToPositionChange
typeString | "MoveImageToPositionChange" |
changeString | "moveImageToPosition"Update actions for moving images |
catalogDataString | |
previousValueArray of Image | |
nextValueArray of Image |
PublishChange
typeString | "PublishChange" |
changeString | "publish" |
RemoveAddressChange
typeString | "RemoveAddressChange" |
changeString | "removeAddress"Update action for |
previousValueAddress |
RemoveAssetChange
typeString | "RemoveAssetChange" |
changeString | "removeAsset"Update action for |
previousValueAsset |
RemoveAttributeDefinitionChange
typeString | "RemoveAttributeDefinitionChange" |
changeString | "removeAttributeDefinition"Update action for |
previousValueAttributeDefinition |
RemoveBillingAddressIdChange
typeString | "RemoveBillingAddressIdChange" |
changeString | "removeBillingAddressId"Update action for |
nextValueArray of String | |
previousValueArray of String | |
addressAddress |
RemoveChannelRolesChange
typeString | "RemoveChannelRolesChange" |
changeString | "removeRoles" |
previousValueArray of ChannelRole | |
nextValueArray of ChannelRole |
RemoveCustomLineItemChange
typeString | "RemoveCustomLineItemChange" |
changeString | "removeCustomLineItem"Update action for adding and removing custom line items |
nextValueCustomLineItem | |
previousValueCustomLineItem |
RemoveDeliveryItemsChange
typeString | "RemoveDeliveryItemsChange" |
changeString | "removeDelivery"Update action for |
previousValueDelivery |
RemoveDiscountCodeChange
typeString | "RemoveDiscountCodeChange" |
changeString | "removeDiscountCode"Update action for |
previousValueDiscountCodeInfo |
RemoveEnumValuesChange
typeString | "RemoveEnumValuesChange" |
changeString | "removeEnumValues"Update action for |
attributeNameString | The name of the attribute updated. |
previousValue |
RemoveFieldDefinitionChange
typeString | "RemoveFieldDefinitionChange" |
changeString | "removeFieldDefinition"Update action for |
previousValueFieldDefinition |
RemoveFromCategoryChange
typeString | "RemoveFromCategoryChange" |
changeString | "removeFromCategory"Update action for |
categoryReference | |
previousValueArray of Reference | |
nextValueArray of Reference |
RemoveImageChange
typeString | "RemoveImageChange" |
changeString | "removeImage"Update actions for removing images |
catalogDataString | |
previousValueArray of Image | |
nextValueArray of Image |
RemoveItemShippingAddressesChange
typeString | "RemoveItemShippingAddressesChange" |
changeString | "removeItemShippingAddress"Update action for |
nextValueAddress | |
previousValueAddress |
RemoveLocalizedEnumValuesChange
typeString | "RemoveLocalizedEnumValuesChange" |
changeString | "removeEnumValues"Update action for |
attributeNameString | The name of the attribute updated. |
previousValue |
RemoveLocationChange
typeString | "RemoveLocationChange" |
changeString | "removeLocation"Update action for |
previousValueLocation | |
nextValueLocation |
RemoveOrderLineItemChange
typeString | "RemoveOrderLineItemChange" |
changeString | "removeLineItem" |
previousValueLineItem | |
nextValueLineItem |
RemoveParcelFromDeliveryChange
typeString | "RemoveParcelFromDeliveryChange" |
changeString | "removeParcelFromDelivery"Update action for |
deliveryIdString | |
previousValueParcel |
RemovePaymentChange
typeString | "RemovePaymentChange" |
changeString | "removePayment"Update action for |
nextValuePaymentInfo | |
previousValuePaymentInfo |
RemovePriceChange
typeString | "RemovePriceChange" |
changeString | "removePrice"Update action for removing prices |
catalogDataString | |
priceIdString | |
previousValuePrice | |
nextValuePrice |
RemovePropertyChange
typeString | "RemovePropertyChange" |
changeString | "removeProperty"Update action for |
pathString | Value path to the property that was removed |
previousValueAny |
RemoveShippingAddressIdChange
typeString | "RemoveShippingAddressIdChange" |
changeString | "removeShippingAddressId"Update action for |
nextValueArray of String | |
previousValueArray of String | |
addressAddress |
RemoveShoppingListLineItemChange
typeString | "RemoveShoppingListLineItemChange" |
changeString | "removeLineItem" |
previousValueLineItem | |
nextValueLineItem |
RemoveStateRolesChange
typeString | "RemoveStateRolesChange" |
changeString | "removeRoles" |
previousValueArray of StateRole | |
nextValueArray of StateRole |
RemoveTaxRateChange
typeString | "RemoveTaxRateChange" |
changeString | "removeTaxRate"Update action for |
previousValueTaxRate | |
nextValueTaxRate |
RemoveTextLineItemChange
typeString | "RemoveTextLineItemChange" |
changeString | "removeTextLineItem" |
previousValueTextLineItem | |
nextValueTextLineItem |
RemoveVariantChange
typeString | "RemoveVariantChange" |
changeString | "removeVariant"Update action for |
catalogDataString | |
previousValueVariant | |
nextValueVariant |
SetAddressChange
typeString | "SetAddressChange" |
changeString | "setAddress"Update action for |
nextValueAddress | |
previousValueAddress |
SetAnonymousIdChange
typeString | "SetAnonymousIdChange" |
changeString | "setAnonymousId"Shape of the action for |
previousValueString | |
nextValueString |
SetApplicationVersionChange
typeString | "SetApplicationVersionChange" |
changeString | "setApplicationVersion"Internal Update action for |
previousValueInt | |
nextValueInt |
SetAssetCustomFieldChange
typeString | "SetAssetCustomFieldChange" |
changeString | "setAssetCustomField"Update action for |
nameString | |
customTypeIdString | |
asset | |
nextValueAny | |
previousValueAny |
SetAssetCustomTypeChange
typeString | "SetAssetCustomTypeChange" |
changeString | "setAssetCustomType"Update action for |
asset | |
nextValueCustomFields | |
previousValueCustomFields |
SetAssetDescriptionChange
typeString | "SetAssetDescriptionChange" |
changeString | "setAssetDescription"Update action for |
asset | |
nextValueLocalizedString | |
previousValueLocalizedString |
SetAssetKeyChange
typeString | "SetAssetKeyChange" |
changeString | "setAssetKey"Update action for |
asset | |
nextValueString | |
previousValueString |
SetAssetSourcesChange
typeString | "SetAssetSourcesChange" |
changeString | "setAssetSources"Update action for |
asset | |
nextValueArray of AssetSource | |
previousValueArray of AssetSource |
SetAttributeChange
typeString | "SetAttributeChange" |
changeString | "setAttribute"Update action for |
catalogDataString | |
previousValueObject | |
nextValueObject |
SetBillingAddressChange
typeString | "SetBillingAddressChange" |
changeString | "setBillingAddress"Update action for |
nextValueAddress | |
previousValueAddress |
SetCartPredicateChange
typeString | "SetCartPredicateChange" |
changeString | "setCartPredicate"Shape of the action for |
previousValueString | |
nextValueString |
SetCategoryOrderHintChange
typeString | "SetCategoryOrderHintChange" |
changeString | "setCategoryOrderHint"Update action for |
catalogDataString | |
categoryIdString | |
previousValueCategoryOrderHints | |
nextValueCategoryOrderHints |
SetChannelRolesChange
typeString | "SetChannelRolesChange" |
changeString | "setRoles" |
previousValueArray of ChannelRole | |
nextValueArray of ChannelRole |
SetCompanyNameChange
typeString | "SetCompanyNameChange" |
changeString | "setCompanyName"Shape of the action for |
previousValueString | |
nextValueString |
SetCountryChange
typeString | "SetCountryChange" |
changeString | "setCountry"Update action for |
previousValueCountryCode | A two-digit country code as per ISO 3166-1 alpha-2. |
nextValueCountryCode | A two-digit country code as per ISO 3166-1 alpha-2. |
SetCustomFieldChange
typeString | "SetCustomFieldChange" |
changeString | "setCustomField"Update action for setting a custom field |
nameString | Custom field name |
customTypeIdString | |
nextValueAny | |
previousValueAny |
SetCustomLineItemCustomFieldChange
typeString | "SetCustomLineItemCustomFieldChange" |
changeString | "setCustomLineItemCustomField"Update action for |
nameString | |
customLineItemLocalizedString | |
customLineItemIdString | |
nextValueAny | |
previousValueAny |
SetCustomLineItemCustomTypeChange
typeString | "SetCustomLineItemCustomTypeChange" |
changeString | "setCustomLineItemCustomType"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
nextValueCustomFields | |
previousValueCustomFields |
SetCustomLineItemMoneyChange
typeString | "SetCustomLineItemMoneyChange" |
changeString | "setCustomLineItemMoney"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
nextValueMoney | |
previousValueMoney |
SetCustomLineItemShippingDetailsChange
typeString | "SetCustomLineItemShippingDetailsChange" |
changeString | "setCustomLineItemShippingDetails"Update action for |
customLineItemIdString | |
nextValueItemShippingDetails | |
previousValueItemShippingDetails |
SetCustomLineItemTaxAmountChange
typeString | "SetCustomLineItemTaxAmountChange" |
changeString | "setCustomLineItemTaxAmount"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
taxModeTaxMode | |
nextValueTaxRate | |
previousValueTaxRate |
SetCustomLineItemTaxCategoryChange
typeString | "SetCustomLineItemTaxCategoryChange" |
changeString | "setCustomLineItemTaxCategory"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
nextValueReference | |
previousValueReference |
SetCustomLineItemTaxRateChange
typeString | "SetCustomLineItemTaxRateChange" |
changeString | "setCustomLineItemTaxRate"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
taxModeTaxMode | |
nextValueTaxRate | |
previousValueTaxRate |
SetCustomLineItemTaxedPriceChange
typeString | "SetCustomLineItemTaxedPriceChange" |
changeString | "setCustomLineItemTaxedPrice"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
nextValueMoney | |
previousValueMoney |
SetCustomLineItemTotalPriceChange
typeString | "SetCustomLineItemTotalPriceChange" |
changeString | "setCustomLineItemTotalPrice"Update action for |
customLineItemLocalizedString | |
customLineItemIdString | |
nextValueMoney | |
previousValueMoney |
SetCustomShippingMethodChange
typeString | "SetCustomShippingMethodChange" |
changeString | "setCustomShippingMethod"Update action for |
nextValue | |
previousValue |
SetCustomTypeChange
typeString | "SetCustomTypeChange" |
changeString | "setCustomType"Update action for setting a custom type |
nextValueCustomFields | |
previousValueCustomFields |
SetCustomerChange
typeString | "SetCustomerChange" |
changeString | "setCustomer"Shape of the action for |
previousValueReference | |
nextValueReference |
SetCustomerEmailChange
typeString | "SetCustomerEmailChange" |
changeString | "setCustomerEmail"Shape of the action for |
previousValueString | |
nextValueString |
SetCustomerGroupChange
typeString | "SetCustomerGroupChange" |
changeString | "setCustomerGroup"Shape of the action for |
previousValueReference | |
nextValueReference |
SetCustomerIdChange
typeString | "SetCustomerIdChange" |
changeString | "setCustomerId"Shape of the action for |
previousValueString | |
nextValueString |
SetCustomerNumberChange
typeString | "SetCustomerNumberChange" |
changeString | "setCustomerNumber"Shape of the action for |
previousValueString | |
nextValueString |
SetDateOfBirthChange
typeString | "SetDateOfBirthChange" |
changeString | "setDateOfBirth"Shape of the action for |
previousValueString | |
nextValueString |
SetDefaultBillingAddressChange
typeString | "SetDefaultBillingAddressChange" |
changeString | "setDefaultBillingAddress"Update action for |
nextValueAddress | |
previousValueAddress |
SetDefaultShippingAddressChange
typeString | "SetDefaultShippingAddressChange" |
changeString | "setDefaultShippingAddress"Update action for |
nextValueAddress | |
previousValueAddress |
SetDeleteDaysAfterLastModificationChange
typeString | "SetDeleteDaysAfterLastModificationChange" |
changeString | "setDeleteDaysAfterLastModification"Shape of the action for |
previousValueInt | |
nextValueInt |
SetDeliveryAddressChange
typeString | "SetDeliveryAddressChange" |
changeString | "setDeliveryAddress"Update action for |
deliveryIdString | |
nextValueAddress | |
previousValueAddress |
SetDeliveryItemsChange
typeString | "SetDeliveryItemsChange" |
changeString | "setDeliveryItems"Update action for |
deliveryIdString | |
nextValueArray of DeliveryItem | |
previousValueArray of DeliveryItem |
SetDescriptionChange
typeString | "SetDescriptionChange" |
changeString | "setDescription"Shape of the action for |
previousValueString | |
nextValueString |
SetDiscountedPriceChange
typeString | "SetDiscountedPriceChange" |
changeString | "setDiscountedPrice"Update action for |
catalogDataString | |
variantString | |
priceIdString | |
previousValuePrice | |
nextValuePrice |
SetDistributionChannelsChange
typeString | "SetDistributionChannelsChange" |
changeString | "setDistributionChannels"Shape of the action for |
previousValueArray of Reference | |
nextValueArray of Reference |
SetExpectedDeliveryChange
typeString | "SetExpectedDeliveryChange" |
changeString | "setExpectedDelivery"Shape of the action for |
previousValueString | |
nextValueString |
SetExternalIdChange
typeString | "SetExternalIdChange" |
changeString | "setExternalId"Shape of the action for |
previousValueString | |
nextValueString |
SetFirstNameChange
typeString | "SetFirstNameChange" |
changeString | "setFirstName"Shape of the action for |
previousValueString | |
nextValueString |
SetGeoLocationChange
typeString | "SetGeoLocationChange" |
changeString | "setGeoLocation"Update action for |
nextValueGeoLocation | |
previousValueGeoLocation |
SetImageLabelChange
typeString | "SetImageLabelChange" |
changeString | "setImageLabel"Update action for |
catalogDataString | |
previousValueImage | |
nextValueImage |
SetInputTipChange
typeString | "SetInputTipChange" |
changeString | "setInputTip"Update action for |
attributeNameString | The name of the updated attribute. |
nextValueLocalizedString | |
previousValueLocalizedString |
SetInterfaceIdChange
typeString | "SetInterfaceIdChange" |
changeString | "setInterfaceId"Shape of the action for |
previousValueString | |
nextValueString |
SetIsValidChange
typeString | "SetIsValidChange" |
changeString | "setIsValid"Shape of the action for |
previousValueBoolean | |
nextValueBoolean |
SetKeyChange
typeString | "SetKeyChange" |
changeString | "setKey"Shape of the action for |
previousValueString | |
nextValueString |
SetLanguagesChange
typeString | "SetLanguagesChange" |
changeString | "setLanguages"Update action for |
previousValueArray of String | |
nextValueArray of String |
SetLastNameChange
typeString | "SetLastNameChange" |
changeString | "setLastName"Shape of the action for |
previousValueString | |
nextValueString |
SetLineItemDiscountedPriceChange
typeString | "SetLineItemDiscountedPriceChange" |
changeString | "setLineItemDiscountedPrice"Update action for |
lineItemLocalizedString | |
variantString | |
nextValueDiscountedLineItemPrice | |
previousValueDiscountedLineItemPrice |
SetLineItemDiscountedPricePerQuantityChange
typeString | "SetLineItemDiscountedPricePerQuantityChange" |
changeString | "setLineItemDiscountedPricePerQuantity"Update action for |
lineItemLocalizedString | |
variantString | |
nextValueDiscountedLineItemPriceForQuantity | |
previousValueDiscountedLineItemPriceForQuantity |
SetLineItemDistributionChannelChange
typeString | "SetLineItemDistributionChannelChange" |
changeString | "setLineItemDistributionChannel"Update action for |
lineItemLocalizedString | |
variantString | |
nextValueReference | |
previousValueReference |
SetLineItemPriceChange
typeString | "SetLineItemPriceChange" |
changeString | "setLineItemPrice"Update action for |
lineItemLocalizedString | |
nextValuePrice | |
previousValuePrice |
SetLineItemProductSlugChange
typeString | "SetLineItemProductSlugChange" |
changeString | "setLineItemProductSlug"Update action for |
lineItemLocalizedString | |
variantString | |
nextValueLocalizedString | |
previousValueLocalizedString |
SetLineItemShippingDetailsChange
typeString | "SetLineItemShippingDetailsChange" |
changeString | "setLineItemShippingDetails"Update action for |
lineItemIdString | |
nextValueItemShippingDetails | |
previousValueItemShippingDetails |
SetLineItemTaxAmountChange
typeString | "SetLineItemTaxAmountChange" |
changeString | "setLineItemTaxAmount"Update action for |
lineItemLocalizedString | |
variantString | |
taxModeTaxMode | |
nextValueTaxRate | |
previousValueTaxRate |
SetLineItemTaxRateChange
typeString | "SetLineItemTaxRateChange" |
changeString | "setLineItemTaxRate"Update action for |
lineItemLocalizedString | |
variantString | |
taxModeTaxMode | |
nextValueTaxRate | |
previousValueTaxRate |
SetLineItemTaxedPriceChange
typeString | "SetLineItemTaxedPriceChange" |
changeString | "setLineItemTaxedPrice"Update action for |
lineItemLocalizedString | |
lineItemIdString | |
nextValueTaxedItemPrice | |
previousValueTaxedItemPrice |
SetLineItemTotalPriceChange
typeString | "SetLineItemTotalPriceChange" |
changeString | "setLineItemTotalPrice"Update action for |
lineItemLocalizedString | |
nextValueMoney | |
previousValueMoney |
SetLocaleChange
typeString | "SetLocaleChange" |
changeString | "setLocale"Update action for |
previousValueLocale | A locale of IETF language tag. |
nextValueLocale | A locale of IETF language tag. |
SetLocalizedDescriptionChange
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
SetMaxApplicationsChange
typeString | "SetMaxApplicationsChange" |
changeString | "setMaxApplications"Shape of the action for |
previousValueInt | |
nextValueInt |
SetMaxApplicationsPerCustomerChange
typeString | "SetMaxApplicationsPerCustomerChange" |
changeString | "setMaxApplicationsPerCustomer"Shape of the action for |
previousValueInt | |
nextValueInt |
SetMetaDescriptionChange
typeString | "SetMetaDescriptionChange" |
changeString | "setMetaDescription"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
SetMetaKeywordsChange
typeString | "SetMetaKeywordsChange" |
changeString | "setMetaKeywords"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
SetMetaTitleChange
typeString | "SetMetaTitleChange" |
changeString | "setMetaTitle"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
SetMethodInfoInterfaceChange
typeString | "SetMethodInfoInterfaceChange" |
changeString | "setMethodInfoInterface"Shape of the action for |
previousValueString | |
nextValueString |
SetMethodInfoMethodChange
typeString | "SetMethodInfoMethodChange" |
changeString | "setMethodInfoMethod"Shape of the action for |
previousValueString | |
nextValueString |
SetMethodInfoNameChange
typeString | "SetMethodInfoNameChange" |
changeString | "setMethodInfoName"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
SetMiddleNameChange
typeString | "SetMiddleNameChange" |
changeString | "setMiddleName"Shape of the action for |
previousValueString | |
nextValueString |
SetNameChange
typeString | "SetNameChange" |
changeString | "setName"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
SetOrderLineItemCustomFieldChange
typeString | "SetOrderLineItemCustomFieldChange" |
changeString | "setLineItemCustomField"Update action for |
customTypeIdString | |
nameString | |
variantString | |
lineItemLocalizedString | |
nextValueAny | |
previousValueAny |
SetOrderLineItemCustomTypeChange
typeString | "SetOrderLineItemCustomTypeChange" |
changeString | "setLineItemCustomType"Update action for |
lineItemLocalizedString | |
variantString | |
nextValueCustomFields | |
previousValueCustomFields |
SetOrderNumberChange
typeString | "SetOrderNumberChange" |
changeString | "setOrderNumber"Shape of the action for |
previousValueString | |
nextValueString |
SetOrderTaxedPriceChange
typeString | "SetOrderTaxedPriceChange" |
changeString | "setOrderTaxedPrice"Update action for |
taxModeTaxMode | |
nextValueTaxedItemPrice | |
previousValueTaxedItemPrice |
SetOrderTotalPriceChange
typeString | "SetOrderTotalPriceChange" |
changeString | "setOrderTotalPrice"Update action for |
nextValueMoney | |
previousValueMoney |
SetOrderTotalTaxChange
typeString | "SetOrderTotalTaxChange" |
changeString | "setOrderTotalTax"Update action for |
taxModeTaxMode | |
nextValueMoney | |
previousValueMoney |
SetParcelItemsChange
typeString | "SetParcelItemsChange" |
changeString | "setParcelItems"Update action for |
parcel | |
nextValueArray of DeliveryItem | |
previousValueArray of DeliveryItem |
SetParcelMeasurementsChange
typeString | "SetParcelMeasurementsChange" |
changeString | "setParcelMeasurements"Update action for |
parcel | |
nextValueParcelMeasurements | |
previousValueParcelMeasurements |
SetParcelTrackingDataChange
typeString | "SetParcelTrackingDataChange" |
changeString | "setParcelTrackingData"Update action for |
parcel | |
nextValueTrackingData | |
previousValueTrackingData |
SetPricesChange
typeString | "SetPricesChange" |
changeString | "setPrices"Update action for |
catalogDataString | |
variantString | |
previousValueArray of Price | |
nextValueArray of Price |
SetProductPriceCustomFieldChange
typeString | "SetProductPriceCustomFieldChange" |
changeString | "setProductPriceCustomField"Update action for |
catalogDataString | |
previousValueCustomFields | |
nextValueCustomFields |
SetProductPriceCustomTypeChange
typeString | "SetProductPriceCustomTypeChange" |
changeString | "setProductPriceCustomType"Update action for |
catalogDataString | |
previousValueCustomFields | |
nextValueCustomFields |
SetProductVariantKeyChange
typeString | "SetProductVariantKeyChange" |
changeString | "setProductVariantKey"Update action for |
catalogDataString | |
previousValueString | |
nextValueString |
SetPropertyChange
typeString | "SetPropertyChange" |
changeString | "setProperty"Update action for |
pathString | Value path to the property that was changed |
nextValueAny | |
previousValueAny |
SetRatingChange
typeString | "SetRatingChange" |
changeString | "setRating"Shape of the action for |
previousValueInt | |
nextValueInt |
SetReservationsChange
typeString | "SetReservationsChange" |
changeString | "setReservations"Update action for |
nextValueArray of Reservation | |
previousValueArray of Reservation |
SetRestockableInDaysChange
typeString | "SetRestockableInDaysChange" |
changeString | "setRestockableInDays"Shape of the action for |
previousValueInt | |
nextValueInt |
SetReturnPaymentStateChange
typeString | "SetReturnPaymentStateChange" |
changeString | "setReturnPaymentState"Update action for |
nextValueReturnPaymentState | |
previousValueReturnPaymentState |
SetReturnShipmentStateChange
typeString | "SetReturnShipmentStateChange" |
changeString | "setReturnShipmentState"Update action for |
nextValueReturnShipmentState | |
previousValueReturnShipmentState |
SetSalutationChange
typeString | "SetSalutationChange" |
changeString | "setSalutation"Shape of the action for |
previousValueString | |
nextValueString |
SetSearchKeywordsChange
typeString | "SetSearchKeywordsChange" |
changeString | "setSearchKeywords"Update action for |
catalogDataString | |
previousValueSearchKeywords | |
nextValueSearchKeywords |
SetShippingAddressChange
typeString | "SetShippingAddressChange" |
changeString | "setShippingAddress"Update action for |
nextValueAddress | |
previousValueAddress |
SetShippingInfoPriceChange
typeString | "SetShippingInfoPriceChange" |
changeString | "setShippingInfoPrice"Update action for |
nextValueMoney | |
previousValueMoney |
SetShippingInfoTaxedPriceChange
typeString | "SetShippingInfoTaxedPriceChange" |
changeString | "setShippingInfoTaxedPrice"Update action for |
nextValueTaxedPrice | |
previousValueTaxedPrice |
SetShippingMethodChange
typeString | "SetShippingMethodChange" |
changeString | "setShippingMethod"Update action for |
nextValue | |
previousValue |
SetShippingMethodTaxAmountChange
typeString | "SetShippingMethodTaxAmountChange" |
changeString | "setShippingMethodTaxAmount"Update action for |
taxModeTaxMode | |
nextValueObject | |
previousValueObject |
SetShippingMethodTaxRateChange
typeString | "SetShippingMethodTaxRateChange" |
changeString | "setShippingMethodTaxRate"Update action for |
taxModeTaxMode | |
nextValueTaxRate | |
previousValueTaxRate |
SetShippingRateChange
typeString | "SetShippingRateChange" |
changeString | "setShippingRate"Update action for |
nextValueMoney | |
previousValueMoney |
SetShippingRateInputChange
typeString | "SetShippingRateInputChange" |
changeString | "setShippingRateInput"Update action for |
nextValueSetCartClassificationShippingRateInputValue | SetCartScoreShippingRateInputValue | |
previousValueSetCartClassificationShippingRateInputValue | SetCartScoreShippingRateInputValue |
SetShoppingListLineItemCustomFieldChange
typeString | "SetShoppingListLineItemCustomFieldChange" |
changeString | "setLineItemCustomField"Update action for |
nameString | |
customTypeIdString | |
lineItem | |
nextValueAny | |
previousValueAny |
SetShoppingListLineItemCustomTypeChange
typeString | "SetShoppingListLineItemCustomTypeChange" |
changeString | "setLineItemCustomType"Update action for |
lineItem | |
nextValueCustomFields | |
previousValueCustomFields |
SetSkuChange
typeString | "SetSkuChange" |
changeString | "setSku"Update action for |
catalogDataString | |
previousValueString | |
nextValueString |
SetSlugChange
typeString | "SetSlugChange" |
changeString | "setSlug"Shape of the action for |
previousValueLocalizedString | |
nextValueLocalizedString |
SetStateRolesChange
typeString | "SetStateRolesChange" |
changeString | "setRoles" |
previousValueArray of StateRole | |
nextValueArray of StateRole |
SetStatusInterfaceCodeChange
typeString | "SetStatusInterfaceCodeChange" |
changeString | "setStatusInterfaceCode"Shape of the action for |
previousValueString | |
nextValueString |
SetStatusInterfaceTextChange
typeString | "SetStatusInterfaceTextChange" |
changeString | "setStatusInterfaceText"Shape of the action for |
previousValueString | |
nextValueString |
SetStoreChange
typeString | "SetStoreChange" |
changeString | "setStore"Shape of the action for |
previousValueReference | |
nextValueReference |
SetStoresChange
typeString | "SetStoresChange" |
changeString | "setStores"Shape of the action for |
previousValueArray of Reference | |
nextValueArray of Reference |
SetSupplyChannelChange
typeString | "SetSupplyChannelChange" |
changeString | "setSupplyChannel"Shape of the action for |
previousValueReference | |
nextValueReference |
SetSupplyChannelsChange
typeString | "SetSupplyChannelsChange" |
changeString | "setSupplyChannels"Shape of the action for |
previousValueArray of Reference | |
nextValueArray of Reference |
SetTargetChange
typeString | "SetTargetChange" |
changeString | "setTarget"Shape of the action for |
previousValueReference | |
nextValueReference |
SetTaxCategoryChange
typeString | "SetTaxCategoryChange" |
changeString | "setTaxCategory"Shape of the action for |
previousValueReference | |
nextValueReference |
SetTextChange
typeString | "SetTextChange" |
changeString | "setText"Shape of the action for |
previousValueString | |
nextValueString |
SetTextLineItemCustomFieldChange
typeString | "SetTextLineItemCustomFieldChange" |
changeString | "setTextLineItemCustomField"Update action for |
nameString | |
customTypeIdString | |
textLineItem | |
nextValueAny | |
previousValueAny |
SetTextLineItemCustomTypeChange
typeString | "SetTextLineItemCustomTypeChange" |
changeString | "setTextLineItemCustomType"Update action for |
textLineItem | |
nextValueCustomFields | |
previousValueCustomFields |
SetTextLineItemDescriptionChange
typeString | "SetTextLineItemDescriptionChange" |
changeString | "setTextLineItemDescription" |
textLineItem | |
previousValueLocalizedString | |
nextValueLocalizedString |
SetTitleChange
typeString | "SetTitleChange" |
changeString | "setTitle"Shape of the action for |
previousValueString | |
nextValueString |
SetTransitionsChange
typeString | "SetTransitionsChange" |
changeString | "setTransitions"Shape of the action for |
previousValueArray of Reference | |
nextValueArray of Reference |
SetValidFromAndUntilChange
typeString | "SetValidFromAndUntilChange" |
changeString | "setValidFromAndUntil" |
previousValue | |
nextValue |
SetValidFromChange
typeString | "SetValidFromChange" |
changeString | "setValidFrom"Shape of the action for |
previousValueString | |
nextValueString |
SetValidUntilChange
typeString | "SetValidUntilChange" |
changeString | "setValidUntil"Shape of the action for |
previousValueString | |
nextValueString |
SetValueChange
typeString | "SetValueChange" |
changeString | "setValue"Update action for |
nextValueAny | |
previousValueAny |
SetVariantAvailabilityChange
typeString | "SetVariantAvailabilityChange" |
changeString | "setVariantAvailability"Update action for |
catalogDataString | |
variantString | |
previousValueProductVariantAvailability | |
nextValueProductVariantAvailability |
SetVatIdChange
typeString | "SetVatIdChange" |
changeString | "setVatId"Shape of the action for |
previousValueString | |
nextValueString |
ShippingMethodChangeValue
idString | |
nameString |
TransitionCustomLineItemStateChange
typeString | "TransitionCustomLineItemStateChange" |
changeString | "transitionCustomLineItemState"Update action for |
lineItemIdString | |
stateIdString | |
nextValueArray of ItemState | |
previousValueArray of ItemState |
TransitionLineItemStateChange
typeString | "TransitionLineItemStateChange" |
changeString | "transitionLineItemState"Update action for |
lineItemIdString | |
stateIdString | |
nextValueArray of ItemState | |
previousValueArray of ItemState |
TransitionStateChange
typeString | "TransitionStateChange" |
changeString | "transitionState"Shape of the action for |
previousValueReference | |
nextValueReference |
UnknownChange
typeString | "UnknownChange" |
changeString | |
previousValueAny | |
nextValueAny |
UnpublishChange
typeString | "UnpublishChange" |
changeString | "unpublish" |
UpdateSyncInfoChange
typeString | "UpdateSyncInfoChange" |
changeString | "updateSyncInfo"Update action for |
channelIdString | |
nextValueSyncInfo |
VerifyEmailChange
typeString | "VerifyEmailChange" |
changeString | "verifyEmail" |
Change Values
AssetChangeValue
idString | |
nameLocalizedString |
ChangeTargetCustomLineItemsChangeValue
Shape of the value for cart discounts line item and custom line items target.
typeString | "customLineItems" |
predicateString |
ChangeTargetLineItemsChangeValue
Shape of the value for cart discounts line item target.
typeString | "lineItems" |
predicateString |
ChangeTargetMultiBuyCustomLineItemsChangeValue
Shape of the value for cart discounts multiBuyCustomLineItems target.
typeString | "multiBuyCustomLineItems" |
predicateString | |
triggerQuantityInt | Quantity of line items that need to be present in order to trigger an application of this discount. |
discountedQuantityInt | Quantity of line items that are discounted per application of this discount. |
maxOccurrenceInt | Maximum number of applications of this discount. |
selectionModeSelectionMode |
ChangeTargetMultiBuyLineItemsChangeValue
Shape of the value for cart discounts multiBuyLineItems target.
typeString | "multiBuyLineItems" |
predicateString | |
triggerQuantityInt | Quantity of line items that need to be present in order to trigger an application of this discount. |
discountedQuantityInt | Quantity of line items that are discounted per application of this discount. |
maxOccurrenceInt | Maximum number of applications of this discount. |
selectionModeSelectionMode |
ChangeTargetShippingChangeValue
Shape of the value for cart discounts shipping target.
typeString | "shipping" |
ChangeValueAbsoluteChangeValue
Shape of the value for cart discounts absolute value.
typeString | "absolute" |
moneyArray of Money |
ChangeValueExternalChangeValue
Shape of the value for product discounts external value.
typeString | "external" |
ChangeValueGiftLineItemChangeValue
Shape of the value for cart discounts gift line item value.
typeString | "giftLineItem" |
productReference | |
variantIdInt | |
supplyChannelReference | |
distributionChannelReference |
ChangeValueRelativeChangeValue
Shape of the value for cart discounts relative value.
typeString | "relative" |
permyriadInt |
CustomFieldExpandedValue
Only available if expand is set to true
nameString | Name of a custom field. |
valueAny | |
labelLocalizedString |
CustomShippingMethodChangeValue
nameString |
DeliveryChangeValue
itemsArray of DeliveryItem | |
addressAddress | |
parcelsArray of Parcel |
SetCartClassificationShippingRateInputValue
Shape of the cart classification shipping input rate value.
keyString | |
typeString | "Classification" |
labelLocalizedString |
SetCartScoreShippingRateInputValue
Shape of the cart score shipping input rate value.
typeString | "Score" |
scoreInt |
EnumValue
keyString | |
labelString |
FieldDefinitionOrderValue
Shape of the value for action changeFieldDefinitionOrder
nameString | |
labelLocalizedString |
InventoryQuantityValue
quantityOnStockInt | |
availableQuantityInt |
LocalizedEnumValue
keyString | |
labelLocalizedString |
ParcelChangeValue
idString | |
createdAtString |
ShippingMethodChangeValue
idString | |
nameString |
ShoppingListLineItemValue
idString | |
nameLocalizedString | |
variantIdInt |
TextLineItemValue
idString | |
nameLocalizedString |
TransactionChangeValue
idString | |
interactionIdString | |
timestampString |
ValidFromAndUntilValue
Shape of the value for setValidFromAndUntil action
validFromString | |
validUntilString |