{"id":1568,"date":"2021-02-15T12:26:45","date_gmt":"2021-02-15T12:26:45","guid":{"rendered":"https:\/\/meetanshi.com\/blog\/add-custom-message-to-admin-sales-order-view-invoice-credit-memo-in-magento-2\/"},"modified":"2025-07-17T17:43:08","modified_gmt":"2025-07-17T12:13:08","slug":"add-custom-message-to-admin-sales-order-view-invoice-credit-memo-in-magento-2","status":"publish","type":"post","link":"https:\/\/meetanshi.com\/blog\/add-custom-message-to-admin-sales-order-view-invoice-credit-memo-in-magento-2\/","title":{"rendered":"How to Add Custom Message to Admin Sales Order View, Invoice, and Credit Memo in Magento 2"},"content":{"rendered":"\n

Magento 2 store admins not only strive to make their store convenient to customers but also continuously implement various tactics to make the store convenient for themselves!<\/p>\n\n\n\n

Default Magento 2 provides a user-friendly interface and customization facility for the admin to address their requirements efficiently.<\/p>\n\n\n\n

Store admins tend to improve their stores\u2019 admin panel by customizing admin functionalities, adding custom messages, columns, adding filters or removing them in the grid, etc.<\/p>\n\n\n\n

One such example that I have mentioned here is to add custom message to admin sales order view, invoice, and credit memo in Magento 2.<\/p>\n\n\n\n

For example, you may want to display a custom message when an order contains gift while processing that order from the admin panel.<\/p>\n\n\n\n

Check out the below solution for implementing such examples in your store:<\/p>\n\n\n\n

Steps to Add Custom Message to Admin Sales Order View, Invoice, and Credit Memo in Magento 2<\/h2>\n\n\n\n

Step 1:<\/strong> Create layout files.<\/p>\n\n\n\n

1. Method to add a custom message to admin sales order view<\/p>\n\n\n\n

\"How<\/figure>\n\n\n\n

Create sales_order_view.xml <\/strong>at Vendor\/Module\/view\/adminhtml\/layout\/<\/strong><\/p>\n\n\n\n

<?xml version=\"1.0\"?>\n<page xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" layout=\"admin-2columns-left\"\n      xsi:noNamespaceSchemaLocation=\"urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd\">\n    <body>\n        <referenceBlock name=\"order_info\">\n            <block class=\"Vendor\\Module\\Block\\Adminhtml\\Order\\View\\CustomMessage\" name=\"sales_order_view_custom_msg\"\n                   template=\"order\/view\/customMessage.phtml\"\/>\n        <\/referenceBlock>\n    <\/body>\n<\/page><\/pre>\n\n\n\n
2. Method to add a custom message to the invoice<\/p>\n\n\n\n
\"How<\/figure>\n\n\n\n
Create sales_order_invoice.xml <\/strong>at Vendor\/Module\/view\/adminhtml\/layout\/<\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<page xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n      xsi:noNamespaceSchemaLocation=\"urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd\">\n    <body>\n        <referenceBlock name=\"order_info\">\n            <block class=\"Vendor\\Module\\Block\\Adminhtml\\Order\\View\\CustomMessage\" name=\"invoice_view_custom_msg\"\n                   template=\"order\/view\/customMessage.phtml\"\/>\n        <\/referenceBlock>\n    <\/body>\n<\/page><\/pre>\n\n\n\n
3. Method to add a custom message to the credit memo<\/p>\n\n\n\n
\"How<\/figure>\n\n\n\n
Create sales_order_creditmemo.xml <\/strong>at Vendor\/Module\/view\/adminhtml\/layout\/<\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<page xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n      xsi:noNamespaceSchemaLocation=\"urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd\">\n    <body>\n        <referenceBlock name=\"order_info\">\n            <block class=\"Vendor\\Module\\Block\\Adminhtml\\Order\\View\\CustomMessage\" name=\"credirmemo_view_custom_msg\"\n                   template=\"order\/view\/customMessage.phtml\"\/>\n        <\/referenceBlock>\n    <\/body>\n<\/page><\/pre>\n\n\n\n
Step 2: <\/strong>Now, create customMessage.php<\/strong> at Vendor\/Module\/Block\/Adminhtml\/Order\/View\/<\/strong><\/p>\n\n\n\n
<?php\nnamespace Vendor\\Module\\Block\\Adminhtml\\Order\\View;\nclass customMessage extends \\Magento\\Backend\\Block\\Template\n{\n    \/\/ Here you can fetch order detail if you want to display in order information as an extra detail\n}<\/pre>\n\n\n\n
Step 3: <\/strong>Create customMessage.phtml<\/strong> at Vendor\/Module\/view\/adminhtml\/templates\/order\/view<\/strong><\/p>\n\n\n\n
<h3>This order contains gift<\/h3><\/pre>\n\n\n\n
That\u2019s all!<\/p>\n\n\n\n
In case you want to change the whole layout of the backend, you can add a custom Phtml file in Magento 2 admin panel<\/a>.<\/p>\n\n\n\n
Learn More – Add Custom Block in Admin Sales Order View in Magento 2<\/a><\/p>\n\n\n\n
Feel free to share the solution with Magento Community via social media.<\/p>\n\n\n\n
Thank You.<\/p>\n","protected":false},"excerpt":{"rendered":"
Magento 2 store admins not only strive to make their store convenient to customers but also continuously implement various tactics to make the store convenient…<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[34],"tags":[],"class_list":["post-1568","post","type-post","status-publish","format-standard","hentry","category-magento"],"acf":[],"_links":{"self":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/1568","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/comments?post=1568"}],"version-history":[{"count":4,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/1568\/revisions"}],"predecessor-version":[{"id":16890,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/1568\/revisions\/16890"}],"wp:attachment":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/media?parent=1568"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/categories?post=1568"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/tags?post=1568"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}