Changes describe data modifications in the Audit Log Change History API.
Representations
Representations are JSON objects submitted or received as payload to API requests or responses.
Change
previousValue (omitted, for example, on creations) and nextValue of the associated change. A Change can also contain extra fields that provide further information.They are not identical to the actual update actions sent.
typeString | Unique discriminator value to reliably deserialize the data type. |
changeString | Type of change on a resource that is similar to the update action it relates to, where possible.
It is not a unique identifier for the data structure, for example, the
setDescription change can occur with a localized and non-localized representation.Records can be filtered by this value using the changes query parameter. |
ChangeValue
AssetChangeValue
idString | id of the Asset. |
name | Name of the Asset. |
CustomFieldExpandedValue
expand is set to true.nameString | Name of the Custom Field. |
valueAny | CustomFieldValue based on the FieldType. |
label | User-defined label of the Custom Field. |
CustomShippingMethodChangeValue
nameString | Name of the Custom ShippingMethod. |
DeliveryChangeValue
itemsArray of DeliveryItem | Line Items or Custom Line Items shipped in the Delivery. |
address | Address to which the parcels are delivered. |
parcelsArray of Parcel | Parcels included in the Delivery. |
ParcelChangeValue
idString | id of the Parcel. |
createdAtString | Date and time (UTC) the Parcel was created. |
ShippingMethodChangeValue
idString | id of the ShippingMethod. |
nameString | Name of the ShippingMethod. |
TransactionChangeValue
idString | id of the Transaction. |
interactionIdString | Identifier used by the interface that manages the Transaction (usually the PSP). |
timestampString | Date and time (UTC) the Transaction took place. |
ChangeValueChangeValue
Indicates how a Cart or Product is discounted:
- ChangeValueAbsoluteChangeValue for Cart or Product discounted by an absolute value
- ChangeValueRelativeChangeValue for Cart or Product discounted by a relative value
- ChangeValueGiftLineItemChangeValue for free Line Item added as a gift to the Cart
- ChangeValueExternalChangeValue for Product discounted by an external service
ChangeValueAbsoluteChangeValue
typeString | "absolute" |
moneyArray of Money | Money values in different currencies. |
ChangeValueRelativeChangeValue
typeString | "relative" |
permyriadInt | Fraction (per ten thousand) the price is reduced by. For example, 1000 results in a 10% price reduction. |
ChangeValueGiftLineItemChangeValue
typeString | "giftLineItem" |
product | Reference to a Product. |
variantIdInt | id of the ProductVariant. |
supplyChannel | Channel with ChannelRoleEnum InventorySupply. |
distributionChannel | Channel with ChannelRoleEnum ProductDistribution. |
ChangeValueExternalChangeValue
typeString | "external" |
ChangeTargetChangeValue
Indicates the segment of the Cart that is discounted:
- ChangeTargetLineItemsChangeValue for LineItems
- ChangeTargetCustomLineItemsChangeValue for CustomLineItems
- ChangeTargetShippingChangeValue for ShippingInfo
- ChangeTargetMultiBuyLineItemsChangeValue for MultiBuyLineItemsTarget
- ChangeTargetMultiBuyCustomLineItemsChangeValue for MultiBuyCustomLineItemsTarget
- ChangeTargetPatternChangeValue for CartDiscountPatternTarget
ChangeTargetLineItemsChangeValue
typeString | "lineItems" |
predicateString | Valid LineItem target predicate. |
ChangeTargetCustomLineItemsChangeValue
typeString | "customLineItems" |
predicateString |
ChangeTargetShippingChangeValue
typeString | "shipping" |
ChangeTargetMultiBuyLineItemsChangeValue
typeString | "multiBuyLineItems" |
predicateString | Valid LineItem target predicate. |
triggerQuantityInt | Quantity of Line Items that triggered the application of the discount. |
discountedQuantityInt | Quantity of Line Items discounted per application of this discount. |
maxOccurrenceInt | Maximum number of times the discount is applicable. |
selectionMode | SelectionMode based on which particular Line Items were discounted. |
ChangeTargetMultiBuyCustomLineItemsChangeValue
typeString | "multiBuyCustomLineItems" |
predicateString | |
triggerQuantityInt | Quantity of Custom Line Items that triggered the application of the discount. |
discountedQuantityInt | Quantity of Custom Line Items discounted per application of this discount. |
maxOccurrenceInt | Maximum number of times the discount is applicable. |
selectionMode | SelectionMode based on which particular Custom Line Items were discounted. |
ChangeTargetPatternChangeValue
typeString | "pattern" |
triggerPatternArray of PatternComponent | Defines the set of units of (Custom) Line Items in a Cart that triggered the discount application. |
targetPatternArray of PatternComponent | Defines the set of units of (Custom) Line Items in a Cart on which the Discount is applied. |
maxOccurrenceInt | Maximum number of times the Discount applies on a Cart. If empty, the Discount applies indefinitely. |
selectionMode | Indicates which of the matching units of (Custom) Line Items were discounted. |
Embedded values
AttributeValue
nameString | Name of the Attribute set. |
valueAny | Value set for the Attribute determined by the AttributeType:
|
EnumValue
keyString | Key of the value used as a programmatic identifier. |
labelString | Descriptive label of the value. |
LocalizedEnumValue
keyString | Key of the value used as a programmatic identifier. |
label | Descriptive localized label of the value. |
FieldDefinitionOrderValue
nameString | Name of the FieldDefinition. |
label | Descriptive label of the field. |
InventoryQuantityValue
quantityOnStockInt | Overall amount of stock ( availableQuantity + reserved). |
availableQuantityInt | Available amount of stock ( quantityOnStock - reserved). |
ShoppingListLineItemValue
idString | id of the ShoppingListLineItem. |
name | Name of the corresponding Product the Product Variant belongs to. |
variantIdInt | id of the ProductVariant the ShoppingListLineItem refers to. |
SetCartClassificationShippingRateInputValue
keyString | Key of the value used as a programmatic identifier. |
typeString | "Classification" |
label | Descriptive localized label of the value. |
SetCartScoreShippingRateInputValue
typeString | "Score" |
scoreInt | Abstract value for categorizing a Cart. |
ShippingMethodTaxAmountChangeValue
taxedPrice | Taxed price for the Shipping Method based on taxRate. |
taxRate | Tax rate set externally for the Shipping Method. |
TaxedPrice
totalNet | Total net price of the Cart or Order. |
totalGross | Total gross price of the Cart or Order. |
taxPortionsArray of TaxPortion | Taxable portions added to the total net price. Calculated from the TaxRates. |
totalTax | Total tax applicable for the Cart or Order. Automatically calculated as the difference between the totalGross and totalNet values. |
TextLineItemValue
idString | id of the TextLineItem. |
name | Name of the TextLineItem. |
ValidFromAndUntilValue
validFromString | Date and time (UTC) from when the Discount is effective. |
validUntilString | Date and time (UTC) until when the Discount is effective. |
Type of Change
Associate Roles B2B
ChangeBuyerAssignableChange B2B
typeString | "ChangeBuyerAssignableChange" |
changeString | "changeBuyerAssignable" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
SetNameChange B2B
typeString | "SetNameChange" |
changeString | "setName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetPermissionsChange B2B
typeString | "SetPermissionsChange" |
changeString | "setPermissions" |
previousValueArray of Permission | Value before the change. |
nextValueArray of Permission | Value after the change. |
addedItemsArray of Permission | Elements added to the array. |
removedItemsArray of Permission | Elements removed from the array. |
Business Units B2B
AddInheritedAssociateChange B2B
typeString | "AddInheritedAssociateChange" |
changeString | "addInheritedAssociate" |
nextValue | Value after the change. |
ChangeAssociateChange B2B
ChangeInheritedAssociateChange B2B
typeString | "ChangeInheritedAssociateChange" |
changeString | "changeInheritedAssociate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeAssociateModeChange B2B
typeString | "ChangeAssociateModeChange" |
changeString | "changeAssociateMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeParentUnitChange B2B
typeString | "ChangeParentUnitChange" |
changeString | "changeParentUnit" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeStatusChange B2B
typeString | "ChangeStatusChange" |
changeString | "changeStatus" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveInheritedAssociateChange B2B
typeString | "RemoveInheritedAssociateChange" |
changeString | "removeInheritedAssociate" |
previousValue | The value before the change. |
SetAddressCustomFieldChange B2B
Change triggered by the following update actions:
- Set Address Custom Field on Business Units.
- Set Address Custom Field on Customers.
- Set Address Custom Field on Channels.
typeString | "SetAddressCustomFieldChange" |
changeString | "setAddressCustomField" |
address | Address which was extended. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetAddressCustomTypeChange B2B
Change triggered by the following update actions:
- Set Address Custom Type on Business Units.
- Set Address Custom Type on Customers.
- Set Address Custom Type on Channels.
typeString | "SetAddressCustomTypeChange" |
changeString | "setAddressCustomType" |
address | Address which was extended. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetStoreModeChange B2B
typeString | "SetStoreModeChange" |
changeString | "setStoreMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetContactEmailChange B2B
typeString | "SetContactEmailChange" |
changeString | "setContactEmail" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeApprovalRuleModeChange B2B
typeString | "ChangeApprovalRuleModeChange" |
changeString | "changeApprovalRuleMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetUnitTypeChange B2B
typeString | "SetUnitTypeChange" |
changeString | "setUnitType" |
parentUnit | If unitType="Division", reference to the new parent unit for the Business Unit. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetAssociatesChange B2B
ChangeTopLevelUnitChange B2B
Change triggered by the following update actions:
- Set Unit Type on Business Units
- Change Parent Unit on Business Units
typeString | "ChangeTopLevelUnitChange" |
changeString | "changeTopLevelUnit" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetInheritedStoresChange B2B
storeMode is "FromParent").typeString | "SetInheritedStoresChange" |
changeString | "setInheritedStores" |
addedItemsArray of KeyReference | Elements added to the array. |
removedItemsArray of KeyReference | Elements removed from the array. |
previousValueArray of KeyReference | Value before the change. |
nextValueArray of KeyReference | Value after the change. |
SetInheritedAssociatesChange B2B
typeString | "SetInheritedAssociatesChange" |
changeString | "setInheritedAssociates" |
addedItemsArray of InheritedAssociate | Elements added to the array. |
removedItemsArray of InheritedAssociate | Elements removed from the array. |
previousValueArray of InheritedAssociate | Value before the change. |
nextValueArray of InheritedAssociate | Value after the change. |
Cart Discounts
ChangeCartPredicateChange
typeString | "ChangeCartPredicateChange" |
changeString | "changeCartPredicate" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
typeString | "ChangeIsActiveChange" |
changeString | "changeIsActive" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeRequiresDiscountCodeChange
typeString | "ChangeRequiresDiscountCodeChange" |
changeString | "changeRequiresDiscountCode" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
ChangeSortOrderChange
Change triggered by the following update actions:
- Change Sort Order on Cart Discounts.
- Change Sort Order on Product Discounts.
typeString | "ChangeSortOrderChange" |
changeString | "changeSortOrder" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeStackingModeChange
typeString | "ChangeStackingModeChange" |
changeString | "changeStackingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTargetChange
typeString | "ChangeTargetChange" |
changeString | "changeTarget" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeValueChange
Change triggered by the following update actions:
- Change Value on Cart Discounts.
- Change Value on Product Discounts.
typeString | "ChangeValueChange" |
changeString | "changeValue" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
typeString | "SetValidFromChange" |
changeString | "setValidFrom" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
typeString | "SetValidFromAndUntilChange" |
changeString | "setValidFromAndUntil" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetValidUntilChange
Change triggered by the following update actions:
- Set Valid Until on Cart Discounts.
- Set Valid Until on Discount Codes.
- Set Valid Until on Product Discounts.
typeString | "SetValidUntilChange" |
changeString | "setValidUntil" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
Categories
AddAssetChange
typeString | "AddAssetChange" |
changeString | "addAsset" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
ChangeAssetNameChange
Change triggered by the following update actions:
- Change Asset Name on Categories.
- Change Asset Name on Products.
typeString | "ChangeAssetNameChange" |
changeString | "changeAssetName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
ChangeAssetOrderChange
Change triggered by the following update actions:
- Change Asset Order on Categories.
- Change Asset Order on Products.
typeString | "ChangeAssetOrderChange" |
changeString | "changeAssetOrder" |
previousValueArray of LocalizedString | Value before the change. |
nextValueArray of LocalizedString | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeOrderHintChange
typeString | "ChangeOrderHintChange" |
changeString | "changeOrderHint" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeParentChange
ChangeSlugChange
Change triggered by the following update actions:
- Change Slug on Categories.
- Change Slug on Products.
typeString | "ChangeSlugChange" |
changeString | "changeSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
RemoveAssetChange
Change triggered by the following update actions:
- Remove Asset on Categories.
- Remove Asset on Products.
typeString | "RemoveAssetChange" |
changeString | "removeAsset" |
previousValue | Value before the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetCustomFieldChange
Change triggered by the following update actions:
- Set Asset CustomField on Categories.
- Set Asset CustomField on Products.
typeString | "SetAssetCustomFieldChange" |
changeString | "setAssetCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetCustomTypeChange
Change triggered by the following update actions:
- Set Asset Custom Type on Categories.
- Set Asset Custom Type on Products.
typeString | "SetAssetCustomTypeChange" |
changeString | "setAssetCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetDescriptionChange
Change triggered by the following update actions:
- Set Asset Description on Categories.
- Set Asset Description on Products.
typeString | "SetAssetDescriptionChange" |
changeString | "setAssetDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetKeyChange
Change triggered by the following update actions:
- Set Asset Key on Categories.
- Set Asset Key on Products.
typeString | "SetAssetKeyChange" |
changeString | "setAssetKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetSourcesChange
Change triggered by the following update actions:
- Set Asset Sources on Categories.
- Set Asset Sources on Products.
typeString | "SetAssetSourcesChange" |
changeString | "setAssetSources" |
previousValueArray of AssetSource | Value before the change. |
nextValueArray of AssetSource | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetExternalIdChange
Change triggered by the following update actions:
- Set External ID on Categories.
- Set External ID on Customers.
typeString | "SetExternalIdChange" |
changeString | "setExternalId" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetMetaDescriptionChange
Change triggered by the following update actions:
- Set Meta Description on Categories.
- Set Meta Description on Products.
typeString | "SetMetaDescriptionChange" |
changeString | "setMetaDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetMetaKeywordsChange
Change triggered by the following update actions:
- Set Meta Keywords on Categories.
- Set Meta Keywords on Products.
typeString | "SetMetaKeywordsChange" |
changeString | "setMetaKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetMetaTitleChange
Change triggered by the following update actions:
- Set Meta Title on Categories.
- Set Meta Title on Products.
typeString | "SetMetaTitleChange" |
changeString | "setMetaTitle" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetAncestorsChange
Channels
ChangeLocalizedDescriptionChange
typeString | "ChangeLocalizedDescriptionChange" |
changeString | "changeDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeKeyChange
Change triggered by the following update actions:
- Change Key on Channels.
- Change State key on States.
- Change Key on Types.
typeString | "ChangeKeyChange" |
changeString | "changeKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeReviewRatingStatisticsChange
typeString | "ChangeReviewRatingStatisticsChange" |
changeString | "changeReviewRatingStatistics" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetAddressChange
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetGeoLocationChange
typeString | "SetGeoLocationChange" |
changeString | "setGeoLocation" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetChannelRolesChange
typeString | "SetChannelRolesChange" |
changeString | "setRoles" |
previousValueArray of ChannelRoleEnum | Value before the change. |
nextValueArray of ChannelRoleEnum | Value after the change. |
addedItemsArray of ChannelRoleEnum | Elements added to the array. |
removedItemsArray of ChannelRoleEnum | Elements removed from the array. |
AddChannelRolesChange
typeString | "AddChannelRolesChange" |
changeString | "addRoles" |
previousValueArray of ChannelRoleEnum | Value before the change. |
nextValueArray of ChannelRoleEnum | Value after the change. |
RemoveChannelRolesChange
typeString | "RemoveChannelRolesChange" |
changeString | "removeRoles" |
previousValueArray of ChannelRoleEnum | Value before the change. |
nextValueArray of ChannelRoleEnum | Value after the change. |
Custom Objects PREMIUM
AddPropertyChange
typeString | "AddPropertyChange" |
changeString | "addProperty" |
nextValueAny | Value after the change. |
pathString | Path to the new property that was added. |
RemovePropertyChange
typeString | "RemovePropertyChange" |
changeString | "removeProperty" |
previousValueAny | Value before the change. |
pathString | Path to the property that was removed. |
SetPropertyChange
typeString | "SetPropertyChange" |
changeString | "setProperty" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
pathString | Path to the property that was updated. |
SetValueChange
typeString | "SetValueChange" |
changeString | "setValue" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
Customers
AddAddressChange
typeString | "AddAddressChange" |
changeString | "addAddress" |
nextValue | Value after the change. |
AddBillingAddressIdChange
typeString | "AddBillingAddressIdChange" |
changeString | "addBillingAddressId" |
previousValueArray of String | Value before the change. |
nextValueArray of String | Value after the change. |
address | Address added to billingAddressIds. |
AddShippingAddressIdChange
typeString | "AddShippingAddressIdChange" |
changeString | "addShippingAddressId" |
previousValueArray of String | Value before the change. |
nextValueArray of String | Value after the change. |
address | Address added to shippingAddressIds. |
ChangeAddressChange
ChangeEmailChange
typeString | "ChangeEmailChange" |
changeString | "changeEmail" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
RemoveAddressChange
typeString | "RemoveAddressChange" |
changeString | "removeAddress" |
previousValue | Value before the change. |
RemoveBillingAddressIdChange
typeString | "RemoveBillingAddressIdChange" |
changeString | "removeBillingAddressId" |
previousValueArray of String | Value before the change. |
nextValueArray of String | Value after the change. |
address | Address removed from billingAddressesIds. |
RemoveShippingAddressIdChange
typeString | "RemoveShippingAddressIdChange" |
changeString | "removeShippingAddressId" |
previousValueArray of String | Value before the change. |
nextValueArray of String | Value after the change. |
address | Address removed from shippingAddressesIds. |
SetCompanyNameChange
typeString | "SetCompanyNameChange" |
changeString | "setCompanyName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerGroupChange
Change triggered by the following update actions:
- Set CustomerGroup on Customers.
- Set CustomerGroup on Order Edits.
SetCustomerNumberChange
typeString | "SetCustomerNumberChange" |
changeString | "setCustomerNumber" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetDateOfBirthChange
typeString | "SetDateOfBirthChange" |
changeString | "setDateOfBirth" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetDefaultBillingAddressChange
SetDefaultShippingAddressChange
SetExternalIdChange
Change triggered by the following update actions:
- Set External ID on Categories.
- Set External ID on Customers.
typeString | "SetExternalIdChange" |
changeString | "setExternalId" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetFirstNameChange
typeString | "SetFirstNameChange" |
changeString | "setFirstName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetLastNameChange
typeString | "SetLastNameChange" |
changeString | "setLastName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetLocaleChange
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
SetMiddleNameChange
typeString | "SetMiddleNameChange" |
changeString | "setMiddleName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetSalutationChange
typeString | "SetSalutationChange" |
changeString | "setSalutation" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetStoresChange
typeString | "SetStoresChange" |
changeString | "setStores" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
addedItemsArray of KeyReference | Elements added to the array. |
removedItemsArray of KeyReference | Elements removed from the array. |
SetTitleChange
SetVatIdChange
typeString | "SetVatIdChange" |
changeString | "setVatId" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
VerifyEmailChange
Change triggered by a Customer email verification.
typeString | "VerifyEmailChange" |
changeString | "verifyEmail" |
SetAuthenticationModeChange
typeString | "SetAuthenticationModeChange" |
changeString | "setAuthenticationMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerGroupAssignmentsChange
typeString | "SetCustomerGroupAssignmentsChange" |
changeString | "setCustomerGroupAssignments" |
addedItemsArray of CustomerGroupAssignment | Elements added to the array. |
removedItemsArray of CustomerGroupAssignment | Elements removed from the array. |
previousValueArray of CustomerGroupAssignment | Value before the change. |
nextValueArray of CustomerGroupAssignment | Value after the change. |
SetPasswordChange
typeString | "SetPasswordChange" |
changeString | "setPassword" |
SetAddressCustomFieldChange
Change triggered by the following update actions:
- Set Address Custom Field on Business Units.
- Set Address Custom Field on Customers.
- Set Address Custom Field on Channels.
typeString | "SetAddressCustomFieldChange" |
changeString | "setAddressCustomField" |
address | Address which was extended. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetAddressCustomTypeChange
Change triggered by the following update actions:
- Set Address Custom Type on Business Units.
- Set Address Custom Type on Customers.
- Set Address Custom Type on Channels.
typeString | "SetAddressCustomTypeChange" |
changeString | "setAddressCustomType" |
address | Address which was extended. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Customer Groups
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
typeString | "ChangeNameChange" |
changeString | "changeName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
Discount Codes
ChangeCartDiscountsChange
typeString | "ChangeCartDiscountsChange" |
changeString | "changeCartDiscounts" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
addedItemsArray of Reference | Elements added to the array. |
removedItemsArray of Reference | Elements removed from the array. |
ChangeGroupsChange
typeString | "ChangeGroupsChange" |
changeString | "changeGroups" |
previousValueArray of String | Value before the change. |
nextValueArray of String | Value after the change. |
addedItemsArray of String | Elements added to the array. |
removedItemsArray of String | Elements removed from the array. |
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
typeString | "ChangeIsActiveChange" |
changeString | "changeIsActive" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
SetCartPredicateChange
typeString | "SetCartPredicateChange" |
changeString | "setCartPredicate" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedNameChange
Change triggered by the following update actions:
- Set Name on Discount Codes.
- Set State Name on States.
- Set Name on Stores.
typeString | "SetLocalizedNameChange" |
changeString | "setName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMaxApplicationsChange
typeString | "SetMaxApplicationsChange" |
changeString | "setMaxApplications" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetMaxApplicationsPerCustomerChange
typeString | "SetMaxApplicationsPerCustomerChange" |
changeString | "setMaxApplicationsPerCustomer" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
typeString | "SetValidFromChange" |
changeString | "setValidFrom" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
typeString | "SetValidFromAndUntilChange" |
changeString | "setValidFromAndUntil" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetValidUntilChange
Change triggered by the following update actions:
- Set Valid Until on Cart Discounts.
- Set Valid Until on Discount Codes.
- Set Valid Until on Product Discounts.
typeString | "SetValidUntilChange" |
changeString | "setValidUntil" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetApplicationVersionChange
This change is initiated by background processes when a discount is applied through a Discount Code.
typeString | "SetApplicationVersionChange" |
changeString | "setApplicationVersion" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
Inventories
ChangeQuantityChange
typeString | "ChangeQuantityChange" |
changeString | "changeQuantity" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetExpectedDeliveryChange
typeString | "SetExpectedDeliveryChange" |
changeString | "setExpectedDelivery" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetRestockableInDaysChange
typeString | "SetRestockableInDaysChange" |
changeString | "setRestockableInDays" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetSupplyChannelChange
SetReservationsChange
typeString | "SetReservationsChange" |
changeString | "setReservations" |
previousValueArray of Reservation | Value before the change. |
nextValueArray of Reservation | Value after the change. |
addedItemsArray of Reservation | Elements added to the array. |
removedItemsArray of Reservation | Elements removed from the array. |
SetMaxCartQuantityChange
typeString | "SetMaxCartQuantityChange" |
changeString | "setMaxCartQuantity" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetMinCartQuantityChange
typeString | "SetMinCartQuantityChange" |
changeString | "setMinCartQuantity" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
Orders
AddDeliveryChange
typeString | "AddDeliveryChange" |
changeString | "addDelivery" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddItemShippingAddressesChange
Change triggered by the following update actions:
- Add ItemShippingAddress on Orders.
- Add ItemShippingAddress on Staged Orders.
AddParcelToDeliveryChange
Change triggered by the following update actions:
- Add Parcel on Orders.
- Add Parcel on Staged Orders.
AddPaymentChange
Change triggered by the following update actions:
- Add Payment on Orders.
- Add Payment on Staged Orders.
typeString | "AddPaymentChange" |
changeString | "addPayment" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddReturnInfoChange
Change triggered by the following update actions:
- Add ReturnInfo on Orders.
- Add ReturnInfo on Staged Orders.
typeString | "AddReturnInfoChange" |
changeString | "addReturnInfo" |
nextValue | Value after the change. |
ChangeOrderStateChange
Change triggered by the following update actions:
- Change OrderState on Orders.
- Change OrderState on Staged Orders.
typeString | "ChangeOrderStateChange" |
changeString | "changeOrderState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangePaymentStateChange
Change triggered by the following update actions:
- Change PaymentState on Orders.
- Change PaymentState on Staged Orders.
typeString | "ChangePaymentStateChange" |
changeString | "changePaymentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeShipmentStateChange
Change triggered by the following update actions:
- Change ShipmentState on Orders.
- Change ShipmentState on Staged Orders.
typeString | "ChangeShipmentStateChange" |
changeString | "changeShipmentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveDeliveryItemsChange
typeString | "RemoveDeliveryItemsChange" |
changeString | "removeDelivery" |
previousValue | Value before the change. |
RemoveItemShippingAddressesChange
RemoveParcelFromDeliveryChange
Change triggered by the following update actions:
- Remove Parcel From Delivery on Orders.
- Remove Parcel From Delivery on Staged Orders.
RemovePaymentChange
Change triggered by the following update actions:
- Remove Payment on Orders.
- Remove Payment on Staged Orders.
typeString | "RemovePaymentChange" |
changeString | "removePayment" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetBillingAddressChange
Change triggered by the following update actions:
- Set Billing Address on Orders.
- Set Billing Address on Staged Orders.
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomLineItemCustomFieldChange
Change triggered by the following update actions:
- Set CustomLineItem Custom Type on Orders.
- Set CustomLineItem Custom Type on Staged Orders.
typeString | "SetCustomLineItemCustomFieldChange" |
changeString | "setCustomLineItemCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
customTypeIdString | id of the referenced Type. |
SetCustomLineItemCustomTypeChange
Change triggered by the following update actions:
- Set CustomLineItem CustomField on Orders.
- Set CustomLineItem CustomField on Staged Orders.
typeString | "SetCustomLineItemCustomTypeChange" |
changeString | "setCustomLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
SetCustomLineItemShippingDetailsChange
Change triggered by the following update actions:
- Set CustomLineItem ShippingDetails on Orders.
- Set CustomLineItem ShippingDetails on Staged Orders.
typeString | "SetCustomLineItemShippingDetailsChange" |
changeString | "setCustomLineItemShippingDetails" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItemIdString | id of the updated CustomLineItem. |
customLineItem | Name of the updated CustomLineItem. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerEmailChange
Change triggered by the following update actions:
- Set Customer Email on Orders.
- Set Customer Email on Staged Orders.
typeString | "SetCustomerEmailChange" |
changeString | "setCustomerEmail" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomerIdChange
Change triggered by the following update actions:
- Set Customer ID on Orders.
- Set Customer ID on Staged Orders.
typeString | "SetCustomerIdChange" |
changeString | "setCustomerId" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetDeliveryAddressChange
Change triggered by the following update actions:
- Set DeliveryAddress on Orders.
- Set DeliveryAddress on Staged Orders.
SetDeliveryItemsChange
Change triggered by the following update actions:
- Set Delivery Items on Orders.
- Set Delivery Items on Staged Orders.
typeString | "SetDeliveryItemsChange" |
changeString | "setDeliveryItems" |
previousValueArray of DeliveryItem | Value before the change. |
nextValueArray of DeliveryItem | Value after the change. |
deliveryIdString | id of the updated Delivery. |
SetOrderLineItemCustomFieldChange
Change triggered by the following update actions:
- Set LineItem CustomField on Orders.
- Set LineItem CustomField on Staged Orders.
typeString | "SetOrderLineItemCustomFieldChange" |
changeString | "setLineItemCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
customTypeIdString | id of the referenced Type. |
nameString | Name of the Custom Field. |
lineItem | Name of the Product the Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItemIdString | id of the updated LineItem. |
SetOrderLineItemCustomTypeChange
Change triggered by the following update actions:
- Set LineItem Custom Type on Orders.
- Set LineItem Custom Type on Staged Orders.
typeString | "SetOrderLineItemCustomTypeChange" |
changeString | "setLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItemIdString | id of the updated LineItem. |
SetLineItemShippingDetailsChange
Change triggered by the following update actions:
- Set LineItem ShippingDetails on Orders.
- Set LineItem ShippingDetails on Staged Orders.
typeString | "SetLineItemShippingDetailsChange" |
changeString | "setLineItemShippingDetails" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItemIdString | id of the updated LineItem. |
lineItem | Name of the Product the updated Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetLocaleChange
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
SetOrderNumberChange
Change triggered by the following update actions:
- Set Order Number on Orders.
- Set Order Number on Staged Order.
typeString | "SetOrderNumberChange" |
changeString | "setOrderNumber" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetParcelItemsChange
Change triggered by the following update actions:
- Set Parcel Items on Orders.
- Set Parcel Items on Staged Orders.
typeString | "SetParcelItemsChange" |
changeString | "setParcelItems" |
previousValueArray of DeliveryItem | Value before the change. |
nextValueArray of DeliveryItem | Value after the change. |
parcel | Information about the updated Parcel. |
SetParcelMeasurementsChange
Change triggered by the following update actions:
- SetParcelMeasurements on Orders.
- SetParcelMeasurements on Staged Orders.
typeString | "SetParcelMeasurementsChange" |
changeString | "setParcelMeasurements" |
previousValue | Value before the change. |
nextValue | Value after the change. |
parcel | Information about the updated Parcel. |
SetParcelTrackingDataChange
Change triggered by the following update actions:
- Set Parcel Tracking Data on Orders.
- Set Parcel Tracking Data on Staged Orders.
typeString | "SetParcelTrackingDataChange" |
changeString | "setParcelTrackingData" |
previousValue | Value before the change. |
nextValue | Value after the change. |
parcel | Information about the updated Parcel. |
SetReturnPaymentStateChange
Change triggered by the following update actions:
- Set PaymentShipmentState on Orders.
- Set PaymentShipmentState on Staged Orders.
typeString | "SetReturnPaymentStateChange" |
changeString | "setReturnPaymentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetReturnShipmentStateChange
Change triggered by the following update actions:
- Set ReturnShipmentState on Orders.
- Set ReturnShipmentState on Staged Orders.
typeString | "SetReturnShipmentStateChange" |
changeString | "setReturnShipmentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetShippingAddressChange
Change triggered by the following update actions:
- Set Shipping Address on Orders.
- Set Shipping Address on Staged Orders.
SetStoreChange
typeString | "SetStoreChange" |
changeString | "setStore" |
previousValue | Value before the change. |
nextValue | Value after the change. |
TransitionCustomLineItemStateChange
Change triggered by the following update actions:
typeString | "TransitionCustomLineItemStateChange" |
changeString | "transitionCustomLineItemState" |
previousValueArray of ItemState | Value before the change. |
nextValueArray of ItemState | Value after the change. |
lineItemIdString | id of the updated LineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
stateIdString | id of the State involved in the transition. |
TransitionLineItemStateChange
Change triggered by the following update actions:
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
UpdateSyncInfoChange
Change triggered by the following update actions:
- Update SyncInfo on Orders.
- Update SyncInfo on Staged Orders.
SetLineItemProductKeyChange
typeString | "SetLineItemProductKeyChange" |
changeString | "setLineItemProductKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
lineItemIdString | id of the updated LineItem. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetOrderTaxedPriceChange
typeString | "SetOrderTaxedPriceChange" |
changeString | "setOrderTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode | Indicates how taxes are set on the Cart. |
SetShippingRateInputChange
typeString | "SetShippingRateInputChange" |
changeString | "setShippingRateInput" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetShippingMethodTaxRateChange
SetShippingMethodTaxAmountChange
typeString | "SetShippingMethodTaxAmountChange" |
changeString | "setShippingMethodTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode | "ExternalAmount" |
SetShippingMethodChange
typeString | "SetShippingMethodChange" |
changeString | "setShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetOrderTotalTaxChange
SetLineItemTotalPriceChange
typeString | "SetLineItemTotalPriceChange" |
changeString | "setLineItemTotalPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
lineItemIdString | id of the updated LineItem. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetLineItemTaxRateChange
typeString | "SetLineItemTaxRateChange" |
changeString | "setLineItemTaxRate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
taxMode | "External" |
lineItemIdString | id of the updated LineItem. |
SetLineItemTaxedPriceChange
typeString | "SetLineItemTaxedPriceChange" |
changeString | "setLineItemTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
lineItemIdString | id of the updated LineItem. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetLineItemTaxAmountChange
typeString | "SetLineItemTaxAmountChange" |
changeString | "setLineItemTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
taxMode | "ExternalAmount" |
lineItemIdString | id of the updated LineItem. |
SetLineItemPriceChange
SetLineItemDistributionChannelChange
typeString | "SetLineItemDistributionChannelChange" |
changeString | "setLineItemDistributionChannel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetCustomShippingMethodChange
typeString | "SetCustomShippingMethodChange" |
changeString | "setCustomShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomLineItemTaxRateChange
typeString | "SetCustomLineItemTaxRateChange" |
changeString | "setCustomLineItemTaxRate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
taxMode | "External" |
SetCustomLineItemTaxAmountChange
typeString | "SetCustomLineItemTaxAmountChange" |
changeString | "setCustomLineItemTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
taxMode | "ExternalAmount" |
SetCustomLineItemMoneyChange
typeString | "SetCustomLineItemMoneyChange" |
changeString | "setCustomLineItemMoney" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
SetCountryChange
typeString | "SetCountryChange" |
changeString | "setCountry" |
previousValue | Value before the change. Pattern:^[A-Z]{2}$ |
nextValue | Value after the change. Pattern:^[A-Z]{2}$ |
RemoveOrderLineItemChange
RemoveDiscountCodeChange
typeString | "RemoveDiscountCodeChange" |
changeString | "removeDiscountCode" |
previousValue | Value before the change. |
RemoveCustomLineItemChange
typeString | "RemoveCustomLineItemChange" |
changeString | "removeCustomLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTaxRoundingModeChange
typeString | "ChangeTaxRoundingModeChange" |
changeString | "changeTaxRoundingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTaxModeChange
ChangeTaxCalculationModeChange
typeString | "ChangeTaxCalculationModeChange" |
changeString | "changeTaxCalculationMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeLineItemQuantityChange
ChangeCustomLineItemQuantityChange
typeString | "ChangeCustomLineItemQuantityChange" |
changeString | "changeCustomLineItemQuantity" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
customLineItem | Name of the CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
AddCustomLineItemChange
typeString | "AddCustomLineItemChange" |
changeString | "addCustomLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddDiscountCodeChange
typeString | "AddDiscountCodeChange" |
changeString | "addDiscountCode" |
nextValue | Value after the change. |
AddOrderLineItemChange
SetOrderTotalPriceChange
SetCustomLineItemTaxedPriceChange
typeString | "SetCustomLineItemTaxedPriceChange" |
changeString | "setCustomLineItemTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
SetCustomLineItemTotalPriceChange
typeString | "SetCustomLineItemTotalPriceChange" |
changeString | "setCustomLineItemTotalPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
SetLineItemProductSlugChange
Change triggered automatically due to a user-initiated change.
typeString | "SetLineItemProductSlugChange" |
changeString | "setLineItemProductSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItemIdString | id of the updated LineItem. |
SetLineItemDiscountedPricePerQuantityChange
typeString | "SetLineItemDiscountedPricePerQuantityChange" |
changeString | "setLineItemDiscountedPricePerQuantity" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItemIdString | id of the updated LineItem. |
SetLineItemDiscountedPriceChange
typeString | "SetLineItemDiscountedPriceChange" |
changeString | "setLineItemDiscountedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItemIdString | id of the updated LineItem. |
SetCustomLineItemTaxCategoryChange
typeString | "SetCustomLineItemTaxCategoryChange" |
changeString | "setCustomLineItemTaxCategory" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
SetShippingInfoPriceChange
SetShippingRateChange
typeString | "SetShippingRateChange" |
changeString | "setShippingRate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetShippingInfoTaxedPriceChange
typeString | "SetShippingInfoTaxedPriceChange" |
changeString | "setShippingInfoTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetPurchaseOrderNumberChange
Change triggered by the following update actions:
- Set Purchase Order Number on Orders.
- Set Purchase Order Number on Staged Orders.
typeString | "SetPurchaseOrderNumberChange" |
changeString | "setPurchaseOrderNumber" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
UpdateItemShippingAddressChange
SetShippingCustomFieldChange
typeString | "SetShippingCustomFieldChange" |
changeString | "setShippingCustomField" |
shippingKeyString | shippingKey of the updated Shipping. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetShippingCustomTypeChange
typeString | "SetShippingCustomTypeChange" |
changeString | "setShippingCustomType" |
shippingKeyString | shippingKey of the updated Shipping. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetShippingAddressCustomFieldChange
typeString | "SetShippingAddressCustomFieldChange" |
changeString | "setShippingAddressCustomField" |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetShippingAddressCustomTypeChange
typeString | "SetShippingAddressCustomTypeChange" |
changeString | "setShippingAddressCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetReturnItemLineItemCustomFieldChange
typeString | "SetReturnItemLineItemCustomFieldChange" |
changeString | "setReturnItemCustomField" |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItem | Name of the Product the updated Line Item is based on. |
lineItemIdString | id of the updated LineItem. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetReturnItemLineItemCustomTypeChange
typeString | "SetReturnItemLineItemCustomTypeChange" |
changeString | "setReturnItemCustomType" |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItem | Name of the Product the updated Line Item is based on. |
lineItemIdString | id of the updated LineItem. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetReturnItemCustomLineItemCustomFieldChange
typeString | "SetReturnItemCustomLineItemCustomFieldChange" |
changeString | "setReturnItemCustomField" |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetReturnItemCustomLineItemCustomTypeChange
typeString | "SetReturnItemCustomLineItemCustomTypeChange" |
changeString | "setReturnItemCustomType" |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetReturnInfoChange
typeString | "SetReturnInfoChange" |
changeString | "setReturnInfo" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetParcelCustomFieldChange
typeString | "SetParcelCustomFieldChange" |
changeString | "setParcelCustomField" |
parcel | Information about the updated Parcel. |
customTypeIdString | id of the referenced Type. |
nameString | Name of the Custom Field. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetParcelCustomTypeChange
typeString | "SetParcelCustomTypeChange" |
changeString | "setParcelCustomType" |
parcel | Information about the updated Parcel. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetItemShippingAddressCustomFieldChange
typeString | "SetItemShippingAddressCustomFieldChange" |
changeString | "setItemShippingAddressCustomField" |
addressIdString | id of the updated Address. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetItemShippingAddressCustomTypeChange
typeString | "SetItemShippingAddressCustomTypeChange" |
changeString | "setItemShippingAddressCustomType" |
addressIdString | id of the updated Address. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetDeliveryCustomFieldChange
typeString | "SetDeliveryCustomFieldChange" |
changeString | "setDeliveryCustomField" |
deliveryIdString | id of the updated Delivery. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetDeliveryCustomTypeChange
typeString | "SetDeliveryCustomTypeChange" |
changeString | "setDeliveryCustomType" |
deliveryIdString | id of the updated Delivery. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetDeliveryAddressCustomFieldChange
typeString | "SetDeliveryAddressCustomFieldChange" |
changeString | "setDeliveryAddressCustomField" |
deliveryIdString | id of the updated Delivery. |
addressIdString | id of the updated Address. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetDeliveryAddressCustomTypeChange
SetBillingAddressCustomFieldChange
typeString | "SetBillingAddressCustomFieldChange" |
changeString | "setBillingAddressCustomField" |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetBillingAddressCustomTypeChange
typeString | "SetBillingAddressCustomTypeChange" |
changeString | "setBillingAddressCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangePriceRoundingModeChange
typeString | "ChangePriceRoundingModeChange" |
changeString | "changePriceRoundingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetDiscountOnTotalPriceChange
typeString | "SetDiscountOnTotalPriceChange" |
changeString | "setDiscountOnTotalPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerGroupChange
Change triggered by the following update actions:
- Set CustomerGroup on Customers.
- Set CustomerGroup on Order Edits.
SetCustomLineItemDiscountedPriceChange
typeString | "SetCustomLineItemDiscountedPriceChange" |
changeString | "setCustomLineItemDiscountedPrice" |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomLineItemDiscountedPricePerQuantityChange
typeString | "SetCustomLineItemDiscountedPricePerQuantityChange" |
changeString | "setCustomLineItemDiscountedPricePerQuantity" |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddShippingChange
typeString | "AddShippingChange" |
changeString | "addShipping" |
nextValue | Value after the change. |
RemoveShippingChange
typeString | "RemoveShippingChange" |
changeString | "removeShipping" |
previousValue | Value before the change. |
Payments PREMIUM
AddInterfaceInteractionChange
typeString | "AddInterfaceInteractionChange" |
changeString | "addInterfaceInteraction" |
nextValue | Value after the change. |
AddTransactionChange
typeString | "AddTransactionChange" |
changeString | "addTransaction" |
nextValue | Value after the change. |
ChangeAmountPlannedChange
ChangeTransactionInteractionIdChange
typeString | "ChangeTransactionInteractionIdChange" |
changeString | "changeTransactionInteractionId" |
previousValueString | Value after the change. |
nextValueString | Value before the change. |
transaction | Holds information about the updated Transaction. |
ChangeTransactionStateChange
typeString | "ChangeTransactionStateChange" |
changeString | "changeTransactionState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
transaction | Holds information about the updated Transaction. |
ChangeTransactionTimestampChange
typeString | "ChangeTransactionTimestampChange" |
changeString | "changeTransactionTimestamp" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
transaction | Holds information about the updated Transaction. |
SetAnonymousIdChange
Change triggered by the following update actions:
- Set AnonymousId on Payments.
- Set AnonymousId on Shopping Lists.
typeString | "SetAnonymousIdChange" |
changeString | "setAnonymousId" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerChange
Change triggered by the following update actions:
- Set Customer on Payments.
- Set Customer on Reviews.
- Set Customer on Shopping Lists.
SetInterfaceIdChange
typeString | "SetInterfaceIdChange" |
changeString | "setInterfaceId" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetMethodInfoInterfaceChange
typeString | "SetMethodInfoInterfaceChange" |
changeString | "setMethodInfoInterface" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetMethodInfoMethodChange
typeString | "SetMethodInfoMethodChange" |
changeString | "setMethodInfoMethod" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetMethodInfoNameChange
typeString | "SetMethodInfoNameChange" |
changeString | "setMethodInfoName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetStatusInterfaceCodeChange
typeString | "SetStatusInterfaceCodeChange" |
changeString | "setStatusInterfaceCode" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetStatusInterfaceTextChange
typeString | "SetStatusInterfaceTextChange" |
changeString | "setStatusInterfaceText" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
SetTransactionCustomFieldChange
typeString | "SetTransactionCustomFieldChange" |
changeString | "setTransactionCustomField" |
transaction | Holds information about the updated Transaction. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
SetTransactionCustomTypeChange
typeString | "SetTransactionCustomTypeChange" |
changeString | "setTransactionCustomType" |
transaction | Holds information about the updated Transaction. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Products
AddAssetChange
typeString | "AddAssetChange" |
changeString | "addAsset" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
AddExternalImageChange
typeString | "AddExternalImageChange" |
changeString | "addExternalImage" |
previousValueArray of Image | Value before the change. |
nextValueArray of Image | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
AddToCategoryChange
typeString | "AddToCategoryChange" |
changeString | "addToCategory" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
category | Category to which the Product was added. |
catalogDataString | Product data that was updated.
|
AddVariantChange
typeString | "AddVariantChange" |
changeString | "addVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
ChangeAssetNameChange
Change triggered by the following update actions:
- Change Asset Name on Categories.
- Change Asset Name on Products.
typeString | "ChangeAssetNameChange" |
changeString | "changeAssetName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
ChangeAssetOrderChange
Change triggered by the following update actions:
- Change Asset Order on Categories.
- Change Asset Order on Products.
typeString | "ChangeAssetOrderChange" |
changeString | "changeAssetOrder" |
previousValueArray of LocalizedString | Value before the change. |
nextValueArray of LocalizedString | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
ChangeMasterVariantChange
typeString | "ChangeMasterVariantChange" |
changeString | "changeMasterVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangePriceChange
typeString | "ChangePriceChange" |
changeString | "changePrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
priceIdString | id of the Embedded Price. |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
ChangeReviewRatingStatisticsChange
typeString | "ChangeReviewRatingStatisticsChange" |
changeString | "changeReviewRatingStatistics" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeSlugChange
Change triggered by the following update actions:
- Change Slug on Categories.
- Change Slug on Products.
typeString | "ChangeSlugChange" |
changeString | "changeSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
PublishChange
typeString | "PublishChange" |
changeString | "publish" |
RemoveAssetChange
Change triggered by the following update actions:
- Remove Asset on Categories.
- Remove Asset on Products.
typeString | "RemoveAssetChange" |
changeString | "removeAsset" |
previousValue | Value before the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
RemoveFromCategoryChange
typeString | "RemoveFromCategoryChange" |
changeString | "removeFromCategory" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
category | Category from which the Product was removed. |
catalogDataString | Product data that was updated.
|
RemoveImageChange
typeString | "RemoveImageChange" |
changeString | "removeImage" |
previousValueArray of Image | Value before the change. |
nextValueArray of Image | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
RemoveVariantChange
typeString | "RemoveVariantChange" |
changeString | "removeVariant" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetAssetCustomTypeChange
Change triggered by the following update actions:
- Set Asset Custom Type on Categories.
- Set Asset Custom Type on Products.
typeString | "SetAssetCustomTypeChange" |
changeString | "setAssetCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetCustomFieldChange
Change triggered by the following update actions:
- Set Asset CustomField on Categories.
- Set Asset CustomField on Products.
typeString | "SetAssetCustomFieldChange" |
changeString | "setAssetCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetDescriptionChange
Change triggered by the following update actions:
- Set Asset Description on Categories.
- Set Asset Description on Products.
typeString | "SetAssetDescriptionChange" |
changeString | "setAssetDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetKeyChange
Change triggered by the following update actions:
- Set Asset Key on Categories.
- Set Asset Key on Products.
typeString | "SetAssetKeyChange" |
changeString | "setAssetKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAssetSourcesChange
Change triggered by the following update actions:
- Set Asset Sources on Categories.
- Set Asset Sources on Products.
typeString | "SetAssetSourcesChange" |
changeString | "setAssetSources" |
previousValueArray of AssetSource | Value before the change. |
nextValueArray of AssetSource | Value after the change. |
asset | Information about the updated Asset. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetAttributeChange
typeString | "SetAttributeChange" |
changeString | "setAttribute" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetCategoryOrderHintChange
typeString | "SetCategoryOrderHintChange" |
changeString | "setCategoryOrderHint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
categoryIdString | id of the updated Category. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetDiscountedPriceChange
typeString | "SetDiscountedPriceChange" |
changeString | "setDiscountedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
price | Embedded Price of the ProductVariant. |
SetImageLabelChange
typeString | "SetImageLabelChange" |
changeString | "setImageLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetMetaDescriptionChange
Change triggered by the following update actions:
- Set Meta Description on Categories.
- Set Meta Description on Products.
typeString | "SetMetaDescriptionChange" |
changeString | "setMetaDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetMetaKeywordsChange
Change triggered by the following update actions:
- Set Meta Keywords on Categories.
- Set Meta Keywords on Products.
typeString | "SetMetaKeywordsChange" |
changeString | "setMetaKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetMetaTitleChange
Change triggered by the following update actions:
- Set Meta Title on Categories.
- Set Meta Title on Products.
typeString | "SetMetaTitleChange" |
changeString | "setMetaTitle" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetProductPriceCustomFieldChange
typeString | "SetProductPriceCustomFieldChange" |
changeString | "setProductPriceCustomField" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
customTypeIdString | id of the referenced Type. |
nameString | Name of the Custom Field. |
SetProductPriceCustomTypeChange
typeString | "SetProductPriceCustomTypeChange" |
changeString | "setProductPriceCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
SetProductVariantKeyChange
typeString | "SetProductVariantKeyChange" |
changeString | "setProductVariantKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetSearchKeywordsChange
typeString | "SetSearchKeywordsChange" |
changeString | "setSearchKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
SetSkuChange
typeString | "SetSkuChange" |
changeString | "setSku" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetTaxCategoryChange
SetVariantAvailabilityChange
typeString | "SetVariantAvailabilityChange" |
changeString | "setVariantAvailability" |
previousValue | Value before the change. |
nextValue | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
UnpublishChange
typeString | "UnpublishChange" |
changeString | "unpublish" |
SetPricesChange
typeString | "SetPricesChange" |
changeString | "setPrices" |
previousValueArray of Price | Value before the change. |
nextValueArray of Price | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
addedItemsArray of Price | Elements added to the array. |
removedItemsArray of Price | Elements removed from the array. |
MoveImageToPositionChange
typeString | "MoveImageToPositionChange" |
changeString | "moveImageToPosition" |
previousValueArray of Image | Value before the change. |
nextValueArray of Image | Value after the change. |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
SetVariantExclusionChange
typeString | "SetVariantExclusionChange" |
changeString | "setVariantExclusion" |
product | Reference to the updated Product. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetProductAttributeChange
typeString | "SetProductAttributeChange" |
changeString | "setProductAttribute" |
catalogDataString | Product data that was updated.
|
previousValue | Value before the change. |
nextValue | Value after the change. |
SetPriceModeChange
typeString | "SetPriceModeChange" |
changeString | "setPriceMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetPriceKeyChange
typeString | "SetPriceKeyChange" |
changeString | "setPriceKey" |
catalogDataString | Product data that was updated.
|
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
priceIdString | id of the Embedded Price. |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
RevertStagedVariantChangesChange
typeString | "RevertStagedVariantChangesChange" |
changeString | "revertStagedVariantChanges" |
RevertStagedChangesChange
typeString | "RevertStagedChangesChange" |
changeString | "revertStagedChanges" |
ChangeLastVariantIdChange
typeString | "ChangeLastVariantIdChange" |
changeString | "changeLastVariantId" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
Product Discounts
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
typeString | "ChangeIsActiveChange" |
changeString | "changeIsActive" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangePredicateChange
typeString | "ChangePredicateChange" |
changeString | "changePredicate" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeSortOrderChange
Change triggered by the following update actions:
- Change Sort Order on Cart Discounts.
- Change Sort Order on Product Discounts.
typeString | "ChangeSortOrderChange" |
changeString | "changeSortOrder" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeValueChange
Change triggered by the following update actions:
- Change Value on Cart Discounts.
- Change Value on Product Discounts.
typeString | "ChangeValueChange" |
changeString | "changeValue" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
typeString | "SetValidFromChange" |
changeString | "setValidFrom" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
typeString | "SetValidFromAndUntilChange" |
changeString | "setValidFromAndUntil" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetValidUntilChange
Change triggered by the following update actions:
- Set Valid Until on Cart Discounts.
- Set Valid Until on Discount Codes.
- Set Valid Until on Product Discounts.
typeString | "SetValidUntilChange" |
changeString | "setValidUntil" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetIsValidChange
typeString | "SetIsValidChange" |
changeString | "setIsValid" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
Product Selections
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetProductCountChange
typeString | "SetProductCountChange" |
changeString | "setProductCount" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetVariantSelectionChange
typeString | "SetVariantSelectionChange" |
changeString | "setVariantSelection" |
previousValue | Value before the change. |
nextValue | Value after the change. |
product | Reference to the updated Product. |
AddProductChange
typeString | "AddProductChange" |
changeString | "addProduct" |
nextValue | Value after the change. |
variantSelection | The Product Variants included in the Product Selection. |
RemoveProductChange
typeString | "RemoveProductChange" |
changeString | "removeProduct" |
previousValue | Value before the change. |
ExcludeProductChange
typeString | "ExcludeProductChange" |
changeString | "excludeProduct" |
variantExclusion | |
nextValue | Value after the change. |
Product Types
AddAttributeDefinitionChange
typeString | "AddAttributeDefinitionChange" |
changeString | "addAttributeDefinition" |
nextValue | Value after the change. |
AddLocalizedEnumValueChange
Change triggered by the following update actions:
- Add LocalizableEnumValue to AttributeDefinition on Product Types.
- Add LocalizedEnumValue to FieldDefinition on Types.
typeString | "AddLocalizedEnumValueChange" |
changeString | "addLocalizedEnumValue" |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
AddPlainEnumValueChange
typeString | "AddPlainEnumValueChange" |
changeString | "addPlainEnumValue" |
nextValue | Value after the change. |
attributeNameString | Name of the updated AttributeDefinition. |
ChangeAttributeConstraintChange
typeString | "ChangeAttributeConstraintChange" |
changeString | "changeAttributeConstraint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
attributeNameString | Name of the updated AttributeDefinition. |
ChangeAttributeOrderByNameChange
typeString | "ChangeAttributeOrderByNameChange" |
changeString | "changeAttributeOrderByName" |
previousValueArray of String | Value before the change. |
nextValueArray of String | Value after the change. |
ChangeDescriptionChange
typeString | "ChangeDescriptionChange" |
changeString | "changeDescription" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeInputHintChange
Change triggered by the following update actions:
- Change AttributeDefinition InputHint on Product Types.
- Change InputHint on Types.
typeString | "ChangeInputHintChange" |
changeString | "changeInputHint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeIsSearchableChange
typeString | "ChangeIsSearchableChange" |
changeString | "changeIsSearchable" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
attributeNameString | Name of the updated AttributeDefinition. |
ChangeLabelChange
Change triggered by the following update actions:
- Change AttributeDefinition Label on Product Types.
- Change FieldDefinition Label on Types.
typeString | "ChangeLabelChange" |
changeString | "changeLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types). |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeLocalizedEnumValueLabelChange
Change triggered by the following update actions:
- Change the label of a LocalizedEnumValue on Product Types.
- Change LocalizedEnumValue Label on Types.
typeString | "ChangeLocalizedEnumValueLabelChange" |
changeString | "changeLocalizedEnumValueLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
valueKeyString | Key of the updated values. |
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
typeString | "ChangeNameChange" |
changeString | "changeName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangePlainEnumValueLabelChange
typeString | "ChangePlainEnumValueLabelChange" |
changeString | "changePlainEnumValueLabel" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
attributeNameString | Name of the updated AttributeDefinition. |
valueKeyString | Key of the updated values. |
RemoveAttributeDefinitionChange
typeString | "RemoveAttributeDefinitionChange" |
changeString | "removeAttributeDefinition" |
previousValue | Value before the change. |
RemoveEnumValuesChange
typeString | "RemoveEnumValuesChange" |
changeString | "removeEnumValues" |
previousValue | Value before the change. |
attributeNameString | Name of the updated AttributeDefinition. |
RemoveLocalizedEnumValuesChange
typeString | "RemoveLocalizedEnumValuesChange" |
changeString | "removeEnumValues" |
previousValue | Value before the change. |
attributeNameString | Name of the updated AttributeDefinition. |
SetInputTipChange
typeString | "SetInputTipChange" |
changeString | "setInputTip" |
previousValue | Value before the change. |
nextValue | Value after the change. |
attributeNameString | Name of the updated AttributeDefinition. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangePlainEnumValueOrderChange
typeString | "ChangePlainEnumValueOrderChange" |
changeString | "changePlainEnumValueOrder" |
previousValueArray of AttributePlainEnumValue | Value before the change. |
nextValueArray of AttributePlainEnumValue | Value after the change. |
attributeNameString | Name of the updated AttributeDefinition. |
ChangeLocalizedEnumValueOrderChange
Change triggered by the following update actions:
- Change the order of LocalizedEnumValues on Product Types.
- Change the order of LocalizedEnumValues on Types.
typeString | "ChangeLocalizedEnumValueOrderChange" |
changeString | "changeLocalizedEnumValueOrder" |
previousValueArray of AttributeLocalizedEnumValue | Value before the change. |
nextValueArray of AttributeLocalizedEnumValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
Quote Requests
ChangeQuoteRequestStateChange
typeString | "ChangeQuoteRequestStateChange" |
changeString | "changeQuoteRequestState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
ChangeCustomerChange
Change triggered by the following update actions:
- Change Customer on Quotes
- Change Customer on Quote Requests
Quotes
ChangeQuoteStateChange
typeString | "ChangeQuoteStateChange" |
changeString | "changeQuoteState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RequestQuoteRenegotiationChange
typeString | "RequestQuoteRenegotiationChange" |
changeString | "requestQuoteRenegotiation" |
previousValue | Value before the change. |
nextValue | Value after the change. |
buyerCommentString |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
ChangeCustomerChange
Change triggered by the following update actions:
- Change Customer on Quotes
- Change Customer on Quote Requests
Reviews PREMIUM
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerChange
Change triggered by the following update actions:
- Set Customer on Payments.
- Set Customer on Reviews.
- Set Customer on Shopping Lists.
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetLocaleChange
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
SetRatingChange
typeString | "SetRatingChange" |
changeString | "setRating" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetTargetChange
SetTextChange
typeString | "SetTextChange" |
changeString | "setText" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetTitleChange
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
ChangeIncludedInStatisticsChange
typeString | "ChangeIncludedInStatisticsChange" |
changeString | "changeIncludedInStatistics" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
Shopping Lists PREMIUM
AddShoppingListLineItemChange
typeString | "AddShoppingListLineItemChange" |
changeString | "addLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddTextLineItemChange
typeString | "AddTextLineItemChange" |
changeString | "addTextLineItem" |
nextValue | Value after the change. |
ChangeShoppingListLineItemQuantityChange
typeString | "ChangeShoppingListLineItemQuantityChange" |
changeString | "changeLineItemQuantity" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
lineItem | Holds information about the updated Shopping List Line Item. |
ChangeShoppingListLineItemsOrderChange
typeString | "ChangeShoppingListLineItemsOrderChange" |
changeString | "changeLineItemsOrder" |
previousValueArray of ShoppingListLineItemValue | Value before the change. |
nextValueArray of ShoppingListLineItemValue | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTextLineItemNameChange
typeString | "ChangeTextLineItemNameChange" |
changeString | "changeTextLineItemName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
ChangeTextLineItemQuantityChange
typeString | "ChangeTextLineItemQuantityChange" |
changeString | "changeTextLineItemQuantity" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
ChangeTextLineItemsOrderChange
typeString | "ChangeTextLineItemsOrderChange" |
changeString | "changeTextLineItemsOrder" |
previousValueArray of TextLineItemValue | Value before the change. |
nextValueArray of TextLineItemValue | Value after the change. |
RemoveShoppingListLineItemChange
typeString | "RemoveShoppingListLineItemChange" |
changeString | "removeLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveTextLineItemChange
typeString | "RemoveTextLineItemChange" |
changeString | "removeTextLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetAnonymousIdChange
Change triggered by the following update actions:
- Set AnonymousId on Payments.
- Set AnonymousId on Shopping Lists.
typeString | "SetAnonymousIdChange" |
changeString | "setAnonymousId" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerChange
Change triggered by the following update actions:
- Set Customer on Payments.
- Set Customer on Reviews.
- Set Customer on Shopping Lists.
SetDeleteDaysAfterLastModificationChange
typeString | "SetDeleteDaysAfterLastModificationChange" |
changeString | "setDeleteDaysAfterLastModification" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetShoppingListLineItemCustomFieldChange
typeString | "SetShoppingListLineItemCustomFieldChange" |
changeString | "setLineItemCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
lineItem | Holds information about the updated Shopping List Line Item. |
SetShoppingListLineItemCustomTypeChange
typeString | "SetShoppingListLineItemCustomTypeChange" |
changeString | "setLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Holds information about the updated Shopping List Line Item. |
SetSlugChange
typeString | "SetSlugChange" |
changeString | "setSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetTextLineItemCustomFieldChange
typeString | "SetTextLineItemCustomFieldChange" |
changeString | "setTextLineItemCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
textLineItem | Holds information about the updated Text Line Item. |
SetTextLineItemCustomTypeChange
typeString | "SetTextLineItemCustomTypeChange" |
changeString | "setTextLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
SetTextLineItemDescriptionChange
typeString | "SetTextLineItemDescriptionChange" |
changeString | "setTextLineItemDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
textLineItem | Holds information about the updated Text Line Item. |
SetStoreChange
typeString | "SetStoreChange" |
changeString | "setStore" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLineItemDeactivatedAtChange
typeString | "SetLineItemDeactivatedAtChange" |
changeString | "setLineItemDeactivatedAt" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
lineItem | Holds information about the updated Shopping List Line Item. |
ChangeLineItemNameChange
typeString | "ChangeLineItemNameChange" |
changeString | "changeLineItemName" |
lineItem | Holds information about the updated Shopping List Line Item. |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeLineItemPublishedChange
typeString | "ChangeLineItemPublishedChange" |
changeString | "changeLineItemPublished" |
lineItem | Holds information about the updated Shopping List Line Item. |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
SetBusinessUnitChange
typeString | "SetBusinessUnitChange" |
changeString | "setBusinessUnit" |
previousValue | Value before the change. |
nextValue | Value after the change. |
States PREMIUM
ChangeInitialChange
typeString | "ChangeInitialChange" |
changeString | "changeInitial" |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
ChangeKeyChange
Change triggered by the following update actions:
- Change Key on Channels.
- Change State key on States.
- Change Key on Types.
typeString | "ChangeKeyChange" |
changeString | "changeKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeStateTypeChange
typeString | "ChangeStateTypeChange" |
changeString | "changeType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetLocalizedNameChange
Change triggered by the following update actions:
- Set Name on Discount Codes.
- Set State Name on States.
- Set Name on Stores.
typeString | "SetLocalizedNameChange" |
changeString | "setName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetStateRolesChange
typeString | "SetStateRolesChange" |
changeString | "setRoles" |
previousValueArray of StateRoleEnum | Value before the change. |
nextValueArray of StateRoleEnum | Value after the change. |
addedItemsArray of StateRoleEnum | Elements added to the array. |
removedItemsArray of StateRoleEnum | Elements removed from the array. |
SetTransitionsChange
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Staged Quotes
ChangeStagedQuoteStateChange
typeString | "ChangeStagedQuoteStateChange" |
changeString | "changeStagedQuoteState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetSellerCommentChange
typeString | "SetSellerCommentChange" |
changeString | "setSellerComment" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetValidToChange
typeString | "SetValidToChange" |
changeString | "setValidTo" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
TransitionStateChange
Change triggered by the following update actions:
- Transition State on Orders.
- Transition State on Staged Orders.
- Transition State on Payments.
- Transition State on Products.
- Transition State on Quotes.
- Transition State on Staged Quotes.
- Transition State on Quote Requests.
- Transition State on Reviews.
- Transition State on States.
Stores
ChangeProductSelectionActiveChange
typeString | "ChangeProductSelectionActiveChange" |
changeString | "changeProductSelectionActive" |
productSelection | Reference to the Product Selection which was changed. |
previousValueBoolean | Value before the change. |
nextValueBoolean | Value after the change. |
SetDistributionChannelsChange
typeString | "SetDistributionChannelsChange" |
changeString | "setDistributionChannels" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
addedItemsArray of Reference | Elements added to the array. |
removedItemsArray of Reference | Elements removed from the array. |
SetLanguagesChange
SetLocalizedNameChange
Change triggered by the following update actions:
- Set Name on Discount Codes.
- Set State Name on States.
- Set Name on Stores.
typeString | "SetLocalizedNameChange" |
changeString | "setName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetProductSelectionsChange
typeString | "SetProductSelectionsChange" |
changeString | "setProductSelections" |
previousValueArray of ProductSelectionSetting | Value before the change. |
nextValueArray of ProductSelectionSetting | Value after the change. |
addedItemsArray of ProductSelectionSetting | Elements added to the array. |
removedItemsArray of ProductSelectionSetting | Elements removed from the array. |
SetSupplyChannelsChange
typeString | "SetSupplyChannelsChange" |
changeString | "setSupplyChannels" |
previousValueArray of Reference | Value before the change. |
nextValueArray of Reference | Value after the change. |
addedItemsArray of Reference | Elements added to the array. |
removedItemsArray of Reference | Elements removed from the array. |
SetCustomFieldChange
Change triggered by the following update actions:
- Set CustomField on Cart Discounts.
- Set CustomField on Categories.
- Set CustomField on Channels.
- Set CustomField on Customers.
- Set CustomField on Customer Groups.
- Set CustomField on Discount Codes.
- Set CustomField on Inventories.
- Set CustomField on Orders.
- Set CustomField on Order Edits.
- Set CustomField on Payments.
- Set CustomField on Product Selections.
- Set CustomField on Quotes.
- Set CustomField on Quote Requests.
- Set CustomField on Reviews.
- Set CustomField on Shopping Lists.
- Set CustomField on Staged Orders.
- Set CustomField on Staged Quotes.
- Set CustomField on Stores.
typeString | "SetCustomFieldChange" |
changeString | "setCustomField" |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |
nameString | Name of the Custom Field. |
customTypeIdString | id of the referenced Type. |
SetCustomTypeChange
Change triggered by the following update actions:
- Set Custom Type on Cart Discounts.
- Set Custom Type on Categories.
- Set Custom Type on Channels.
- Set Custom Type on Customers.
- Set Custom Type on Customer Groups.
- Set Custom Type on Discount Codes.
- Set Custom Type on Inventories.
- Set Custom Type on Orders.
- Set Custom Type on Order Edits.
- Set Custom Type on Staged Orders.
- Set Custom Type on Payments.
- Set Custom Type on Product Selections.
- Set Custom Type on Quotes.
- Set Custom Type on Staged Quotes.
- Set Custom Type on Quote Requests.
- Set Custom Type on Reviews.
- Set Custom Type on Shopping Lists.
- Set Custom Type on Stores.
typeString | "SetCustomTypeChange" |
changeString | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCountriesChange
typeString | "SetCountriesChange" |
changeString | "setCountries" |
previousValueArray of StoreCountry | Value before the change. |
nextValueArray of StoreCountry | Value after the change. |
addedItemsArray of StoreCountry | Elements added to the array. |
removedItemsArray of StoreCountry | Elements removed from the array. |
Tax Categories
AddTaxRateChange
typeString | "AddTaxRateChange" |
changeString | "addTaxRate" |
nextValue | Value after the change. |
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
typeString | "ChangeNameChange" |
changeString | "changeName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
RemoveTaxRateChange
typeString | "RemoveTaxRateChange" |
changeString | "removeTaxRate" |
previousValue | Value before the change. |
SetDescriptionChange
Change triggered by the following update actions:
- Set Description on Tax Categories.
- Set Description on Zones.
typeString | "SetDescriptionChange" |
changeString | "setDescription" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ReplaceTaxRateChange
Types PREMIUM
AddEnumValueChange
typeString | "AddEnumValueChange" |
changeString | "addEnumValue" |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition. |
attributeNameString | Name of the updated AttributeDefinition. |
AddFieldDefinitionChange
typeString | "AddFieldDefinitionChange" |
changeString | "addFieldDefinition" |
nextValue | Value after the change. |
AddLocalizedEnumValueChange
Change triggered by the following update actions:
- Add LocalizableEnumValue to AttributeDefinition on Product Types.
- Add LocalizedEnumValue to FieldDefinition on Types.
typeString | "AddLocalizedEnumValueChange" |
changeString | "addLocalizedEnumValue" |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeEnumValueLabelChange
typeString | "ChangeEnumValueLabelChange" |
changeString | "changeEnumValueLabel" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
fieldNameString | Name of the updated FieldDefinition. |
valueKeyString | Key of the updated values. |
attributeNameString | Name of the updated AttributeDefinition. |
ChangeEnumValueOrderChange
typeString | "ChangeEnumValueOrderChange" |
changeString | "changeEnumValueOrder" |
previousValueArray of CustomFieldEnumValue | Value before the change. |
nextValueArray of CustomFieldEnumValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition. |
attributeNameString | Name of the updated AttributeDefinition. |
ChangeFieldDefinitionOrderChange
typeString | "ChangeFieldDefinitionOrderChange" |
changeString | "changeFieldDefinitionOrder" |
previousValueArray of FieldDefinitionOrderValue | Value before the change. |
nextValueArray of FieldDefinitionOrderValue | Value after the change. |
ChangeInputHintChange
Change triggered by the following update actions:
- Change AttributeDefinition InputHint on Product Types.
- Change InputHint on Types.
typeString | "ChangeInputHintChange" |
changeString | "changeInputHint" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeKeyChange
Change triggered by the following update actions:
- Change Key on Channels.
- Change State key on States.
- Change Key on Types.
typeString | "ChangeKeyChange" |
changeString | "changeKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
ChangeLabelChange
Change triggered by the following update actions:
- Change AttributeDefinition Label on Product Types.
- Change FieldDefinition Label on Types.
typeString | "ChangeLabelChange" |
changeString | "changeLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types). |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeLocalizedEnumValueLabelChange
Change triggered by the following update actions:
- Change the label of a LocalizedEnumValue on Product Types.
- Change LocalizedEnumValue Label on Types.
typeString | "ChangeLocalizedEnumValueLabelChange" |
changeString | "changeLocalizedEnumValueLabel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
valueKeyString | Key of the updated values. |
ChangeLocalizedEnumValueOrderChange
Change triggered by the following update actions:
- Change the order of LocalizedEnumValues on Product Types.
- Change the order of LocalizedEnumValues on Types.
typeString | "ChangeLocalizedEnumValueOrderChange" |
changeString | "changeLocalizedEnumValueOrder" |
previousValueArray of AttributeLocalizedEnumValue | Value before the change. |
nextValueArray of AttributeLocalizedEnumValue | Value after the change. |
fieldNameString | Name of the updated FieldDefinition; only present on changes to Types. |
attributeNameString | Name of the updated AttributeDefinition; only present on changes to Product Types. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Product Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
typeString | "ChangeLocalizedNameChange" |
changeString | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveFieldDefinitionChange
typeString | "RemoveFieldDefinitionChange" |
changeString | "removeFieldDefinition" |
previousValue | Value before the change. |
SetLocalizedDescriptionChange
Change triggered by the following update actions:
- Set Description on Cart Discounts.
- Set Description on Categories.
- Set Description on Discount Codes.
- Set Description on Products.
- Set Description on Product Discounts.
- Set Description on Shopping Lists.
- Set Description on States.
- Set Description on Types.
typeString | "SetLocalizedDescriptionChange" |
changeString | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Zones
AddLocationChange
typeString | "AddLocationChange" |
changeString | "addLocation" |
nextValue | Value after the change. |
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
typeString | "ChangeNameChange" |
changeString | "changeName" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
RemoveLocationChange
typeString | "RemoveLocationChange" |
changeString | "removeLocation" |
previousValue | Value before the change. |
SetDescriptionChange
Change triggered by the following update actions:
- Set Description on Tax Categories.
- Set Description on Zones.
typeString | "SetDescriptionChange" |
changeString | "setDescription" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
- Set Key on Cart Discounts.
- Set Key on Categories.
- Set Key on Customers.
- Set Key on Customer Groups.
- Set Key on Discount Codes.
- Set Key on Inventories.
- Set Key on Payments.
- Set Key on Products.
- Set Key on Product Discounts.
- Set Key on Product Selections.
- Set Key on Product Types.
- Set Key on Reviews.
- Set Key on Shopping Lists.
- Set Key on Zones.
typeString | "SetKeyChange" |
changeString | "setKey" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
UnknownChange
Change triggered when the format of changes on an entity is not identified by Audit Log.
typeString | "UnknownChange" |
changeString | Identifier for the type of modification. |
previousValueAny | Value before the change. |
nextValueAny | Value after the change. |