Change types that represent data modifications made to the Inventories entity.
Change types
Change Quantity
Change triggered by the Change Quantity update action.
typeString | "ChangeQuantityChange" |
changeString | "changeQuantity" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Custom Field
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. |
Set Custom Type
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. |
Set Expected Delivery
Change triggered by the Set ExpectedDelivery update action.
typeString | "SetExpectedDeliveryChange" |
changeString | "setExpectedDelivery" |
previousValueString | Value before the change. |
nextValueString | Value after the change. |
Set Key
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. |
Set Max Cart Quantity
Change triggered by the Set Inventory Limits update action.
typeString | "SetMaxCartQuantityChange" |
changeString | "setMaxCartQuantity" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
Set Min Cart Quantity
Change triggered by the Set Inventory Limits update action.
typeString | "SetMinCartQuantityChange" |
changeString | "setMinCartQuantity" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
Set Reservations
This change is initiated by background processes after the Add Quantity, Remove Quantity, or Change Quantity update action is performed.
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. |
Set Restockable In Days
Change triggered by the Set RestockableInDays update action.
typeString | "SetRestockableInDaysChange" |
changeString | "setRestockableInDays" |
previousValueInt | Value before the change. |
nextValueInt | Value after the change. |
Set Supply Channel
Change triggered by the Set SupplyChannel update action.