Set up Fooman Shipping Surcharge in the Magento backend
We indicate which features are available on which version of Fooman Shipping Surcharge in the following way: (v1.0.0+).
Add a New Shipping Surcharge
Head to Sales > Surcharges to configure your surcharge settings.
Click on the “Add Surcharge” dropdown button and select either:
- Shipping Surcharge: based on shipping method/carrier
- Weight Surcharge: based on order weight
You can add as many different surcharges as you like based on your store's requirements.
Customer Emails and Pdf Documents (v1.0.0+)
Surcharges will be automatically added to customer emails and pdfs generated by Magento (including pdfs generated using Fooman Pdf Customiser).
General Settings
Description (1.0.0+)
Enter the surcharge description - e.g. ‘Bulky Item Fee ($5)’.
Status (1.0.0+)
When set to “Active”, the surcharge will be enabled.
Store (1.0.0+)
Choose which store the surcharge should be applied to.
Tax Rate (1.0.0+)
Choose which store the tax rate should be applied to the surcharge amount.
Amounts Are (1.0.0+)
Specify if the surcharge amount is inclusive or exclusive of tax.
When utilising tax inclusive amounts we suggest also enabling Magento's cross border mode if you are selling in multiple tax areas to avoid 0.01 differences.
Apply Group Filter (1.0.0+)
When set to Yes the surcharge will only apply to the specified customer groups below.
Group (1.0.0+)
Works in conjunction with the above Apply Group Filter setting. Choose the customer groups for which the surcharge should be applicable - for example Wholesale customers.
Apply Country Filter (1.0.0+)
When set to Yes the surcharge will only apply to the specified countries below.
Address (1.0.0+)
Which address type should be considered for the country choice.
Countries (1.0.0+)
Choose the countries for which the surcharge should be applicable.
Based On (1.0.0+)
Choose to base the surcharge calculation on:
- Subtotal
- Shipping cost
- Subtotal + shipping
Shipping Surcharge Settings
Shipping Methods (1.0.0+)
Control-click to select the shipping methods/carriers you wish to apply the surcharge to. This list is automatically populated with all installed shipping options.
Order Minimum (1.0.0+)
If set only apply the Surcharge to orders with an amount above and equal this value.
Order Maximum (1.0.0+)
If set only apply the Surcharge to orders with an amount below and equal this value.
Surcharge Calculation Mode (1.0.0+)
Choose your preferred surcharge calculation mode:
- Fixed: Charge the same surcharge amount for all transactions (e.g. $5)
- Percent: Charge a variable surcharge amount as a % of the order subtotal (e.g. 3%)
- Fixed + Percent: Charge a combination of a fixed and % surcharge amount (e.g. $5 + 3%)
- Maximum of Fixed or Percent: The higher of either the Fixed Surcharge ($5) or Percent Surcharge (3%, if this is more than $5)
All surcharges will be applied in the base currency of your store.
Surcharge % (1.0.0+)
Enter the percentage that you wish to charge – eg. 2.5 (don’t add the % symbol).
Surcharge Fixed Cost (1.0.0+)
Enter the fixed surcharge cost you wish to charge – eg. 10 (don’t add any currency symbols).
Click “save” to add the new surcharge.
Weight Surcharge Settings
For every X kg (1.0.0+)
Set the surcharge increment, e.g. 1
Do not write kg.
Add this Surcharge Amount (1.0.0+)
The fixed surcharge amount added for each surcharge increment specified above. For example:
- For every X kg: 1
- Add this Surcharge Amount: 5
- Item weight 3kg = surcharge of 15
- Item weight 7.5kg = surcharge of 35
The fixed surcharge amount will be in your store's base currency.
Apply Shipping Method Filter (1.0.0+)
Select Yes for the weight surcharge to only apply to selected shipping methods.
Shipping Methods (1.0.0+)
Control-click to select the shipping methods that the weight surcharge should apply to.
Order Minimum (1.0.0+)
If set only apply the Surcharge to orders with an amount above and equal this value.
Order Maximum (1.0.0+)
If set only apply the Surcharge to orders with an amount below and equal this value.
Click “save” to add the new surcharge.
Tax Display Settings
The display of the surcharges can be configured alongside Magento’s default Tax settings under Stores > Configuration > Sales >Tax for both the shopping cart display, as well as once an order is placed.
Display Surcharge Amount (1.0.0+)
Choose your preferred tax display mode:
- Excluding Tax
- Including Tax
- Including and Excluding Tax
Display Zero Surcharge (1.0.0+)
Display the Surcharge if its value is 0.00.
Click “save” to apply the settings.