First public version of the documentation for version 1.0.0

Updated documentation for version 1.1.0

Updated documentation for version 1.2.0

Updated documentation for version 1.2.1 and following

Introduction

With the plugin MND Add Charge Manager you can define surcharges and link them to articles. Surcharges become distinct articles with ordernumbers in the Shopware basket and order which will be calculated accordingly.

Typical applications could be:

• Bottle deposit
• Bulky goods surcharge
• Handling fees

Special features of the plugins

• ERP compatibly: Surcharges are distinct articles in the shopware basket and order! Ordernumbers can be custom values.
• Surcharges are calculated per article amount. I.e. with order amount 10 = 10x surcharge is being factored.
• You can define VAT setting per surcharge article
• Name and description can be custom defined.
• You can define multiple surcharge articles and link them to as many articles as you like
  
• Multiple surcharges can be linked to one article
• Deposits can be limited to one or several shipping-countries
• You can use surcharge information in the Shopware product feed
  
• You can set custom prices for customer groups

Surcharges are placed in the basket as shopware discount articles and factored with default shopware process.

Screenshots

Display on the article detail page:

Display in Article Listing:

Display in the basket of goods:

Installation

The installation is being done as usual about the Shopware Plugin Manager.

Further information about the installation process in Shopware:

Plugin-Installation: http://community.shopware.com/Lizenzierung-und-Installation-von-lizenzpflichtigen-Plugins_detail_1340.html
Plugin-Manager: http://community.shopware.com/Plugin-Manager-ab-Shopware-5_detail_1856.html)

Plugin-Configuration (Experts Settings)

Usage

Configuration in the backend

Select the submenu item "Additional Charges Manager" in the main menu:

Create/Edit Surcharges

Click "Add" to create a new surcharge or click on the pen icon in the grid to edit an existing one.

A deposit can be assigned to several articles and be limited to certain shipping countries.

Creating a Deposit

The following fields are relevant for the configuration of a deposit:

an ordernumber must be unique

Although technically possible, you should use for ordernumbers only sign A-Z, a-z, 0-9 and "-". 

I.e. no umlauts, special characters or blanks.

Short description of the surcharge. It is shown by the article in the shop below the surcharge price info.

Here you can set the input type for the price (incl. VAT.) / (excl. VAT.)

Price of surcharge (decimal separator is a dot)

Set which VAT configuration should be used

Add different prices for Customer Groups

You can set dirrerent prices for customer groups. If an exception ist not active the default price will be calculated

All Customer Groups are listed. A Customer Group can be activated as exception.

Example for a customer group exception

The Customer Group "Shopkunden" has the additional charge of 1,00 €.

For "Händler" and "Entwickler" the default price is being caculated.

Assign from Articles

You can add a surcharge for an article via the name of the article or the ordernumber.

The surcharge was successfully linked to the article

Limit surcharges to shipping countries

A surcharge can be limited to (shipping) countries. The surcharge will then only be calculated when the country in the shipping address of the user corresponds to the selected countries.

For surcharges limited to countries we recommend using an according name or description for the surcharge. E.g. "handling fee for delivery to france".

The surcharge was limited for the supplier country, in this case "Switzerland".

You should clear the Shopware cache (frontend and http-proxy) after changing surcharge configurations

Assigning two or more surcharges to an article

You can assign more than one surcharge to an article.

Template customization

Use in the shopware productfeeds

In the templates of the productfeeds, a new field is added to the variable $sArticle

$sArticle.mnd_addcharge

This variable contains a JSON object with surcharge information:

name of the surcharge for the customer

Reusable cans deposit

The description may contain newline characters. You should convert the value according to your target format. (e.g. CSV does not like line wraps)

reusable cans deposit is mandatory in Germany.

The gross price of the deposit in the currency opposed for the export

The tax rate of the deposit

Examples of integration in productfeed template 

Spend deposit information as text

First we add a column to the header template of the productfeed

[...]
Deposit{#S#}
[...]

[...]
{assign var=addChargeData value=$sArticle.mnd_addcharge|unescape:'html'|json_decode:1}
{assign var="output" value=null}
{foreach $addChargeData AS $data}{append 'output' "plus {$data.price|format:"number"} {$sCurrency.currency} {$data.display_name}"}{/foreach}
{", "|implode:$output}{#S#}
[...]

Result:

plus 0,25 EUR Test surcharge, plus 3,21 EUR Second Test Surcharge

Explanation:

the first three lines only prepare the output (they are not visible in the feed):

{assign var=addChargeData value=$sArticle.mnd_addcharge|unescape:'html'|json_decode:1}

Then we convert the JSON-String to an array. We use the array so we can use the values in a more civilized manner.

{assign var="output" value=null}

Then we create a variable which we assign values to. (still no output in the feed)

{foreach $addChargeData AS $data}{append 'output' "zzgl. {$data.price|format:"number"} {$sCurrency.currency} {$data.display_name}"}{/foreach}

Then we loop through all available surcharges and save the info to the "output" array.

{$data.price|format:"number"} 

this makes sure the prices are correctly formatted

{", "|implode:$output}

Finally, we output the surcharges separated by comma.

Add price of surcharge to article price

[...]
Price incl Surcharge{#S#}
{/strip}{#L#}

[...]
{assign var=addChargeData value=$sArticle.mnd_addcharge|unescape:'html'|json_decode:1}
{assign var="priceIncl" value=$sArticle.price}
{foreach $addChargeData AS $data}{assign var="priceIncl" value=$priceIncl+$data.price}{/foreach}
{$priceIncl}

Result:

123.41

Then we convert the JSON-String to an array. We use the array so we can use the values in a more civilized manner.

{assign var="priceIncl" value=$sArticle.price}

We create a smarty variable and assign the price of the article to it

{foreach $addChargeData AS $data}{assign var="priceIncl" value=$priceIncl+$data.price}{/foreach}

Now we loop through every available surcharge and add the price to our variable

{$priceIncl}

Finally, we output the price as float value (without any formatting in this case).

Uninstall

The plugin is also uninstalled about the Plugin Manager.

When you uninstall the plugin, the surcharge configuration will not be removed. The configuration is saved in the following db tables: