Available since versions 104.17.0 and 105.14.0 of the Akeneo Connector for Adobe Commerce.
The whole configuration of the Akeneo Connector for Adobe Commerce can be exported to a file and imported into another Adobe Commerce environment. This is what you need when you promote a configuration from a Sandbox or Staging environment to Production, when you migrate to a new Adobe Commerce instance, or when you simply want to keep a backup of your connector settings before upgrading the module. Instead of copying parameters and attribute mappings line by line, you export them once and load them where you need them.
Where to find the export and import buttons
Go to Stores > Settings > Configuration > Catalog > Akeneo Connector, and open the General section.
Three buttons are available:
| Button | What it does |
|---|---|
| Export PDF | Downloads a human-readable summary of the connector configuration, for review or for sharing with the Akeneo support team |
| Export JSON | Downloads the connector configuration as a structured JSON file, ready to be imported into another environment |
| Import JSON | Opens a file picker and applies a configuration file previously exported from another environment |
Exporting the configuration
- Open Stores > Settings > Configuration > Catalog > Akeneo Connector
- Open the General section and click Export JSON. The file is downloaded by your browser.
The exported file contains the connector parameters, the mapping tables, and the feature toggles. The configuration of the connector is global to the Adobe Commerce instance, so a single export covers all of it.
Sensitive credentials, such as the Akeneo API client secret and password, are excluded from the export. They have to be entered manually in the target environment, which also prevents you from connecting an environment to the wrong Akeneo instance by mistake.
Importing the configuration
- In the target environment, open Stores > Settings > Configuration > Catalog > Akeneo Connector
- Open the General section, click Import JSON, select the file exported from the source environment, and confirm
- The connector validates the file, applies the values, and displays the message "Akeneo Connector configuration imported successfully."
The connector configuration cache is flushed automatically, so the imported values are active immediately: there is no CLI command to run afterwards.
If the file is not a valid connector export, the import stops and nothing is written: the message "Failed to import configuration: Invalid file format or missing required schema keys." is displayed, and the configuration already in place is left untouched.
Promoting a configuration from Sandbox to Production
- In the source environment, export the configuration with Export JSON
- In the target environment, import that file with Import JSON
- Enter the Akeneo API credentials of the target environment
- Review the settings that usually differ between environments, such as the channel, the locales, and the website mapping
- Save the configuration and run a first structural import to verify the result
An import overwrites the connector configuration already in place. Export the current configuration first if you want to be able to roll back.