For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration

Once you have successfully installed the extension, go to Stores -> Configuration -> MageComp -> Cancel Order to configure the extension for use.

General Settings

  • Cancel Order - Enable or disable the extension from here.

  • Customer Groups - Select the customer groups for whom you want to enable the order and item cancellation pop-up.

  • Order Statuses - Enable order and item cancellation ability based on order status.

  • Cancel Order Valid Till (Days) - Enter the number of days for which the order and item cancellation functionality can be used.

Cancel Order Popup Settings

  • Cancellation Popup - Enable frontend cancellation popup from here.

  • Cancel Order Title - From here, you can set the frontend order cancellation popup title that you want to display.

  • Cancel Item Title - From here, you can set the frontend item cancellation popup title that you want to display.

  • Order Cancellation Reasons - The extension comes with the option to add multiple order and item cancellation reasons to display in the store frontend popup as a dropdown.

  • Cancellation Popup Note - Enter confirmation message for successful cancel request submission.

Cancel Order Approval Settings

  • Admin Approval Required - Set auto cancellation or manual approval for the cancellation request by the customer.

  • Order Rejection Reasons - Add multiple order and item cancellation rejection reasons to display in the admin approval option as a dropdown.

  • Cancellation Pending Message - Set message shown to customer when a cancellation request is pending from the admin for approval.

  • Cancellation Approved Message - Set message shown to customer when a cancellation request is approved by the admin.

  • Cancellation Rejected Message - Set message shown to customer when a cancellation request is rejected by the admin.

Auto Cancel Order Settings

The extension also supports auto-cancellation of orders based on certain conditions.

  • Auto Cancel Order - Enable automatic cancellation of orders.

  • Auto Order Statuses - Select the order status to enable auto-cancellation of orders.

  • Payment and Duration - Set payment methods and duration to enable auto-cancellation of orders.

  • Auto Cancel Start Date - Set date and time to enable auto cancellation of orders.

Email Configuration Settings

  • Send Emails to - Enter the admin email ID to which you want to receive an order and item cancellation email.

  • Email Sender - Select the Email sender using which you want to send the order and item cancellation email.

  • Email Template for Customer (Pending) - Select the Email template that you want to use for sending the order and item cancellation approval pending email to the customer.

  • Email Template for Customer (Approved) - Select the Email template that you want to use for sending the order and item cancellation approved email to the customer.

  • Email Template for Customer (Rejected) - Select the Email template that you want to use for sending the order and item cancellation rejected email to the customer.

  • Email Template for Admin (New Request) - Select the Email template you want to use for sending a new order and item cancellation request email to the admin.

  • Email Template for Customer (Auto Approved) - Select the Email template that you want to use for sending the order and item cancellation automatically approved email to the customer.

  • Email Template for Admin (Auto Approved) - Select the Email template that you want to use for sending the order and item cancellation automatically approved email to the admin.

SMS Gateway Settings

MSG91 Configuration

  • Cancel Order SMS Notification - Enable it to send order and item cancellation notifications to customers via SMS.

  • SMS Gateway - Select the Msg91 SMS Gateway from the dropdown.

  • Msg91 Sender ID - Enter the sender ID or Name provided by Msg91.

  • Msg91 Authentication Key - Enter the authentication key of MSG91.

  • Send Message API - Select the API for sending messages as a DLT Template or a Campaign Template.

  • Route - Select the route from the dropdown, whether you need to send it as promotional or transactional.

  • API URL - Enter API URL for Msg91.

  • DLT Dev Mode - Admin can activate the DLT dev mode from here.

Twilio Configuration

  • Cancel Order SMS Notification - Enable it to send order and item cancellation notifications to customers via SMS.

  • SMS Gateway - Select the Twilio SMS Gateway from the dropdown.

  • NOTE: To use Twilio SMS Gateway, you need to run the ‘composer require twilio/sdk‘ command in the terminal.

  • Twilio Account SID - You need to enter the Account SID from Twilio.

  • Twilio Auth Token - Enter the Auth Token from Twilio.

  • Twilio Mobile Number - Enter the mobile number that you have purchased from Twilio.

WhatsApp Configuration Settings

  • WhatsApp Configuration - Enable it to send order and item cancellation notifications to customers via WhatsApp.

  • WhatsApp Gateway - Select WhatsApp API as the gateway.

  • Client ID - Add the client ID of WhatsApp API.

  • Instance ID - Add the instance ID of WhatsApp API.

  • API URL - Enter the API URL for WhatsApp API.

Country Flag Settings

  • Country Flag - Enable country flag for mobile number from here.

  • Country Digit - Add the country and allowed digits for validation. Admin can add countries according to the requirement and delete them easily.

Cancel Order Notification Templates

  • Notification - Enable SMS/WhatsApp notifications for order and item cancellation from here.

  • Notification Type - Select the type of notification from here.

  • Order Auto Cancel Success Text - Set custom text using variables for sending an order automatically cancelled notification to the customer.

  • Order Cancel Pending Text - Set custom text using variables for sending an order cancellation pending approval notification to the customer.

  • Order Cancel Approved Text - Set custom text using variables for sending an order cancellation approved notification to the customer.

  • Order Cancel Rejected Text - Set custom text using variables for sending an order cancellation rejected notification to the customer.

  • Item Auto Cancel Success Text - Set custom text using variables for sending an item automatically cancelled notification to the customer.

  • Item Cancel Pending Text - Set custom text using variables for sending an item cancellation pending approval notification to the customer.

  • Item Cancel Approved Text - Set custom text using variables for sending an item cancellation approved notification to the customer.

  • Item Cancel Rejected Text - Set custom text using variables for sending an item cancellation rejected notification to the customer.

  • DLT Template ID - Enter DLT Template ID. This is only for Msg91 SMS API users.

  • Campaign Name - Enter Campaign Name. This is only for Msg91 SMS API users.

Last updated