Set up in the Magento backend
We indicate which features are available on which version of Fooman Product Surcharge in the following way: (v1.0.0+).
Add Surcharge - Product
Configuring a product surcharge requires two steps:
- Define the type of surcharge in general
- Set the amount on a per product level
Step 1 - Define Product Surcharge in general
Head to Sales > Surcharges to configure your surcharge settings.
Click on the “Add Surcharge” dropdown button and select “Product” to create a new product based surcharge. 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).
Enter the surcharge description - e.g. ‘Recycling Fee’.
When set to “Active”, the product surcharge will be enabled.
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+)
Ability to 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.
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.
Which address type should be considered for the country choice.
Choose the countries for which the surcharge should be applicable.
Product Surcharge Type (1.0.0+)
Choose your preferred surcharge calculation mode:
- Per Order: This surcharge is only charged once per order, if multiple would apply the maximum is taken
- Per Product: This surcharge is charged once per product in the cart (each line item), useful for example for set up costs
- Per Item: Each item in the cart gets added the surcharge
All surcharges will be applied in the base currency of your store.
Maximum Surcharge (2.1.0+)
If set the maximum amount in your base currency that would get applied. Useful for Per Product and Per Item types where you want to limit the maximum amount that would get added. For example with Per Item with SKU A and Product Surcharge set to 5 with a Maximum Surcharge set to 12 the following would get calculated for the cart.
1 x SKU A = 5
2 x SKU A = 10
3 x SKU A = 12
4 x SKU A = 12
Maximum Times Applied (2.1.0+)
If set the maximum number of times a Per Item or Per Product surcharge hat would get applied. For example with Per Item with SKU A and Product Surcharge set to 5 with a Maximum Times Applied set to 2 the following would get calculated for the cart.
1 x SKU A = 5
2 x SKU A = 10
3 x SKU A = 10
4 x SKU A = 10
Step 2 - Define Product Surcharge per product
The product surcharges can be configured for simple, virtual and downloadable products. Open the product under Catalog > Products and open the Advanced Pricing section.
On the advanced pricing screen find the Product Surcharge section:
Under Linked Surcharge select the one you previously set up. Type will be "Product" - unless you have other Fooman Surcharge extensions installed, in which case they can be selected to override their fixed amount value and or can be used to exclude this product from the calculation.
Enter the amount for this product. Close this window via "Done" and "Save" the product.
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 (2.1.0+)
Choose your preferred tax display mode:
- Excluding Tax
- Including Tax
- Including and Excluding Tax
Display Zero Surcharge (2.1.0+)
Display the Surcharge if its value is 0.00.
Click “save” to apply the settings.