Change types that represent data modifications made to the Orders entity.

Change types

on Order

Add Discount Code

Change triggered by the Add DiscountCode update action.
type​
String​
"AddDiscountCodeChange"
change​
String​
"addDiscountCode"
nextValue​

Value after the change.

Add Order Line Item

Change triggered by the Add LineItem update action.
type​
String​
"AddOrderLineItemChange"
change​
String​
"addLineItem"
previousValue​

Value before the change.

nextValue​

Value after the change.

Add Payment

Change triggered by the following update actions:

type​
String​
"AddPaymentChange"
change​
String​
"addPayment"
previousValue​

Value before the change.

nextValue​

Value after the change.

Add Return Info

Change triggered by the following update actions:

type​
String​
"AddReturnInfoChange"
change​
String​
"addReturnInfo"
nextValue​

Value after the change.

Add Shipping

type​
String​
"AddShippingChange"
change​
String​
"addShipping"
nextValue​

Value after the change.

Change Discount Type Combination

Change triggered by the Set Discounts Configuration update action.
type​
String​
"ChangeDiscountTypeCombinationChange"
change​
String​
"changeDiscountTypeCombination"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Order State

Change triggered by the following update actions:

type​
String​
"ChangeOrderStateChange"
change​
String​
"changeOrderState"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Payment State

Change triggered by the following update actions:

type​
String​
"ChangePaymentStateChange"
change​
String​
"changePaymentState"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Price Rounding Mode

Change triggered by the Change Price Rounding Mode update action.
type​
String​
"ChangePriceRoundingModeChange"
change​
String​
"changePriceRoundingMode"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Shipment State

Change triggered by the following update actions:

type​
String​
"ChangeShipmentStateChange"
change​
String​
"changeShipmentState"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Tax Calculation Mode

Change triggered by the Change TaxCalculationMode update action.
type​
String​
"ChangeTaxCalculationModeChange"
change​
String​
"changeTaxCalculationMode"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Tax Mode

Change triggered by the Change TaxMode update action.
type​
String​
"ChangeTaxModeChange"
change​
String​
"changeTaxMode"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Tax Rounding Mode

Change triggered by the Change Tax RoundingMode update action.
type​
String​
"ChangeTaxRoundingModeChange"
change​
String​
"changeTaxRoundingMode"
previousValue​

Value before the change.

nextValue​

Value after the change.

Remove Discount Code

Change triggered by the Remove DiscountCode update action.
type​
String​
"RemoveDiscountCodeChange"
change​
String​
"removeDiscountCode"
previousValue​

Value before the change.

Remove Payment

Change triggered by the following update actions:

type​
String​
"RemovePaymentChange"
change​
String​
"removePayment"
previousValue​

Value before the change.

nextValue​

Value after the change.

Remove Shipping

type​
String​
"RemoveShippingChange"
change​
String​
"removeShipping"
previousValue​

Value before the change.

Set Country

Change triggered by the Set Country update action.
type​
String​
"SetCountryChange"
change​
String​
"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 Set Custom Field update action.
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​
id of the referenced Type.

Set Custom Shipping Method

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.

Set Custom Type

Change triggered by the Set Custom Type update action.
type​
String​
"SetCustomTypeChange"
change​
String​
"setCustomType"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Customer Email

Change triggered by the following update actions:

type​
String​
"SetCustomerEmailChange"
change​
String​
"setCustomerEmail"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Customer Group

type​
String​
"SetCustomerGroupChange"
change​
String​
"setCustomerGroup"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Customer ID

Change triggered by the following update actions:

type​
String​
"SetCustomerIdChange"
change​
String​
"setCustomerId"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Direct Discounts

Change triggered by the Set DirectDiscounts update action.
type​
String​
"SetDirectDiscountsChange"
change​
String​
"setDirectDiscounts"
addedItems​
Array of DirectDiscount​

Elements added to the array.

removedItems​
Array of DirectDiscount​

Elements removed from the array.

previousValue​
Array of DirectDiscount​

Value before the change.

nextValue​
Array of DirectDiscount​

Value after the change.

Set Discount On Total Price

Change triggered by the Add DiscountCode, Remove DiscountCode, Add LineItem, or Remove LineItem update action.
type​
String​
"SetDiscountOnTotalPriceChange"
change​
String​
"setDiscountOnTotalPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Locale

type​
String​
"SetLocaleChange"
change​
String​
"setLocale"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Order Number

Change triggered by the following update actions:

type​
String​
"SetOrderNumberChange"
change​
String​
"setOrderNumber"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Order Taxed Price

type​
String​
"SetOrderTaxedPriceChange"
change​
String​
"setOrderTaxedPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

taxMode​

Indicates how taxes are set on the Cart.

Set Order Total Price

Change triggered automatically due to a user-initiated change.

type​
String​
"SetOrderTotalPriceChange"
change​
String​
"setOrderTotalPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Order Total Tax

Change triggered by the Set OrderTotalTax update action.
type​
String​
"SetOrderTotalTaxChange"
change​
String​
"setOrderTotalTax"
previousValue​

Value before the change.

nextValue​

Value after the change.

taxMode​
"ExternalAmount"

Set Purchase Order Number

Change triggered by the following update actions:

type​
String​
"SetPurchaseOrderNumberChange"
change​
String​
"setPurchaseOrderNumber"
previousValue​
String​

Value before the change.

nextValue​
String​

Value after the change.

Set Return Info

Change triggered by the Set ReturnInfo update action.
type​
String​
"SetReturnInfoChange"
change​
String​
"setReturnInfo"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Return Payment State

Change triggered by the following update actions:

type​
String​
"SetReturnPaymentStateChange"
change​
String​
"setReturnPaymentState"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Return Shipment State

Change triggered by the following update actions:

type​
String​
"SetReturnShipmentStateChange"
change​
String​
"setReturnShipmentState"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Store

Change triggered by the Set Store update action.
type​
String​
"SetStoreChange"
change​
String​
"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.

type​
String​
"SetTaxedShippingPriceChange"
change​
String​
"setTaxedShippingPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

Transition State

Change triggered by the Transition State or Transition State update action.
type​
String​
"TransitionStateChange"
change​
String​
"transitionState"
previousValue​

Value before the change.

nextValue​

Value after the change.

Update Sync Info

Change triggered by the following update actions:

type​
String​
"UpdateSyncInfoChange"
change​
String​
"updateSyncInfo"
nextValue​

Value after the change.

channelId​
String​
id of the updated Channel.

on Custom LineItem

Add Custom Line Item

Change triggered by the Add CustomLineItem update action.
type​
String​
"AddCustomLineItemChange"
change​
String​
"addCustomLineItem"
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Custom Line Item Price Rounding Mode

Change triggered by the Change Price Rounding Mode update action.
type​
String​
"ChangeCustomLineItemPriceRoundingModeChange"
change​
String​
"changeCustomLineItemPriceRoundingMode"
customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Custom Line Item Quantity

Change triggered by the Change CustomLineItem Quantity update action.
type​
String​
"ChangeCustomLineItemQuantityChange"
change​
String​
"changeCustomLineItemQuantity"
previousValue​
Int​

Value before the change.

nextValue​
Int​

Value after the change.

customLineItem​

Name of the CustomLineItem.

customLineItemId​
String​
id of the updated CustomLineItem.

Remove Custom Line Item

Change triggered by the Remove CustomLineItem update action.
type​
String​
"RemoveCustomLineItemChange"
change​
String​
"removeCustomLineItem"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Custom Line Item Custom Field

Change triggered by the following update actions:

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​
id of the updated CustomLineItem.
customTypeId​
String​
id of the referenced Type.

Set Custom Line Item Custom Type

Change triggered by the following update actions:

type​
String​
"SetCustomLineItemCustomTypeChange"
change​
String​
"setCustomLineItemCustomType"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.

Set Custom Line Item Discounted Price

Change triggered after a recalculation of discount on a Custom Line Item.
type​
String​
"SetCustomLineItemDiscountedPriceChange"
change​
String​
"setCustomLineItemDiscountedPrice"
customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Custom Line Item Discounted Price Per Quantity

Change triggered after a recalculation of discount on a Custom Line Item.
type​
String​
"SetCustomLineItemDiscountedPricePerQuantityChange"
change​
String​
"setCustomLineItemDiscountedPricePerQuantity"
customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Custom Line Item Money

Change triggered by the Set CustomLineItem Money update action.
type​
String​
"SetCustomLineItemMoneyChange"
change​
String​
"setCustomLineItemMoney"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.

Set Custom Line Item Shipping Details

Change triggered by the following update actions:

type​
String​
"SetCustomLineItemShippingDetailsChange"
change​
String​
"setCustomLineItemShippingDetails"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItemId​
String​
id of the updated CustomLineItem.
customLineItem​
Name of the updated CustomLineItem.

Set Custom Line Item Tax Amount

Change triggered by the Set CustomLineItem TaxAmount update action.
type​
String​
"SetCustomLineItemTaxAmountChange"
change​
String​
"setCustomLineItemTaxAmount"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
taxMode​
"ExternalAmount"

Set Custom Line Item Tax Category

type​
String​
"SetCustomLineItemTaxCategoryChange"
change​
String​
"setCustomLineItemTaxCategory"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.

Set Custom Line Item Tax Rate

Change triggered by the Set CustomLineItem TaxRate update action.
type​
String​
"SetCustomLineItemTaxRateChange"
change​
String​
"setCustomLineItemTaxRate"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
taxMode​
"External"

Set Custom Line Item Taxed Price

type​
String​
"SetCustomLineItemTaxedPriceChange"
change​
String​
"setCustomLineItemTaxedPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.

Set Custom Line Item Total Price

type​
String​
"SetCustomLineItemTotalPriceChange"
change​
String​
"setCustomLineItemTotalPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.

Transition Custom Line Item State

type​
String​
"TransitionCustomLineItemStateChange"
change​
String​
"transitionCustomLineItemState"
previousValue​
Array of ItemState​

Value before the change.

nextValue​
Array of ItemState​

Value after the change.

lineItemId​
String​
id of the updated LineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
stateId​
String​
id of the State involved in the transition.

on LineItem

Change Line Item Price Rounding Mode

Change triggered by the Change Price Rounding Mode update action.
type​
String​
"ChangeLineItemPriceRoundingModeChange"
change​
String​
"changeLineItemPriceRoundingMode"
variant​
String​

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.
lineItemId​
String​
id of the updated LineItem.
previousValue​

Value before the change.

nextValue​

Value after the change.

Change Line Item Quantity

Change triggered by the Change LineItem Quantity update action.
type​
String​
"ChangeLineItemQuantityChange"
change​
String​
"changeLineItemQuantity"
previousValue​
Int​

Value before the change.

nextValue​
Int​

Value after the change

lineItem​
Name of the Product the updated Line Item is based on.
lineItemId​
String​
id of the updated LineItem.

Remove Order Line Item

Change triggered by the Remove Parcel From Delivery update action.
type​
String​
"RemoveOrderLineItemChange"
change​
String​
"removeLineItem"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Line Item Discounted Price

type​
String​
"SetLineItemDiscountedPriceChange"
change​
String​
"setLineItemDiscountedPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

lineItem​
Name of the Product the Line Item is based on.
variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

lineItemId​
String​
id of the updated LineItem.

Set Line Item Discounted Price Per Quantity

type​
String​
"SetLineItemDiscountedPricePerQuantityChange"
change​
String​
"setLineItemDiscountedPricePerQuantity"
previousValue​

Value before the change.

nextValue​

Value after the change.

lineItem​
Name of the Product the Line Item is based on.
variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

lineItemId​
String​
id of the updated LineItem.

Set Line Item Distribution Channel

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​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Line Item Price

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.
lineItemId​
String​
id of the updated LineItem.

Set Line Item Product Key

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​
id of the updated LineItem.
variant​
String​

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.

type​
String​
"SetLineItemProductSlugChange"
change​
String​
"setLineItemProductSlug"
previousValue​

Value before the change.

nextValue​

Value after the change.

lineItem​
Name of the Product the updated Line Item is based on.
variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

lineItemId​
String​
id of the updated LineItem.

Set Line Item Shipping Details

Change triggered by the following update actions:

type​
String​
"SetLineItemShippingDetailsChange"
change​
String​
"setLineItemShippingDetails"
previousValue​

Value before the change.

nextValue​

Value after the change.

lineItemId​
String​
id of the updated LineItem.
lineItem​
Name of the Product the updated Line Item is based on.
variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Line Item Tax Amount

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​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

taxMode​
"ExternalAmount"
lineItemId​
String​
id of the updated LineItem.

Set Line Item Tax Rate

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​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

taxMode​
"External"
lineItemId​
String​
id of the updated LineItem.

Set Line Item Taxed Price

type​
String​
"SetLineItemTaxedPriceChange"
change​
String​
"setLineItemTaxedPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

lineItem​
Name of the Product the Line Item is based on.
lineItemId​
String​
id of the updated LineItem.
variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

Set Line Item Total Price

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.
lineItemId​
String​
id of the updated LineItem.
variant​
String​

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:

type​
String​
"SetOrderLineItemCustomFieldChange"
change​
String​
"setLineItemCustomField"
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

customTypeId​
String​
id of the referenced Type.
name​
String​
Name of the Custom Field.
lineItem​
Name of the Product the Line Item is based on.
variant​
String​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

lineItemId​
String​
id of the updated LineItem.

Set Order Line Item Custom Type

Change triggered by the following update actions:

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​

Identifier of the updated Product Variant.

This field holds the SKU, if defined; otherwise the key; otherwise the ID.

lineItemId​
String​
id of the updated LineItem.

Transition Line Item State

type​
String​
"TransitionLineItemStateChange"
change​
String​
"transitionLineItemState"
previousValue​
Array of ItemState​

Value before the change.

nextValue​
Array of ItemState​

Value after the change.

lineItemId​
String​
id of the updated LineItem.
stateId​
String​
id of the State involved in the transition.

on ReturnItem

Set Return Item Custom Line Item Custom Field

Change triggered by the Set ReturnItem CustomField update action.
type​
String​
"SetReturnItemCustomLineItemCustomFieldChange"
change​
String​
"setReturnItemCustomField"
customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Return Item Custom Line Item Custom Type

Change triggered by the Set ReturnItem Custom Type update action.
type​
String​
"SetReturnItemCustomLineItemCustomTypeChange"
change​
String​
"setReturnItemCustomType"
customLineItem​
Name of the updated CustomLineItem.
customLineItemId​
String​
id of the updated CustomLineItem.
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Return Item Line Item Custom Field

Change triggered by the Set ReturnItem CustomField update action.
type​
String​
"SetReturnItemLineItemCustomFieldChange"
change​
String​
"setReturnItemCustomField"
variant​
String​

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.
lineItemId​
String​
id of the updated LineItem.
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Return Item Line Item Custom Type

Change triggered by the Set ReturnItem Custom Type update action.
type​
String​
"SetReturnItemLineItemCustomTypeChange"
change​
String​
"setReturnItemCustomType"
variant​
String​

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.
lineItemId​
String​
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:

type​
String​
"SetBillingAddressChange"
change​
String​
"setBillingAddress"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Billing Address Custom Field

Change triggered by the Set Billing Address CustomField update action.
type​
String​
"SetBillingAddressCustomFieldChange"
change​
String​
"setBillingAddressCustomField"
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Billing Address Custom Type

Change triggered by the Set Billing Address Custom Type update action.
type​
String​
"SetBillingAddressCustomTypeChange"
change​
String​
"setBillingAddressCustomType"
previousValue​

Value before the change.

nextValue​

Value after the change.

on Shipping Address

Set Shipping Address

Change triggered by the following update actions:

type​
String​
"SetShippingAddressChange"
change​
String​
"setShippingAddress"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Shipping Address Custom Field

Change triggered by the Set Shipping Address CustomField update action.
type​
String​
"SetShippingAddressCustomFieldChange"
change​
String​
"setShippingAddressCustomField"
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Shipping Address Custom Type

Change triggered by the Set Shipping Address Custom Type update action.
type​
String​
"SetShippingAddressCustomTypeChange"
change​
String​
"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:

type​
String​
"AddItemShippingAddressesChange"
change​
String​
"addItemShippingAddress"
previousValue​

Value before the change.

nextValue​

Value after the change.

Remove Item Shipping Addresses

Change triggered by the Remove Item Shipping Address update action.
type​
String​
"RemoveItemShippingAddressesChange"
change​
String​
"removeItemShippingAddress"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Item Shipping Address Custom Field

Change triggered by the Set ItemShipping Address CustomField update action.
type​
String​
"SetItemShippingAddressCustomFieldChange"
change​
String​
"setItemShippingAddressCustomField"
addressId​
String​
id of the updated Address.
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Item Shipping Address Custom Type

Change triggered by the Set ItemShipping Address Custom Type update action.
type​
String​
"SetItemShippingAddressCustomTypeChange"
change​
String​
"setItemShippingAddressCustomType"
addressId​
String​
id of the updated Address.
previousValue​

Value before the change.

nextValue​

Value after the change.

Update Item Shipping Address

Change triggered by the Update ItemShippingAddress update action.
type​
String​
"UpdateItemShippingAddressChange"
change​
String​
"updateItemShippingAddress"
previousValue​

Value before the change.

nextValue​

Value after the change.

on Delivery

Add Delivery

Change triggered by the Add Delivery update action.
type​
String​
"AddDeliveryChange"
change​
String​
"addDelivery"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Delivery Custom Field

Change triggered by the Set Delivery CustomField update action.
type​
String​
"SetDeliveryCustomFieldChange"
change​
String​
"setDeliveryCustomField"
deliveryId​
String​
id of the updated Delivery.
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Delivery Custom Type

Change triggered by the Set Delivery Custom Type update action.
type​
String​
"SetDeliveryCustomTypeChange"
change​
String​
"setDeliveryCustomType"
deliveryId​
String​
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:

type​
String​
"SetDeliveryItemsChange"
change​
String​
"setDeliveryItems"
previousValue​
Array of DeliveryItem​

Value before the change.

nextValue​
Array of DeliveryItem​

Value after the change.

deliveryId​
String​
id of the updated Delivery.

Remove Delivery Items

Change triggered by the Remove Delivery update action.
type​
String​
"RemoveDeliveryItemsChange"
change​
String​
"removeDelivery"
previousValue​

Value before the change.

on Parcel

Add Parcel To Delivery

Change triggered by the following update actions:

type​
String​
"AddParcelToDeliveryChange"
change​
String​
"addParcelToDelivery"
nextValue​

Value after the change.

deliveryId​
String​
id of the Delivery to which the Parcel was added.

Remove Parcel From Delivery

Change triggered by the following update actions:

type​
String​
"RemoveParcelFromDeliveryChange"
change​
String​
"removeParcelFromDelivery"
previousValue​

Value before the change.

deliveryId​
String​
id of the Delivery from which the Parcel was removed.

on Delivery Address

Set Delivery Address

Change triggered by the following update actions:

type​
String​
"SetDeliveryAddressChange"
change​
String​
"setDeliveryAddress"
previousValue​

Value before the change.

nextValue​

Value after the change.

deliveryId​
String​
id of the updated Delivery.

Set Delivery Address Custom Field

Change triggered by the Set Delivery Address CustomField update action.
type​
String​
"SetDeliveryAddressCustomFieldChange"
change​
String​
"setDeliveryAddressCustomField"
deliveryId​
String​
id of the updated Delivery.
addressId​
String​
id of the updated Address.
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Delivery Address Custom Type

Change triggered by the Set Delivery Address Custom Type update action.
type​
String​
"SetDeliveryAddressCustomTypeChange"
change​
String​
"setDeliveryAddressCustomType"
deliveryId​
String​
id of the updated Delivery.
addressId​
String​
id of the updated Address.
previousValue​

Value before the change.

nextValue​

Value after the change.

on Parcel

Set Parcel Custom Field

Change triggered by the Set Parcel CustomField update action.
type​
String​
"SetParcelCustomFieldChange"
change​
String​
"setParcelCustomField"
parcel​

Information about the updated Parcel.

customTypeId​
String​
id of the referenced Type.
name​
String​
Name of the Custom Field.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Parcel Custom Type

Change triggered by the Set Parcel Custom Type update action.
type​
String​
"SetParcelCustomTypeChange"
change​
String​
"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:

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.

Set Parcel Measurements

Change triggered by the following update actions:

type​
String​
"SetParcelMeasurementsChange"
change​
String​
"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:

type​
String​
"SetParcelTrackingDataChange"
change​
String​
"setParcelTrackingData"
previousValue​

Value before the change.

nextValue​

Value after the change.

parcel​

Information about the updated Parcel.

on Shipping

Set Shipping Custom Field

Change triggered by the Set Shipping CustomField update action.
type​
String​
"SetShippingCustomFieldChange"
change​
String​
"setShippingCustomField"
shippingKey​
String​
shippingKey of the updated Shipping.
name​
String​
Name of the Custom Field.
customTypeId​
String​
id of the referenced Type.
previousValue​
Any​

Value before the change.

nextValue​
Any​

Value after the change.

Set Shipping Custom Type

Change triggered by the Set Shipping Custom Type update action.
type​
String​
"SetShippingCustomTypeChange"
change​
String​
"setShippingCustomType"
shippingKey​
String​
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.

type​
String​
"SetShippingInfoDiscountedPriceChange"
change​
String​
"setShippingInfoDiscountedPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Shipping Info Price

type​
String​
"SetShippingInfoPriceChange"
change​
String​
"setShippingInfoPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Shipping Info Taxed Price

type​
String​
"SetShippingInfoTaxedPriceChange"
change​
String​
"setShippingInfoTaxedPrice"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Shipping Method

Change triggered by the Set ShippingMethod update action.
type​
String​
"SetShippingMethodChange"
change​
String​
"setShippingMethod"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Shipping Method Tax Amount

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​
"ExternalAmount"

Set Shipping Method Tax Category

Change triggered when the Tax Category of a Shipping Method associated with an Order has changed.

type​
String​
"SetShippingMethodTaxCategoryChange"
change​
String​
"setShippingMethodTaxCategory"
taxMode​

Indicates how Tax Rates are set.

previousValue​

Value before the change.

nextValue​

Value after the change.

Set Shipping Method Tax Rate

Change triggered by the Set ShippingMethod TaxRate update action.
type​
String​
"SetShippingMethodTaxRateChange"
change​
String​
"setShippingMethodTaxRate"
previousValue​

Value before the change.

nextValue​

Value after the change.

taxMode​
"External"

Set Shipping Rate

type​
String​
"SetShippingRateChange"
change​
String​
"setShippingRate"
previousValue​

Value before the change.

nextValue​

Value after the change.

Set Shipping Rate Input

Change triggered by the Set Shipping Rate Input update action.
type​
String​
"SetShippingRateInputChange"
change​
String​
"setShippingRateInput"

Value before the change.

Value after the change.