Checkout Comment - Add a comment to the order in Magento 2
The Checkout Comment module for Magento 2 allows you to add a customer comment field during checkout. The comment is saved in the database, displayed in the admin panel, and available in the order history.
Key Features
- Addition of comment field on the checkout page in Magento 2.
- Automatic saving of the comment to the database.
- Displaying the comment in order details in the admin panel.
- Checkout Comment column in the orders grid in Magento Admin.
- Ability to enable and disable the module in Magento configuration.
- SEO optimization - improved customer service and better order management.
Use Cases
The module is suitable for Magento stores that want to allow customers to provide additional information with their order, such as:
- Delivery information (e.g., “Please deliver after 6 PM”)
- Packing notes (e.g., “Wrap as a gift”)
- Special remarks for the order
Configuration and Management
The module allows full management of customer comments through the Magento 2 admin panel. You can:
- Enable or disable the comment field in Magento configuration.
- Review comments on the orders list in the admin panel.
- Search and sort orders by comment content.
Compatibility with Magento 2
The module is designed in accordance with the official guidelines of Magento 2. It does not interfere with the core code of the sales process and does not require modifications to the cart. This ensures full compatibility with future Magento updates and other modules extending checkout.
Wydanie | Community |
---|---|
Kompatybilność | 2.4.7, 2.4.6, 2.4.5, 2.4.4, 2.4.3, 2.4.2, 2.4.1, 2.4.0 |
Installation and Deployment
To install the module, simply:
- Install the module: - Add the composer repository to the configuration by running
composer config repositories.project.checkout.comment vcs https://gitlab.com/magento2ext/magento-2-checkout-comment
Add an access token for the private GitLab repositorycomposer config --auth gitlab-token.gitlab.com
Install the module with composer by runningcomposer require kowal/module-checkoutcomment
Enable the module by runningphp bin/magento module:enable Kowal_CheckoutComment
- Run the commands:
bin/magento setup:upgrade bin/magento setup:di:compile bin/magento cache:flush bin/magento indexer:reindex sales_order_grid
- Go to Kowal.co → Checkout Comment → Settings and enable the module.
Version: 1.0.1
28.01.2025
Fix
Improvement of comment recording in order comment history