Best practices for working with the Commerce Engine config.json file

Version: 10.2

We recommend that you follow best practices when you work with the Commerce Engine configuration file:

  • We recommend that you are familiar with Microsoft .Net Core application configuration framework.

  • Do not add configuration that is applicable to a specific plugin to the config.json file, unless it is required by the Commerce engine startup process. For example, a very specific functional setting such as “maximum qty of an item to purchase” does not belong in the engine config.json file. However, a configuration setting related to third-party service plugin loaded via dependency injection at startup is acceptable.

  • Only modify the config.json file to add new configuration settings, or change the value of existing settings.

  • Always add new configuration settings at the end of the config.json file.

  • Do not remove existing settings or modify the structure of the config.json file.

Do you have some feedback for us?

If you have suggestions for improving this article,