Change types
on Order
Add Discount Code
typeString | "AddDiscountCodeChange" |
changeString | "addDiscountCode" |
nextValue | Value after the change. |
Add Order Line Item
Add Payment
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. |
Add Return Info
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. |
Add Shipping
typeString | "AddShippingChange" |
changeString | "addShipping" |
nextValue | Value after the change. |
Change Discount Type Combination
typeString | "ChangeDiscountTypeCombinationChange" |
changeString | "changeDiscountTypeCombination" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Order State
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. |
Change Payment State
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. |
Change Price Rounding Mode
typeString | "ChangePriceRoundingModeChange" |
changeString | "changePriceRoundingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Shipment State
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. |
Change Tax Calculation Mode
typeString | "ChangeTaxCalculationModeChange" |
changeString | "changeTaxCalculationMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Tax Mode
Change Tax Rounding Mode
typeString | "ChangeTaxRoundingModeChange" |
changeString | "changeTaxRoundingMode" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Remove Discount Code
typeString | "RemoveDiscountCodeChange" |
changeString | "removeDiscountCode" |
previousValue | Value before the change. |
Remove Payment
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. |
Remove Shipping
typeString | "RemoveShippingChange" |
changeString | "removeShipping" |
previousValue | Value before the change. |
Set Country
typeString | "SetCountryChange" |
changeString | "setCountry" |
previousValue | Value before the change. Pattern:^[A-Z]{2}$ |
nextValue | Value after the change. Pattern:^[A-Z]{2}$ |
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 Shipping Method
typeString | "SetCustomShippingMethodChange" |
changeString | "setCustomShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |
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 Customer Email
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. |
Set Customer Group
Change triggered by the following update actions:
- Set CustomerGroup on Customers.
- Set CustomerGroup on Order Edits.
Set Customer ID
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. |
Set Direct Discounts
typeString | "SetDirectDiscountsChange" |
changeString | "setDirectDiscounts" |
addedItemsArray of DirectDiscount | Elements added to the array. |
removedItemsArray of DirectDiscount | Elements removed from the array. |
previousValueArray of DirectDiscount | Value before the change. |
nextValueArray of DirectDiscount | Value after the change. |
Set Discount On Total Price
typeString | "SetDiscountOnTotalPriceChange" |
changeString | "setDiscountOnTotalPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Locale
Change triggered by the following update actions:
- Set Locale on Customers.
- Set Locale on Orders.
- Set Locale on Staged Orders.
- Set Locale on Reviews.
Set Order Number
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. |
Set Order Taxed Price
typeString | "SetOrderTaxedPriceChange" |
changeString | "setOrderTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode | Indicates how taxes are set on the Cart. |
Set Order Total Price
Set Order Total Tax
Set Purchase Order Number
Change triggered by the following update actions:
- Set Purchase Order Number on Carts.
- 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. |
Set Return Info
typeString | "SetReturnInfoChange" |
changeString | "setReturnInfo" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Return Payment State
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. |
Set Return Shipment State
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. |
Set Store
typeString | "SetStoreChange" |
changeString | "setStore" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Taxed Shipping Price
Change triggered when there is a recalculation after an Order Edit.
typeString | "SetTaxedShippingPriceChange" |
changeString | "setTaxedShippingPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Transition State
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.
Update Sync Info
Change triggered by the following update actions:
- Update SyncInfo on Orders.
- Update SyncInfo on Staged Orders.
on Custom LineItem
Add Custom Line Item
typeString | "AddCustomLineItemChange" |
changeString | "addCustomLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Custom Line Item Price Rounding Mode
typeString | "ChangeCustomLineItemPriceRoundingModeChange" |
changeString | "changeCustomLineItemPriceRoundingMode" |
customLineItem | Name of the updated CustomLineItem. |
customLineItemIdString | id of the updated CustomLineItem. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Custom Line Item Quantity
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. |
Remove Custom Line Item
typeString | "RemoveCustomLineItemChange" |
changeString | "removeCustomLineItem" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Custom Line Item Custom Field
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. |
Set Custom Line Item Custom Type
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. |
Set Custom Line Item Discounted Price
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. |
Set Custom Line Item Discounted Price Per Quantity
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. |
Set Custom Line Item Money
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. |
Set Custom Line Item Shipping Details
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. |
Set Custom Line Item Tax Amount
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" |
Set Custom Line Item Tax Category
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. |
Set Custom Line Item Tax Rate
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" |
Set Custom Line Item Taxed Price
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. |
Set Custom Line Item Total Price
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. |
Transition Custom Line Item State
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. |
on LineItem
Change Line Item Price Rounding Mode
typeString | "ChangeLineItemPriceRoundingModeChange" |
changeString | "changeLineItemPriceRoundingMode" |
variantString | Identifier of the updated Product Variant. This field holds the SKU, if defined; otherwise the key; otherwise the ID. |
lineItem | Name of the updated LineItem. |
lineItemIdString | id of the updated LineItem. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Change Line Item Quantity
Remove Order Line Item
Set Line Item Discounted Price
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. |
Set Line Item Discounted Price Per Quantity
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. |
Set Line Item Distribution Channel
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. |
Set Line Item Price
Set Line Item Product Key
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. |
Set Line Item Product Slug
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. |
Set Line Item Shipping Details
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. |
Set Line Item Tax Amount
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. |
Set Line Item Tax Rate
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. |
Set Line Item Taxed Price
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. |
Set Line Item Total Price
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. |
Set Order Line Item Custom Field
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. |
Set Order Line Item Custom Type
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. |
Transition Line Item State
Change triggered by the following update actions:
on ReturnItem
Set Return Item Custom Line Item Custom Field
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. |
Set Return Item Custom Line Item Custom Type
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. |
Set Return Item Line Item Custom Field
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. |
Set Return Item Line Item Custom Type
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. |
on Billing Address
Set Billing Address
Change triggered by the following update actions:
- Set Billing Address on Orders.
- Set Billing Address on Staged Orders.
Set Billing Address Custom Field
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. |
Set Billing Address Custom Type
typeString | "SetBillingAddressCustomTypeChange" |
changeString | "setBillingAddressCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
on Shipping Address
Set Shipping Address
Change triggered by the following update actions:
- Set Shipping Address on Orders.
- Set Shipping Address on Staged Orders.
Set Shipping Address Custom Field
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. |
Set Shipping Address Custom Type
typeString | "SetShippingAddressCustomTypeChange" |
changeString | "setShippingAddressCustomType" |
previousValue | Value before the change. |
nextValue | Value after the change. |
on ItemShipping Address
Add Item Shipping Addresses
Change triggered by the following update actions:
- Add ItemShippingAddress on Orders.
- Add ItemShippingAddress on Staged Orders.
Remove Item Shipping Addresses
Set Item Shipping Address Custom Field
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. |
Set Item Shipping Address Custom Type
typeString | "SetItemShippingAddressCustomTypeChange" |
changeString | "setItemShippingAddressCustomType" |
addressIdString | id of the updated Address. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Update Item Shipping Address
on Delivery
Add Delivery
typeString | "AddDeliveryChange" |
changeString | "addDelivery" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Delivery Custom Field
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. |
Set Delivery Custom Type
typeString | "SetDeliveryCustomTypeChange" |
changeString | "setDeliveryCustomType" |
deliveryIdString | id of the updated Delivery. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Delivery Items
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. |
Remove Delivery Items
typeString | "RemoveDeliveryItemsChange" |
changeString | "removeDelivery" |
previousValue | Value before the change. |
on Parcel
Add Parcel To Delivery
Change triggered by the following update actions:
- Add Parcel on Orders.
- Add Parcel on Staged Orders.
Remove Parcel From Delivery
Change triggered by the following update actions:
- Remove Parcel From Delivery on Orders.
- Remove Parcel From Delivery on Staged Orders.
on Delivery Address
Set Delivery Address
Change triggered by the following update actions:
- Set DeliveryAddress on Orders.
- Set DeliveryAddress on Staged Orders.
Set Delivery Address Custom Field
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. |
Set Delivery Address Custom Type
on Parcel
Set Parcel Custom Field
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. |
Set Parcel Custom Type
typeString | "SetParcelCustomTypeChange" |
changeString | "setParcelCustomType" |
parcel | Information about the updated Parcel. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Parcel Items
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. |
Set Parcel Measurements
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. |
Set Parcel Tracking Data
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. |
on Shipping
Set Shipping Custom Field
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. |
Set Shipping Custom Type
typeString | "SetShippingCustomTypeChange" |
changeString | "setShippingCustomType" |
shippingKeyString | shippingKey of the updated Shipping. |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Shipping Info Discounted Price
Change triggered when a shipping price is modified due to a discount.
typeString | "SetShippingInfoDiscountedPriceChange" |
changeString | "setShippingInfoDiscountedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Shipping Info Price
Set Shipping Info Taxed Price
typeString | "SetShippingInfoTaxedPriceChange" |
changeString | "setShippingInfoTaxedPrice" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Shipping Method
typeString | "SetShippingMethodChange" |
changeString | "setShippingMethod" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Shipping Method Tax Amount
typeString | "SetShippingMethodTaxAmountChange" |
changeString | "setShippingMethodTaxAmount" |
previousValue | Value before the change. |
nextValue | Value after the change. |
taxMode | "ExternalAmount" |
Set Shipping Method Tax Category
Change triggered when the Tax Category of a Shipping Method associated with an Order has changed.
Set Shipping Method Tax Rate
Set Shipping Rate
typeString | "SetShippingRateChange" |
changeString | "setShippingRate" |
previousValue | Value before the change. |
nextValue | Value after the change. |
Set Shipping Rate Input
typeString | "SetShippingRateInputChange" |
changeString | "setShippingRateInput" |
previousValue | Value before the change. |
nextValue | Value after the change. |