Download the PHP package sas/esd without Composer

ESD / Product downloads for Shopware 6

You can finally offer digital downloads to your customers. After purchasing an ESD / download product, the customer will be able to download the product within his account within a new download section.

Installation

Go to your project root folder and execute the following commands:

cd custom/plugins

git clone [email protected]:Shape-and-Shift/shopware-esd.git SasEsd

bin/console plugin:refresh && bin/console plugin:install SasEsd --activate

The plugin is now installed and activated.

Setup of an ESD product

Each product will have a new tab called ESD where you can upload a file and/or assign serial numbers.

A product will automaticlly be an ESD product if one of those cases are true.

All files which will be uploaded here are private which means they're not visible within the Media Manager, or available to the public.

Serial numbers

If you check the toggle Enable serial numbers a new card will be visible where you can create or import your serial numbers.

Manually import serial numbers

If you want to manually add serial numbers a modal will be opened where you can type in your serial numbers manually. Each new line is a new serial number.

After clicking the button import serial numbers those will be directly listed within the serial number table.

If a customer now buys the ESD article the next free serial number will be assigned to the customer.

Storefront customer Account

Within the storefront the customer will have a new menu entry called Downloads where all ESD products will be listed.

To manually create or import serial numbers from a CSV file, just click on of the buttons which fits your needs.

Only ESD products where the payment status is set to paid will be listed here or if the ESD product is for free e.g €0,00

If the ESD product contains a serial number, it will also be listed.

Tax rates

You might want to have different tax rates depending on the country where the buyer comes from.

Within the administration go to settings->tax and add your new tax-group, for example "ESD tax rates". Now you add the different countries with it's tax rates. For example you can add Germany with a 19% tax rate.

You also have to choose a default tax rate. So if you're not logged in for example and therefore don't have a shipping country yet, you will see the default tax rate.

Please double check the VAT rates, to be 100% sure those are correct.

You need to assign this ESD tax group to your article. Go to your ESD product and select the ESD tax group within the price section.

Now: If your shop is based for example in Germany ( 19% VAT ) and a customer from Portugal ( 23% VAT ) is ordering an ESD article within your shop - The ESD product will be taxed with the 23% VAT from Portugal, and not with 19% from Germany.

Add serial numbers via API endpoint

Thanks to the new concept of Shopware 6 it's easy peasy to create new serial numbers with the API. You just have to make a POST request to the API endpoint /api/v2/sas-product-esd-serial. Within the body you need three parameters.

• esdId which is the ID of the ESD article
• serial which represents the actual serial number
• id which has to be a random generated UUID

Full POST example to the endpoint /api/v2/sas-product-esd-serial:

So a fully working request would look like this example with Postman

Be sure to have a valid oauth token to be able to make requests to the admin API

Add your digital media to the product

To add the digital media to the product, we will use the Bulk Edit API to do it.

First, we need to upload a media file if it doesn't exist in our store, you can take a look at the Admin-API how to add a media file here.

After finished adding the media you've got the mediaId, we will use it to add to the product through the Bulk Edit API with my example below.

Full POST example to the endpoint /api/_action/sync:

Explain:

• payload.id is productId
• payload.versionId is product.versionId
• esd.id is the esd id of this product, and if your product doesn't have it, you can generate a new one
• esd.esdMedia.mediaId is the media ID you want to add to the product

So a fully working request would look like this example with testing tool

[
  {
    "key": "write",
    "action": "upsert",
    "entity": "product",
    "payload": [
      {
        "id": "d47aa1700fa248e5b147861c54aab3f5",
        "taxId": "c4ccbc056e41461bbd0f07a1f68d7013",
        "featureSetId": "4a6d48155744418e889cdc6ba132df79",
        "price": [
          {
            "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca",
            "net": 84.033613445378,
            "linked": true,
            "gross": 100
          }
        ],
        "productNumber": "SW10000",
        "stock": 100,
        "active": true,
        "purchasePrices": [
          {
            "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca",
            "net": 0,
            "linked": true,
            "gross": 0
          }
        ],
        "name": "esd product",
        "visibilities": [
          {
            "id": "8480748ab62a43e89d674eef687c8bab",
            "productId": "d47aa1700fa248e5b147861c54aab3f5",
            "salesChannelId": "f864c45dcb0c4e8bba36287f9bd29a0a",
            "visibility": 30
          }
        ],
        "esd": {
          "id": "7921470085d740ec88f0daa912a93d70",
          "esdMedia": [
            {
              "mediaId": "01bb489a85e14f1085cf814c110f5f85"
            }
          ]
        }
      }
    ]
  }
]

Re-Send ESD mail for an order

In version 1.2.11 we added the ability to send the ESD mail again from an order. Just go to your order and scroll a bit down until the ESD Mail Service section, to send the mail again to your customer

send the ESD mail again