Get started with Product Keys Delivery

This page walks you through the first setup after installation: configure delivery, add keys, map them to products and, when needed, issue keys by hand.

Configure general settings#

1. In the Magento admin, go to DART > Product Keys > Configuration.
2. Under General Configuration, set the fields described below.
3. Select Save Config.

Field	Description
Issue When Invoiced	Yes issues a key to the order automatically when it is invoiced and paid.
Product Key Type	The title sent with the key, for example License Key or Activation Key. Defaults to Productkey if left empty.
Update Product Quantity and Stock	Yes sets the product quantity and stock status from the number of keys left in the key pool.
Not Available Message	The message the customer sees after checkout when no key is available for the product. Defaults to Oops! No Productkey Available right now. Please call or email. if left empty.
Send Customer Email	Yes delivers the key to the customer by email.
CC Email To	An admin address that receives a BCC copy of every key delivery email. Leave it empty if you don't want copies.
Delivery Email Template	The email template used to deliver keys.
Send Low Warning Email	Yes emails an administrator when a key pool is running low.
Low Warning Template	The email template used for the low-stock warning.
Low Warning Level	When the number of keys in a pool drops below this value, the low-stock warning is sent.
Email Low Warning To	The administrator address that receives low-stock warnings.

View the keys list#

Go to DART > Product Keys > Product Keys List. The grid shows every key you have added.

A key with status used has been delivered with an order, and the grid shows that order's ID. You can edit or delete keys from this grid.

Add keys#

1. On the Product Keys List page, select Add New Key.
2. In SKU / Key Pool Name, enter either:
   • the SKU of a product, to assign the keys to that product directly, or
   • a key pool name, which you then map to one or more products.
3. Optionally, fill in User Data with the key type, for example License Key, Pin or Voucher Code. You can use this value in email templates.
4. In Product Key, enter one key per line.
5. Select Save.

Import keys from a file#

Use Import Keys to add many keys and pools at once from a CSV or Excel file.

1. On the Product Keys List page, select Import Keys.
2. Select Download Sample File to get the expected format.

3. Fill in the file with these columns:

   Column	Description
   type	Any label for the key, for example License Key, Product Key or Voucher Code.
   sku	The key pool name or product SKU the key belongs to.
   product_key	The key itself.

4. Under Browse File To Import, select your file, then select Save.

Map a key pool to a product#

A key pool can serve one product or be shared by several.

1. Go to Catalog > Products and edit the product.
2. Scroll down and expand the Product Keys section.
3. In Key Pool Name, enter the pool name. Leave it empty to use the product SKU as the pool.
4. Save the product.

To share the pool with other products, repeat these steps for each product.

Set Overwrite General Configuration to Yes to give this product its own settings instead of the general configuration.

Issue or reissue keys manually#

You can issue keys from the order page when:

• Issue When Invoiced is set to No.
• The order was placed while the key pool was empty.
• You want to edit a key and send it again.
• You want to issue more keys on the same order.

Issue a key from the pool#

1. Go to Sales > Orders and open the order.
2. Under Product Keys Issued, select the product.
3. Select Issue Product Keys. A key is taken from the product's key pool and issued to the order.

The pool must already contain keys for that product.

Edit, add or send a key directly#

Use this when you want to edit an existing key, send a key that is not in a pool, or add extra keys.

1. On the order page, in the Action column, select Edit.

2. In the pop-up, add or edit the keys and save. The keys are issued against that product.

   

3. To email the keys to the customer, select the product and select Email Product Keys.