Differences

This shows you the differences between two versions of the page.

--- magento2:extensions:toweringmedia-module-backorder [2026/05/20 18:10] – created - external edit 127.0.0.1
+++ magento2:extensions:toweringmedia-module-backorder [2026/05/28 19:08] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Magento 2 Back-in-Stock Notifications Extension User Guide ======
-===== Extension context =====
+This user guide provides an overview of the Toweringmedia Backorder Extension for Magento 2 (``toweringmedia/module-backorder``). The extension allows customers to subscribe for back-in-stock notifications using email alerts and optional Twilio-powered SMS notifications.
-This guide covers the Toweringmedia Backorder extension (`toweringmedia/module-backorder`) for Magento 2.4, including email-based back-in-stock alerts and optional Twilio SMS notifications.
+===== Extension Overview =====
-===== Product page =====
+The Toweringmedia Backorder Extension enhances the Magento 2 shopping experience by enabling customers to request notifications for products that are currently out of stock or unavailable for purchase. When a product becomes available again, the extension automatically notifies subscribed customers through email and, optionally, SMS.
-  * [[https://toweringmedia.com/magento-2-back-in-stock-notifications-extension|Magento 2 Back-in-Stock Notifications Extension]]
+Built as a lightweight and Magento-native solution, the extension integrates seamlessly with both Luma and Hyvä themes. It is designed for merchants who want a simple yet effective restock notification workflow without depending on complex third-party marketing automation systems.
-===== Overview =====
+===== Product Information =====
-Toweringmedia Backorder adds a product-page subscription form so shoppers can request notification when an item that is currently not salable becomes available again. The module stores subscriptions, monitors salability, and sends alerts through Magento email—optionally supplemented by Twilio SMS when you enable and configure SMS in Admin.
+  * Product Name: Magento 2 Back-in-Stock Notifications Extension
+  * Module Name: toweringmedia/module-backorder
+  * Supported Magento Version: Magento 2.4.x
+  * Supported Themes: Luma and Hyvä
+  * Notification Channels: Email Alerts and Optional Twilio SMS Notifications
-The extension supports both Luma and Hyvä product layouts and is intended for merchants who want a lightweight, Magento-native restock alert flow without operating a separate marketing automation stack for basic notifications.
+===== What This Extension Does =====
-===== What this extension does =====
+  * Displays a subscription form on product detail pages when a product is not salable.
+  * Captures customer email addresses and optional phone numbers with explicit opt-in consent checkboxes.
-  * Presents a subscribe form on product detail pages when the product is not salable.
+  * Processes subscriptions automatically through Magento cron jobs and sends notifications once product availability is restored.
-  * Records customer-supplied email and (optional) phone with explicit opt-in checkboxes.
+  * Supports email-based notifications and optional Twilio SMS alerts.
-  * Processes subscriptions on a cron schedule and dispatches email and/or SMS when salability is restored.
+  * Provides Admin configuration settings for email sender selection, email template management, Twilio credentials, and SMS testing tools.
-  * Provides Admin configuration for email sender, template selection, Twilio credentials, and SMS test tools.
 ===== Installation =====
-Install and validate in a staging environment before production rollout.
+Please refer to the official installation guide for step-by-step setup instructions:
-<code bash>
+https://toweringmedia.com/installation
-cd /path/to/magento
-# Install from your licensed Composer source (see product / account delivery email)
-php bin/magento module:enable Toweringmedia_Backorder
-php bin/magento setup:upgrade
-php bin/magento setup:di:compile
-php bin/magento setup:static-content:deploy -f
-php bin/magento cache:flush
-</code>
 ===== Configuration =====
-  * Enable the module under **Stores > Configuration > Toweringmedia > Backorder**.
+To configure the extension, navigate to:
-  * Configure **Email** sender and template defaults; customize the transactional template if needed.
-  * For SMS, enable the SMS section, supply Twilio credentials (Account SID, Auth Token, From number or Messaging Service SID), and use the Admin **Send test SMS** action to confirm connectivity.
-  * Ensure Magento cron is running in production so subscription processing jobs execute on schedule.
-===== Operational checklist =====
+<code>
+Stores > Configuration > Toweringmedia > Back In Stock Notifications
+</code>
-  * Verify the subscribe block appears on an out-of-stock / not salable product.
+Within the General section, you can enable or disable the extension, select the email sender identity, and choose the transactional email template used for back-in-stock notifications.
-  * Confirm a test subscription row is created after form submit.
-  * Simulate replenishment (or toggle salability in staging) and confirm email and/or SMS delivery.
+The SMS Notifications section allows you to enable Twilio-powered SMS alerts. Enter your Twilio Account SID, Auth Token, and either a Twilio From Number or a Messaging Service SID. You can also use the built-in Send Test SMS button to verify that your Twilio configuration is working correctly.
-  * Review logs if notifications fail (Twilio rejections, missing phone when SMS-only is expected, etc.).
+Make sure Magento cron jobs are properly configured and running in production mode so subscription processing and notification dispatching can execute automatically.
+{{:magento2:extensions:backorder-system-config.png?400|}}
+===== Customer Experience on Product Page =====
+When a product is out of stock, the extension automatically displays a subscription form on the product detail page. Customers can enter their email address and optionally provide a phone number to receive SMS alerts when configured.
+==== 1. Back-in-Stock Subscription Form ====
+The following example shows the subscription form displayed on an out-of-stock product page. Customers can subscribe for email notifications and optionally enable SMS notifications if SMS functionality has been configured in the Admin panel.
+{{:magento2:extensions:backorder-pdp1.png?400|}}
+==== 2. Successful Subscription Confirmation ====
+After the customer submits the subscription form, a success message is displayed confirming that the customer will be notified once the product is back in stock.
+{{:magento2:extensions:backorder-pdp22.png?400|}}
+===== Operational Checklist =====
+After configuring the extension, perform the following checks to ensure the back-in-stock notification workflow is functioning correctly.
+  * Verify that the back-in-stock subscription block is displayed on out-of-stock or non-salable product pages.
+  * Submit a test subscription and confirm that a new subscription record is created successfully.
+  * Simulate inventory replenishment or change the product salability status in a staging environment, then verify that notification emails and/or SMS messages are delivered correctly.
+  * Review Magento and Twilio logs if notifications fail, including issues such as Twilio delivery rejections, invalid credentials, or missing phone numbers when SMS-only notifications are expected.
 ===== Troubleshooting =====
-  * **Form does not display**: flush cache, redeploy static content if applicable, confirm the module is enabled and the product is genuinely not salable per MSI/bundle rules.
+If you encounter issues while using the Back-in-Stock Notifications Extension, review the following common troubleshooting scenarios and recommended solutions.
-  * **No emails**: validate email sender identity, template assignment, and Magento mail transport (SPF/DMARC on your domain may affect deliverability).
-  * **SMS not delivered**: re-check Twilio credentials, approved sender/Messaging Service, and customer SMS opt-in; use the Admin test SMS tool to isolate configuration issues.
+  * **Subscription form does not appear:** Flush Magento cache, redeploy static content if required, verify that the extension is enabled in Admin configuration, and confirm that the product is truly non-salable according to Magento MSI or bundle product rules.
-  * **Duplicate notifications**: verify cron is not duplicated across environments hitting the same database.
+  * **Email notifications are not sent:** Check the configured email sender identity, verify the assigned email template, and confirm that Magento mail transport is working correctly. Also review SPF, DKIM, and DMARC records for your domain to improve email deliverability.
+  * **SMS notifications are not delivered:** Revalidate the Twilio Account SID, Auth Token, Twilio From Number, or Messaging Service SID configuration. Ensure customers have opted in for SMS notifications and use the Admin Send Test SMS feature to isolate configuration or delivery issues.
+  * **Duplicate notifications are sent:** Verify that Magento cron jobs are not running multiple times across different environments connected to the same database instance.
 ===== Related Magento 2 docs =====
@@ Line 62: / Line 86: @@
   * [[magento2:extensions:start|Magento 2 extension index]]
   * [[start|Global docs home]]