Obsolete and removed APIs, classes, and methods

Note

The Retail Interest Group by Dynamics 365 Commerce has moved from Yammer to Viva Engage. If you don't have access to the new Viva Engage community, fill out this form (https://aka.ms/JoinD365commerceVivaEngageCommunity) to be added and stay engaged in the latest discussions.

This article lists the obsolete and removed APIs, classes, and methods in Microsoft Dynamics 365 Commerce.

Several APIs, classes, and methods are either removed or marked as obsolete in Dynamics 365 Commerce. As Dynamics 365 Commerce changes over time, each new version adds new APIs, classes, and methods that provide new functionality. Existing APIs, classes, and methods also change over time. For example, some APIs become less important as the functionality that they support is replaced by new functionality, whereas other methods are superseded by newer methods that are superior in some way or use different underlying technologies to provide better performance and reliability.

Dynamics 365 Commerce strives to support backward compatibility, so that extensions that you developed by using one version of Commerce can run on the next version. However, backward compatibility makes it difficult to remove APIs, classes, or methods. Instead, Dynamics 365 Commerce marks an API, class, or method as obsolete or deprecated. (The terms obsolete and deprecated have the same meaning when they apply to .NET types and members.) By using this approach, developers are aware that the API, class, or method will go away, and they have time to prepare for its removal.

Obsolete attribute

In Dynamic 365 Commerce, mark an API, class, or method as obsolete by applying the Obsolete attribute to it. This attribute indicates that the API, class, or method will be removed in a future version of Dynamic 365 Commerce.

Handling obsolete types and members

When you upgrade and recompile existing code, you might receive a compiler warning message if you use an obsolete API, class, or method in your extension. However, it's acceptable to use the obsolete API, class, or method until it's removed. Review the warning message to determine whether you should change your extension code. If the warning message doesn't point to a suitable alternative, follow one of these steps:

If you can, change your code so that the API, class, or method is no longer used.
Review the documentation for this area to determine how to respond to the deprecation.