Maintenance Message Banner is an extension for Magento 2 developed by PIT Solutions that enables admin users to inform customers about the maintenance timing or downtime earlier via a banner on top of every page. By default, Magento only provides the option to display maintenance messages at the time of maintenance, which can be disturbing for customers and might affect sales in some way. 

This extension is very easy to use, and it does not require any technical skills. This extension is useful because, by default, Magento doesn't provide such functionality to display the maintenance message earlier. The extension works with all the devices, including touch-based devices. Access to the functionality of this extension can be managed by the user roles of administrators 

 To install the Maintenance Message Banner Extension for Magento 2, follow the steps below. 

1) Download the extension. 

2) Access your web server directories and unzip and upload the content of the zip file to app/code/Pits/MaintenanceMessage directory. 

3) Run the following commands from the SSH terminal of the server to complete the installation. 

1. Enable the module - php bin/magento module:enable Pits_MaintenanceMessage 
2. Update the database schema - php bin/magento setup:upgrade 
3. Generate and pre-compile classes - php bin/magento setup:di:compile 
4. Deploy static files - php bin/magento setup:static-content:deploy 
5. Clear the cache – php bin/magento cache:flush 

 Navigate to Admin STORES > Settings > Configuration > Pits Configuration > Maintenance Manager 

The maintenance message will be displayed in the frontend based on the configuration. Message can be displayed all the time until it is disabled, or it can be scheduled to display within a time interval. Admin will be able to select message type as HTML / TEXT and then style / design it based on the need. 

Configure the message type as TEXT, and then customize the message using the fields such as Message, Font Color and Maintenance Banner Icon accordingly. After configuring the fields, the maintenance message will appear in the frontend like below. 

Configure the message type as HTML. The maintenance message can then be prepared, styled and saved in HTML format with the help of WYSIWYG editor. After saving the configurations, the maintenance message will appear in the frontend like below. 

Time interval configuration allows the display of the maintenance message within a time slot. The Time Interval option can be enabled by setting the dropdown value to Yes and then configuring the datetimes in the Start Time and End Time fields, during which the maintenance message will be displayed. If the date and time are outside the Start Time and End Time, then the message will not be visible in the frontend. This gives you the flexibility to configure the maintenance message earlier and display it without manually enabling it at the time. 

Maintenance Banner extension provides Rest API and GraphQL (PWA) support. Below are the details which will help you use the said features. 

Rest API:

Request URL:

https://<base_url>/index.php/rest/default/V1/maintenancemessage 

 Request Method: GET 

 Sample Response: 

 {

    "message": "This is a sample maintenance message",

    "session": "60",

    "background_color": "#FF5733",

    "text_color": "#FFFFFF",

     "message_type": "text",

     "icon": "https://<base_url>/maintenancemessage/info-icon.png"

} 

 GraphQL: 

 Request URL: https://<base_url>/graphql/ 

 Request Method: POST 

 Query: 

 {

              getMaintenanceMessage {

                     message,

                      session,

                      background_color,

                       text_color,

                      message_type,

                       icon

             }

} 

 Sample Response: 

 {

    "data":  {

        "getMaintenanceMessage": {

             "message": "This is a sample maintenance message",

             "session": "60",

             "background_color": "#FF5733",

             "text_color": "#FFFFFF",

             "message_type": "text",

             "icon": " https://<base_url>/maintenancemessage/info-icon.png "

           }

     }

} 

Magento Community 2.3.x and 2.4.x 

English and other Magento supported language packs.

If you have questions use our contact form in webshopextension.com.