Troubleshooting Withdrawal Button Issues

Symptoms:

• No "Withdraw from this order" button on order detail page
• No "Withdraw" link in My Orders
• Customers report they can't find the withdrawal option

Solution:

1. Confirm the module is enabled for the correct store view
2. Check that the order is eligible:
   • Order status must be pending, processing, or complete
   • Order must be within the configured withdrawal period
   • Order must not already have a pending/confirmed/processed withdrawal
   • Order must not consist entirely of excluded product types, categories, or SKUs
3. Clear the full page cache and block HTML cache
4. If using a custom theme, verify that sales_order_view.xml and sales_order_history.xml layout updates are not being overridden

Prevention:

• After changing withdrawal settings, always clear cache
• Review excluded product types/categories/SKUs if buttons disappear unexpectedly

Symptoms:

• Customer clicks the withdrawal link in their order email and gets an error
• Link leads to a 404 page
• "Invalid or expired token" message

Solution:

1. Check that Include Magic Link in Order Email is set to Yes
2. Verify the token hasn't expired — tokens expire when the withdrawal period ends
3. Check that the order doesn't already have an active withdrawal (only one per order)
4. If the link was never in the email, check that your order confirmation email template includes the `` variable — the module injects this automatically, but custom templates may strip it

Prevention:

• Make sure your email templates are based on the default Magento templates or include the withdrawal variable
• Expired tokens are cleaned up daily at 03:00 UTC by cron

Symptoms:

• Withdrawal is submitted successfully (reference code shown)
• Customer doesn't receive confirmation email
• Withdrawal record exists in admin grid

Solution:

1. Check Magento's email queue: System → Email Queue (if using async email)
2. Verify the email template is configured: Stores → Configuration → Magmodules → Withdrawal Button → Email → Customer Confirmation Template
3. Check that Magento can send emails at all — test with a different transactional email
4. Look for errors in var/log/magmodules_withdrawal_button_error.log
5. Verify the customer's email address is valid in the withdrawal record

Prevention:

• Test email sending during initial setup
• Monitor your email delivery infrastructure

Symptoms:

• Using Semi-automatic or Full Automatic mode
• No notification emails received when withdrawals are submitted
• Withdrawals appear in the admin grid but team wasn't notified

Solution:

1. Verify Admin Notification Recipients has at least one valid email address
2. Check that you're using Semi-automatic or Full Automatic mode — Registration Only doesn't send admin notifications
3. Check spam folders
4. Review error logs for email sending failures

Prevention:

• Use a shared mailbox that's actively monitored
• Test with a real withdrawal after changing email settings

Symptoms:

• After-action Mode is set to Full Automatic
• Withdrawal is confirmed but order status doesn't change
• action_taken shows none in the admin grid

Solution:

1. Check if the order can be canceled — Magento only allows canceling orders in certain states (pending, processing). Already shipped or completed orders can't be canceled.
2. For shipped orders, check if a credit memo can be created — the order needs invoices and items available for refund
3. Look at the withdrawal record's action_taken field:
   • canceled — order was successfully canceled
   • credit_memo — offline credit memo was created
   • none — neither action was possible; falls back to manual handling
4. Check error logs for specific failure reasons

Prevention:

• Understand that Full Automatic has fallback behavior by design — complex cases require manual intervention
• Monitor the admin grid for withdrawals with action_taken = none

Symptoms:

• Customer enters order number and email on /withdrawal page
• Gets error message that order can't be found
• Order exists in the system

Solution:

1. Verify the customer is entering the increment ID (e.g. 100000042), not the entity ID
2. Check that the email address matches exactly — it's case-insensitive but must match the order's customer email
3. Verify the order belongs to the store view the customer is browsing
4. Check that the order meets eligibility requirements

Prevention:

• Consider adding a note to the lookup form clarifying which order number to use (the one from their confirmation email)

Symptoms:

• Footer link configured but not showing on the storefront

Solution:

1. Check that Enable Footer Link is set to Yes
2. Clear full page cache
3. If using a custom theme, verify the theme isn't overriding default.xml in a way that removes the withdrawal link block
4. Check that the module is enabled for the current store view

Prevention:

• After theme updates, verify that module layout handles are still being processed