Change Types
Changes describe data modifications in the Audit Log Change History API.
Representations
Representations are JSON objects submitted or received as payload to API requests or responses.
Change
Difference between the previous and next version of a resource represented by previousValue
(omitted, for example, on creations) and nextValue
of the associated change. A Change can also contain extra fields that provide further information.
They are not identical to the actual update actions sent.
type String | Unique discriminator value to reliably deserialize the data type. |
change String | Type of change on a resource that is similar to the update action it relates to, where possible.
It is not a unique identifier for the data structure, for example, the Records can be filtered by this value using the |
ChangeValue
AssetChangeValue
id String |
|
name | Name of the Asset. |
CustomFieldExpandedValue
Only present if expand
is set to true
.
name String | Name of the Custom Field. |
value Any | CustomFieldValue based on the FieldType. |
label | User-defined label of the Custom Field. |
CustomShippingMethodChangeValue
name String | Name of the Custom ShippingMethod. |
DeliveryChangeValue
items Array of DeliveryItem | Line Items or Custom Line Items shipped in the Delivery. |
address | Address to which the parcels are delivered. |
parcels Array of Parcel | Parcels included in the Delivery. |
ParcelChangeValue
id String |
|
createdAt String | Date and time (UTC) the Parcel was created. |
ShippingMethodChangeValue
id String |
|
name String | Name of the ShippingMethod. |
TransactionChangeValue
id String |
|
interactionId String | Identifier used by the interface that manages the Transaction (usually the PSP). |
timestamp String | Date and time (UTC) the Transaction took place. |
ChangeValueChangeValue
Indicates how a Cart or Product is discounted:
- ChangeValueAbsoluteChangeValue 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
type String | "absolute" |
money Array of Money | Money values in different currencies. |
ChangeValueRelativeChangeValue
type String | "relative" |
permyriad Int | Fraction (per ten thousand) the price is reduced by. For example, 1000 results in a 10% price reduction. |
ChangeValueGiftLineItemChangeValue
type String | "giftLineItem" |
product | Reference to a Product. |
variantId Int |
|
supplyChannel | Channel with ChannelRoleEnum |
distributionChannel | Channel with ChannelRoleEnum |
ChangeValueExternalChangeValue
type String | "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
ChangeTargetLineItemsChangeValue
type String | "lineItems" |
predicate String | Valid LineItem target predicate. |
ChangeTargetCustomLineItemsChangeValue
type String | "customLineItems" |
predicate String |
ChangeTargetShippingChangeValue
type String | "shipping" |
ChangeTargetMultiBuyLineItemsChangeValue
type String | "multiBuyLineItems" |
predicate String | Valid LineItem target predicate. |
triggerQuantity Int | Quantity of Line Items that triggered the application of the discount. |
discountedQuantity Int | Quantity of Line Items discounted per application of this discount. |
maxOccurrence Int | Maximum number of times the discount is applicable. |
selectionMode | SelectionMode based on which particular Line Items were discounted. |
ChangeTargetMultiBuyCustomLineItemsChangeValue
type String | "multiBuyCustomLineItems" |
predicate String | |
triggerQuantity Int | Quantity of Custom Line Items that triggered the application of the discount. |
discountedQuantity Int | Quantity of Custom Line Items discounted per application of this discount. |
maxOccurrence Int | Maximum number of times the discount is applicable. |
selectionMode | SelectionMode based on which particular Custom Line Items were discounted. |
Embedded values
AttributeValue
name String | Name of the Attribute set. |
value Any | Value set for the Attribute determined by the AttributeType:
|
EnumValue
key String | Key of the value used as a programmatic identifier. |
label String | Descriptive label of the value. |
LocalizedEnumValue
key String | Key of the value used as a programmatic identifier. |
label | Descriptive localized label of the value. |
FieldDefinitionOrderValue
name String | Name of the FieldDefinition. |
label | Descriptive label of the field. |
InventoryQuantityValue
quantityOnStock Int | Overall amount of stock ( |
availableQuantity Int | Available amount of stock ( |
ShoppingListLineItemValue
id String |
|
name | Name of the corresponding Product the Product Variant belongs to. |
variantId Int |
|
SetCartClassificationShippingRateInputValue
key String | Key of the value used as a programmatic identifier. |
type String | "Classification" |
label | Descriptive localized label of the value. |
SetCartScoreShippingRateInputValue
type String | "Score" |
score Int | Abstract value for categorizing a Cart. |
ShippingMethodTaxAmountChangeValue
taxedPrice | Taxed price for the Shipping Method based on |
taxRate | Tax rate set externally for the Shipping Method. |
TaxedPrice
TextLineItemValue
id String |
|
name | Name of the TextLineItem. |
ValidFromAndUntilValue
validFrom String | Date and time (UTC) from when the Discount is effective. |
validUntil String | Date and time (UTC) until when the Discount is effective. |
Type of Change
Associate Roles
ChangeBuyerAssignableChange
Change triggered by the Change BuyerAssignable update action.
type String | "ChangeBuyerAssignableChange" |
change String | "changeBuyerAssignable" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
SetNameChange
Change triggered by the Set Name update action.
type String | "SetNameChange" |
change String | "setName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetPermissionsChange
Change triggered by the Set Permissions, Add Permission, and Remove Permission update actions.
type String | "SetPermissionsChange" |
change String | "setPermissions" |
previousValue Array of Permission | Value before the change. |
nextValue Array of Permission | Value after the change. |
Business Units
AddAssociateChange
Change triggered by the Add Associate update action.
type String | "AddAssociateChange" |
change String | "addAssociate" |
nextValue | Value after the change. |
AddInheritedAssociateChange
Change triggered by the Add Associate update action on a parent of a Business Unit in cases where inheritance applies.
type String | "AddInheritedAssociateChange" |
change String | "addInheritedAssociate" |
nextValue | Value after the change. |
ChangeAssociateChange
Change triggered by the Change Associate update action.
ChangeInheritedAssociateChange
Change triggered by the Change Associate update action on a parent of a Business Unit in cases where inheritance applies.
type String | "ChangeInheritedAssociateChange" |
change String | "changeInheritedAssociate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeAssociateModeChange
Change triggered by the Change Associate Mode update action.
type String | "ChangeAssociateModeChange" |
change String | "changeAssociateMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeParentUnitChange
Change triggered by the Change Parent Unit update action.
type String | "ChangeParentUnitChange" |
change String | "changeParentUnit" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeStatusChange
Change triggered by the Change Status update action.
type String | "ChangeStatusChange" |
change String | "changeStatus" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveAssociateChange
Change triggered by the Remove Associate update action.
type String | "RemoveAssociateChange" |
change String | "removeAssociate" |
previousValue | Value before the change. |
RemoveInheritedAssociateChange
Change triggered by the Remove Associate update action on a parent of a Business Unit in cases where inheritance applies.
type String | "RemoveInheritedAssociateChange" |
change String | "removeInheritedAssociate" |
previousValue | The value before the change. |
SetAddressCustomFieldChange
Change triggered by the Set Address Custom Field update action.
type String | "SetAddressCustomFieldChange" |
change String | "setAddressCustomField" |
address | Address which was extended. |
name String | Name of the Custom Field. |
customTypeId String |
|
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
SetAddressCustomTypeChange
Change triggered by the Set Address Custom Type update action.
type String | "SetAddressCustomTypeChange" |
change String | "setAddressCustomType" |
address | Address which was extended. |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetStoreModeChange
Change triggered by the Set Store Mode update action.
type String | "SetStoreModeChange" |
change String | "setStoreMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetContactEmailChange
Change triggered by the Set Contact Email update action.
type String | "SetContactEmailChange" |
change String | "setContactEmail" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Cart Discounts
ChangeCartPredicateChange
Change triggered by the Change Cart Predicate update action.
type String | "ChangeCartPredicateChange" |
change String | "changeCartPredicate" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
type String | "ChangeIsActiveChange" |
change String | "changeIsActive" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeRequiresDiscountCodeChange
Change triggered by the Change Requires DiscountCode update action.
type String | "ChangeRequiresDiscountCodeChange" |
change String | "changeRequiresDiscountCode" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
ChangeSortOrderChange
Change triggered by the following update actions:
- Change Sort Order on Cart Discounts.
- Change Sort Order on Product Discounts.
type String | "ChangeSortOrderChange" |
change String | "changeSortOrder" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeStackingModeChange
Change triggered by the Change Stacking Mode update action.
type String | "ChangeStackingModeChange" |
change String | "changeStackingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeTargetChange
Change triggered by the Change Target update action.
type String | "ChangeTargetChange" |
change String | "changeTarget" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeValueChange
Change triggered by the following update actions:
- Change Value on Cart Discounts.
- Change Value on Product Discounts.
type String | "ChangeValueChange" |
change String | "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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "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.
type String | "SetLocalizedDescriptionChange" |
change String | "setDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
type String | "SetValidFromChange" |
change String | "setValidFrom" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
type String | "SetValidFromAndUntilChange" |
change String | "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.
type String | "SetValidUntilChange" |
change String | "setValidUntil" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Categories
AddAssetChange
ChangeAssetNameChange
Change triggered by the following update actions:
- Change Asset Name on Categories.
- Change Asset Name on Products.
type String | "ChangeAssetNameChange" |
change String | "changeAssetName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
ChangeAssetOrderChange
Change triggered by the following update actions:
- Change Asset Order on Categories.
- Change Asset Order on Products.
type String | "ChangeAssetOrderChange" |
change String | "changeAssetOrder" |
previousValue Array of LocalizedString | Value before the change. |
nextValue Array of LocalizedString | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeOrderHintChange
Change triggered by the Change OrderHint update action.
type String | "ChangeOrderHintChange" |
change String | "changeOrderHint" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeParentChange
Change triggered by the Change Parent update action.
ChangeSlugChange
Change triggered by the following update actions:
- Change Slug on Categories.
- Change Slug on Products.
type String | "ChangeSlugChange" |
change String | "changeSlug" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveAssetChange
Change triggered by the following update actions:
- Remove Asset on Categories.
- Remove Asset on Products.
type String | "RemoveAssetChange" |
change String | "removeAsset" |
previousValue | Value before the change. |
SetAssetCustomFieldChange
Change triggered by the following update actions:
- Set Asset CustomField on Categories.
- Set Asset CustomField on Products.
type String | "SetAssetCustomFieldChange" |
change String | "setAssetCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
asset | Information about the updated Asset. |
SetAssetCustomTypeChange
Change triggered by the following update actions:
- Set Asset Custom Type on Categories.
- Set Asset Custom Type on Products.
type String | "SetAssetCustomTypeChange" |
change String | "setAssetCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
SetAssetDescriptionChange
Change triggered by the following update actions:
- Set Asset Description on Categories.
- Set Asset Description on Products.
type String | "SetAssetDescriptionChange" |
change String | "setAssetDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
asset | Information about the updated Asset. |
SetAssetKeyChange
Change triggered by the following update actions:
- Set Asset Key on Categories.
- Set Asset Key on Products.
type String | "SetAssetKeyChange" |
change String | "setAssetKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
asset | Information about the updated Asset. |
SetAssetSourcesChange
Change triggered by the following update actions:
- Set Asset Sources on Categories.
- Set Asset Sources on Products.
type String | "SetAssetSourcesChange" |
change String | "setAssetSources" |
previousValue Array of AssetSource | Value before the change. |
nextValue Array of AssetSource | Value after the change. |
asset | Information about the updated Asset. |
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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "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.
type String | "SetLocalizedDescriptionChange" |
change String | "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.
type String | "SetExternalIdChange" |
change String | "setExternalId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetMetaDescriptionChange
Change triggered by the following update actions:
- Set Meta Description on Categories.
- Set Meta Description on Products.
type String | "SetMetaDescriptionChange" |
change String | "setMetaDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMetaKeywordsChange
Change triggered by the following update actions:
- Set Meta Keywords on Categories.
- Set Meta Keywords on Products.
type String | "SetMetaKeywordsChange" |
change String | "setMetaKeywords" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMetaTitleChange
Change triggered by the following update actions:
- Set Meta Title on Categories.
- Set Meta Title on Products.
type String | "SetMetaTitleChange" |
change String | "setMetaTitle" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Channels
ChangeLocalizedDescriptionChange
Change triggered by the Change Description update action.
type String | "ChangeLocalizedDescriptionChange" |
change String | "changeDescription" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeKeyChange
Change triggered by the following update actions:
- Change Key on Channels.
- Change State key on States.
- Change Key on Types.
type String | "ChangeKeyChange" |
change String | "changeKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
ChangeLocalizedNameChange
Change triggered by the following update actions:
- Change Name on Cart Discounts.
- Change Name on Categories.
- Change Name on Channels.
- Change Name on Products.
- Change Name on Product Discounts.
- Change Name on Product Selections.
- Change Name on Shopping Lists.
- Change Name on Zones.
type String | "ChangeLocalizedNameChange" |
change String | "changeName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
ChangeReviewRatingStatisticsChange
type String | "ChangeReviewRatingStatisticsChange" |
change String | "changeReviewRatingStatistics" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetAddressChange
Change triggered by the Set Address update action.
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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetGeoLocationChange
Change triggered by the Set GeoLocation update action.
type String | "SetGeoLocationChange" |
change String | "setGeoLocation" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetChannelRolesChange
Change triggered by the Set Roles update action.
type String | "SetChannelRolesChange" |
change String | "setRoles" |
previousValue Array of ChannelRoleEnum | Value before the change. |
nextValue Array of ChannelRoleEnum | Value after the change. |
AddChannelRolesChange
Change triggered by the Add Roles update action.
type String | "AddChannelRolesChange" |
change String | "addRoles" |
previousValue Array of ChannelRoleEnum | Value before the change. |
nextValue Array of ChannelRoleEnum | Value after the change. |
RemoveChannelRolesChange
Change triggered by the Remove Roles update action.
type String | "RemoveChannelRolesChange" |
change String | "removeRoles" |
previousValue Array of ChannelRoleEnum | Value before the change. |
nextValue Array of ChannelRoleEnum | Value after the change. |
Custom Objects
AddPropertyChange
Change triggered by the Update CustomObject request when a new property is added.
type String | "AddPropertyChange" |
change String | "addProperty" |
nextValue Any | Value after the change. |
path String | Path to the new property that was added. |
RemovePropertyChange
Change triggered by the Update CustomObject request when an existing property is removed.
type String | "RemovePropertyChange" |
change String | "removeProperty" |
previousValue Any | Value before the change. |
path String | Path to the property that was removed. |
SetPropertyChange
Change triggered by the Update CustomObject request when an existing property is updated.
type String | "SetPropertyChange" |
change String | "setProperty" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
path String | Path to the property that was updated. |
SetValueChange
Change triggered by the Update CustomObject request when a value of a property is updated.
type String | "SetValueChange" |
change String | "setValue" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
Customers
AddAddressChange
Change triggered by the Add Address update action.
type String | "AddAddressChange" |
change String | "addAddress" |
nextValue | Value after the change. |
AddBillingAddressIdChange
Change triggered by the Add Billing Address ID update action.
type String | "AddBillingAddressIdChange" |
change String | "addBillingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address added to |
AddShippingAddressIdChange
Change triggered by the Add Shipping Address ID update action.
type String | "AddShippingAddressIdChange" |
change String | "addShippingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address added to |
ChangeAddressChange
Change triggered by the Change Address update action.
ChangeEmailChange
Change triggered by the Change Email update action.
type String | "ChangeEmailChange" |
change String | "changeEmail" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
RemoveAddressChange
Change triggered by the Remove Address update action.
type String | "RemoveAddressChange" |
change String | "removeAddress" |
previousValue | Value before the change. |
RemoveBillingAddressIdChange
Change triggered by the Remove Billing Address ID update action.
type String | "RemoveBillingAddressIdChange" |
change String | "removeBillingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address removed from |
RemoveShippingAddressIdChange
Change triggered by the Remove Shipping Address ID update action.
type String | "RemoveShippingAddressIdChange" |
change String | "removeShippingAddressId" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
address | Address removed from |
SetCompanyNameChange
Change triggered by the Set Company Name update action.
type String | "SetCompanyNameChange" |
change String | "setCompanyName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- 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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomerGroupChange
Change triggered by the Set CustomerGroup update action.
SetCustomerNumberChange
Change triggered by the Set Customer Number update action.
type String | "SetCustomerNumberChange" |
change String | "setCustomerNumber" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetDateOfBirthChange
Change triggered by the Set Date of Birth update action.
type String | "SetDateOfBirthChange" |
change String | "setDateOfBirth" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetDefaultBillingAddressChange
Change triggered by the Set Default Billing Address update action.
SetDefaultShippingAddressChange
Change triggered by the Set Default Shipping Address update action.
SetExternalIdChange
Change triggered by the following update actions:
- Set External ID on Categories.
- Set External ID on Customers.
type String | "SetExternalIdChange" |
change String | "setExternalId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetFirstNameChange
Change triggered by the Set First Name update action.
type String | "SetFirstNameChange" |
change String | "setFirstName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetLastNameChange
Change triggered by Set Last Name update action.
type String | "SetLastNameChange" |
change String | "setLastName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetLocaleChange
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
SetMiddleNameChange
Change triggered by the Set Middle Name update action.
type String | "SetMiddleNameChange" |
change String | "setMiddleName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetSalutationChange
Change triggered by the Set Salutation update action.
type String | "SetSalutationChange" |
change String | "setSalutation" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetStoresChange
Change triggered by the Set Stores update action.
SetTitleChange
SetVatIdChange
Change triggered by the Set Vat ID update action.
type String | "SetVatIdChange" |
change String | "setVatId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
VerifyEmailChange
Change triggered by a Customer email verification.
type String | "VerifyEmailChange" |
change String | "verifyEmail" |
SetAuthenticationModeChange
Change triggered by the Set AuthenticationMode update action.
type String | "SetAuthenticationModeChange" |
change String | "setAuthenticationMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Customer Groups
ChangeNameChange
Change triggered by the following update actions:
- Change Name on Customer Groups.
- Change Name on Product Types.
- Change Name on Tax Categories.
- Change Name on Zones.
type String | "ChangeNameChange" |
change String | "changeName" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- 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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetKeyChange
Change triggered by the following update actions:
type String | "SetKeyChange" |
change String | "setKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
Discount Codes
ChangeCartDiscountsChange
Change triggered by the Change CartDiscounts update action.
ChangeGroupsChange
Change triggered by the Change Groups update action.
type String | "ChangeGroupsChange" |
change String | "changeGroups" |
previousValue Array of String | Value before the change. |
nextValue Array of String | Value after the change. |
ChangeIsActiveChange
Change triggered by the following update actions:
- Change IsActive on Cart Discounts.
- Change IsActive on Discount Codes.
- Change IsActive on Product Discounts.
type String | "ChangeIsActiveChange" |
change String | "changeIsActive" |
previousValue Boolean | Value before the change. |
nextValue Boolean | Value after the change. |
SetCartPredicateChange
Change triggered by the Set Cart Predicate update action.
type String | "SetCartPredicateChange" |
change String | "setCartPredicate" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- 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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "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.
type String | "SetLocalizedDescriptionChange" |
change String | "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.
type String | "SetLocalizedNameChange" |
change String | "setName" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetMaxApplicationsChange
Change triggered by the Set Max Applications update action.
type String | "SetMaxApplicationsChange" |
change String | "setMaxApplications" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetMaxApplicationsPerCustomerChange
Change triggered by the Set Max Applications Per Customer update action.
type String | "SetMaxApplicationsPerCustomerChange" |
change String | "setMaxApplicationsPerCustomer" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetValidFromChange
Change triggered by the following update actions:
- Set Valid From on Cart Discounts.
- Set Valid From on Discount Codes.
- Set Valid From on Product Discounts.
type String | "SetValidFromChange" |
change String | "setValidFrom" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetValidFromAndUntilChange
Change triggered by the following update actions:
- Set Valid From and Until on Cart Discounts.
- Set Valid From and Until on Discount Codes.
- Set Valid From and Until on Product Discounts.
type String | "SetValidFromAndUntilChange" |
change String | "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.
type String | "SetValidUntilChange" |
change String | "setValidUntil" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetApplicationVersionChange
Change triggered automatically due to a user-initiated change.
type String | "SetApplicationVersionChange" |
change String | "setApplicationVersion" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
Inventories
ChangeQuantityChange
Change triggered by the Change Quantity update action.
type String | "ChangeQuantityChange" |
change String | "changeQuantity" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetCustomFieldChange
Change triggered by the following update actions:
- 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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "setCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetExpectedDeliveryChange
Change triggered by the Set ExpectedDelivery update action.
type String | "SetExpectedDeliveryChange" |
change String | "setExpectedDelivery" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetRestockableInDaysChange
Change triggered by the Set RestockableInDays update action.
type String | "SetRestockableInDaysChange" |
change String | "setRestockableInDays" |
previousValue Int | Value before the change. |
nextValue Int | Value after the change. |
SetSupplyChannelChange
Change triggered by the Set SupplyChannel update action.
SetReservationsChange
type String | "SetReservationsChange" |
change String | "setReservations" |
previousValue Array of Reservation | Value before the change. |
nextValue Array of Reservation | Value after the change. |
Orders
AddDeliveryChange
Change triggered by the Add Delivery update action.
type String | "AddDeliveryChange" |
change String | "addDelivery" |
previousValue | Value before the change. |
nextValue | Value after the change. |
AddItemShippingAddressesChange
Change triggered by the following update actions:
- 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.
type String | "AddPaymentChange" |
change String | "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.
type String | "AddReturnInfoChange" |
change String | "addReturnInfo" |
nextValue | Value after the change. |
ChangeOrderStateChange
Change triggered by the following update actions:
- Change OrderState on Orders.
- Change OrderState on Staged Orders.
type String | "ChangeOrderStateChange" |
change String | "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.
type String | "ChangePaymentStateChange" |
change String | "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.
type String | "ChangeShipmentStateChange" |
change String | "changeShipmentState" |
previousValue | Value before the change. |
nextValue | Value after the change. |
RemoveDeliveryItemsChange
Change triggered by the Remove Delivery update action.
type String | "RemoveDeliveryItemsChange" |
change String | "removeDelivery" |
previousValue | Value before the change. |
RemoveItemShippingAddressesChange
Change triggered by the Remove Item Shipping Address update action.
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.
type String | "RemovePaymentChange" |
change String | "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.
type String | "SetCustomFieldChange" |
change String | "setCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customTypeId String |
|
SetCustomLineItemCustomFieldChange
Change triggered by the following update actions:
- Set CustomLineItem Custom Type on Orders.
- Set CustomLineItem Custom Type on Staged Orders.
type String | "SetCustomLineItemCustomFieldChange" |
change String | "setCustomLineItemCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
name String | Name of the Custom Field. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String |
|
SetCustomLineItemCustomTypeChange
Change triggered by the following update actions:
- Set CustomLineItem CustomField on Orders.
- Set CustomLineItem CustomField on Staged Orders.
type String | "SetCustomLineItemCustomTypeChange" |
change String | "setCustomLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItem | Name of the updated CustomLineItem. |
customLineItemId String |
|
SetCustomLineItemShippingDetailsChange
Change triggered by the following update actions:
- Set CustomLineItem ShippingDetails on Orders.
- Set CustomLineItem ShippingDetails on Staged Orders.
type String | "SetCustomLineItemShippingDetailsChange" |
change String | "setCustomLineItemShippingDetails" |
previousValue | Value before the change. |
nextValue | Value after the change. |
customLineItemId String |
|
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.
type String | "SetCustomTypeChange" |
change String | "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.
type String | "SetCustomerEmailChange" |
change String | "setCustomerEmail" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetCustomerIdChange
Change triggered by the following update actions:
- Set Customer ID on Orders.
- Set Customer ID on Staged Orders.
type String | "SetCustomerIdChange" |
change String | "setCustomerId" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetDeliveryAddressChange
Change triggered by the following update actions:
- 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.
type String | "SetDeliveryItemsChange" |
change String | "setDeliveryItems" |
previousValue Array of DeliveryItem | Value before the change. |
nextValue Array of DeliveryItem | Value after the change. |
deliveryId String |
|
SetOrderLineItemCustomFieldChange
Change triggered by the following update actions:
- Set LineItem CustomField on Orders.
- Set LineItem CustomField on Staged Orders.
type String | "SetOrderLineItemCustomFieldChange" |
change String | "setLineItemCustomField" |
previousValue Any | Value before the change. |
nextValue Any | Value after the change. |
customTypeId String |
|
name String | Name of the Custom Field. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
|
SetOrderLineItemCustomTypeChange
Change triggered by the following update actions:
- Set LineItem Custom Type on Orders.
- Set LineItem Custom Type on Staged Orders.
type String | "SetOrderLineItemCustomTypeChange" |
change String | "setLineItemCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
variant String |
|
SetLineItemShippingDetailsChange
Change triggered by the following update actions:
- Set LineItem ShippingDetails on Orders.
- Set LineItem ShippingDetails on Staged Orders.
type String | "SetLineItemShippingDetailsChange" |
change String | "setLineItemShippingDetails" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItemId String |
|
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.
type String | "SetOrderNumberChange" |
change String | "setOrderNumber" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
SetParcelItemsChange
Change triggered by the following update actions:
- Set Parcel Items on Orders.
- Set Parcel Items on Staged Orders.
type String | "SetParcelItemsChange" |
change String | "setParcelItems" |
previousValue Array of DeliveryItem | Value before the change. |
nextValue Array of DeliveryItem | Value after the change. |
parcel | Information about the updated Parcel. |
SetParcelMeasurementsChange
Change triggered by the following update actions:
- SetParcelMeasurements on Orders.
- SetParcelMeasurements on Staged Orders.
type String | "SetParcelMeasurementsChange" |
change String | "setParcelMeasurements" |
previousValue | Value before the change. |
nextValue | Value after the change. |
parcel | Information about the updated Parcel. |
SetParcelTrackingDataChange
Change triggered by the following update actions:
- Set Parcel Tracking Data on Orders.
- Set Parcel Tracking Data on Staged Orders.
type String | "SetParcelTrackingDataChange" |
change String | "setParcelTrackingData" |
previousValue | Value before the change. |
nextValue | Value after the change. |
parcel | Information about the updated Parcel. |
SetReturnPaymentStateChange
Change triggered by the following update actions:
- Set PaymentShipmentState on Orders.
- Set PaymentShipmentState on Staged Orders.
type String | "SetReturnPaymentStateChange" |
change String | "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.
type String | "SetReturnShipmentStateChange" |
change String | "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
TransitionCustomLineItemStateChange
Change triggered by the following update actions:
type String | "TransitionCustomLineItemStateChange" |
change String | "transitionCustomLineItemState" |
previousValue Array of ItemState | Value before the change. |
nextValue Array of ItemState | Value after the change. |
lineItemId String |
|
stateId String |
|
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
type String | "SetLineItemProductKeyChange" |
change String | "setLineItemProductKey" |
previousValue String | Value before the change. |
nextValue String | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
lineItemId String |
|
variant String |
|
SetOrderTaxedPriceChange
type String | "SetOrderTaxedPriceChange" |
change String | "setOrderTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode |
SetShippingRateInputChange
Change triggered by the Set Shipping Rate Input update action.
type String | "SetShippingRateInputChange" |
change String | "setShippingRateInput" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetShippingMethodTaxRateChange
Change triggered by the Set ShippingMethod TaxRate update action.
SetShippingMethodTaxAmountChange
Change triggered by the Set ShippingMethod TaxAmount update action.
type String | "SetShippingMethodTaxAmountChange" |
change String | "setShippingMethodTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode |
|
SetShippingMethodChange
Change triggered by the Set ShippingMethod update action.
type String | "SetShippingMethodChange" |
change String | "setShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |
SetOrderTotalTaxChange
Change triggered by the Set OrderTotalTax update action.
SetLineItemTotalPriceChange
Change triggered by the Set LineItemTotalPrice update action.
type String | "SetLineItemTotalPriceChange" |
change String | "setLineItemTotalPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
SetLineItemTaxRateChange
Change triggered by the Set LineItemTaxRate update action.
type String | "SetLineItemTaxRateChange" |
change String | "setLineItemTaxRate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
|
taxMode |
|
SetLineItemTaxedPriceChange
SetLineItemTaxAmountChange
Change triggered by the Set LineItem TaxAmount update action.
type String | "SetLineItemTaxAmountChange" |
change String | "setLineItemTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
|
taxMode |
|
SetLineItemPriceChange
Change triggered by the Set LineItem Price update action.
type String | "SetLineItemPriceChange" |
change String | "setLineItemPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the updated Line Item is based on. |
SetLineItemDistributionChannelChange
Change triggered by the Set LineItem DistributionChannel update action.
type String | "SetLineItemDistributionChannelChange" |
change String | "setLineItemDistributionChannel" |
previousValue | Value before the change. |
nextValue | Value after the change. |
lineItem | Name of the Product the Line Item is based on. |
variant String |
|
SetCustomShippingMethodChange
Change triggered by the Set Custom ShippingMethod update action.
type String | "SetCustomShippingMethodChange" |
change String | "setCustomShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |