Deprecated Change Types (listed below) will no longer be included in new records but remain filterable for historical records.

Changes:

• For Change Types related to Associate Roles:
  • [API] Added the addedItems and removedItems fields to SetPermissionsChange.
• For Change Types related to Business Units:
  • [API] Added the following: ChangeApprovalRuleModeChange, SetInheritedAssociatesChange, SetInheritedStoresChange, ChangeTopLevelUnitChange, SetUnitTypeChange, SetAssociatesChange.
  • [API] Added the addedItems and removedItems fields to the following: SetStoresChange.
  • [API] Deprecated addAssociateChange and removeAssociateChange in favor of setAssociatesChange.
• For Change Types related to Cart Discounts:
  • [API] Added the addedItems and removedItems fields to the following: SetStoresChange.
• For Change Types related to Categories:
  • [API] Added the following: SetAncestorsChange.
• For Change Types related to Channels:
  • [API] Added the following: SetAddressCustomFieldChange, SetAddressCustomTypeChange.
  • [API] Added the addedItems and removedItems fields to the following: SetChannelRolesChange.
• For Change Types related to Customers:
  • [API] Added the following: SetPasswordChange, SetCustomerGroupAssignmentsChange, SetAddressCustomFieldChange, SetAddressCustomTypeChange.
  • [API] Added the addedItems and removedItems fields to the following: SetStoresChange.
• For Change Types related to Discount Codes:
  • [API] Added the following: SetKeyChange.
  • [API] Added the addedItems and removedItems fields to the following: ChangeCartDiscountsChange, ChangeGroupsChange.
• For Change Types related to Inventories:
  • [API] Added the following: SetKeyChange, SetMaxCartQuantityChange, SetMinCartQuantityChange.
  • [API] Added the addedItems and removedItems fields to the following: SetReservationsChange.
• For Change Types related to Orders:
  • [API] Added the following: AddShippingChange, RemoveShippingChange, SetBillingAddressCustomFieldChange, SetBillingAddressCustomTypeChange, SetCustomLineItemDiscountedPriceChange, SetCustomLineItemDiscountedPricePerQuantityChange, SetDeliveryCustomFieldChange, SetDeliveryCustomTypeChange, SetDeliveryAddressCustomFieldChange, SetDeliveryAddressCustomTypeChange, SetDiscountOnTotalPriceChange, SetItemShippingAddressCustomFieldChange, SetItemShippingAddressCustomTypeChange, SetParcelCustomFieldChange, SetParcelCustomTypeChange, SetReturnInfoChange, SetReturnItemCustomLineItemCustomFieldChange, SetReturnItemCustomLineItemCustomTypeChange, SetReturnItemLineItemCustomFieldChange, SetReturnItemLineItemCustomTypeChange, SetShippingAddressCustomFieldChange, SetShippingAddressCustomTypeChange, SetShippingCustomFieldChange, SetShippingCustomTypeChange, ChangePriceRoundingModeChange, UpdateItemShippingAddressChange.
  • [API] Added the customTypeId field to the following: SetCustomLineItemCustomFieldChange.
  • [API] Added the customLineItem field to the following: SetCustomLineItemShippingDetailsChange.
  • [API] Added the customLineItemId field to the following: TransitionCustomLineItemStateChange.
  • [API] Added the variant field to the following: SetLineItemShippingDetailsChange, SetLineItemTaxedPriceChange, SetLineItemTotalPriceChange.
  • [API] Added the lineItem field to the following: SetLineItemShippingDetailsChange.
  • [API] Added the lineItemId field to the following: SetLineItemTotalPriceChange, SetLineItemDiscountedPriceChange, SetLineItemDiscountedPricePerQuantityChange, SetLineItemPriceChange, SetLineItemProductSlugChange, SetLineItemTaxAmountChange, SetLineItemTaxRateChange, SetOrderLineItemCustomFieldChange, SetOrderLineItemCustomTypeChange.
• For Change Types related to Payments:
  • [API] Added the following: SetTransactionCustomFieldChange, SetTransactionCustomTypeChange.
  • [API] Deprecated changeAmountAuthorizedChange.
• For Change Types related to Products:
  • [API] Added the following: ChangeLastVariantIdChange, RevertStagedChangesChange, RevertStagedVariantChangesChange, SetPriceKeyChange, SetPriceModeChange, SetProductAttributeChange
  • [API] Added the price field to the following: SetDiscountedPriceChange.
  • [API] Added the addedItems and removedItems fields to the following: SetPricesChange.
  • [API] Added the catalogData field to the following: AddToCategoryChange, SetMetaDescriptionChange, SetMetaKeywordsChange, SetMetaTitleChange, ChangeSlugChange, RemoveFromCategoryChange, AddAssetChange, ChangeAssetNameChange, ChangeAssetOrderChange, RemoveAssetChange, SetAssetCustomFieldChange, SetAssetCustomTypeChange, SetAssetDescriptionChange, SetAssetKeyChange, SetAssetSourcesChange, SetAssetTagsChange.
  • [API] Added the variant field to the following: AddAssetChange, ChangeAssetNameChange, ChangeAssetOrderChange, RemoveAssetChange, SetAssetCustomFieldChange, SetAssetCustomTypeChange, SetAssetDescriptionChange, SetAssetKeyChange, SetAssetSourcesChange, SetAssetTagsChange, AddExternalImageChange, ChangePriceChange, MoveImageToPositionChange, RemoveImageChange, SetAttributeChange, SetImageLabelChange, SetSkuChange, SetProductVariantKeyChange, SetProductPriceCustomFieldChange, SetProductPriceCustomTypeChange,
  • [API] Added the customTypeId and name field to the following: SetProductPriceCustomFieldChange.
  • [API] Added the priceId field to the following: SetProductPriceCustomFieldChange, SetProductPriceCustomTypeChange.
  • [API] Deprecated addPriceChange and removePriceChange in favor of setPricesChange.
• For Change Types related to Product Selections:
  • [API] Added the following: SetVariantExclusionChange, ExcludeProductChange.
• For Change Types related to Product Types:
  • [API] Added the attributeName field to the following: ChangeEnumValueLabelChange, ChangeEnumValueOrderChange.
• For Change Types related to Quotes:
  • [API] Added the following: ChangeCustomerChange.
• For Change Types related to Quote Requests:
  • [API] Added the following: ChangeCustomerChange.
• For Change Types related to Reviews:
  • [API] Added the following: ChangeIncludedInStatisticsChange.
• For Change Types related to Shopping Lists:
  • [API] Added the following: SetBusinessUnitChange, ChangeLineItemNameChange, ChangeLineItemPublishedChange.
• For Change Types related to States:
  • [API] Added the addedItems and removedItems fields to the following: SetStateRolesChange, SetTransitionsChange.
  • [API] Deprecated addRolesChange and removeRolesChange in favor of setRolesChange.
• For Change Types related to Stores:
  • [API] Added the addedItems and removedItems fields to the following: SetCountriesChange, SetDistributionChannelsChange, SetLanguagesChange, SetProductSelectionsChange, SetSupplyChannelsChange.
  • [API] Deprecated addProductSelectionChange and removeProductSelectionChange in favor of setProductSelectionsChange.
• For Change Types related to Tax Categories:
  • [API] Added the following: ReplaceTaxRateChange.
• For Change Types related to Types:
  • [API] Added the attributeName field to the following: AddEnumValueChange.