boldcommerce/magento2-ordercomments dev-master

Magento 2 Module to add a comment field above the place order button in the checkout

Type

magento2-module

License

MIT

Requires
Requires (dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

Bold Commerce: Magento 2 Order Comments

Description

This extension allows customers to place a comment during the checkout. The comment field is displayed in the billing step right above the place order button.

Store owners can then see these comments in the backend on the order grid and on the order view page.

Checkout view

comment box closed

comment box opened

Admin panel

admin panel

Installation

composer require "boldcommerce/magento2-ordercomments":"~1.5.0"
php bin/magento module:enable Bold_OrderComment
php bin/magento setup:upgrade

Changelog

1.5.0

  • Third party contribution: Form selector fallback for compatability with external changes that move the comment field #24

1.4.1

  • Third party contribution: Fixed it_IT translation csv #20

1.4.0

  • Third party contribution: Made the comment available in the order list web api V1/orders #18

1.3.0

  • UX changes to the max comment length feature #15
  • Made the comment available in the order detail web api V1/orders/{id} #15

1.2.0

  • added setting to change initial collapse state of comment field (closed/opened/no collapse) #14

1.1.4

  • updated composer.json to allow PHP 7.1

1.1.3

  • Third party contribution: Dutch translations #10
  • Third party contribution: Italian translations #11

1.1.2

  • Fix for fatal error on admin order view page when used with some other extensions #9

1.1.1

  • Third party contribution: Swedish translations and fixes in German translations #5

1.1.0

  • Third party contribution: German translations #2
  • Third party contribution: Optional configuration for maximum comment length #3
  • Third party contribution: Show order comments in customer account #4

1.0.0

initial version

Technical

To take in account third party payment extensions using custom implementations of Magento_Checkout/js/action/place-order.js to submit the order, this extension sends the order comment in a separate request during the validation, before the order is placed. It should therefore work out of the box.

Uninstall

If you installed this module through composer, then you can run php bin/magento module:uninstall Bold_OrderComment to automatically remove the code and drop the columns added by this extension.

note: the uninstall command seems bugged and might get stuck at Removing code from Magento codebase: (It worked fine for me on a 2.1.0 install but not on a 2.1.4 install). When this happens you should exit with ctrl+c and run

composer update
php bin/magento maintenance:disable

See github issue 3544

Alternatively you can manually remove the extension and remove the column bold_order_comment from the tables

  • quote
  • sales_order
  • sales_order_grid

License

MIT