Magento Community Edition 2.0 User Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 1036 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Magento Community Edition 2.0 User Guide
Contents
Getting Started
- Introduction
- Basic Configuration
Products
Marketing
Content
- Content Elements
- Design & Theme
Customers
Sales
Reports
Operations
- Stores
- System
Appendices
Index

Magento

Community Edition

User Guide

Version 2.0

Contents

GETTING STARTED 1

Introduction 2

CHAPTER 1: Welcome 3

Resources 4

Join the Conversation! 7

CHAPTER 2: About this Release 9

System Requirements 10

Installation 13

Prelaunch Checklist 14

Your Login Credentials 16

For Your Records 17

CHAPTER 3: Your Magento Account 19

Creating a Magento Account 20

Sharing Your Account 23

CHAPTER 4: Quick Tour 27

The Path to Purchase 28

Home Page 30

Catalog Page 32

Search Results 34

Product Page 36

Shopping Cart 38

Customer Journey 40

Attract New Customers 42

Engage Your Customers 43

Moment of Purchase 45

Increase Average Order Value 46

Customer Retention 47

Loyalty & Advocacy 48

Success! 49

Basic Configuration 51

CHAPTER 5: Store Admin 53

Admin Sign In 54

Your Admin Account 56

Admin Sidebar 57

Admin Workspace 60

Dashboard 61

Message Inbox 65

Global Search 69

Grid Controls 70

Grid Layout 72

Actions Control 73

CHAPTER 6: Store Details 77

Store Information 78

Locale Options 80

State Options 81

Country Options 82

Merchant Location 84

Currency 85

Store Email Addresses 86

CHAPTER 7: Storefront Branding 91

Uploading Your Logo 92

Adding a Favicon 95

Magento Community Edition 2.0 User Guide iii

Contents

Store Demo Notice 97

Changing the Welcome Message 98

CHAPTER 8: Websites, Stores & Views 101

Configuration Scope 102

Single Store Mode 104

CHAPTER 9: Industry Compliance 105

PCI Compliance Guidelines 106

Cookie Law Compliance 108

Cookie Restriction Mode 109

Cookie Reference 111

PRODUCTS 113

CHAPTER 10: Products Menu 115

Catalog Workspace 117

Product Scope 120

CHAPTER 11: Creating Products 123

Catalog URLs 124

Dynamic URL 124

Static URL 124

URL Key 124

HTML Suffix 125

Category Path 125

Product Workspace 127

Attribute Set 127

Online Status 128

Expand/Collapse 128

Save Menu 129

iv Magento Community Edition 2.0 User Guide

Contents

Default Field Values 130

Product Types 132

Simple Product 134

Configurable Product 139

Adding Configurations 144

Grouped Product 152

Virtual Product 159

Bundle Product 164

Customizing the Bundle 165

Downloadable Product 174

Download Options 182

CHAPTER 12: Basic Settings 185

Product Details 186

Images and Video 189

Media Gallery 194

Image Zoom 195

Light Boxes and Sliders 195

Adding Product Video 196

Placeholders 199

Watermarks 200

Swatches 203

Text-Based Swatches 203

Swatches in Layered Navigation 204

Creating Swatches 205

Search Engine Optimization 210

Websites 212

CHAPTER 13: Advanced Settings 213

Advanced Pricing 214

Group Price 217

Special Price 218

Tier Price 219

Magento Community Edition 2.0 User Guide v

Contents

Minimum Advertised Price 221

MAP Logic 221

Configuring MAP 223

Advanced Inventory 227

Stock Options 232

Product Stock Options 234

Stock Message Scenarios 236

Product Page Stock Messages 236

Catalog Page Stock Messages 238

Product Alerts 240

Product Alert Run Settings 242

Custom Options 243

Categories

Product Attributes

Contents

Products Menu

Inventory Workspace

Product Scope

Creating Products

Catalog URLs

Product Workspace

Default Field Values

Product Types

Simple Product

Configurable Product

Adding Configurations

Grouped Product

Virtual Product

Bundle Product

Downloadable Product

Download Options

Basic Settings

Product Details

Images and Videos

Media Gallery

Product Videos

Placeholders

Watermarks

Swatches

Creating a Swatch

Search Engine Optimization

Websites

Advanced Settings

Pricing

Group Price

Special Price

Tier Price

Minimum Advertised Price

MAPLogic

MAPConfiguration

Inventory

Stock Options

Product Stock Options

Stock Message Scenarios

Product Alerts

Product Alert Run Settings

Custom Options

Related Products

Up-sells

Cross-sells

Design

Autosettings

Product Reviews

Ratings

Categories

Creating Categories

Modifying Categories

Root Categories

Hidden Categories

General Information

Display Settings

Custom Design

Category Products

Product Attributes

Adding an Attribute

Attribute Input Types

Date & Time Options

114 Magento Community Edition 2.0 User Guide

CHAPTER 10:

Products Menu

The Products Menu provides easy access to product creation, category and inventory

management, as well as tools to manage catalog content.

Products Menu

Magento Community Edition 2.0 User Guide 115

Menu Options

Catalog

Create new products of every type, and manage your

inventory.

Categories

Create the category structure that is the foundation of

your store’s navigation.

116 Magento Community Edition 2.0 User Guide

CHAPTER 10: Products Menu

Catalog Workspace

The Catalog grid lists all products in the catalog. Use the standard controls to sort and filter

the list, find products, and apply actions to selected products. From the grid, you can create

new products and edit existing ones.

Catalog Grid

CONTROL DESCRIPTION

Store View Sets the scope of the product to a specific view.

Add Product Click the Add Product button to create a new simple product. To

choose a specific product type, click the down arrow. Options

include:

Simple Product

Configurable Product

Grouped Product

Virtual Product

Bundle Product

Downloadable Product

Search Initiates a catalog search based on the current filters.

Reset Filter Restores all filters to a blank state.

Workspace Controls

CHAPTER 10: Products Menu Catalog Workspace

Magento Community Edition 2.0 User Guide 117

CONTROL DESCRIPTION

Actions Lists all actions that can be applied to selected products in the list. To

apply an action to a product or group of products, mark the checkbox

in the first column of each product. Options:

Delete

Change Status

Update Attributes

Mass Actions Can be used to select multiple records as the target of action. The

checkbox is marked in the first column of each selected record.

Options:

Select All

Unselect All

Select Visible

Unselect Visible

Submit Applies the current action to selected product records.

Edit Opens the product in edit mode. You can accomplish the same thing

by clicking anywhere on the row.

Workspace Controls (cont.)

COLUMN DESCRIPTION

Selection State Determines how products are listed when the checkbox is marked.

Options:

Any Lists all records, regardless of checkbox status.

Yes Lists only records with the checkbox marked.

No Lists only records without the checkbox marked.

ID A unique, sequential number that is assigned when a new product is

saved for the first time.

Thumbnail Displays a thumbnail of the main product image.

Name The product name.

Type The product type. Options:

Columns

Catalog Workspace CHAPTER 10: Products Menu

118 Magento Community Edition 2.0 User Guide

COLUMN DESCRIPTION

Simple Product

Virtual Product

Bundle Product

Downloadable Product

Grouped Product

Configurable Product

Attribute Set The product template upon which the product is based.

SKU A unique Stock Keeping Unit that is assigned to the product.

Price The unit price of the product.

Quantity The quantity currently in stock.

Visibility Indicates where in the catalog the product is visible. Options:

Not Visible Individually

Catalog

Catalog, Search

Status Indicates the current status of the product. Options:

Enabled

Disabled

Websites Indicates the website(s) where the product is available.

Columns (cont.)

CHAPTER 10: Products Menu Catalog Workspace

Magento Community Edition 2.0 User Guide 119

Product Scope

For installations with multiple websites, stores, and views, the scope determines where

products are available for sale, and manages the product information for each store view.

Initially, all products that you create are published to the default website, store, and view.

If you have only a single store with the default view, you can run your store in Single Store

Mode to hide the scope settings from view. However, if your store has multiple views, a scope

indicator appears to the right of each field.

To edit the product information for a specific view, use the Store View control in the upper-left

corner to select the view. After the view is selected, additional controls become available for any

field that can be edited at the store view level. In the following example, although the Spanish

store view is selected, the product information is still in the language of the default store view.

The process of editing a product for a store view can be likened to adding a layer of product

information that is specific to the view. For example, you can switch to the Spanish view, and

translate the text fields, such as product title, description, and the meta data. To learn more,

see: Translating Products.

To edit product information for a different view:

1. In the upper-left corner, set Store View to the specific view to be edited. When prompted, tap

OK to change the scope.

Store View

2. A checkbox appears after any field that can be edited for the store view. To edit a field, clear the

Use Default Value checkbox. Then, update the field with the new value for the view.

Editing a Field for a View

Catalog Workspace CHAPTER 10: Products Menu

120 Magento Community Edition 2.0 User Guide

3. When complete, tap Save.

4. In the upper-left corner, set Store View back to the default store view.

5. To see the change in your store, do the following:

a. In the upper-right corner, tap the Admin menu arrow. Then, choose Customer View.

Customer View

b. In the upper-right corner of the store, set the Language Chooser to the store view to find

the product that you edited.

Language Chooser

CHAPTER 10: Products Menu Catalog Workspace

Magento Community Edition 2.0 User Guide 121

Notes

122 Magento Community Edition 2.0 User Guide

CHAPTER 11:

Creating Products

Choosing a product type is one of the first things you must do to create a new product. In

this chapter, you will learn how to create a product of each type. In addition to the basic

product types, the term, complex product1refers to a product that requires the

customer to choose from a selection of options before making a purchase. To learn more

about the available options, see Basic Settings and Advanced Settings.

If you are just starting out, you can create a few sample products to experiment with each

product type. For a deeper understanding, make sure to read about catalog navigation,

how to set up categories and attributes, and the catalog URL options that are available to

you.

Product Catalog

1A product that requires the customer to choose from a selection of options.

Magento Community Edition 2.0 User Guide 123

Catalog URLs

The URLs you assign to products and categories play a major role in determining how well

your site is indexed by search engines. Before you start building your catalog is an ideal time to

consider the available options.

Dynamic URL

A dynamic URL is created “on the fly,” and might include a query string with variables for the

product ID, sort order, and the page where the request was made. When a customer searches

for a product in your store, the resulting URL might look something like this:

http://mystore.com/catalogsearch/result/?q=tee+shirt

Static URL

A static URL is a fixed address for a specific page. A static URL can be displayed in a search-

engine friendly format, or one that references products and categories by ID. Search-engine

friendly URLs include words that people might use to look for a product, and require Web

Server Rewrites to be enabled.

http://mystore.com/accessories/eyewear.html

http://mystore.com/catalog/product/view/id/409/s/chelsea-tee-

409/category/16/

URL Key

The URL key is the part of a static URL that describes the product or category. When you

create a product or category, an initial URL key is automatically generated, based on the name.

The URL key should consist of lowercase characters with hyphens to separate words. A well-

designed, “search engine friendly” URL key might include the product name and key words to

improve the way it is indexed by search engines. The URL key can be configured to create an

automatic redirect if the URL key is changed.

Catalog URLs CHAPTER 11: Creating Products

124 Magento Community Edition 2.0 User Guide

HTML Suffix

Your catalog can be configured to either include or exclude the suffix as part of category and

product URLs. There are various reasons why people might choose to use or to omit the suffix.

Some believe that the suffix no longer serves any useful purpose, and that pages without a

suffix are indexed more effectively by search engines. However, your company might have a

standardized format for URLs that requires a suffix.

Because the suffix is controlled by the system configuration, you should never type the suffix

directly into the URL key of a category or product. (Doing so will result in a double suffix at

the end of the URL.) Whether you decide to use the suffix or not, be consistent and use the

same setting for all your product and category pages. Here are examples of a category URL

with, and without, the suffix.

http://mystore.com/accessories/eyewear.htm

http://mystore.com/accessories/eyewear.html

http://mystore.com/accessories/eyewear/retro-chic-eyeglasses

Category Path

You can configure the URL to either include or exclude the category path. By default, the

category path is included in all category and product pages. The following examples show the

same product URL with, and without, the category path.

http://mystore.com/accessories/eyewear/retro-chic-eyeglasses

http://mystore.com/retro-chic-eyeglasses

To prevent search engines from indexing multiple URLs that lead to the same content, you can

exclude the category path from the URL. Another method is to use a canonical meta tag to let

search engines know which URLs to index and which to ignore.

To configure catalog URLs:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Catalog.

3. Expand the Search Engine Optimizations section, and do the following:

a. Set Product URL Suffix to “html” or “htm.” Enter the suffix without a period, because it is

applied automatically.

b. Set Category URL Suffix to “html” or “htm.” Enter the suffix without a period, because it

is applied automatically.

CHAPTER 11: Creating Products Catalog URLs

Magento Community Edition 2.0 User Guide 125

c. Set Use Categories Path for Product URLs to your preference.

http://mystore.com/furniture/living-room/microfiber-sofa-sleeper

URL with Category Path

http://mystore.com/microfiber-sofa-sleeper

URL without Category Path

Search Engine Optimization

4. When complete, tap Save Config.

5. When prompted, click the Cache Management link in the system message, and refresh the

invalid cache.

Refresh Cache

Catalog URLs CHAPTER 11: Creating Products

126 Magento Community Edition 2.0 User Guide

Product Workspace

The panel on the left of the product workspace lists the selection of Basic and Advanced

Settings, with the current selection on the right. The workspace includes multiple Save options

and gives you control over the online status of the product.

Product Workspace

Attribute Set

The name of the attribute set appears in the upper-left corner, and determines the fields that

make up the product record. When creating a new product, an existing attribute set can be

chosen by clicking the down arrow next to the default attribute set name.

Attribute Sets

CHAPTER 11: Creating Products Product Workspace

Magento Community Edition 2.0 User Guide 127

Online Status

The online status of the product is indicated by the switch in the upper-right corner. To change

the online status, simply click the switch.

CONTROL DESCRIPTION

Indicates that the product is currently online.

Indicates that the product is currently offline.

Expand/Collapse

To expand or collapse a section, tap either the expand or collapse button to the right.

Product Details

Product Workspace CHAPTER 11: Creating Products

128 Magento Community Edition 2.0 User Guide

Save Menu

The Save menu includes several options that let you save and continue, save and create a new

product, save and duplicate the product, or save and close.

Save Menu

COMMAND DESCRIPTION

Save Save the current product, and continue working.

Save & New Save and close the current product, and begin a new product, based on the

same product type and template.

Save & Duplicate Save and close the current product, and open a new duplicate copy.

Save & Close Save the current product and return to the Inventory workspace.

CHAPTER 11: Creating Products Product Workspace

Magento Community Edition 2.0 User Guide 129

Default Field Values

To save time when creating products, the default value of several product fields references

values from another field. You can either accept the default value, or enter another. The

following fields have automatically generated default values:

FIELD DESCRIPTION

SKU Based on product Name.

Meta Title Based on product Name.

Meta Keywords Based on product Name.

Meta Description Based on product Name and Description.

The placeholders that represent the value of another field are enclosed in double-curly braces.

Any attribute code that is included in the product attribute set can be used as a placeholder.

Product Fields Auto-Generation

Product Workspace CHAPTER 11: Creating Products

130 Magento Community Edition 2.0 User Guide

To edit the placeholder value:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Catalog.

3. Expand the Product Fields Auto-Generation section. Then, make any changes needed to the

placeholder values.

For example, if there’s a specific keyword that you want to include for every product, or a

phrase that you want to include in every meta description, you can type the value directly into

the appropriate field.

If you want to keep the existing placeholder values, be careful to preserve the double curly braces

that enclose each markup tag.

4. When complete, tap Save Config.

PLACEHOLDER

Common Placeholders

CHAPTER 11: Creating Products Product Workspace

Magento Community Edition 2.0 User Guide 131

Product Types

Simple Product

A simple product is a physical item with a single SKU.

Simple products have a variety of pricing and of input

controls which makes it possible to sell variations of the

product. Simple products can be used in association with

grouped, bundle, and configurable products.

Configurable Product

A configurable product appears to be a single product

with lists of options for each variation. However, each

option represents a separate, simple product with a

distinct SKU, which makes it possible to track inventory

for each variation.

Grouped Product

A grouped product presents multiple, standalone

products as a group. You can offer variations of a single

product, or group them for a promotion. The products can

be purchased separately, or as a group.

Virtual Product

Virtual products are not tangible products, and are

typically used for products such as services,

memberships, warranties, and subscriptions. Virtual

products can be used in association with grouped and

bundle products.

Product Types CHAPTER 11: Creating Products

132 Magento Community Edition 2.0 User Guide

Bundle Product

A bundle product let customers “build their own” from an

assortment of options. The bundle could be a gift basket,

computer, or anything else that can be customized. Each

item in the bundle is a separate, standalone product.

Downloadable Product

A digitally downloadable product that consists of one or

more files that are downloaded. The files can reside on

your server or be provided as URLs to any other server.

CHAPTER 11: Creating Products Product Types

Magento Community Edition 2.0 User Guide 133

Simple Product

One of the keys to harnessing the power of product types is learning when to use a simple,

standalone product. A simple products can be sold individually, or as part of a grouped,

configurable, or bundle product. A simple product with custom options is sometimes referred to

as a composite product.

The following steps take you through the process of creating a simple product using the default

product template with basic settings. When you finish the basics, you can complete the

advanced settings as needed.

Simple Product

Process Overview:

Step 1: Choose the Product Type

Step 2: Choose the Product Template (Optional)

Step 3: Complete the Required Fields

Step 4: Complete the Remaining Product Details

Step 5: Publish the Product

Step 6: View the Product in Your Store

Simple Product CHAPTER 11: Creating Products

134 Magento Community Edition 2.0 User Guide

Step 1: Choose the Product Type

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. In the upper-right corner on the Add Product menu, choose Simple Product.

Add Simple Product

Step 2: Choose the Product Template (Optional)

To choose the product template, do one of the following:

lIn the Search box, enter the name of the template.

lIn the list, choose the template that you want to use.

The form is updated to reflect the template.

Choose Template

CHAPTER 11: Creating Products Simple Product

Magento Community Edition 2.0 User Guide 135

Step 3: Complete the Required Fields

1. In the Product Details section. do the following:

a. Enter the product Name.

b. You can either use the default SKU that is based on the product name, or enter another.

c. Enter the product Price.

2. Because the product is not yet ready to publish, set the Product Online switch to the “Off”

position.

3. Tap Save, and continue with the next step.

With the required fields complete, the product can be saved as needed.

Step 4: Complete the Remaining Product Details

1. Set Tax Class to one of the following:

lNone

lTaxable Goods

2. If you're ready to add a product image, do one of the following:

lDrag an image from your desktop, and drop it on the camera tile in the Images and

Videos box.

lIn the Images box, tap the camera tile, and navigate to the image file on your computer.

Then, select the image, and tap Open.

Aplaceholder appears until a product image is uploaded.

3. Enter the Quantity of the product that is currently in stock.

4. Enter the product Weight.

5. To assign the product to a Category, do one of the following:

lStart typing to find a match. Then, choose the Category.

lTap Show List to see the category tree. Then, drill down and tap each category that you

want to assign to the product.

lTap New Category. Enter the Category Name and choose the Parent Category to determine

its position in the menu structure. Then, tap Create Category.

Simple Product CHAPTER 11: Creating Products

136 Magento Community Edition 2.0 User Guide

Create Category

6. Enter the product Description directly into the text box, and format as needed. Then, tap

Submit. You can also use the WYSIWYG Editor, for additional control.

Product Details

CHAPTER 11: Creating Products Simple Product

Magento Community Edition 2.0 User Guide 137

Step 5: Publish the Product

1. If you are ready to publish the product in the catalog, set the Product Online switch to the

“On” position.

2. When complete, on the Save menu, choose Save & Close.

Save & Close

Step 6: View the Product in Your Store

In the upper-right corner on the Admin menu, choose Customer View.

Customer View

THINGS TO REMEMBER

Simple products can be included in configurable, bundle, and grouped product types.

A simple product can have custom options with a variety of input controls, which makes it

possible to sell many product variations from a single SKU.

Simple Product CHAPTER 11: Creating Products

138 Magento Community Edition 2.0 User Guide

Configurable Product

A configurable product looks like a single product with drop-down lists of options for each

variation. Each option is actually a separate simple product with a unique SKU, which makes

it possible to track inventory for each product variation. You could achieve a similar effect by

using a simple product with custom options, but without the ability to track inventory for each

variation.

Although a configurable product uses more SKUs, and may initially take a little longer to set

up, it can save you time in the long run. If you plan to grow your business, the configurable

product type is a good choice for products with multiple options.

Configurable Product

CHAPTER 11: Creating Products Configurable Product

Magento Community Edition 2.0 User Guide 139

Process Overview:

Part I: Create the Configurable Product

Step 1: Choose the Product Type

Step 3: Complete the Required Fields

Step 4: Complete the Remaining Product Details

Step 5: Save and Continue

Step 1: Choose the Product Type

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. In the upper-right corner on the Add Product menu, choose Configurable Product.

Add Configurable Product

Configurable Product CHAPTER 11: Creating Products

140 Magento Community Edition 2.0 User Guide

Step 2: Choose the Product Template

The product template that is used to create a configurable product determines the selection of

fields that are available, and must include at least one drop-down attribute. The drop-down

attributes are included in an attribute set, which is then used as a template for the configurable

product.

The template used in this example has drop-down attributes for color and size. To choose the

product template, click the template field and do one of the following:

lIn the Search box, enter the name of the template.

lIn the list, choose the template that you want to use.

The form is updated to reflect the template.

Choose Template

Step 3: Complete the Required Fields

1. In the Product Details section, enter the product Name.

2. Either accept the default SKU that is based on the product name, or enter another value.

3. Enter the product Price.

4. If necessary, change the Tax Class. The default setting is “Taxable Goods.”

5. Because the product is not yet ready to publish in your catalog, set the Product Online switch

to the “Off” position.

CHAPTER 11: Creating Products Configurable Product

Magento Community Edition 2.0 User Guide 141

Step 4: Complete the Remaining Product Details

1. (Optional) You can add an image that represents the configurable product as a whole, or wait

until later when you set up the configurations. In this example, we use an image that shows

the top in all three colors. An image uploaded here becomes the image of the “parent product.”

lDrag an image from your desktop, and drop it on the camera tile in the Images and

Videos box.

lIn the box, tap the camera tile, and navigate to the image file on your computer. Then,

select the image, and tap Open.

Aplaceholder appears until an image is uploaded. If you prefer, you can later add video to the

gallery.

2. The Quantity field is not available because it’s determined by each product variation.

3. To assign the product to a Category, do one of the following:

lStart typing to find a match. Then, choose the Category.

lTap the Show List icon to view the Category tree. Then, drill down through the available

categories, and tap each category that you want to assign to the product.

lTap New Category. Enter the Category Name and choose the Parent Category to determine

its position in the menu structure. Then, tap Create Category.

4. Enter the product Description directly into the text box, and format as needed. Then, tap

Submit. You can also use the WYSIWYG Editorfor additional control.

Configurable Product CHAPTER 11: Creating Products

142 Magento Community Edition 2.0 User Guide

Product Details

Step 5: Save and Continue

This is a good time to save your work. In the next step, you’ll set up the configurations for each

variation of the product.

1. In the upper-right corner, tap Save.

2. Continue with Adding Configurations.

CHAPTER 11: Creating Products Configurable Product

Magento Community Edition 2.0 User Guide 143

Adding Configurations

The following example shows how to add configurations for three colors and three sizes. In all,

nine simple products will be created with unique SKUs to cover every possible combination of

variations. The progress bar at the top of the page shows where you are in the process, and

guides you through each step.

Progress Bar

Process Overview:

Part II: Add Configurations

Step 1: Choose the Attributes

Step 2: Enter the Attribute Values

Step 3: Configure the Images, Price, and Quantity

Step 4:Generate the Product Configurations

Step 5: Publish the Products

Step 6: Configure the Shopping Cart Thumbnails (Optional)

Step 7: View the Products in Your Store

Configurable Product CHAPTER 11: Creating Products

144 Magento Community Edition 2.0 User Guide

Step 1: Select Attributes

1. At the bottom of Product Details, expand the Configurations section. Then, tap

CreateConfigurations.

Configurations

2. Mark the checkbox of each attribute that is to be used as a configuration.

3. If you need to add a new attribute, tap CreateNewAttribute. Complete the attribute properties,

and tap SaveAttribute. Then, mark the checkbox to select the attribute.

4. In the upper-right corner, tap Next.

Select Attributes

Step 2: Enter Attribute Values

1. Mark the checkbox of each variation of the product.

2. To add a new value, click Create New Value. Then, enter the new value in the input box, and

tap the Enter arrow.

3. Repeat these steps for each attribute that is included as a configuration.

You can rearrange the list of attributes by dragging the box in the upper-left corner to a new

position.

4. In the upper-right corner, tap Next.

CHAPTER 11: Creating Products Configurable Product

Magento Community Edition 2.0 User Guide 145

Step 3: Configure the Images, Price, and Quantity

This step determines the images, pricing and quantity of each configuration. The available

options are the same for each, and you can choose only one. You can apply the same setting to

all SKUs, apply a unique setting to each SKU, or skip the settings for now.

1. Choose the configuration options that apply.

Configure the Images

Method 1: Apply a Single Set of Images to All SKUs

1. Select Apply single set of images to all SKUs.

2. Browse to each image that you want to include in the product gallery, or drag them to the

box.

Use Same Images for All SKUs

Method 2: Apply Unique Images for Each SKU

Because we already uploaded an image for the parent product, we’ll use this option to upload

an image of each color. This is the image that will appear in the shopping cart when someone

buys the shirt in a specific color.

1. Select Apply unique images by attribute to each SKU.

Configurable Product CHAPTER 11: Creating Products

146 Magento Community Edition 2.0 User Guide

2. Select the attribute that the images illustrate. For example: color.

3. For each attribute value, either browse to the images that you want to use for that

configuration, or drag them to the box.

If you drag the an image to a value box, it appears in the sections for the other values, as well.

If you want to delete an image, tap the trashcan icon.

Unique Images per SKU

Configure the Prices

Method 1: Apply the Same Price to All SKUs

1. If the price is the same for all variations of the product, select Apply single price to all

SKUs.

2. Enter the Price.

Same Price per SKU

Method 2: Apply a Different Price for Each SKU

1. If the price differs for each or for some variations of the product, select Apply unique

prices by attribute to each SKU.

2. Select the attribute that is the basis of the price difference.

3. Enter the price for each attribute value. In this example, the XL size costs more.

CHAPTER 11: Creating Products Configurable Product

Magento Community Edition 2.0 User Guide 147

Unique Price per SKU

Configure the Quantity

Method 1: Apply the Same Quantity to All SKUs

1. If the quantity is the same for all SKUs, select Apply single quantity to each SKU.

2. Enter the Quantity.

Same Quantity for All SKUs

Method 2: Apply Different Quantity by Attribute

1. If the quantity is the different for each SKU, select Apply unique quantity by attribute to

each SKU.

2. Enter the Quantityfor each.

Configurable Product CHAPTER 11: Creating Products

148 Magento Community Edition 2.0 User Guide

Different Quantities per Attribute

2. When complete, tap Next in the upper-right corner.

Step 4: Generate the Product Configurations

1. Wait a moment for the list of products to appear. When you are ready to add the products to

your catalog, tap GenerateProducts.

The product variations now appear at the bottom of Product Details in the Configuration

section.

2. If you want to edit any of the settings, tap EditConfigurations.

Generate Products

CHAPTER 11: Creating Products Configurable Product

Magento Community Edition 2.0 User Guide 149

Step 5: Publish the Products

1. If you are ready to publish the products in the catalog, set the Product Online switch to the

“On” position. Otherwise, leave the switch in the “Off” position until the product is ready to

publish.

2. When complete, on the Save menu, choose Save & Close.

Save & Close

3. When prompted to refresh the cache, tap the Cache Management link in the system message,

and refresh the invalid cache.

4. On the Admin sidebar, tap Products. Your new configurable product and its variations appears

in the grid at the top of the list.

Step 6: Configure the Shopping Cart Thumbnails (Optional)

If you have a different image for each variation you can set the configuration to use the correct

image for the shopping cart thumbnail.

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Sales, choose Checkout. Then, expand the Shopping Cart

section.

3. Set Configurable Product Image to “Product Thumbnail Itself.”

4. When complete, tap SaveConfig.

Configurable Product CHAPTER 11: Creating Products

150 Magento Community Edition 2.0 User Guide

Shopping Cart - Configurable Product Image

Step 7: View the Product in Your Store

When the product is online, tap the Admin arrow in the upper-right corner, and choose

Customer View to see how they look in your store.

Customer View

THINGS TO REMEMBER

A configurable product allows the shopper to choose options from drop-down lists. Each

option is actually a separate, simple product.

Each drop-down list values is based on an attribute of the “Dropdown”input type. The

drop-down attributes must be included in the attribute set, which is then used as a

template for the configurable product.

The thumbnail image in the shopping cart can be set to display the image from the

configurable product record, or from the product variation.

CHAPTER 11: Creating Products Configurable Product

Magento Community Edition 2.0 User Guide 151

Grouped Product

A grouped product is made up of simple standalone products that are presented as a group.

You can offer variations of a single product, or group them by season or theme to create a set of

different products. Each product can be purchased separately, or as part of the group. In the

shopping cart, each item is listed separately.

Grouped Product

Process Overview:

Step 1: Choose the Product Type

Step 2: Choose the Product Template (Optional)

Step 3: Complete the Required Fields

Step 4: Complete the Remaining Product Details

Step 5: Add the Grouped Products

Step 6: Publish the Product

Step 7: Configure the Shopping Cart Thumbnails (Optional)

Step 8: View the Product in Your Store

Grouped Product CHAPTER 11: Creating Products

152 Magento Community Edition 2.0 User Guide

Step 1: Choose the Product Type

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. In the upper-right corner on the Add Product menu, choose Grouped Product.

Add Grouped Product

Step 2: Choose the Product Template (Optional)

To choose the product template, do one of the following:

lIn the Search box, enter the name of the template.

lIn the list, choose the template that you want to use.

The form is updated to reflect the template.

Choose Template

CHAPTER 11: Creating Products Grouped Product

Magento Community Edition 2.0 User Guide 153

Step 3: Complete the Required Fields

1. In the Product Details section, do the following:

a. Enter the product Name.

b. Either accept the default SKU that is based on the product name, or enter another value.

2. Because the product is not yet ready to publish, set the Product Online switch to the “Off”

position.

Step 4: Complete the Remaining Product Details

1. To add an image that represents the product group, do one of the following:

lDrag an image from your desktop, and drop it on the camera tile in the Images and

Videos box.

lIn the Images and Videos box, tap the camera tile, and navigate to the image file on

your computer. Then, select the image, and tap Open.

Aplaceholder appears until a product image is uploaded.

2. The Quantity is grayed out because it’s derived from the individual products that make up the

group.

3. To assign the product to a Category, do one of the following:

lStart typing to find a match. Then, choose the Category.

lTap the Show List icon to view the Category tree. Then, drill down through the available

categories, and tap each category that you want to assign to the product.

lTap New Category. Enter the Category Name and choose the Parent Category to determine

its position in the menu structure. Then, tap Create Category.

Add Categories

4. Enter the product Description directly into the text box, and format as needed. Then, tap

Submit. You can also use the WYSIWYG Editor, for additional control.

Grouped Product CHAPTER 11: Creating Products

154 Magento Community Edition 2.0 User Guide

Product Details

Step 5: Add the Grouped Products

1. At the bottom of the page, expand the Grouped Products section. Then, tap

AddProductstoGroup.

2. In the grid, use the filters at the top of the columns to find the products that you want to

include in the group. Then, tap Search.

3. In the list, mark the checkbox of each item that you want to include in the group.

CHAPTER 11: Creating Products Grouped Product

Magento Community Edition 2.0 User Guide 155

4. Tap AddSelectedProducts to add them to the grouped product. Then, do any of the following:

lTo specify a default quantity for any of the items, enter the number in the Default Qty field.

lTo remove any product from the list, tap the Delete icon.

Products Added

Grouped Product CHAPTER 11: Creating Products

156 Magento Community Edition 2.0 User Guide

Step 6: Publish the Product

1. If you are ready to publish the product in the catalog, set the Product Online switch to the

“On” position.

2. When complete, on the Save menu, choose Save & Close.

Save & Close

Step 7: Configure the Shopping Cart Thumbnails (Optional)

If you have a different image for each variation you can set the configuration to use the correct

image for the shopping cart thumbnail.

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Sales, choose Checkout. Then, expand the Shopping Cart

section.

3. Set Grouped Product Image to “Product Thumbnail Itself.”

4. Tap Save Config.

Shopping Cart

CHAPTER 11: Creating Products Grouped Product

Magento Community Edition 2.0 User Guide 157

Step 8: View the Product in Your Store

On the Admin menu, choose Customer View.

Customer View

THINGS TO REMEMBER

A grouped product is essentially a collection of simple associated products.

Simple and virtual products that are part of a grouped product cannot have custom

options.

Each item purchased appears individually in the shopping cart, rather than as part of the

group.

The thumbnail image in the shopping cart can be set to display the image from the

grouped parent product , or the associated product.

Grouped Product CHAPTER 11: Creating Products

158 Magento Community Edition 2.0 User Guide

Virtual Product

Virtual products are used to represent non-tangible items such as memberships, services,

warranties, or subscriptions. Virtual products can be sold individually, or included as part of

the following product types:

lGrouped Product

lBundle Product

Aside from the absence of the Weight field, the process of creating a virtual product and a

simple product is the same.

Virtual Product

Process Overview:

Step 1: Choose the Product Type

Step 2: Choose the Product Template (Optional)

Step 3: Complete the Required Fields

Step 4: Complete the Remaining Product Details

Step 5: Publish the Product

Step 6: View the Product in Your Store

CHAPTER 11: Creating Products Virtual Product

Magento Community Edition 2.0 User Guide 159

Step 1: Choose the Product Type

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. In the upper-right corner on the Add Product menu, choose Virtual Product.

Add Virtual Product

Step 2: Choose the Product Template (Optional)

To choose the product template, do one of the following:

lIn the Search box, enter the name of the template.

lIn the list, choose the template that you want to use.

The form is updated to reflect the template.

Choose Template

Virtual Product CHAPTER 11: Creating Products

160 Magento Community Edition 2.0 User Guide

Step 3: Complete the Required Fields

1. In the Product Details section. do the following:

a. Enter the product Name.

b. Either accept the default SKU that is based on the product name, or enter another value.

c. Enter the product Price.

2. Because the product is not yet ready to publish, set the Product Online switch to the “Off”

position.

3. Tap Save and continue with the next step.

With the required fields complete, the product can be saved as needed.

Step 4: Complete the Remaining Product Details

1. Set Tax Class to one of the following:

lNone

lTaxable Goods

To learn about requirements for the taxation of digital goods and services, see the white paper,

Identification & Taxability of Digital Products on the Avalara site.

2. If you're ready to add Images, do one of the following:

lDrag an image from your desktop, and drop it on the camera tile in the Images and

Video box.

lIn the Images and Video box, tap the camera tile, and navigate to the image file on your

computer. Then, select the image, and tap Open.

Aplaceholder appears until a product image is uploaded.

3. If applicable, enter the Quantity of the product that is currently available.

4. To assign the product to a Category, do one of the following:

lStart typing to find a match. Then, choose the Category.

lTap the Show List icon to view the Category tree. Then, drill down through the available

categories, and tap each category that you want to assign to the product.

lTap New Category. Enter the Category Name and choose the Parent Category to determine

its position in the menu structure. Then, tap Create Category.

CHAPTER 11: Creating Products Virtual Product

Magento Community Edition 2.0 User Guide 161

Choose Category

5. Enter the product Description directly into the text box, and format as needed. Then, tap

Submit. You can also use the WYSIWYG Editor, for additional control.

Product Details

Virtual Product CHAPTER 11: Creating Products

162 Magento Community Edition 2.0 User Guide

Step 5: Publish the Product

1. If you are ready to publish the product in the catalog, set the Product Online switch to the

“On” position.

2. When complete, on the Save menu, choose Save & Close.

Save & Close

Step 6: View the Product in Your Store

On the Admin menu, choose Customer View.

Customer View

THINGS TO REMEMBER

Virtual products are used for non-tangible products such as services, subscriptions, and

warranties.

Virtual products are much like simple products, but without the Weight.

Shipping Options do not appear during checkout unless there is a tangible product in the

cart.

CHAPTER 11: Creating Products Virtual Product

Magento Community Edition 2.0 User Guide 163

Bundle Product

A bundle is a “build your own,” customizable product. Each item in a bundle can be based on

one of the following product types:

lSimple Product

lVirtual Product

Bundle Product

Bundle Product CHAPTER 11: Creating Products

164 Magento Community Edition 2.0 User Guide

Customizing the Bundle

The selection of options in the bundle appears when the customer taps either the Customize

and Add to Cart button. Because the products that are included in the bundle vary, the SKU,

Price, and Weight can be set to either a dynamic or fixed value.

Minimum Advertised Price (MAP) is not available for Bundle products with dynamic pricing.

Customize Bundle

The following instructions walk you through the process of creating a bundle product with the

basic settings. After you complete the required settings and save the product, you can complete

the remaining information as needed.

Process Overview:

Step 1: Choose the Product Type

Step 2: Choose the Product Template

Step 3: Complete the Required Fields

Step 4: Complete the Remaining Product Details

Step 5: Add the Bundle Items

Step 6: Publish the Product

Step 7: View the Product in Your Store

CHAPTER 11: Creating Products Bundle Product

Magento Community Edition 2.0 User Guide 165

Step 1: Choose the Product Type

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. In the upper-right corner on the Add Product menu, choose Bundle Product.

Add Bundle Product

Step 2: Choose the Product Template

To choose the product template, do one of the following:

lIn the Search box, enter the name of the template,

lIn the list, choose the template that you want to use.

The form is updated to reflect the template.

Choose Template

Bundle Product CHAPTER 11: Creating Products

166 Magento Community Edition 2.0 User Guide

Step 3: Complete the Required Fields

1. In the Product Details section. do the following:

a. Enter the product Name.

b. Either accept the default SKU that is based on the product name, or enter a different

value. Then set the type of value to one of the following:

lDynamic

lFixed

c. To set the product Price, do the following:

lIf you want the price to change according to the options selected, leave Price blank, and

choose “Dynamic.”

lTo have a set price for the bundle, choose “Fixed,” and enter the Price.

Dynamic or Fixed SKU and Price

2. Because the product is not yet ready to publish, set the Product Online switch to the “Off”

position.

3. Tap Save and continue with the next step.

Now that the required fields are complete, the product can be saved whenever needed.

Step 4: Complete the Remaining Product Details

1. If the product is set to Fixed Pricing, set Tax Class to one of the following:

lNone

lTaxable Goods

2. If you're ready to add a product image, do one of the following:

lDrag an image from your desktop, and drop it on the camera tile in the Images and

Videos box.

lIn the Images and Videos box, tap the camera tile, and navigate to the image file on

your computer. Then, select the image, and tap Open.

Aplaceholder appears until a product image is uploaded.

3. The Quantity field is grayed out because the value is determined by each item in the bundle.

CHAPTER 11: Creating Products Bundle Product

Magento Community Edition 2.0 User Guide 167

4. To choose how Weight is determined for shipping, do one of the following:

lIf you want the weight to change according to the options included, choose “Dynamic.”

lFor a set product weight, choose “Fixed,” and enter the Weight.

Dynamic or Fixed Weight

5. To assign the product to a Category, do one of the following:

lStart typing to find a match. Then, choose the Category.

lTap the Show List icon to view the Category tree. Then, drill down through the available

categories, and tap each category that you want to assign to the product.

lTap New Category. Enter the Category Name and choose the Parent Category to

determine its position in the menu structure. Then, tap Create Category.

Categories

6. Enter the product Description directly into the text box, and format as needed. Then, tap

Submit. You can also use the WYSIWYG Editor for additional control.

Bundle Product CHAPTER 11: Creating Products

168 Magento Community Edition 2.0 User Guide

Bundle Details

Step 5: Add the Bundle Items

1. In the Bundle Items section, set Ship Bundle Items to one of the following:

lSeparately

lTogether

2. Tap Create New Option, Then, do the following:

a. Enter an Option Title to be used field label.

b. Set Input Type to one of the following:

CHAPTER 11: Creating Products Bundle Product

Magento Community Edition 2.0 User Guide 169

lDrop-down

lRadio buttons

lCheckbox

lMultiple Select

c. To make the field a required entry, mark the Required checkbox.

New Option

d. Tap Add Products to Option. Then, mark the checkbox of each product that you want to

include in this option. If there are many products, use the list filters and pagination

controls to find the products you need.

e. Tap Add Selected Products.

Add Selected Products

f. Choose one item to be the Default selection.

g. In the Default Quantity column, enter the quantity of each item that is to be added to the

bundle when a customer chooses the item.

h. To prevent customers from changing the quantity of any item, clear the User Defined

checkbox of any item that you do not want changed. By default, the quantity of all items

can be changed.

3. Repeat these steps for each item you want to add to the bundle.

4. To remove any item from the bundle, tap the Delete icon.

5. Repeat these steps to add as many options as needed in the bundle.

Bundle Product CHAPTER 11: Creating Products

170 Magento Community Edition 2.0 User Guide

6. When complete, tap Save.

Option Items

Step 6: Publish the Product

1. If you are ready to publish the product in the catalog, set the Product Online switch to the

“On” position.

2. On the Save menu, choose Save & Close.

Save & Close

Step 7: View the Product in Your Store

On the Admin menu, choose Customer View.

Customer View

CHAPTER 11: Creating Products Bundle Product

Magento Community Edition 2.0 User Guide 171

CONTROL DESCRIPTION

Drop-down Displays a drop-down list of options with the product name and price.

Only one item can be selected.

Radio Buttons Displays a radio button for each option, followed by the product name

and price. Only one item can be selected.

Checkbox Displays a checkbox for each option, followed by the product name

and price. Multiple items can be selected.

Multiple Select Displays a list of options with the product name and price. To select

multiple items, hold down the Ctrl (or Option) key, and click each

item.

Input Controls

Bundle Product CHAPTER 11: Creating Products

172 Magento Community Edition 2.0 User Guide

FIELD DESCRIPTION

SKU Determines if each item is assigned a variable, dynamic SKU, or if a

fixed SKU is used for the bundle. Options include: Fixed/Dynamic.

Weight Specifies the weight is calculated based on the items selected, or is

a fixed weight for the entire bundle. Options include:

Fixed/Dynamic.

Price View Determines if the product price is shown as a range, from the least

expensive to the most expensive (Price Range), or with the least

expensive shown (As Low As). Options include: Price Range/ As

Low As.

Ship Bundle Items Specifies if individual items can be shipped separately.

Field Descriptions

THINGS TO REMEMBER

Customers can “build their own” bundle product.

Bundle items can be simple or virtual products without custom options.

The Price View can be set to a price range or to “As Low As.”

SKU and Weight can be either “Fixed” or “Dynamic.”

The Quantity can be a preset or user-defined value.

Bundle items can be shipped together or separately.

CHAPTER 11: Creating Products Bundle Product

Magento Community Edition 2.0 User Guide 173

Downloadable Product

A downloadable product can be anything that you can deliver as a file, such as an eBook,

music, video, software application, or update. You can offer an album for sale, and sell each

song individually. You can also use a downloadable product to deliver an electronic version of

your product catalog.

Because the actual download doesn’t become available until after the purchase, you can provide

samples, such as an excerpt from a book, a clip from an audio file, or a trailer from a video that

the customer can try before purchasing the product. The files that you make available for

download can be either uploaded to your server, or from a different server.

Downloadable Product

Downloadable products can be configured to require that the customer log in to an account to

receive the link, or can be sent by email and shared with others. The status of the order before

the download becomes available, default values, and other delivery options are set in the

configuration. To learn more, see: Download Options .

The following instructions take you through the process of creating a downloadable product

with the basic fields. After you complete the required settings and save the product, you can

add images and complete the remaining product information as needed.

Downloadable Product CHAPTER 11: Creating Products

174 Magento Community Edition 2.0 User Guide

Process Overview:

Step 1: Choose the Product Type

Step 2: Choose the Product Template

Step 3: Complete the Required Fields

Step 4: Complete the Remaining Product Details

Step 5: Complete the Downloadable Information

Step 6: Publish the Product

Step 7: View the Product in Your Store

Step 1: Choose the Product Type

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. In the upper-right corner on the Add Product menu, choose Downloadable Product.

Add Downloadable Product

Step 2: Choose the Product Template (Optional)

The sample data includes a product template called “Downloadable” that has special fields for

downloadable products. You can use an existing template, or create another before the product

is saved. To use an existing template, do one of the following:

lIn the Search box, enter the name of the template.

lIn the list, choose the Downloadable template.

The form is updated to reflect the template.

CHAPTER 11: Creating Products Downloadable Product

Magento Community Edition 2.0 User Guide 175

Choose Template

Step 3: Complete the Required Fields

1. In the Product Details section. do the following:

a. Enter the product Name.

b. Either accept the default SKU that is based on the product name, or enter another value.

c. Enter the product Price.

2. Because the product is not yet ready to publish, set the Product Online switch to the “Off”

position.

3. Tap Save and continue with the next step.

With the required fields complete, the product can be saved as needed.

Downloadable Product CHAPTER 11: Creating Products

176 Magento Community Edition 2.0 User Guide

Step 4: Complete the Remaining Product Details

1. Set Tax Class to one of the following:

lNone

lTaxable Goods

To learn about requirements for the taxation of digital goods and services, see the white paper,

Identification & Taxability of Digital Products on the Avalara site.

2. If you're ready to add a product image, do one of the following:

lDrag an image from your desktop, and drop it on the camera tile in the Images and

Videos box.

lIn the Images and Videos box, tap the camera tile, and navigate to the image file on

your computer. Then, select the image, and tap Open.

Aplaceholder appears until a product image is uploaded.

3. If applicable, enter the Quantity of the product that is currently available for download.

4. Skip the Weight field, and mark the Virtual / Downloadable checkbox, if necessary.

5. To assign the product to a Category, do one of the following:

lStart typing to find a match. Then, choose the Category.

lTap the Show List icon to view the Category tree. Then, drill down through the available

categories, and tap each category that you want to assign to the product.

lTap New Category. Enter the Category Name and choose the Parent Category to determine

its position in the menu structure. Then, tap Create Category.

Choose Category

6. Enter the product Description directly into the text box, and format as needed. Then, tap

Submit. You can also use the WYSIWYG Editor, for additional control.

CHAPTER 11: Creating Products Downloadable Product

Magento Community Edition 2.0 User Guide 177

Product Details

Step 5: Complete the Downloadable Information

The Downloadable Information is divided into two sections. The first section describes each

download link, and thesecond section describes each sample file. The default value for many of

these options can be set in the configuration.

Links

1. In the Links section, enter the Title that you want to use as a heading for the download

links.

2. Set Links can be purchased separately to one of the following:

Downloadable Product CHAPTER 11: Creating Products

178 Magento Community Edition 2.0 User Guide

lTo offer multiple download links, such as to sell individual songs on an album, choose

“Yes.”

lTo offer a single download of this item, choose “No.”

Links Title

3. Click Add New Link. Then, do the following:

a. Enter the Title and Price of the download.

b. Choose one of the following distribution methods:

Attach File Choose the File option. Then, browse to the file, and select it

to upload.

Enter Link Choose the URL option, Then, enter the full URL to the

download file.

c. Set Shareable to one of the following:

No Requires customers to log in to their accounts to access the

download link.

Yes Sends the link by email, which customers can share with

others.

d. Do one of the following:

lTo limit downloads per customer, enter the number of Max. Downloads.

lTo allow unlimited downloads, mark the Unlimited checkbox.

Link Detail

4. To add another link, click Add New Link. Then, repeat these steps.

CHAPTER 11: Creating Products Downloadable Product

Magento Community Edition 2.0 User Guide 179

Samples

1. In the Samples section, enter the Title that you want to use as a heading for the samples.

2. To complete the information for each sample, tap Add New Link.

Samples

3. Complete the link detail as follows:

a. Enter the Title of the individual sample.

b. Choose one of the following distribution methods:

Attach File Choose the File option. Then, browse to the file, and select it

to upload.

Enter Link Choose the URL option, Then, enter the full URL to the

sample file.

Downloadable product file names can include letters and numbers. You can to use either

a dash or underscore character to represent a space between words. Any invalid

characters in the file name are replaced with an underscore.

c. To add another sample, tap Add New Row, and repeat these steps.

d. To change the order of the samples, tap the sort icon, and drag the sample to a

new position.

Sample Detail

Downloadable Product CHAPTER 11: Creating Products

180 Magento Community Edition 2.0 User Guide

Step 6: Publish the Product

1. If you are ready to publish the downloadable product in your catalog, set the Product Online

switch to the “On” position.

2. On the Save menu, choose Save & Close.

Save & Close

Step 7: View the Product in Your Store

On the Admin menu, choose Customer View.

Customer View

THINGS TO REMEMBER

Downloadable products can be uploaded to the server, or linked to from another server on

the Internet.

You can determine the number of times a customer can download a product.

Customers who purchase a downloadable product can be required to log in before going

through checkout.

The delivery of a downloadable product can be made when the order is in either a

“Pending” or “Invoiced” state.

CHAPTER 11: Creating Products Downloadable Product

Magento Community Edition 2.0 User Guide 181

Download Options

The downloadable configuration settings determine the default values and delivery options for

downloadable products, and specify if guests can purchase downloads.

To configure download options:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Catalog.

3. Expand the Downloadable Product Options section, and do the following:

a. To determine the stage in the order workflow when the download becomes available, set

Order Item Status to Enable Downloads to one of the following:

lPending

lInvoiced

b. To set a default limit on the number of downloads that a single customer can make, enter

the number in the Default Maximum Number of Downloads field.

c. Set Shareable to one of the following:

Yes Allows customers to email the download link to others.

No Prevents customers from sharing the download link with others by

requiring customers to log in to their accounts to access download links.

d. In the Default Sample Title field, enter the heading that you want to appear above the

selection of samples.

Sample Title

Downloadable Product CHAPTER 11: Creating Products

182 Magento Community Edition 2.0 User Guide

e. In the Default Link Title field, enter the default text that you want to use for download

links.

f. If you want the download link to open in a new browser window, set Opens Links in New

Window to “Yes.” This setting is used to keep the browser window to your store open.

g. To determine how downloadable content is delivered, set Use Content Disposition to one

of the following:

Attachment Delivers the download link by email as an attachment.

Inline Delivers the download link as a link on a web page.

h. If you want to require that purchasers register for a customer account and log in before

purchasing a download, set Disable Guest Checkout if Cart Contains Downloadable

Items to “Yes.”

4. When complete, tap Save Config.

Downloadable Product Options

CHAPTER 11: Creating Products Downloadable Product

Magento Community Edition 2.0 User Guide 183

Notes

184 Magento Community Edition 2.0 User Guide

CHAPTER 12:

Basic Settings

The Basic Settings section is designed to help you create products quickly, and includes

Product Details, Images and Videos, Search Engine Optimization, and Websites.

Basic Settings

Magento Community Edition 2.0 User Guide 185

Product Details

The Product Details section provides basic information about the product, and gives you the

ability to add attributes and categories as you define the product. To learn more, see the

instructions for each product type.

Product Details

Product Details CHAPTER 12: Basic Settings

186 Magento Community Edition 2.0 User Guide

FIELD SCOPE DESCRIPTION

Name Store View (Required) The name of the product, as you want it to

appear in the catalog.

SKU Global (Required) The Stock Keeping Unit is a unique

identifier for each individual product or service

provided. A default SKU is auto-generated, based on

the product name.

Price Website (Required) The retail price of the product.

Tax Class Website The tax class that is associated with the product.

Images and Videos Store View Displays the images and videos that are currently

available for the product.

Add Video Associates a new video with

the product.

Quantity Global The number of items currently in stock.

Weight Global Determines if the product has weight, and specifies

the value for shipping calculations. In the United

States, weight is measured in pounds and ounces,

whereas countries on the metric system use grams

and kilograms. The unit of measurement defined for

your locale in the configuration.

Categories Global Indicates the categories that are assigned to the

product.

New Category Assigns an additional

category to the product.

Description Store View The main product description that appears on the

product page. The product description is initially

entered as plain text. The WYSIWYG Editor can be

used to format the text with HTML tags, if permitted

by the description attribute properties .

Field Descriptions (Default Template)

CHAPTER 12: Basic Settings Product Details

Magento Community Edition 2.0 User Guide 187

FIELD SCOPE DESCRIPTION

Do not paste text directly from a word processor,

because it might include print control codes that do not

render correctly online. If using a word processor to

compose the text, first save the description as a .txt

file to strip out any control codes before copying and

pasting it into the product description field.

WYSIWYG Editor Launches the Editor in a pop-

up window.

Field Descriptions (Default Template) (cont.)

Product Details CHAPTER 12: Basic Settings

188 Magento Community Edition 2.0 User Guide

Images and Video

Using high-quality images of consistent proportion gives your catalog a professional look with

commercial appeal. If you have a large catalog with several images per product, you can easily

have hundreds, if not thousands of product images to manage. Before you get started, establish

a naming convention for your image files, and organize them so you can find the originals if

you ever need them.

Product Images

A single product image is rendered in different sizes throughout the catalog. The size of the

image container on the page is defined in the style sheet, but how the image is used is

determined by the role that is assigned to the image. The main product image, or “base” image,

must be large enough to produce the magnification that is needed for zoom. In addition to the

main image, a smaller version of the same image might appear in product listings, or as a

thumbnail in the shopping cart. You can upload an image in the largest size that is needed,

and let Magento render the sizes needed for each use. The same image can be used for all roles,

or a different image can be assigned to each role. By default, the first image that is uploaded is

assigned to all three roles.

From the Product Detail section, you can perform basic image management tasks such as

upload multiple images, link to video, rearrange their order, and determine how each is used.

For additional control, open the image in “detail view.” If you have a large quantity of images

to manage, it can be more efficient to import them as a batch, rather than upload individual

images. To learn more, see: Importing Product Images.

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 189

Image Detail

To manage images:

1. Open the product in edit mode. Then, do any of the following:

Upload an Image

lDrag an image from your desktop, and drop it on the camera tile in the Images and

Videos box.

lIn the Images and Video box, tap the camera tile, and browse to the image file on your

computer. Then, select the image, and tap Open.

Drag and Drop Image

Images and Video CHAPTER 12: Basic Settings

190 Magento Community Edition 2.0 User Guide

Assign the Base Image

An orange banner appears in the lower-right corner of the current base image. To assign a

different image as the base, move the mouse over the image that you want to use, and tap the

tag icon in the lower-right corner.

Make Base

Rearrange Images

To change the order of images in the gallery, tap the Sort icon at the bottom of the image.

Then, drag the image to a different position in the Images box.

Change Order

Delete an Image

To remove an image, tap the Delete icon in the lower-left corner of the image.

Remove Image

2. Tap Save

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 191

To view image detail:

1. To open an image in detail view:

lTap the Image Management link below the image tiles.

lIn the panel on the left under Basic Settings, tap Image Management.

Then, do any of the following:

Enter Alt Text

Image Alt text is referenced by screen readers to improve web accessibility, and by search

engines when indexing the site. Some browsers display the Alt text on mouseover. Alt text can

be several words long, and include carefully selected key words.

In the Alt Text box, enter a brief description of the image.

Assign Roles

By default, all three roles are assigned to the first image that is uploaded to the product. To

reassign a role to another image, do the following:

1. Tap an image tile to open the image in detail view.

2. In the Role box, choose the role that you want to assign to the image.

The assigned role appears with a checkmark in selected mode, and the previous image is no

longer assigned to the role.

Hide Images

To exclude an image from the thumbnail gallery, mark the Hide from Product Page checkbox.

Then, tap Save.

Hidden Image

2. To exit Detail View, click the Close box in the upper-right corner.

3. When complete, tap Save

Images and Video CHAPTER 12: Basic Settings

192 Magento Community Edition 2.0 User Guide

IMAGE ROLE DESCRIPTION

Swatch Images A swatch image can be illustrate a color, texture, finish, or pattern.

Swatch images that are specific to the product can be uploaded to

the image gallery.

Base Image The base image is the main image on the product detail page. Image

zoom is activated if you upload an image that is larger image than the

image container. Example sizes:

470 x 470 pixels (without Zoom)

1100 x 1100 pixels (with Zoom)

Small Image The small image is used for the product images in listings on

category and search results pages, and to display the product images

needed for sections such as for Up-sells, Cross-sells, and the New

Products List. Example size:

470 x 470 pixels

Thumbnail Thumbnail images appear in the thumbnail gallery, shopping cart, and

in some blocks such as Related Items. Example size:

50 x 50 pixels

Image Roles

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 193

Media Gallery

The media gallery on the product page displays multiple images, video, or swatches related to

the product. Each thumbnail can show a different view or variation of the product. Click a

thumbnail to browse through the gallery, Although the position of the gallery varies by theme,

the default position is just below the main image on the product page.

Media Gallery

Images and Video CHAPTER 12: Basic Settings

194 Magento Community Edition 2.0 User Guide

Image Zoom

Customers can view a magnified portion of the image on mouseover, if the image is large

enough to create the zoom effect. When zoom is activated, you can click the main image and

move the cursor around to magnify different parts of the image. The magnified selection

appears to the right of the image.

Image Zoom

Light Boxes and Sliders

There are many third-party light boxes and sliders that you can use to enhance the

presentation of your product images. Look for extensions in Magento Marketplace.

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 195

Adding Product Video

To add product video, you must first obtain an API Key from your Google account, and enter it

in the configuration of your store. Then, you can link to the video from the product.

Step 1: Get Your YouTube APIKey

1. Log in to your Google account, and visit the Google Developers Console. Then, do the

following:

a. Under Use Google APIs, click Enable and manage APIs.

b. In the panel on the left choose Credentials. Expand the Add Credentials menu, and

choose APIkey.

c. When prompted to create a new key, choose Server key. Enter a name for the key, and tap

Create.

2. Wait a few moments while the key is generated. Then, copy the key to the clipboard.

In the next step, you will paste the key into your store’s configuration.

Step 2: Configure Magento

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Catalog.

3. Expand the Product Video section. Then, paste your YouTube APIkey.

Product Video

4. When complete, click Save Config.

5. When prompted, refresh the cache.

Images and Video CHAPTER 12: Basic Settings

196 Magento Community Edition 2.0 User Guide

Step 3: Link to the Video

1. Open a product in edit mode. Then in the Images and Video section, tap Add Video.

If you haven’t yet entered your YouTube APIkey, tap OKto continue. You won’t be able to link

to a YouTube video, but you can go through the process.

Add Video

2. Enter the URLof the YouTube or Vimeo video.

3. Enter the Title and Description of the video.

4. To upload a Preview Image, browse to the image and select the file.

5. If you prefer to use the video meta data, tap Get Video Information.

6. To determine how the video is used in the store, mark the checkbox of each Role that applies:

lBase Image

lSmall Image

lSwatch Image

lThumbnail

lHide from Product Page

7. When complete, tap Save.

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 197

New Video

FIELD DESCRIPTION

URL The URLof the associated video.

Title The video title.

Description The video description.

Preview Image An uploaded image that is used as a preview of the video in your

store.

Get Video Information Retrieves the video meta data that is stored on the host server. You

can use the original data, or update it as needed.

Role Determines how the preview image is used in your store. Options:

Base Image

Small Image

Thumbnail

Swatch Image

Hide from Product Page

Field Descriptions

Images and Video CHAPTER 12: Basic Settings

198 Magento Community Edition 2.0 User Guide

Placeholders

Magento uses temporary images as placeholders until the permanent product images become

available. A different placeholder can be uploaded for each role. The initial placeholder image is

the Magento logo, which you can replace with an image of your choice.

Image Placeholder

To upload placeholder images:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, and choose Catalog.

3. Expand the Product Image Placeholders section.

4. For each image role, tap Choose File. Find the image on your computer and upload the file.

You can use the same image for all three roles, or upload a different placeholder image for each

role.

Product Image Placeholders

5. When complete, tap Save.

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 199

Watermarks

If you go to the expense of creating your own original product images, there is not much you

can do to prevent unscrupulous competitors from stealing them with the click of a mouse.

However, you can make them a less attractive target by placing a watermark on each image to

identify them as your property. A watermark file can be either a .jpg (jpeg), .gif, or .png image.

Both ,gif and .png formats support transparent layers, which can be used to give the

watermark a transparent background.

The watermark used for the “small” image in the following example is a black logo with a

transparent background, and saved as a .png file with the following settings:

Size: 50x50

Opacity: 5

Position: Tile

Tiled Watermark

Images and Video CHAPTER 12: Basic Settings

200 Magento Community Edition 2.0 User Guide

To add watermarks to product images:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under General, choose Design.

3. Expand the Product Image Watermarks section. Then, complete the following steps for the

Base, Small, and Thumbnail images:

a. Enter the Watermark Default Size, in pixels. For example: 200 x 200

b. Enter the Watermark Opacity, Percent, as a percentage. For example: 40

c. Tap Choose File, and choose the image file to upload.

d. Set Watermark Position to your preference.

Product Image Watermarks

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 201

4. When complete, tap Save Config.

5. When prompted to refresh the cache, tap the Cache Management link in the system message.

Then, refresh the invalid cache.

Refresh Cache

To delete a watermark:

1. Do one of the following:

lUnder the watermark thumbnail, tap Delete Image.

lMark the checkbox to the right of the watermark thumbnail.

Delete Watermark

2. Tap Save Config. Then, do the following:

a. When prompted to refresh the cache, tap the Cache Management link in the system

message. Then, refresh the invalid cache.

b. If the watermark image persists in the storefront, return to Cache Management and tap

FlushMagentoCache.

Images and Video CHAPTER 12: Basic Settings

202 Magento Community Edition 2.0 User Guide

Swatches

Customers have high expectations when it comes to color, and it is crucial that product

descriptions accurately represent each available color, pattern, or texture. For example, the

capris in the illustration below are not simply available in red, green, and blue. Rather, they are

available only in very specific shades of red, green, and blue, which are probably unique to this

product.

For configurable products, color can be indicated by a visual swatch, text swatch, or a drop-

down input control. Swatches can be used on the product page, in product listings, and in

layered navigation. On the product page, swatches are synchronized to display the

corresponding product image when the swatch is chosen. When chosen, the corresponding

value appears in the input field, and the swatch is outlined as the current selection.

Swatches on Product Page

Text-Based Swatches

If an image isn’t available for a swatch, the attribute value appears as text. A text-based swatch

is like a button with a text label, and behaves in the same way as a swatch with an image.

When text-based swatches are used to show the available sizes, any size that is not available is

crossed out.

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 203

Text-Based Swatches for Size

Swatches in Layered Navigation

Swatches can also be used in layered navigation, provided that the Use in Layered Navigation

property of the color attribute is set to “Yes.” The following example shows both text-based

and color image swatches in layered navigation.

Swatches in Layered Navigation

Images and Video CHAPTER 12: Basic Settings

204 Magento Community Edition 2.0 User Guide

Creating Swatches

Swatches can be defined as a component of the color attribute, or set up locally for a specific

product as uploaded product images.

In the following examples, the Sylvia Capris are available in specific values of red, green, and

blue. Because the swatches were taken from the product image, each is a true representation of

the color. The color attribute is used to manage the information for all product colors and

swatches.

Step 1: Create the Swatches

Use either of the following methods to create swatches for your products:

Method 1: Add a Color Swatch

1. To capture the true color of a product, open the image in a photo editor and use the eye

dropper tool to identify the exact color. Then, take note of the equivalent hexadecimal value.

Hexadecimal Color Values

2. On the Admin sidebar, tap Stores. Then under Attributes, choose Product.

3. In the grid, open the color attribute in edit mode.

4. Verify that Catalog Input Type for Store Owner is set to “Visual Swatch.”

5. Under Manage Swatch (values of your attribute.) tap Add Swatch to add a new definition to

the bottom of the list. Then, do the following:

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 205

Manage Swatch Values

a. On the swatch menu, select Choose a color.

Choose a Color

b. In the color picker, place your cursor in the #field, and press the Backspace key to delete

the current value. Then, enter the six numbers that represent the hexadecimal value of the

new color..

c. To save the swatch, tap the Color Wheel button in the lower-right corner of the color

picker.

d. Enter the labels for the Admin and Storefront. In this example, we include the SKU in the

admin label for reference because these colors are used only for a specific product. You can

include a space or underscore in the label, but not a hyphen.

e. Under Is Default, select the swatch that you want to use as the default option.

Images and Video CHAPTER 12: Basic Settings

206 Magento Community Edition 2.0 User Guide

f. To change the order, simply drag the swatch into position.

Swatch Labels

6. When complete, tap Save Attribute. Then when prompted, refresh the cache.

7. The last step is to open each product in Edit mode, and update the Color attribute with the

correct swatch. To update multiple products at the same time, follow the steps below.

Method 2:Upload a Swatch Image

1. To capture an image for a swatch, open the product image in a photo editor, and save a square

area of the image that depicts the color, pattern, or texture. Then repeat for each variation of

the product. The size and dimensions of the swatch is determined by the theme. As a general

rule, saving an image as a square helps to preserve the aspect ratio of a pattern.

Swatch Images

2. On the Admin sidebar, tap Stores. Then under Attributes, choose Product.

3. In the grid, open the color attribute in edit mode.

4. Verify that Catalog Input Type for Store Owner is set to “Visual Swatch.”

5. Under Manage Swatch (values of your attribute.) tap Add Swatch to add a new definition to

the bottom of the list. Then, do the following:

a. On the swatch menu, choose Upload a file.

Upload a File

b. Navigate to the swatch file that you prepared and choose the file for upload.

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 207

c. Repeat these steps for each swatch image.

d. Enter the labels for the Admin and Storefront. In this example, we include the SKU in the

admin label for reference because these colors are used only for a specific product. You can

include a space or underscore in the label, but not a hyphen.

Enter Labels

6. When complete, tap Save Attribute. Then when prompted, refresh the cache.

7. The last step is to open each product in Edit mode, and update the Color attribute with the

correct swatch. To update multiple products at the same time, follow the steps below.

Step 2: Update Your Products

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. Filter the list by Name or SKU to include only the applicable products. The following example

filters the list on a partial product name.

Filters

3. In the grid, mark the checkbox of each product to which the swatch applies. In this example,

all blue capris are selected. Then, set the Actions control to “Update Attributes.”

Images and Video CHAPTER 12: Basic Settings

208 Magento Community Edition 2.0 User Guide

Update Attributes

4. Scroll down to the Colorattribute, and mark the Change checkbox.

Change

5. Choose the swatch that applies to the selected products, and tap Save. Then when prompted,

refresh the cache.

Swatch in Storefront

CHAPTER 12: Basic Settings Images and Video

Magento Community Edition 2.0 User Guide 209

Search Engine Optimization

The Search Engine Optimization page of basic product settings includes the primary fields used

by search engines to index the product. Although some search engines ignore meta keywords,

others continue to use them. The current best practice is to incorporate high-value keywords in

both the meta title and meta description. The default value for each meta data field is auto-

generated based on the configuration setting. Each field contains a placeholder that is replaced

by an actual value. To learn more, see: Default Field Values .

Search Engine Optimization

Search Engine Optimization CHAPTER 12: Basic Settings

210 Magento Community Edition 2.0 User Guide

FIELD SCOPE DESCRIPTION

URL Key Store View Determines the online address of the product. The

URLkey is added to the base URL of the store, and

appears in the address bar of a browser. Magento

initially creates a default, “search engine friendly”

URL, that is based on the product name.

The URL Key should be all lowercase characters, with

hyphens instead of spaces. Do not include a suffix

such as .html in the URL Key, because it is managed

in the configuration.

Meta Title Store View The title appears in the title bar and tab of your

browser, and is also used as the title on a search

engine results page (SERP1). The meta title should be

unique to the page, and less than 70 characters in

length.

Auto-generated value: {{name}}

Meta Keywords Store View Relevant keywords for the product. Consider using

keywords that customers might use to find the

product.

Auto-generated value: {{name}}

Meta Description Store View The meta description provides a brief overview of the

page for search results listings. An ideal length is

between 150-160 characters in length, with a

maximum of 255 characters. Although not visible to

the customer, some search engines include the meta

description on the search results page.

Auto-generated value: {{name}}

Field Descriptions

1Search Engine Results Page

CHAPTER 12: Basic Settings Search Engine Optimization

Magento Community Edition 2.0 User Guide 211

Websites

The Websites page shows the current scope of the product within the store hierarchy. In the

following screenshot, the marked checkbox indicates the website, store, and views where the

product is available. To assign a product to a specific store view, use the Store View control in

the upper-right corner of the page.

Websites

Websites CHAPTER 12: Basic Settings

212 Magento Community Edition 2.0 User Guide

CHAPTER 13:

Advanced Settings

The Advanced Settings section includes tools that are used less frequently.

lAdvanced Pricing

lAdvanced Inventory

lCustom Options

lProduct Relationships

lDesign

lAutosettings

lProduct Reviews

Advanced Settings

Magento Community Edition 2.0 User Guide 213

Advanced Pricing

The Advanced Pricing settings are used to define the conditions for special pricing based on

customer group and website, and for quantity discount tier pricing.

Advanced Pricing

Advanced Pricing CHAPTER 13: Advanced Settings

214 Magento Community Edition 2.0 User Guide

FIELD DESCRIPTION

Group Price Sets up promotional prices for specific customer groups within the

selected website. Options include:

Web Site Identifies the website where the group price

rule applies. This option appears only if the

installation has multiple websites.

Customer Group (Required) Identifies the customer group that

qualifies to receive the group price.

Price (Required) Specifies the product price for

members of the customer group, within the

specific website.

Actions Deletes the current Group Price rule.

Add Group Price Inserts an additional row for a new Group Price rule

Special Price Offers a discounted price during the time period defined by the

From/To dates.

In the storefront when a special price is available, the retail price is

crossed out and the special price appears below in large, bold text.

Special Price From Date Sets the first date the Special Price is available. You can either enter

the date or select it from the calendar.

Special Price To Date Sets the last date the Special Price is available. You can either enter

the date or select it from the calendar.

Cost The actual cost of the item.

Tier Price Offers a quantity discount to members of a specific customer group

and website. Options include:

Web Site Identifies a specific website where the tier

price rule applies.

Customer Group Identifies a specific customer group that

qualifies to receive the tier price discount.

Field Descriptions

CHAPTER 13: Advanced Settings Advanced Pricing

Magento Community Edition 2.0 User Guide 215

FIELD DESCRIPTION

Quantity (Required) The quantity that must be

purchased to receive the tier price.

Item Price (Required) The discounted product price for

the quantity purchased.

Actions Deletes the current tier price rule.

Add Tier Inserts an additional row for a new tier price rule definition.

Field Descriptions (cont.)

Advanced Pricing CHAPTER 13: Advanced Settings

216 Magento Community Edition 2.0 User Guide

Group Price

You can extend a discounted price to members of a specific customer group, if they shop while

logged in to their accounts. The discounted price appears in the shopping cart instead of the

regular price.

Group Price Applied in Shopping Cart

To set up a group price:

1. Open the product in edit mode.

2. In the panel on the left under Advanced Settings, choose Advanced Pricing.

3. In the Group Price section, tap Add Group Price. Then, do the following:

a. Set Customer Group to the group that is to receive the discounted price.

b. Enter the discounted Price.

4. To add another group price tap Add Group Price and repeat the previous steps.

5. When complete, tap Save.

CHAPTER 13: Advanced Settings Advanced Pricing

Magento Community Edition 2.0 User Guide 217

Special Price

To offer a special price, enter the discounted price and the dates when the special price is in

effect. The special price appears instead of the regular price, followed by “was (previous price).”

Special Price

To apply a special price:

1. Open the product in edit mode.

2. In the panel on the left under Advanced Settings, choose Advanced Pricing.

3. Enter the amount of the Special Price.

4. Complete the Special Price From Date and Special Price To Date to define the period of time

that the special price is in effect. Use the Calendar button to the right of each field to set

the dates.

Special Pricing Settings

5. When complete, tap Save.

Advanced Pricing CHAPTER 13: Advanced Settings

218 Magento Community Edition 2.0 User Guide

Tier Price

Tier pricing lets you offer a quantity discount from the catalog list and product detail pages.

The discount can be applied to a specific store view or customer group.

Tier Price “As Low as”

lOn the catalog page, the product price includes the words, “As Low As,” followed by the

lowest tier price.

lThe product page calculates the quantity discount and displays a message such as:

Buy 3 for $5.00 each and save 29%

The prices in the storefront take precedence from the highest to the lowest quantity. Therefore,

if you have a tier for the quantity 5 and one for the quantity 10, and a customer adds 5, 6, 7, 8

or 9 items to the shopping cart, the customer receives the discounted price that you specified

for the quantity 5 tier. As soon as the customer adds the 10th item, the discounted price

specified for the quantity 10 tier supersedes the tier for a quantity of 5, and discounted price for

10 applies.

CHAPTER 13: Advanced Settings Advanced Pricing

Magento Community Edition 2.0 User Guide 219

Tier Price on Product Page

To set up a tier price:

1. Open the product in edit mode.

2. In the panel on the left under Advanced Settings, choose Advanced Pricing.

3. In the Tier Price section, tap Add Tier. Then, do the following:

Tier Pricing

a. If your store has multiple websites, choose the Website where the tier pricing applies.

b. Choose the Customer Group to which the tier pricing applies.

c. In the Qty field, enter the quantity that must be ordered to receive the tier price.

d. In the Item Price field, enter the adjusted price of the item.

To apply the same tier to more than one group, create a separate tier for each group, but

with the same Qty and Price information.

4. To add another group price, tap Add Tier and repeat the previous steps.

5. When complete, tap Save.

Advanced Pricing CHAPTER 13: Advanced Settings

220 Magento Community Edition 2.0 User Guide

Minimum Advertised Price

Merchants are sometimes prohibited from displaying a price that is lower than the

manufacturer’s suggested retail price (MSRP). Magento’s Minimum Advertised Price (MAP)

gives you the ability to remain in compliance with the manufacturer’s requirements while

offering your customers a better price. Because requirements differ from one manufacturer to

another, you can configure your store to prevent the display of your actual price on pages where

it is not allowed to appear according to the terms of the manufacturer.

MAP Logic

For products with prices that depend on a selected options, (such as custom options, or simple

products with their own SKUs and stock management), the following logic is used:

lMAP is applied to the main price. The prices of options, bundle items, and associated

products (which add or subtract from the main price) appear normally.

lIf a product does not have a main price, and its price is derived from the associated product

prices (such as in a grouped product), the MAP settings of the associated products are

applied.

lIf a product in the cart has the Manufacturer’s Suggested Retail Price (MSRP) specified, the

price is not crossed-out.

For other price settings, the following MAP logic is used:

lIf tier pricing is set, the tier price appears according to the Display Actual Price setting.

lIf a special price is set, it is considered to be the actual price for MAP.

In the order management and customer management tools, as well as in the reports sections of

the Admin, only the actual price appears.

CHAPTER 13: Advanced Settings Advanced Pricing

Magento Community Edition 2.0 User Guide 221

Using MAP with Product Types

PRODUCT TYPE DESCRIPTION

Simple,Virtual The actual price does not automatically appear on catalog list and

product pages, but is included only according to the Display Actual

Price setting. Custom option prices appear normally.

Grouped The prices of associated simple products do not automatically

appear on catalog list and product pages, but are included only

according to the Display Actual Price setting.

Configurable The actual price does not automatically appear on catalog list and

product pages, but is included only according to the Display Actual

Price setting. Option prices appear normally.

Bundle (with fixed price) The actual price does not automatically appear on catalog pages, but

is included only according to the Display Actual Price setting. The

prices of bundle items appear normally.

MAP is not available for bundle products with dynamic pricing.

Downloadable The actual price does not automatically appear on catalog list and

product pages, but is included only according to the Display Actual

Price setting. The price associated with each download link appears

normally.

Using MAP with Price Settings

PRICE SETTING DESCRIPTION

Tier Price If tier pricing is set, the tier pricing message is not displayed in the

catalog. On the product page a notification is displayed that indicates

that the price can be lower when ordering more than a certain

quantity, but the discount is displayed in percentages only. For

associated products of a grouped product, the discounts are not

displayed on the product page.

The tier price is shown according to the Display Actual Price setting.

Special Price If the Special price is specified, the special price is displayed

according to the Display Actual Price setting.

Advanced Pricing CHAPTER 13: Advanced Settings

222 Magento Community Edition 2.0 User Guide

Configuring MAP

Your store’s MAP settings can be applied to all products in your catalog, or configured for only

specific products. When Minimum Advertised Price is enabled globally, all product prices in the

storefront are hidden from view. There are a variety of configuration options that you can use to

remain in compliance with the terms of your agreement with the manufacturer, while still

offering your customers a better price.

Actual Price Appears “On Gesture”

On the global level, you can enable or disable MAP, apply it to all products, define how the

actual price is displayed, and edit the text of the related messages and information tips that

appear in the store.

When MAP is enabled, the product-level MAP settings become available. You can apply MAP to

an individual product by entering the MSRP, and choosing how you want the actual price to

appear in the store. Product-level MAP settings override the global MAP settings.

CHAPTER 13: Advanced Settings Advanced Pricing

Magento Community Edition 2.0 User Guide 223

What’s This?

To configure MAP:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. If applicable, in the upper-right corner, set Store View to the view where the configuration

applies.

3. In the panel on the left under Sales, choose Sales.

4. Expand the Minimum Advertised Price section.

5. If necessary, set Enable MAP to “Yes.” Then, do the following:

Minimum Advertised Price

Advanced Pricing CHAPTER 13: Advanced Settings

224 Magento Community Edition 2.0 User Guide

Method 1: Configure MAPfor All Products:

1. To determine when and where you want the actual price to be visible to customers, set Display

Actual Price to one of the following:

lIn Cart

lBefore Order Confirmation

lOn Gesture (on click)

2. Enter the text that you want to appear for the Default Popup Text Message.

3. Enter any additional explanation in the Default “What’s This” Text Message field.

4. When complete, tap Save Config .

Method 2: Configure MAP for a Single Product

1. On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.

2. Open the product in Edit mode.

3. In the panel on the left under Advanced Settings, choose Advanced Pricing. Then, do the

following:

Manufacturer’s Suggested Retail Price

CHAPTER 13: Advanced Settings Advanced Pricing

Magento Community Edition 2.0 User Guide 225

a. Enter the Manufacturer’s Suggested Retail Price.

In this example, the product price is $54.00, and the MSRP is 59.95.

b. Set Display Actual Price to one of the following:

Use config (Default) Applies the MAP configuration setting.

On Gesture Displays the actual product price in a popup when the customer

clicks the “Click for price” or “What’s this?” link.

In Cart Displays the actual product price in the shopping cart.

Before Order

Confirmation

Displays the actual product price at the end of the checkout

process, just before the order is confirmed.

The Manufacturer’s Suggested Retail Price and Display Actual Price fields appear only when

Minimum Advertised Price is enabled in the configuration.

4. When complete, tap Save.

Advanced Pricing CHAPTER 13: Advanced Settings

226 Magento Community Edition 2.0 User Guide

Advanced Inventory

Each product in your catalog has both a short and long version of the Advanced Inventory

options, depending on whether you want to manage stock for the product. The long form

appears when Manage Stock is set to “Yes.” The initial values reflect the default Product Stock

Options set in the configuration.

Advanced Inventory (Short Form)

Method 1: Without Stock Management

1. Open the product in edit mode.

2. In the panel on the left under Advanced Settings, choose Advanced Inventory.

3. Set Manage Stock to “No.” If necessary, clear the Use Config Settings checkbox to make the

field available.

4. Enter the Minimum Qty Allowed in Shopping Cart.

5. Enter the Maximum Qty Allowed in Shopping Cart.

6. If you want to sell by quantity increment, do the following:

a. Set Enable Qty Increments to “Yes.”

b. In the Qty Increments field, enter the number of products that must be purchased in an

incremental step. For example, if you enter 6, the customer must purchase the product in

quantities of 6, 12, 18, and so on.

7. When complete, tap Save.

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 227

FIELD SCOPE DESCRIPTION

Manage Stock Global Determines if inventory control is used to manage this

product in your catalog. Options: Yes / No

Minimum Qty Allowed in

Shopping Cart

Global Determines the minimum number of the product that

can be purchased in a single order.

Maximum Qty Allowed in

Shopping Cart

Global Determines the maximum number of the product that

can be purchased in a single order.

Enable Qty Increments Global Determines if the product can be sold in quantity

increments. Options: Yes / No

Qty Increments Global Enter the number of products that must be purchased

at the same time. For example, if set to 6, the

customer must purchase a quantity of 6, 12, 18, and

so on.

When a product is sold in quantity increments, the

number appears in the upper-right corner, next to the

shopping cart link. If the customer tries to purchase

the product in any other quantity, a message appears

in the shopping cart,

Field Descriptions

Method 2: With Stock Management

1. Open the product in edit mode.

2. In the panel on the left under Advanced Settings, choose Advanced Inventory.

3. Set Manage Stock to “Yes.” If necessary, clear the Use Config Settings checkbox to make the

field available. Then, do the following:

a. Enter the Qty currently in stock.

b. Enter the Qty for Item’s Status to Become Out of Stock.

c. Enter the Minimum Qty Allowed in Shopping Cart.

d. Enter the Maximum Qty Allowed in Shopping Cart.

4. If the quantity is a decimal value, do the following:

a. Set Qty Uses Decimals to “Yes.”

b. If the quantity purchased Can be Divided into Multiple Boxes for Shipping, select “Yes.”

Advanced Inventory CHAPTER 13: Advanced Settings

228 Magento Community Edition 2.0 User Guide

5. Set Backorders to one of the following:

lNo Backorders

lAllow Qty Below 0

lAllow Qty Below 0 and Notify Customer

6. In the Notify for Quantity Below field, enter the stock level that triggers a Quantity Below

notification.

7. To sell the product in quantity increments, do the following:

a. Set Enable Qty Increments to “Yes.”

b. In the Qty Increments field, enter the number of products that must be purchased in an

incremental step. For example, if you enter 6, the customer must purchase the product in

quantities of 6, 12, 18, and so on.

8. If the product is currently in stock, set Stock Availability to “In Stock.”

9. When complete, tap Save .

Advanced Inventory (Long Form)

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 229

FIELD SCOPE DESCRIPTION

Manage Stock Global Determines if inventory control is used to manage this

product in your catalog. Options:

Yes Displays the long form with all stock

management options.

No Display the short form without stock

management options.

Qty Global The quantity of the item that is currently in stock.

Qty for Item’s Status to

Become Out of Stock

Global Determines the stock level at which a product is

considered to be out of stock.

Minimum Qty Allowed in

Shopping Cart

Global Determines the minimum number of the product that

can be purchased in a single order.

Maximum Qty Allowed in

Shopping Cart

Global Determines the maximum number of the product that

can be purchased in a single order.

Qty Uses Decimals Global Determines if customers can use a decimal value

rather than a whole number when entering the quantity

ordered. Options:

Yes Permits values to be entered as

decimals, rather than whole

numbers, which is suitable for

products sold by weight, volume or

length.

No Requires quantity values to be

entered as whole numbers.

Can be Divided into

Multiple Boxes for

Shipping

Global Determines if parts of the product can be shipped

separately. Options: Yes / No

Field Descriptions

Advanced Inventory CHAPTER 13: Advanced Settings

230 Magento Community Edition 2.0 User Guide

FIELD SCOPE DESCRIPTION

Backorders Global Determines how backorders are managed.

Backorders do not change the processing status of

the order. Funds are still authorized or captured

immediately when the order is placed, regardless of

whether the product is in stock. Products are shipped

as they become available. Options:

Backorders

Does not accept backorders when

product is out of stock.

Allow Qty

Below 0

Accepts backorders when the

quantity falls below zero.

Allow Qty

Below 0 and

Notify

Customer

Accepts backorders when the

quantity falls below zero, but notifies

customers that orders can still be

placed.

Notify for Quantity Below Global Determines the stock level at which notification is

sent that the inventory has fallen below the threshold.

Enable Qty Increments Global Determines if the product can be sold in quantity

increments. Options: Yes / No

Stock Availability Global Determines the current availability of the product.

Options:

In Stock Makes the product available for

purchase.

Out of Stock Unless Backorders are activated,

prevents the product from being

available for purchase and removes

the listing from the catalog.

Field Descriptions (cont.)

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 231

Stock Options

Your catalog can be configured to display the availability of each item as “In Stock” or “Out of

Stock,” The configuration setting applies to the catalog as a whole, and the message changes

according to the stock status of the product. There are several display variations possible,

including how “out of stock” products are managed in the catalog and in product listings.

The out of stock threshold indicates when a product needs to be reordered, and can be set to

any number greater than zero. Another way you can use the stock availability threshold is to

manage products that are in high demand. If you want to capture new customers, rather than

sell to high-quantity buyers, you can set a maximum quantity to prevent a single buyer from

taking out your entire inventory.

In Stock, Only 1 Left

Advanced Inventory CHAPTER 13: Advanced Settings

232 Magento Community Edition 2.0 User Guide

To configure stock options:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Inventory.

3. Expand the Stock Options section, and do the following:

a. To return items to stock if an order is canceled, Set Items’ Status to be in Stock When

Order in Canceled to “Yes.”

b. To adjust the quantity on hand when an order is placed, set Decrease Stock When Order

is Placed to “Yes.”

c. Set Display Out of Stock Products to “Yes” to continue to display products in the catalog

that are no longer in stock.

If price alerts are enabled, customers can sign up to be notified when the product is back in

stock.

d. To display the message, “Only x left,” enter the number in the Display X left Threshold

field.

The message begins to appear when the quantity in stock reaches the threshold. For

example, if set to 3, the message “Only 3 left” appears when the quantity in stock reaches

3. The message adjusts to reflect the quantity in stock, until the quantity reaches zero.

e. To display an “In Stock” or “Out of Stock” message on the product page, set Display

Products Availability In Stock on Storefront to “Yes.”

Stock Options

4. When complete, tap Save Config.

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 233

Product Stock Options

The Product Stock Options configuration determines the default product inventory settings at

the product level. The configuration applies to individual products, rather than to the contents

of the cart as a whole.

To configure the default inventory settings:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Inventory.

3. Expand the Product Stock Options section, and do the following:

a. To activate inventory control for your catalog, set Manage Stock to “Yes.”

Product Stock Options

Advanced Inventory CHAPTER 13: Advanced Settings

234 Magento Community Edition 2.0 User Guide

b. Set Backorders to one of the following:

No Backorders To not accept backorders when product is out of stock.

Allow Qty Below

To accept backorders when the quantity falls below zero.

Allow Qty Below

0 and Notify

Customer

To accept backorders when the quantity falls below zero, and notify

the customer that the order can still be placed.

c. Enter the Maximum Qty Allowed in Shopping Cart.

d. Enter the Qty for Item's Status to Become Out of Stock.

e. Enter the Minimum Qty Allowed in Shopping Cart.

f. In the Notify for Quantity Below field, enter the stock level that triggers notification that

the item is out of stock.

g. To activate quantity increments for the product, set Enable Qty Increments to “Yes.” Then

in the Qty Increments field, enter the number of the items that must be purchased to meet

the requirement. For example, an item that is sold in increments of 6 can be purchased in

quantities of 6, 12, 18, and so on.

h. When a credit memo is issued for the item, set Automatically Return Credit Memo Item to

Stock to “Yes” if you want to return the item to inventory by default.

4. When complete, tap Save Config.

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 235

Stock Message Scenarios

You can use a combination of configuration settings to control stock availability messages on

product pages and in listings of products on catalog pages.

Grouped Product with “Out of Stock” Message

Product Page Stock Messages

There are several variations of messaging available for the product page, depending on the

combination of Manage Stock and Stock Availability settings.

Advanced Inventory CHAPTER 13: Advanced Settings

236 Magento Community Edition 2.0 User Guide

Example 1: Show Availability Message

Scenario 1: This combination of settings causes the availability message to appear on the

product page, according to the stock availability of each product.

STOCK OPTIONS MESSAGE

Display product availability in stock in the frontend: Yes

Product Inventory

Manage Stock Yes

Stock Availability In Stock

Out of Stock

“Availability: In

Stock”

“Availability: Out of

Stock”

Scenario 2: When stock is not managed for a product, this combination of settings can be

used to display the availability message on the product page.

STOCK OPTIONS MESSAGE

Display product availability in stock in the frontend: Yes

Product Inventory

Manage Stock No “Availability: In

Stock”

Example 2: Hide Availability Message

Scenario 1: This combination of configuration and product settings prevents the availability

message from appearing on the product page.

STOCK OPTIONS MESSAGE

Display product availability in stock in the frontend: No

Product Inventory

Manage Stock Yes

Stock Availability In Stock

Out of Stock

None

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 237

Scenario 2: When stock is not managed for a product, this combination of configuration and

product settings prevents the availability message from appearing on the product page.

STOCK OPTIONS MESSAGE

Display product availability in stock in the frontend: No

Product Inventory

Manage Stock No None

Catalog Page Stock Messages

The following display options are possible for the category and search results lists, depending

on the product availability and configuration settings.

“Out of Stock” Message on Category Page

Advanced Inventory CHAPTER 13: Advanced Settings

238 Magento Community Edition 2.0 User Guide

Example 1: Show Product with “Out of Stock Message”

This combination of configuration settings includes out of stock products in the category and

search results lists, and displays an “out of stock” message.

STOCK OPTIONS MESSAGE

Display Out of Stock Products

Display product availability in stock in the frontend

Yes

Yes “Out of stock”

Display Out of Stock Products Yes

Display product availability in stock in the frontend No None

Example 2: Show Product without “Out of Stock Message”

This combination of configuration settings includes out of stock products in the category and

search results lists, but does not display a message.

STOCK OPTIONS MESSAGE

Display Out of Stock Products

Display product availability in stock in the frontend

Yes

None

Example 3: Hide Product Until Back in Stock

This configuration setting omits out of stock products entirely from the category and search

results lists, until they are back in stock.

STOCK OPTIONS MESSAGE

Display Out of Stock Products No None

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 239

Product Alerts

Customers can subscribe to two types of alerts by email: price change alerts and in-stock alerts.

For each type of alert, you can determine if customers are able to subscribe, select the email

template that is used, and identify the sender of the email.

When price change alerts are enabled, a “Sign up for price alert” link appears on every product

page. Customers can click the link to subscribe to alerts related to the product. Guests are

prompted to open an account with your store. Whenever the price changes, or the product goes

on special, everyone who has signed up to be notified receives an email alert.

The in-stock alert creates a link called “Sign up to get notified when this product is back in

stock” for every product that is out of stock. Customers can click the link to subscribe to the

alert. When the product is back in stock, customers receive email notification that the product

is available. Products with alerts have a Product Alerts tab in the Product Information panel

that lists the customers who have subscribed to an alert.

Advanced Inventory CHAPTER 13: Advanced Settings

240 Magento Community Edition 2.0 User Guide

To set up product alerts:

1. On the Admin sidebar, tapStores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Catalog.

3. Click to expand the Product Alerts section, and do the following:

a. To offer price change alerts to your customers, set Allow Alert When Product Price

Changes to “Yes.”

b. Set Price Alert Email Template to the template that you want to use for the price alert

notifications.

c. To offer alerts when out-of-stock products become available again, set Allow Alert When

Product Comes Back in Stock to “Yes.”

The “Sign up to get notified when this product is back in stock” message appears only when

Inventory Stock Options - Display Out of Stock Products is set to “Yes.”

d. Set Stock Alert Email Template to the template that you want to use for product stock

alerts.

e. Set Alert Email Sender to the store contact that you want to appear as the sender of the

email alert.

Product Alerts

4. When complete, tap Save Config.

CHAPTER 13: Advanced Settings Advanced Inventory

Magento Community Edition 2.0 User Guide 241

Product Alert Run Settings

These settings enable you to select how often Magento checks for changes that require alerts to

be sent. Additionally, you can select the recipient, sender, and template for emails that are sent

if the sending of alerts fails.

Product Alert Run Settings

To set up product alerts:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Catalog, choose Catalog.

3. Expand the Product Alerts Run Settings section, and do the following:

a. To determine how often product alerts are sent, set Frequency to one of the following:

lDaily

lWeekly

lMonthly

b. To determine the time of day product alerts are sent, set Start Time to the hour, minute,

and second.

c. In the Error Email Recipient field, enter the email of the person to be contacted if an error

occurs.

d. In the Error Email Sender field, select the store identity that appears as the sender of the

error notification.

e. Set Error Email Template to the transactional email template to be used for the error

notification.

4. When complete, tap Save Config.

Advanced Inventory CHAPTER 13: Advanced Settings

242 Magento Community Edition 2.0 User Guide

Custom Options

Adding custom options to a product is an easy way to offer customers a selection of options

with a variety of text, selection, and date input types. Custom options are a good solution if

your inventory needs are simple. However, because custom options are variations of a single

SKU, they cannot be used to manage stock. If you have multiple products with the same

options, you can set the custom options in one product, and then import the options to other

products.

Custom Options

To create custom options:

1. Open the product in edit mode.

2. In the panel on the left under Advanced Settings, choose Custom Options.

3. Tap Add New Options. Then, do the following:

a. In the Option Title field, enter a name for the option.

b. Set the Input Type for data entry.

c. If the option is not required to purchase the product, clear the Required checkbox.

4. Tap Add New Row. Then, complete the following:

a. In the Title field, enter a name for this option.

b. In the Price field, enter any markup or markdown from the base product price that applies

to this option.

c. Set Price Type to one of the following:

Fixed The price of the variation differs from the price of the base product by

a fixed monetary amount, such as $1.

Percentage The price of the variation differs from the price of the base product by

a percentage, such as 10%.

CHAPTER 13: Advanced Settings Custom Options

Magento Community Edition 2.0 User Guide 243

d. Enter a SKU for the option. The option SKUis a suffix that is added to the product SKU.

e. To change the order of the options, tap the Sort Order icon , and drag the option to a

new position in the list.

f. Repeat this step for each option to be added.

5. When complete, tap Save.

Change Order of Options

To import custom options:

1. In the Custom Options section, tap Import Options.

2. In the list, mark the checkbox of the product with the options that you want to import.

3. Tap Import.

4. When complete, you can add more custom options, or tap Save and Close.

Importing Custom Options

Custom Options CHAPTER 13: Advanced Settings

244 Magento Community Edition 2.0 User Guide

INPUT TYPE DESCRIPTION

TEXT

Field A single line input field for text.

Area A multiple-line input box for paragraphs of text. You can use the

WYSIWYG Editor to format the text with HTML tags, or type HTML

directly into the text area.

FILE

File A file to be uploaded by the customer.

SELECT

Drop-down A drop-down list of options. Only one item can be selected at a time.

Radio Buttons A set of options that allows only one to be selected at a time.

Checkbox A checkbox is a variation of a Yes/No option. If the product has more

than one checkbox, multiple selections can be made at the same

time.

Multiple Select A drop-down list of options that accepts multiple selections. To

select multiple options, hold down the Ctrl (PC) or Command (Mac)

key.

DATE

Date An input field for a date value. The date can be typed directly into the

field, selected from a list or calendar. The method of input used and

format of the date is determined by the Date & Time Custom Options

configuration.

Date &Time An input field for date and time values.

Time An input field for a time value.

Input Controls

CHAPTER 13: Advanced Settings Custom Options

Magento Community Edition 2.0 User Guide 245

Related Products

Related products are meant to be purchased in addition to the item the customer is viewing.

The customer can place the item in the shopping cart by simply clicking the checkbox. The

placement of the Related Products block varies according to theme and page layout. In the

example below, it appears at the bottom of the Product View page. With a 2 column layout, the

Related Product block often appears in the right sidebar.

Related Products

To set up related products:

1. Open the product in edit mode.

2. In the panel on the left under Advanced Settings, choose Related Products.

Related Products

Related Products CHAPTER 13: Advanced Settings

246 Magento Community Edition 2.0 User Guide

3. In the upper-left corner, tap Reset Filter to list all the available products, or use the search

filters at the top of each column to find specific products.

4. In the list, mark the checkbox in the first column of any product you want to feature as a

Categories

Before you add products to your catalog, you need to establish the basic category structure

of your catalog. Every product must be assigned to at least one category. Categories are

usually created in advance, before products are added to the catalog. However, you can

also add categories “on the fly” while creating a product.

The category structure of your catalog is like an upside-down tree, with the root at the top.

Each section of the tree can be expanded and collapsed. Any disabled or hidden categories

are grayed out. The first level of categories below the root typically appear as options in the

main menu. Below that, you can have as many additional subcategories as you need.

Category Tree

Magento Community Edition 2.0 User Guide 257

FIELD DESCRIPTION

Add Root Category Creates a new root category.

Add Subcategory Adds a subcategory below the current category or subcategory.

Collapse All / Expand All Either collapses or expands the category tree.

Delete Category Removes the current category or subcategory from the tree.

Reset Removes unsaved changes, and restores the previous settings.

Save Category Saves any changes made to the category.

Controls

258 Magento Community Edition 2.0 User Guide

CHAPTER 14: Categories

Creating Categories

The category structure of your catalog is represented as an upside-down tree, with the root at

the top. Each section of the tree can be expanded and collapsed. Any disabled or hidden

categories are grayed out. Categories can be dragged and dropped to other locations in the tree,

and each category has an ID number in parentheses after the category name at the top of the

page.

Category Tree

Process Overview:

Step 1: Create a Category

Step 2: Complete the General Information

Step 3: Complete the Display Settings

Step 1: Create a Category

1. On the Admin sidebar, tap Products. Then under Inventory, choose Categories.

2. In the category tree, tap the parent category of the new category. The parent is one level above

the new category.

If you’re starting from the beginning without any data, there might be only two categories in

the list: “Default Category,” which is the root, and an “Example Category.”

3. Tap Add Subcategory.

CHAPTER 14: Categories Creating Categories

Magento Community Edition 2.0 User Guide 259

Step 2: Complete the General Information

1. On the General Information tab, do the following:

a. (Required) Enter the Name of the category.

b. (Required) To enable the category, set Is Active to “Yes.”

c. You can enter a URL Key for the category, or let the system automatically create one that

is based on the category name.

2. In the Description box, enter a paragraph or two of descriptive text for the category landing

page.

3. To display an Image at the top of the category landing page, tap Choose File, and choose the

image to upload.

4. Complete the following category meta data:

lPage Title

lMeta Keywords

lMeta Description

5. (Required) To include the category in the main menu, set Include in Navigation Menu to “Yes.”

6. Tap Save Category.

Step 3: Complete the Display Settings

You can configure the category landing page to display both a static block and product list, or

one or the other. A static block can provide additional information, including text, images, and

even embedded video.

1. On the Display Settings tab, set Display Mode to one of the following:

lProducts Only

lStatic Block Only

lStatic Block and Products

2. If applicable, set CMSBlock to the static block that you want to appear on the category page.

3. If you want this category page to display the “Filter by Attribute” section of layered navigation,

set Is Anchor to “Yes.”

Creating Categories CHAPTER 14: Categories

260 Magento Community Edition 2.0 User Guide

4. Clear the checkbox under Default Product Listing Sort By. Then select one of the available

values to sort the list. By default, all available attributes are listed. The default values typically

include:

lBest Value

lName

lPrice

Display Settings

5. When complete, tap Save Category.

CHAPTER 14: Categories Creating Categories

Magento Community Edition 2.0 User Guide 261

Modifying Categories

After a category is established, it can be edited, moved to another position in the category tree,

or deleted from the catalog. If your catalog is live, first consider how the change might impact

any existing links to products in the category. For example, if your product URLs include the

category path, and the category name is changed, any existing links to products in the category

will be broken. To avoid this problem, you can configure your catalog to automatically create a

permanent redirect if the URLkey changes. You can also use the URL Rewrite tool to redirect

traffic from an old URL to a new one.

To move a category:

1. On the Admin sidebar, tap Products. Then under Inventory, choose Categories.

2. To move a category, drag-and-drop the category to a new position in the tree. Changes to the

category structure are saved automatically.

To delete a category:

3. In the category tree, select the category that you want to delete.

A deleted category cannot be restored, so make sure that you have selected the correct category

before proceeding.

4. Tap Delete Category. Then when prompted to confirm, tap OK.

Creating Categories CHAPTER 14: Categories

262 Magento Community Edition 2.0 User Guide

Root Categories

The category structure is like an upside-down tree, with the root on top. All categories in your

catalog are nested below the root. Because the root category is the highest level of the catalog,

your store can have only one root category active at a time. You can, however, create additional

root categories for alternate catalog structures, different stores, and views. Cart price rule

conditions can be based on any category that is a child of the store’s root. The root category is

not visible to customers in the store, and does not have a URLkey.

New Root Category

Process Overview:

Step 1: Create a New Root Category

Step 2: Add Subcategories to the New Root

Step 3: Apply the New Root Category to Your Store

CHAPTER 14: Categories Creating Categories

Magento Community Edition 2.0 User Guide 263

Step 1: Create a New Root Category

1. On the Admin sidebar, tap Products. Then under Inventory, choose Categories.

2. Tap Add Root Category.

3. On the General Information tab, do the following:

a. Enter a Name for the root category.

b. Set Is Active to “Yes.”

c. Enter the URL Key for the root category.

d. Enter a Description of the root category.

a. To upload an Image for the category, tap Choose File and select the image.

b. Complete the following meta data:

lPage Title

lMeta Keywords

lMeta Description

c. To show the root category in the main menu, set Include in Navigation Menu to “Yes.”

4. On the Display Settings tab, set Is Anchor to “Yes.”

5. When complete, tap Save Category.

Step 2: Add Subcategories to the New Root

1. In the category tree on the left, select the new root category that you created in the last step.

2. Tap Add Subcategory.

3. Enter a Name for the subcategory.

4. Set Is Active to “Yes.”

5. Tap Save Category.

6. Repeat this process to create as many subcategories as needed.

Creating Categories CHAPTER 14: Categories

264 Magento Community Edition 2.0 User Guide

New Root with Subcategory

Step 3: Apply the New Root Category to Your Store

1. On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.

2. Under Store, tap the Main Website Store link.

3. Set Root Category to the new root category.

4. When complete, tap Save Store.

CHAPTER 14: Categories Creating Categories

Magento Community Edition 2.0 User Guide 265

Hidden Categories

There are many ways to use hidden categories. You might want to create additional category

levels for your own internal purposes, but show only the higher-level categories to your

customers. Or, you might want to link to a category that is not included in the navigation

menu.

To create hidden categories:

1. On the Admin sidebar, tap Products. Then under Inventory, choose Categories.

2. In the category tree, select the category you want to hide.

3. On the General Information tab, do the following:

a. Set Is Active to “No.”

b. Set Include in Navigation Menu to “No.”

4. On the Display Settings tab, set Is Anchor to “No.”

5. Although the category is hidden, you can still create additional subcategories beneath it, and

make them active. Complete the following settings for each hidden subcategory:

a. On the General Information tab, set Is Active to “Yes.”

b. On the Display Settings tab, set Is Anchor to “Yes.”

As active categories, you can now link to them from other places in your store, but they will not

appear in the navigation menu.

6. When complete, tap Save Category.

Creating Categories CHAPTER 14: Categories

266 Magento Community Edition 2.0 User Guide

General Information

The General Information tab contains the basic information about the category. You can

activate the category, enter meta data to improve the way the category is indexed by search

engines, define the URL key, and include the category in the main menu.

General Information

CHAPTER 14: Categories General Information

Magento Community Edition 2.0 User Guide 267

FIELD DESCRIPTION

Name (Required) The category name appears in the navigation, and also in

the URL key of the category page and associated product pages.

Is Active (Required) To make this category available, select “Yes.”

Options:Yes/No

URL Key The URL Key is a relative path to the category, and is automatically

generated when the category is saved. The URL Key must be all

lower-case characters, with no spaces. As a best practice, each

word is separated by a hyphen. If you edit the default URL key, a

custom redirect is created automatically. A root category does not

have a URL key.

Description The category description, if used, appears below the category image-

and before the product list.

Image If supported by your theme, a thumbnail image can be associated

with each category and appear as part of the option in the main menu

of the store.

WYSIWYG Editor Opens the editor.

Image The category image, if used, appears at the top of the category page,

before the description and product list.

As an alternative, you can display a CMS static block in place of the

description and image. (See Category Display Settings.)

Browse Locates the image file to be uploaded from the directory of your

system.

Page Title The category page title appears in the browser tab and title bar. As a

best practice, the title should be not more than twelve words in

length, and should include a combination of primary and secondary

keywords.

Field Descriptions

General Information CHAPTER 14: Categories

268 Magento Community Edition 2.0 User Guide

FIELD DESCRIPTION

Meta Keywords Keywords are used by some search engines, and not by others. You

can use a keyword search tool to identify high value keywords that

relate to your category. A general rule is to use no more than thirty

keywords, or 180 characters. Avoid repeats, and empty words such

as “a,” “an,” “or” and “that.”

Meta Description Enter a description of the category, using approximately twenty-five

words or 150 characters.

Include in Navigation

(Required) Determines if the category is included in the main menu.

Options:

Yes Include this category in the top navigation,

select “Yes.”

No Hides the category, although it is active.

Hidden categories do not appear in the top

navigation, but are included in layered

navigation.

Field Descriptions (cont.)

CHAPTER 14: Categories General Information

Magento Community Edition 2.0 User Guide 269

Display Settings

The Display Settings determine which content elements appear on a category page and the

order in which products appear. You can enable CMS blocks, set the anchor status of the

category, and manage sorting options from the Display Settings tab.

Display Settings

Display Settings CHAPTER 14: Categories

270 Magento Community Edition 2.0 User Guide

FIELD DESCRIPTION

Display Mode Determines the content elements displayed on the category page.

Options:

Products Only

Static Block Only

Static Block and Products

CMS Block To display a CMS static block at the top of the category page, select

the name of the block from the list.

Is Anchor When set to “Yes,” includes the “filter by attribute” section in the

layered navigation. Options:Yes/No

Available Product Listing

Sort By

(Required) The default values are Position, Name, and Price. To

customize the sorting option, clear the Use All Available Attributes

checkbox and select the attributes you want to use. You can define

and add attributes as needed.

Default Product Listing

Sort By

(Required) To define the default “Sort By” option, clear the “Use

Config Settings” checkbox and select an attribute.

Layered Navigation Price

Step

By default, Magento displays the price range in increments of 10,

100, and 1000, depending on the products in the list. To change the

Price Step range, clear the “Use Config Settings” checkbox.

Field Descriptions

CHAPTER 14: Categories Display Settings

Magento Community Edition 2.0 User Guide 271

Custom Design

The Custom Design tab gives you control over the look and feel of a category and all assigned

product pages, and page layout. You can customize a category page its assigned products for a

promotion or to differentiate the category. For example, you might develop distinctive design

for a brand or special line of products.

Custom Design

Custom Design CHAPTER 14: Categories

272 Magento Community Edition 2.0 User Guide

FIELD DESCRIPTION

Use Parent Category

Settings

Allows the current category to inherit the design settings from the

parent category. Options:Yes/No

Apply to Products Applies the custom settings to all products in the category.

Options:Yes/No

Custom Theme Applies a custom theme to the category.

Active From The beginning of a date range that specifies the first day the theme is

to be used in the store. The date can be entered or selected from the

calendar.

Active To The end of a date range that specifies the last day the theme is to be

used in the store. The date can be entered or selected from the

calendar

Page Layout Applies a different layout to the category page. Options:

No layout updates Pre-selected by default, and does not apply

layout changes to the category page.

Empty Use to define your own page layout.

(Requires an understanding of XML.)

1 column Applies a one-column layout to the category

page.

2 columns with left

bar

Applies a two-column layout with a left

sidebar to the category page.

2 columns with

right bar

Applies a two-column layout with a right

sidebar to the category page.

3 columns Applies a three-column layout to the category

page.

Custom Layout Update Updates the theme layout with custom XML code.

Field Descriptions

CHAPTER 14: Categories Custom Design

Magento Community Edition 2.0 User Guide 273

Category Products

The Category Products tab lists the products that are currently assigned to the category. The

search filters at the top of each column are used to add and remove products from the category.

Category Products

FIELD DESCRIPTION

Selection The checkbox in the header of the first column can be used to select

or deselect all products.

The control in the first row determines the type of search, and can be

set to incude any record, or only those that are either assigned or not

assigned to the category. The checkbox in the first column of each

row identifies products to be added to the category. Options: Yes /

No / Any

Search Filters The filter controls at the top of each column can be used to enter

specific values you want to either include or omit from the list,

depending on the Select All setting.

Reset Filter Clears all search filters.

Search Searches the catalog based on the filter criteria, and displays the

result.

Controls

Category Products CHAPTER 14: Categories

274 Magento Community Edition 2.0 User Guide

CHAPTER 15:

Using Product Attributes

Attributes are the building blocks of your product catalog, and describe specific

characteristics of a product. Attributes determine the type of input control that is used for

product options, provide additional information for product pages, and are used as search

parameters and criteria for layered navigation, product comparison reports, and

promotions. You can create as many attributes as you need to describe the products in

your catalog. Other attributes such as price, are built into the core Magento platform and

are referred to as “system attributes.”

Creating a New Attribute from an Open Product

Magento Community Edition 2.0 User Guide 275

Adding an Attribute

Although attributes are managed from the Stores menu, you can add new attributes “on the fly”

while working on a product. You can choose from the list of existing attributes, or create a new

attribute. The new attribute is added to the attribute set used by the product.

Process Overview:

Step 1: Add a New Attribute

Step 2: Describe the Basic Properties

Step 3: Describe the Advanced Properties

Step 4: Enter the Field Label

Step 5: Describe the Frontend Properties

Adding an Attribute CHAPTER 15: Using Product Attributes

276 Magento Community Edition 2.0 User Guide

Step 1: Add a New Attribute

1. Open the product in edit mode. Under Product Details , tap Add Attribute.

New Attribute

2. To add an existing attribute to the product, do one of the following:

lType the name of an existing attribute into the search box.

lClick the search box, and choose an existing attribute from the list.

3. To define a new attribute, tap New Attribute. Then, do the following:

CHAPTER 15: Using Product Attributes Adding an Attribute

Magento Community Edition 2.0 User Guide 277

Step 2: Describe the Basic Properties

1. On the Admin sidebar, tap Stores. Then under Attributes, choose Product.

2. Tap Add New Attribute.

Attribute Properties

3. Under Attribute Properties, enter a Default Label to identify the attribute.

4. Set Catalog Input Type for Store Owner to the type in input control to be used for data entry.

5. For Dropdown and Multiple Select input types, do the following:

a. Under Manage Options, tap Add Option.

b. Enter the first value that you want to appear in the list. You can enter one value for the

Admin, and a translation of the value for each store view. If you have only one store view,

you can enter only the Admin value and it will be used for the storefront as well.

c. Tap Add Option and repeat the previous step for each option that you want to include in

the list.

d. Select Is Default to use the option as the default value.

6. If you want to require the customer to choose an option before the product can be purchased,

set Values Required to “Yes.”

Manage Options

Adding an Attribute CHAPTER 15: Using Product Attributes

278 Magento Community Edition 2.0 User Guide

Step 3: Describe the Advanced Properties (if needed)

1. Enter a unique Attribute Code in lowercase characters, and without spaces.

Advanced Attribute Properties

2. Set Scope to indicate where in your store hierarchy the attribute can be used.

3. If you want to prevent duplicate values from being entered, set Unique Value to “Yes.”

4. To run a validity test of any data entered into a text field, set Input Validation for Store Owner

to the type of data that the field should contain. This field is not available for input types with

values that are selected. The test can validate any of the following:

lDecimal Number

lInteger Number

lEmail

lURL

lLetters

lLetters (a-z, A-Z) or Numbers (0-9)

Input Validation

CHAPTER 15: Using Product Attributes Adding an Attribute

Magento Community Edition 2.0 User Guide 279

Step 4: Enter the Field Label

1. Expand the Manage titles section.

2. Enter a Title to be used as a label for the field. If your store is available in different languages,

you can enter a translated title for each view.

Manage Titles

Step 5: Describe the Storefront Properties

1. In the panel on the left, choose Storefront Properties.

2. If the attribute is to be available for search, set Use in Search to “Yes.”

3. To include the attribute in Product Compare, set Comparable on Storefront to “Yes.”

4. For dropdown, multiple select and price fields, do the following:

a. To use the attribute as a filter in layered navigation, set Use in Layered Navigation to

“Yes.”

b. to use the attribute in layered navigation on search results pages, set Use in Search

Results Layered Navigation to “Yes,”

c. In the Position field, enter a number to indicate the relative position of the attribute in the

layered navigation block.

5. To use the attribute in price rules, set Use for Promo Rule Conditions to “Yes,”

6. To allow the text to be formatted with HTML, set Allow HTML Tags on Frontend to “Yes.”

This setting makes the WYSIWYG editor available for the field.

To include the attribute in catalog page listings, set Visible on Catalog Pages on Storefront to

“Yes.”

Adding an Attribute CHAPTER 15: Using Product Attributes

280 Magento Community Edition 2.0 User Guide

7. Complete the following settings if supported by your theme:

a. To include the attribute on the product detail page, set Visible on Catalog Pages on

Storefront to “Yes.”

b. To include the attribute in product listings, set Used in Product Listing to “Yes.”

c. To use attribute as a sort parameter for product listings, set Used for Sorting in Product

Listing to “Yes.”

8. When complete, tap Save Attribute.

Storefront Properties

CHAPTER 15: Using Product Attributes Adding an Attribute

Magento Community Edition 2.0 User Guide 281

Attribute Input Types

When viewed from the Admin, attributes are the fields that you complete when you create a

product. The input type that is assigned to an attribute determines the type of data that can be

entered and the format of the field or input control. From the standpoint of the customer,

attributes provide information about the product, and are the options and data entry fields

that must be completed to purchase a product.

PROPERTY DESCRIPTION

Text Field A single line input field for text.

Text Area A multiple-line input field for entering paragraphs of text such as a

product description. You can use the WYSIWYG Editor to format the

text with HTML tags, or type the tags directly into the text.

Date Date values can be entered by making a selection from a drop-down

list, or popup calendar . Depending on your system configuration,

dates can be typed directly into a field, or selected from the calendar

or list. To format date and time values, see: Date & Time Custom

Options.

Yes/No Displays a drop-down list with pre-defined options of “Yes” and “No.”

Dropdown Displays a drop-down list of values. Only one item can be selected at

a time. The Dropdown input type is a key component of configurable

products.

Multiple Select Displays a drop-down list of values. To select more than one option,

hold the Ctrl key down and click each item.

Price This input type is used to create price fields that are in addition to the

predefined attributes, Price, Special Price, Tier Price and Cost. The

currency used is determined by your system configuration.

Media Image Associates an additional image with a product, such as a product

logo, care instructions, or ingredients from a food label. When you

add a media image attribute to the attribute set of a product, it

becomes an additional image type, along with Base, Small, and

Thumbnail. The media image attribute can be excluded from the

thumbnail gallery, but can still be used.

Attribute Input Types CHAPTER 15: Using Product Attributes

282 Magento Community Edition 2.0 User Guide

PROPERTY DESCRIPTION

Fixed Product Tax Lets you define FPT rates based on the requirements of your locale.

Visual Swatch Displays a swatch that depicts the color, texture, or pattern of the

product. A visual swatch can be filled with a hexadecimal color value,

or display an image.

Text Swatch Displays a text value such as size. A text swatch looks like a button,

and can be used to represent an attribute value such as size.

CHAPTER 15: Using Product Attributes Attribute Input Types

Magento Community Edition 2.0 User Guide 283

Date & Time Options

You can customize the format of date and time fields, and select the input control that is used

for data entry. Dates values can be selected from a drop-down list, or pop-up calendar.

Pop-up Calendar

Attribute Input Types CHAPTER 15: Using Product Attributes

284 Magento Community Edition 2.0 User Guide

To format date/time fields:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left, tap Catalog. Then, choose the Catalog option.

3. Expand the Date & Time Custom Options section, and do the following:

a. To use a popup calendar as the input control for date fields, set Use JavaScript Calendar

to “Yes.”

b. To establish the Date Fields Order, set each to one of the following:

lMonth

lDay

lYear

c. Set your preferred Time Format to one of the following:

l12h AM/PM

l24h

d. To establish the Year Range for the drop-down year values, enter the year in YYYY format

to set the from and to dates. If blank, the field defaults to the current year.

Date & Time Custom Options

4. When complete, tap Save Config.

CHAPTER 15: Using Product Attributes Attribute Input Types

Magento Community Edition 2.0 User Guide 285

Notes

286 Magento Community Edition 2.0 User Guide

MARKETING

Marketing Menu

Shopping Tools

Promotions

Communications

SEO & Search

Contents Marketing Menu

Shopping Tools

Opportunities to Engage

Email a Friend

Wish List

Configuring the Wish List

Product Relationships

Compare Products

Related Products

Related products are meant to be purchased in

addition to the item the customer is viewing. They

complement, enhance, or add optional features to the

product.

Up-sells

Up-sell products are items that are similar, but are

perhaps of a higher-quality, more popular, or have a

better profit margin than the item the customer is

considering.

Cross-sells

Cross-sell products are offered on the shopping cart

page as last-minute purchases before the checkout

process begins.

Product Relationships CHAPTER 17: Shopping Tools

300 Magento Community Edition 2.0 User Guide

Compare Products

Compare Products generates a detailed, side-by-side comparison of two or more products. You

can customize the report to include additional attributes or remove ones that you don’t want to

include. Depending on the theme, the Add to Compare link might be represented by an icon or

text.

Compare Products

To compare products:

1. From your storefront, find the products that you want to compare, and click the Compare link

for each.

2. Depending on the theme and page layout, there might be a Compare Products block in the

sidebar. If so, you can mark the checkbox of the products to include in the report, and tap

Compare. The Compare Products report opens in a new window.

3. To print the report, tap Print This Page.

4. After navigating to other pages, you can click the link in the header or sidebar to return to the

report.

lTo remove a single product from the report, tap Delete .

lTo remove all products from the report, click the Clear All link.

CHAPTER 17: Shopping Tools Compare Products

Magento Community Edition 2.0 User Guide 301

Compare Products

Compare Products CHAPTER 17: Shopping Tools

302 Magento Community Edition 2.0 User Guide

See also:

European Commission Taxation and Customs Union

EU 1015 Place of Supply Changes

CHAPTER 65: Taxes EU Place of Supply

Magento Community Edition 2.0 User Guide 799

Tax Zones and Rates

Tax rates generally apply to transactions that take place within a specific geographical area.

The Tax Zones and Rates tool enables you to specify the tax rate for each geographical area

from which you collect and remit taxes. Because each tax zone and rate has a unique identifier,

you can have multiple tax rates for a given geographic area (such as places that do not tax food

or medicine, but do tax other items).

Store tax is calculated based on the store’s address. The actual customer tax for an order is

calculated after the customer completes the order information. Magento then calculates the tax

based upon the tax configuration of the store.

Tax Zones and Rates

To define a new tax rate:

1. On the Admin sidebar, tap Stores. Under Taxes, choose Tax Zones and Rates.

2. In the upper-right corner, tap Add New Tax Rate.

3. Enter a Tax Identifier.

4. To apply the tax rate to a single ZIP or postal code, enter the code in the Zip/Post Code field.

5. The asterisk wildcard (*) can be used to match up to ten characters in the code. For example,

90* represents all ZIP codes from 90000 through 90999.

6. To apply the tax rate to a range of ZIP or postal codes, do the following::

a. Mark the Zip/Post is Range checkbox.

b. Enter the first ZIP or postal code in the range.

c. Enter the last ZIP or postal code in the range.

d. Choose the State where the tax rate applies.

Tax Zones and Rates CHAPTER 65: Taxes

800 Magento Community Edition 2.0 User Guide

e. Choose the Country where the tax rate applies.

f. Enter the Rate Percent that is used for the tax rate calculation.

7. When complete, tap Save Rate.

New Tax Rate

To edit an existing tax rate:

1. On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Zones and Rates.

2. Find the tax rate in the Tax Zones and Rates grid, and open the record in edit mode.

If there are many rates in the list, use the filter controls to find the rate you need.

3. Make the necessary changes to the Tax Rate Information.

4. Update the Tax Titles as needed.

5. When complete, tap Save Rate.

CHAPTER 65: Taxes Tax Zones and Rates

Magento Community Edition 2.0 User Guide 801

Import/Export Tax Rates

If you conduct business in several states and ship a large quantity of product, it is more

efficient to download tax rates by ZIP code than enter the rates manually. The rates can then be

imported into Magento. The following example shows how to import a set of California tax

rates that was downloaded from the Avalara website. Avalara is a Magento Technology Partner,

and provides tax rate tables that can be downloaded at no charge for every ZIP code in the

United States.

Process Overview:

Step 1: Export the Magento Tax Rate Data

Step 2: Prepare the Import Data

Step 3: Import the Tax Rates

Step 1: Export the Magento Tax Rate Data

1. On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export Tax

Rates.

2. Tap Export Tax Rates. Look for the download file in the lower-left corner of the browser

window.

3. Save the file, and then open it in a spreadsheet. (In this example, we use OpenOffice Calc.)

The exported Magento tax rate data includes the following columns:

lCode

lCountry

lState

lZip/Post Code

lRate

lRange From

lRange To

lA column for each store view

Exported Tax Rate Data

Tax Zones and Rates CHAPTER 65: Taxes

802 Magento Community Edition 2.0 User Guide

4. Open the new tax rate data in a second instance of the spreadsheet, so you can see both, side

by side.

In the new tax rate data, take note of any additional tax rate data that you might need to set

up in your store before the data is imported. For example, the tax rate data for California also

includes:

lTaxRegionName

lCombinedRate

lStateRate

lCountyRate

lCityRate

lSpecialRate

If you need to import additional tax zones and rates, you must first define them from the

Admin of your store, and update the tax rules as needed. Then, export the data, and open the

file in OpenOffice Calc, so it can be used for reference. However, to keep this example simple,

we will import only the standard tax rate columns.

Step 2: Prepare the Import Data

You now have two spreadsheets open, side by side. One with the Magento export file structure,

and the other with the new tax rate data that you want to import.

1. To create a place to work in the spreadsheet with the new data, insert as many blank columns

at the far left as needed. Then, use cut and paste to rearrange the columns so they match the

order of the Magento export data.

2. Rename the column headers to match the Magento export data.

3. Delete any columns that have no data. Otherwise, the structure of the import file should match

the original Magento export data.

4. Before saving the file, scroll down and make sure that the tax rate columns contain only

numeric data. Any text found in a tax rate column will prevent the data from being imported.

5. Save the prepared data as a .CSVfile. When prompted, verify that a comma is used a Field

delimiter, and double quotes as the Text delimiter. Then, tap OK.

CHAPTER 65: Taxes Tax Zones and Rates

Magento Community Edition 2.0 User Guide 803

Step 3: Import the Tax Rates

1. On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export Tax

Rates.

2. Tap Browse, and choose the .CSV tax rate file that you prepared to import. Then, tap Import

Tax Rates.

It might take several minutes to import the data. When the process is complete, the message,

"The tax rate has been imported" appears. If you receive an error message, correct the problem

in the data and try again.

3. On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Zones and Rates. The

imported rates appear in the list. Use the page controls to view the new tax rates.

Imported Tax Rates

4. Run some test transactions in your store with customers from different ZIP codes to make sure

that the new tax rates work correctly.

Tax Zones and Rates CHAPTER 65: Taxes

804 Magento Community Edition 2.0 User Guide

Value Added Tax (VAT)

Some countries charge a value added tax, or VAT, on goods and services. There can be different

VAT rates depending on which stage you as a merchant are at in the manufacture or

distribution of the products, materials, or services that you sell to your customers. In this case

you may need to use more than one VAT rate in your store for tax calculation purposes.

Configuring VAT

The following instructions include a sample procedure to set up a 20% VAT in the U.K. for

sales to retail customers. For other tax rates and countries, follow the general procedure but

enter specific information that corresponds to your country, VAT rate, customer types, and so

on.

Before proceeding, make sure to find out which rules and regulations apply to VAT in your area.

In certain business-to-business transactions, VAT is not assessed. Magento can validate a

customer’s VAT ID to ensure that VAT is assessed (or not assessed) properly. To learn more,

see: VAT Validation.

Process Overview:

Step 1: Set Up Customer Tax Classes

Step 2: Set Up Product Tax Classes

Step 3: Set Up Tax Zones and Rates

Step 4: Set Up Tax Rules

Step 5: Apply Tax Classes to Products

Step 1: Set Up Customer Tax Classes

1. On the Admin sidebar, tap Stores. Then choose, select Tax Zones and Rates.

2. Ensure that there is a customer tax class that is appropriate to use with the VAT. For this

example, ensure that there is a customer tax class named Retail Customer. If Retail Customer

does not exist, click the Add New button and add it.

Step 2: Set Up Product Tax Classes

1. On the Admin menu, select Sales > Tax > Product Tax Classes.

2. Click the Add New button and create three new classes:

CHAPTER 65: Taxes Value Added Tax (VAT)

Magento Community Edition 2.0 User Guide 805

lVAT Standard

lVAT Reduced

lVAT Zero

3. Click the Save Class button for each new class that you add.

Step 3: Set Up Tax Zones and Rates

1. On the Admin menu, select Sales > Tax > Manage Tax Zones & Rates.

For this example you can remove the U.S. tax rates, or leave them as they are.

2. Click the Add New Tax Rate button. Add new rates as follows:

NEW TAX RATE SETTINGS

VAT Standard Tax Identifier: VAT Standard

Country and State: United Kingdom

Rate Percent: 20.00

VAT Reduced Tax Identifier: VAT Reduced

Country and State: United Kingdom

Rate Percent: 5.00

3. Click the Save Rate button for each rate.

Step 4: Set Up Tax Rules

A tax rule is a combination of a customer tax class, a product tax class, and a tax rate.

1. On the Admin menu, select Sales > Tax > Manage Tax Rules.

2. Add new tax rules as follows:

NEW TAX RULE SETTINGS

VAT Standard Name: VAT Standard

Customer Tax Class: Retail Customer

Product Tax Class: VAT Standard

Tax Rate: VAT Standard Rate

Value Added Tax (VAT) CHAPTER 65: Taxes

806 Magento Community Edition 2.0 User Guide

NEW TAX RULE SETTINGS

VAT Reduced Name: VAT Reduced

Customer Tax Class: Retail Customer

Product Tax Class: VAT Reduced

Tax Rate: VAT Reduced Rate

3. Click the Save Rule button for each rate.

Step 5: Apply Tax Classes to Products

1. On the Admin menu, select Catalog > Manage Products.

2. Open a product from your catalog in edit mode.

3. On the General page, find the Tax Class field. Then, select the VAT Class that applies to the

product.

4. When complete, click the Save button.

CHAPTER 65: Taxes Value Added Tax (VAT)

Magento Community Edition 2.0 User Guide 807

VATValidation

VATIDValidation automatically calculates the required tax for B2B transactions that take

place within the European Union (EU), based on the merchant and customer locale. Magento

performs VAT ID validation using the web services of the European Commission server.

VAT-related tax rules do not influence other tax rules, and do not prevent the application of other tax

rules. Only one tax rule can be applied at a given time.

lVAT is charged if the merchant and customer are located in the same EU country.

lVAT is not charged if the merchant and customer are located in different EU countries, and

both parties are EU-registered business entities.

The store administrator creates more than one default customer group that can be

automatically assigned to the customer during account creation, address creation or update,

and checkout. The result is that different tax rules are used for intra-country (domestic) and

intra-EU sales.

Important: If you sell virtual or downloadable products, which by their nature do not require

shipping, the VAT rate of a customer’s location country should be used for both intra-union and

domestic sales. You must create additional individual tax rules for product tax classes that

correspond to the virtual products.

Customer Registration Workflow

If VAT ID Validation is enabled, after registration each customer is proposed to enter the VAT

ID number. However only those who are registered VAT customers are expected to fill this field.

After a customer specifies the VAT number and other address fields, and chooses to save, the

system saves the address and sends the VAT ID validation request to the European

Commission server. According to the results of the validation, one of the default groups is

assigned to a customer. This group can be changed if a customer or an administrator changes

the VAT ID of the default address or changes the whole default address. The group can be

temporarily changed (group change will be emulated) in some cases during one-page checkout.

If enabled, you can override VAT ID Validation for individual customers by selecting the

checkbox on the Customer Information page.

Value Added Tax (VAT) CHAPTER 65: Taxes

808 Magento Community Edition 2.0 User Guide

Checkout Workflow

If a customer’s VAT validation is performed during checkout, the VAT request identifier and

VAT request date are saved in the Comments History section of the order.

The system behavior concerned with the VAT ID validation and the customer group change

during the checkout depends on how the Validate on Each Transaction and the Disable

Automatic Group Change settings are configured. This section describes the implementation of

the VAT ID Validation functionality for the checkout on the frontend.

In case a customer uses Google Express Checkout, PayPal Express Checkout or another

external checkout method, when the checkout is performed completely on the side of the

external payment gateway, the Validate on Each Transaction setting cannot be applied. Thus

the customer group cannot change during checkout.

CHAPTER 65: Taxes Value Added Tax (VAT)

Magento Community Edition 2.0 User Guide 809

VATValidation Checkout Workflow

Value Added Tax (VAT) CHAPTER 65: Taxes

810 Magento Community Edition 2.0 User Guide

Configuring VAT ID Validation

Example: Minimal Tax Rules Required for VATID Validation

TAX RULE #1

Customer Tax Class Customer tax classes must include:

A class for domestic customers

A class for customers with invalid VAT ID

A class for customers, for whom VAT ID validation failed

Product Tax Class Product tax classes must include a class for products of all types,

except bundle and virtual.

Tax Rate The tax rate must include the VAT rate of the merchant’s country.

TAX RULE #2

Customer Tax Class A class for intra-union customers.

Product Tax Class A class for products of all types, except virtual.

Tax Rate VAT rates for all EU countries, except merchant’s country. Currently

this rate is 0%.

TAX RULE #3 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)

Customer Tax Class Customer tax classes must include:

A class for domestic customers

A class for customers with invalid VAT ID

A class for customers, for whom VAT ID validation failed

Product Tax Class A class for virtual products.

Tax Rate VAT rate of the merchant’s country.

TAX RULE #4 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)

Customer Tax Class A class for intra-union customers.

Product Tax Class A class for virtual products.

Tax Rate VAT rates for all EU countries, except merchant’s country. Currently

this rate is 0%.

CHAPTER 65: Taxes Value Added Tax (VAT)

Magento Community Edition 2.0 User Guide 811

Process Overview:

Step 1: Create VAT-Related Customer Groups

Step 2: Create VAT-Related Classes, Rates and Rules

Step 3: Enable and Configure VAT ID Validation

Step 4: Set your VAT ID and Location Country

Step 5: Verify the List of EU Member Countries

Step 1: Create VAT-Related Customer Groups

VAT ID Validation automatically assigns one of the four default customer groups to customers

according to VAT ID validation results:

lDomestic

lIntra-EU

lInvalid VAT ID

lValidation error

You can create new customer groups for VAT ID Validation or use existing groups, if they

comply with your business logic. When configuring VAT ID Validation, you must assign each

of the created customer groups as a default for customers with appropriate VAT ID validation

results.

Step 2: Create VAT-Related Classes, Rates, and Rules

Each tax rule is defined be three entities:

lCustomer Tax Classes

lProduct Tax Classes

lTax Rates

Create the tax rules that you need to use VAT IDValidation effectively.

lTax rules include tax rates and tax classes.

lTax classes are assigned to customer groups.

Step 3: Enable and Configure VAT ID Validation

1. On the Admin sidebar, tap Stores. Under Settings, choose Configuration.

2. If necessary, set the Store View for the configuration.

3. In the panel on the left under Customers, choose Customer Configuration.

Value Added Tax (VAT) CHAPTER 65: Taxes

812 Magento Community Edition 2.0 User Guide

4. Expand the Create New Account Options section.

Create New Account Options

5. Set Enable Automatic Assignment to Customer Group to “Yes.” Then complete the following

fields as needed.

lDefault Group

lDefault Value for Disable Automatic Group Changes Based on VATID

lShow VAT Number on Frontend

6. When complete, tap Save Config.

Step 4: Set Your VAT ID and Location Country

1. On the Admin sidebar, tap Stores. Under Settings, choose Configuration.

2. If needed, set Store View to the applicable store view.

3. In the panel on the left under General, choose General.

4. Expand the Store Information section. Then, do the following:

CHAPTER 65: Taxes Value Added Tax (VAT)

Magento Community Edition 2.0 User Guide 813

Store Information

a. Select your Country.

b. Enter your VAT Number. Then, tap Validate VAT Number. The result appears immediately.

5. When complete, tap Save Config.

Value Added Tax (VAT) CHAPTER 65: Taxes

814 Magento Community Edition 2.0 User Guide

Step 5: Verify the List of EU Member Countries

1. Continuing in the General configuration section, expand the Countries Options section.

Countries Options

2. In the list of European Union Countries, verify that each member country of the EU is

selected.

3. When complete, tap Save Config.

CHAPTER 65: Taxes Value Added Tax (VAT)

Magento Community Edition 2.0 User Guide 815

Tax Quick Reference

Some tax settings have a choice of options that determines the way the tax is calculated and

presented to the customer. To learn more, see: International Tax Guidelines.

Tax Calculation Methods

Tax calculation method options include Unit Price, Row Total, and Total. The following table

explains how rounding (to two digits) is handled for different settings.

SETTING CALCULATION AND DISPLAY

Unit Price Magento calculates the tax for each item and displays prices tax-

inclusive. To calculate the tax total, Magento rounds the tax for each

item, and then adds them together.

Row Total Magento calculates the tax for each line. To calculate the tax total,

Magento rounds the tax for each line item and then adds them

together.

Total Magento calculates the tax for each item and adds those tax values

to calculate the total unrounded tax amount for the order. Magento

then applies the specified rounding mode to the total tax to determine

the total tax for the order.

Tax Configuration Options

Catalog PricesWith or Without Tax

The possible display fields vary depending on the calculation method and whether the catalog

prices include or exclude taxes. Display fields have two-decimal precision in normal

computations. Some combinations of price settings display prices that both include and

exclude tax. When both appear on the same line item, it can be confusing to customers, and

triggers a warning.

Tax Quick Reference CHAPTER 65: Taxes

816 Magento Community Edition 2.0 User Guide

SETTING CALCULATION AND DISPLAY

Excluding Tax Using this setting, the base item price is used as it is entered and the

tax calculation methods are applied.

IncludingTax Using this setting, the base item price excluding tax is calculated

first. This value is used as the base price, and the tax calculation

methods are applied.

Tax Configuration Options

Important! Changes have been made from earlier versions for EU merchants or other VAT merchants

who display prices including tax and operate in several countries with multiple store views. If you load

prices with more than two digits of precision, Magento automatically rounds all prices to two digits to

ensure that a consistent price is presented to buyers.

Shipping Prices With or Without Tax

SETTING DISPLAY CALCULATION

Excluding Tax Appears without tax. Normal calculation. Shipping is added

to cart total, typically displayed as a

separate item.

Including Tax Can be tax inclusive, or tax

can be displayed

separately.

Shipping is treated as another item in

cart with taxes, using the same

calculations.

Tax Configuration Options

Tax Amounts as Line Items

To display two different tax amounts as separate line items, such as GST and PST for Canadian

stores, you must set different priorities for the related tax rules. However, in previous tax

calculations, taxes with different priorities would automatically be compounded. To correctly display

separate tax amounts without an incorrect compounding of the tax amounts, you can set different

priorities, and also select the Calculate off subtotal only checkbox. This produces correctly

calculated tax amounts that appear as separate line items.

CHAPTER 65: Taxes Tax Quick Reference

Magento Community Edition 2.0 User Guide 817

International Tax Guidelines

TAX OPTION RECOMMENDED SETTING

Load catalog prices Excluding tax

FPT No, because FPT is not taxed.

Tax based on Shipping origin

Tax Calculation On total

Tax shipping? No

Apply Discount Before tax

Comment All tax zones are the same priority; ideally, a zone for state and one or

more zones for zip code lookup.

U.S. Tax Configuration

TAX OPTION RECOMMENDED SETTING

Load catalog prices Excluding tax

FPT Yes, including FPT and description

Tax based on Shipping address

Tax Calculation On total

Tax shipping? Yes

Apply Discount Before tax, discount on prices, including tax.

Comment For merchants marking up supplier invoices (including VAT).

UK B2C Tax Configuration

TAX OPTION RECOMMENDED SETTING

Load catalog prices Excluding tax

FPT Yes, including FPT and description

U.K. B2B Tax Configuration

International Tax Guidelines CHAPTER 65: Taxes

818 Magento Community Edition 2.0 User Guide

TAX OPTION RECOMMENDED SETTING

Tax based on Shipping address

Tax Calculation On item

Tax shipping? Yes

Apply Discount Before tax, discount on prices, including tax.

Comment For B2B merchants to provide simpler VAT supply chain

considerations. Tax calculation on row is also valid; however, check

with your taxing jurisdiction. Setup assumes a merchant is in the

supply chain and that goods sold are used by other vendors for VAT

rebates and so on. This makes it easy to discern tax by item for

faster rebate generation. Note that some jurisdictions require different

rounding strategies not currently supported by Magento, and that not

all jurisdictions allow item or row level tax.

U.K. B2B Tax Configuration (cont.)

TAX OPTION RECOMMENDED SETTING

Load catalog prices Excluding tax

FPT Yes, including FPT, description, and apply tax to FPT.

Tax based on Shipping origin

Tax Calculation On total

Tax shipping? Yes

Apply Discount Before tax

Comment Merchants located in a GST/PST province (Montreal) should create

one tax rule and show a combined tax amount.

Be sure to consult a qualified tax authority if you have any questions.

For information about the tax requirements of specific provinces, see

the following:

Revenu Québec

Government of Saskatchewan

Manitoba Information for Vendors

Canada Tax Configuration

CHAPTER 65: Taxes International Tax Guidelines

Magento Community Edition 2.0 User Guide 819

U.S. Tax Guidelines

Tax Classes

TAX CLASS RECOMMENDED SETTING

Tax Class for Shipping None

Calculation Settings

CALCULATION RECOMMENDED SETTING

Tax Calculation Method Based On Total

Tax Calculation Based On Shipping Origin

Catalog Prices Excluding Tax

Shipping Prices Excluding Tax

Apply Customer Tax After Discount

Apply Discount on Prices Excluding Tax

Default Tax Destination Calculation

SETTING RECOMMENDED SETTING

Default Country United States

Default State State where business is located.

Default Post Code The postal code that is used in your tax zones.

Price Display Settings

SETTING RECOMMENDED SETTING

Display Product Prices in Catalog Excluding Tax

Display Shipping Prices Excluding Tax

International Tax Guidelines CHAPTER 65: Taxes

820 Magento Community Edition 2.0 User Guide

Shopping Cart Display Settings

SETTING RECOMMENDED SETTING

Display Prices Excluding Tax

Display Subtotal Excluding Tax

Display Shipping Amount Excluding Tax

Display Gift Wrapping Prices Excluding Tax

Display Printed Card Prices Excluding Tax

Include Tax in Grand Total Yes

Display Full Tax Summary Yes

Display Zero Tax Subtotal Yes

Orders, Invoices, Credit Memos, Display Settings

SETTING RECOMMENDED SETTING

Display Prices Excluding Tax

Display Subtotal Excluding Tax

Display Shipping Amount Excluding Tax

Include Tax in Grand Total Yes

Display Full Tax Summary Yes

Display Zero Tax Subtotal Yes

Fixed Product Taxes

SETTING RECOMMENDED SETTING

Enable FPT No, except in California.

CHAPTER 65: Taxes International Tax Guidelines

Magento Community Edition 2.0 User Guide 821

Canadian Tax Guidelines

The following example shows how to set up GSTtax rates for Canada and PSTtax rates for

Saskatchewan, with tax rules that calculate and display the two tax rates. Because this is an

example configuration, be sure to verify the correct tax rates and rules for your tax

jurisdictions. When setting up taxes, set the store scope to apply the configuration to all

applicable stores and websites.

lFixed product tax is included for relevant goods as a product attribute.

lIn Quebec, PST is referred to as TVQ. If you need to set up a rate for Quebec, make sure to

use TVQ as the identifier.

Process Overview:

Step 1: Complete the Tax Calculation Settings

Step 2: Set Up Canadian Goods & Services Tax (GST)

Step 3: Set Up Canadian Provincial Sales Tax (PST)

Step 4: Create a GSTTax Rule

Step 5: Create a PSTTax Rule for Saskatchewan

Step 6: Save and Test the Results

Step 1: Complete Tax Calculation Settings

1. On the Admin menu, select System >Configuration. Then in the panel on the left, under

Sales, select Tax.

2. Click to expand each section, and complete the following settings:

FIELD RECOMMENDED SETTING

Tax Calculation Method Based On Total

Tax Calculation Based On Shipping Address

Catalog Prices Excluding Tax

Shipping Prices Excluding Tax

Apply Customer Tax After Discount

Apply Discount on Prices Excluding Tax

Apply Tax On Custom Price (if available)

Tax Calculation Settings

International Tax Guidelines CHAPTER 65: Taxes

822 Magento Community Edition 2.0 User Guide

FIELD RECOMMENDED SETTING

Tax Class for Shipping Shipping (shipping is taxed)

Tax Classes

FIELD RECOMMENDED SETTING

Default Country Canada

Default State (as appropriate)

Default Postal Code * (asterisk)

Default Tax Destination Calculation

FIELD RECOMMENDED SETTING

Include Tax in Grand Total Yes

Display Full Tax Summary Yes

Display Zero in Tax Subtotal Yes

Shopping Cart Display Settings

FIELD RECOMMENDED SETTING

Enable FPT Yes

All FPT Display Settings Including FPT and FPT description

Apply Discounts to FPT No

Apply Tax to FPT Yes

Include FPT in Subtotal No

Fixed Product Taxes

Step 2: Set Up Canadian Goods & Services Tax (GST)

To print the GST number on invoices and other sales documents, include it in the name of the

applicable tax rates. The GST will appear as part of the GST amount on any order summary.

CHAPTER 65: Taxes International Tax Guidelines

Magento Community Edition 2.0 User Guide 823

FIELD RECOMMENDED SETTING

Tax Identifier Canada-GST

Country Canada

State * (asterisk)

Zip/Post is Range No

Zip/Post Code * (asterisk)

Rate Percent 5.0000

Manage Tax Zones & Rates

Step 3: Set Up Canadian Provincial Sales Tax (PST)

Set up another tax rate for the applicable province.

FIELD RECOMMENDED SETTING

Tax Identifier Canada-SK-PST

Country Canada

State Saskatchewan

Zip/Post is Range No

Zip/Post Code * (asterisk)

Rate Percent 5.0000

Tax Rate Information

International Tax Guidelines CHAPTER 65: Taxes

824 Magento Community Edition 2.0 User Guide

Step 4: Create a GST Tax Rule

To avoid compounding the tax and to correctly display the calculated tax as separate line

items for GSTand PST, you must set different priorities for each rule, and select the “Calculate

off subtotal only” checkbox. Each tax appears as a separate line item, but the tax amounts are

not compounded.

FIELD RECOMMENDED SETTING

Name Retail-Canada-GST

Customer Tax Class Retail Customer

Product Tax Class Taxable Goods

Shipping

Tax Rate Canada-GST

Priority 0

Calculate off subtotal only Select this checkbox.

Sort Order 0

Tax Rule Information

Step 5: Create a PST Tax Rule for Saskatchewan

For this tax rule, make sure to set the priority to 0 and select the "Calculate off subtotal only"

checkbox. Each tax appears as a separate line item, but the tax amounts are not compounded.

FIELD RECOMMENDED SETTING

Name Retail-Canada-PST

Customer Tax Class Retail Customer

Product Tax Class Taxable Goods

Shipping

Tax Rate Canada-SK-PT

Priority 1

Tax Rule Information

CHAPTER 65: Taxes International Tax Guidelines

Magento Community Edition 2.0 User Guide 825

FIELD RECOMMENDED SETTING

Calculate off subtotal only Select this checkbox.

Sort Order 0

Tax Rule Information (cont.)

Step 6: Save and Test the Results

1. When complete, click the Save Config button.

2. Return to your storefront, and create a sample order to test the results.

International Tax Guidelines CHAPTER 65: Taxes

826 Magento Community Edition 2.0 User Guide

EU Tax Guidelines

The following example depicts a store based in France that sells > 100k Euros in France and >

100k Euros in Germany.

lTax calculations are managed at the website level.

lCurrency conversion and tax display options are controlled individually at the store view

level, (Click the Use Website checkbox to override the default).

lBy setting the default tax country you can dynamically show the correct tax for the

jurisdiction.

lFixed product tax is included for relevant goods as a product attribute.

lIt might be necessary to edit the catalog to ensure that it shows up in the correct

category/website/store view.

Process Overview:

Step 1: Create Three Product Tax Classes

Step 2: Create Tax Rates for France and Germany

Step 3: Set Up the Tax Rules

Step 4: Set Up a Store View for Germany

Step 5: Configure Tax Settings for France

Step 6: Configure Tax Settings for Germany

Step 1: Create Three Product Tax Classes

For this example, it is assumed that multiple VAT-Reduced product tax classes are not needed.

1. Create a VAT-Standard product tax class.

2. Create a VAT-Reduced product tax class.

3. Create a VAT-Free product tax class.

CHAPTER 65: Taxes International Tax Guidelines

Magento Community Edition 2.0 User Guide 827

Step 2: Create Tax Rates for France and Germany

Create the following tax rates:

TAX RATE SETTING

France-StandardVAT Country: France

State/Region: *

ZIP/Postal Code: *

Rate: 20%

France-ReducedVAT Country: France

State/Region: *

ZIP/Postal Code: *

Rate: 5%

Germany-StandardVAT Country: Germany

State/Region: *

ZIP/Postal Code: *

Rate: 19%

Germany-ReducedVAT Country: Germany

State/Region: *

ZIP/Postal Code: *

Rate: 7%

Tax Rates

International Tax Guidelines CHAPTER 65: Taxes

828 Magento Community Edition 2.0 User Guide

Step 3: Set Up the Tax Rules

Create the following tax rules:

TAX RULE SETTING

Retail-France-StandardVAT Customer Class: Retail Customer

Tax Class: VAT-Standard

Tax Rate: France-StandardVAT

Priority: 0

Sort Order: 0

Retail-France-ReducedVAT Customer Class: Retail Customer

Tax Class: VAT Reduced

Tax Rate: France-ReducedVAT

Priority: 0

Sort Order: 0

Retail-Germany-

StandardVAT

Customer Class: Retail Customer

Tax Class: VAT-Standard

Tax Rate: Germany-StandardVAT

Priority: 0

Sort Order: 0

Retail-Germany-

ReducedVAT

Customer Class: Retail Customer

Tax Class: VAT-Reduced

Tax Rate: Germany-ReducedVAT

Priority: 0

Sort Order: 0

Tax Rules

CHAPTER 65: Taxes International Tax Guidelines

Magento Community Edition 2.0 User Guide 829

Step 4: Set Up a Store View for Germany

1. On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.

2. Under the default website, create a store view for Germany. Then, do the following:

a. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

a. In the upper-left corner, set Default Config to the French store.

b. On the General page, expand the Countries Options section, and set the default

country to “France.”

c. Complete the locale options as needed.

3. In the upper-left corner, choose the German Store View. Then, do the following:

a. On the General page, expand Countries Options, and set the default country to

“Germany.”

b. Complete the locale options as needed.

Step 5: Configure Tax Settings for France

Complete the following General tax settings:

FIELD RECOMMENDED SETTING

Tax Class for Shipping Shipping (shipping is taxed)

Tax Calculation Method Based

Total

Tax Calculation Based On Shipping Address

Catalog Prices Including Tax

Shipping Prices Including Tax

Apply Customer Tax After Discount

Apply Discount on Prices Including Tax

Apply Tax On Custom Price (if available)

Default Country France

General Settings

International Tax Guidelines CHAPTER 65: Taxes

830 Magento Community Edition 2.0 User Guide

FIELD RECOMMENDED SETTING

Default State

Default Postal Code * (asterisk)

Include Tax in Grand Total Yes

Enable FPT Yes

All FPT Display Settings Including FPT and FPT description

Apply Discounts to FPT No

Apply Tax to FPT Yes

Include FPT in Subtotal Yes

General Settings (cont.)

CHAPTER 65: Taxes International Tax Guidelines

Magento Community Edition 2.0 User Guide 831

Step 6: Configure Tax Settings for Germany

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left, under Sales,choose Tax. Then, do the following:

a. In the upper-right corner, choose the German Store View.

b. To the right of the Default Country field, clear the Use Website checkbox. Then, set

Default Country to “Germany.”

c. To the right of the Default State field, clear the Use Website checkbox. Then, set Default

State to “*.”

d. To the right of the Default Post Code field, mark the Use Website checkbox. Then, set

Default Post Code to “*.”

3. When complete, tap Save Config.

Default Tax Destination Calculation

International Tax Guidelines CHAPTER 65: Taxes

832 Magento Community Edition 2.0 User Guide

Warning Messages

Some combinations of tax-related options might be confusing to customers and trigger a

warning. These conditions might occur when the tax calculation method is set to “Row” or

“Total,” and the customer is presented with prices that both exclude and include tax, or a tax

on an item basis in the cart. Because the tax calculation is rounded, the amount that appears

in the cart might differ from the amount that a customer expects to pay.

If your tax calculation is based on a problematic configuration, the following warnings appear:

Warning. Tax discount configuration might result in different discounts than a customer

might expect for store(s); Europe Website (French), Europe Website (German). Please

see source for more details.

Warning. Tax configuration can result in rounding errors for store(s): Europe Websites

(French), Europe Websites (German).

Calculation Settings

Use the following tables for reference when configuring tax calculation settings:

Tax Calculation Method Based On: Excluding Tax

PRICE DISPLAY UNIT PRICE ROW TOTAL TOTAL

Tax Class for Shipping Shipping (is taxed)

Excluding tax OK OK OK

Including tax OK OK OK

Including and

Excluding tax

OK OK Warning

Tax Excluded

Catalog Prices: Including Tax

PRICE DISPLAY UNIT PRICE ROW TOTAL TOTAL

Excluding tax OK OK OK

Including tax OK OK OK

Tax Included

CHAPTER 65: Taxes Warning Messages

Magento Community Edition 2.0 User Guide 833

PRICE DISPLAY UNIT PRICE ROW TOTAL TOTAL

Including and

Excluding tax

OK Warning Warning

Tax Included (cont.)

Calculation Settings

Warning Messages CHAPTER 65: Taxes

834 Magento Community Edition 2.0 User Guide

Discount Settings

We strongly recommend that you use the following settings to avoid issues when configuring

taxes in relation to discounts.

FIELD RECOMMENDED SETTING

Apply Customer Tax After Discount

Apply Discount on Prices US and Canada Excluding Tax

EU Including Tax

Recommended Settings

CHAPTER 65: Taxes Warning Messages

Magento Community Edition 2.0 User Guide 835

Notes

836 Magento Community Edition 2.0 User Guide

CHAPTER 66:

Currency

Magento Community Edition 2.0 gives you the ability to accept currencies from more than

two hundred countries around the world. If the store supports multiple currencies, a

Currency Chooser appears in the header after currency rates are updated.

If you accept payment in multiple currencies, make sure to monitor the currency rate settings,

because any fluctuation can impact your profit margin.

Currency symbols appear in product prices and sales documents such as orders and

invoices. You can customize the currency symbols as needed, and also set the display of

the price separately for each store or view.

Currency Chooser

Magento Community Edition 2.0 User Guide 837

Currency Configuration

Before setting up individual currency rates, first specify which currencies you accept, and the

currency that you want to use to display prices in your store.

Currency Setup

Process Overview:

Step 1: Choose the Accepted Currencies

Step 2: Configure the Import Connection

Step 3: Configure the Scheduled Import Settings

Step 4: Update the Currency Rates

Currency Configuration CHAPTER 66: Currency

838 Magento Community Edition 2.0 User Guide

Step 1: Choose the Accepted Currencies

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under General, choose Currency Setup.

3. Expand the Currency Options section, and do the following:

a. Set Base Currency to the primary currency that you use for online transactions.

b. Set Default Display Currency to the currency that you use to display pricing in your store.

c. In the Allowed Currencies list, select all currencies that you accept as payment in your

store. Make sure to also select your primary currency. (For multiple currencies, hold down

the Ctrl key and select each option.)

Currency Options

4. When prompted to refresh the cache, tap the Close box in the upper-right corner of the

system message. We’ll refresh the cache later.

5. To define the scope of the base currency, do the following:

a. In the panel on the left under Catalog, choose Catalog. Then, scroll down and expand

the Price section.

b. Set Catalog Price Scope to either “Global” or “Website.”

CHAPTER 66: Currency Currency Configuration

Magento Community Edition 2.0 User Guide 839

Price

Step 2: Configure the Import Connection

1. Scroll back up to the top of the page. In the panel on the left under General, choose Currency

Setup.

2. Expand the WebserviceX section.

3. In the Connection Timeout in Seconds field, enter the number of seconds of inactivity to

allow before the connection times out.

WebserviceX

Step 3: Configure the Scheduled Import Settings

1. Continuing with Currency Setup, expand the Scheduled Import Settings section.

2. To automatically update currency rates, set Enabled to "Yes." Then, do the following:

a. Set Service to the rate provider. The default value is “Webservicex.”

b. Set Start Time to the hour, minute, and second that the rates will be updated according to

the schedule.

c. To determine how often the rates are updated, set Frequency to one of the following:

lDaily

lWeekly

lMonthy

d. In the Error Email Recipient field, enter the email address of the person who is to receive

email notification if an error occurs during the import process. To enter multiple email

addresses, separate each with a comma.

Currency Configuration CHAPTER 66: Currency

840 Magento Community Edition 2.0 User Guide

e. Set Error Email Sender to the store contact that appears as the sender of the error

notification.

f. Set Error Email Template to the email template used for the error notification.

3. When complete, tap Save Config.

4. When prompted to update the cache, tap the Cache Management link. Then, refresh the

invalid cache.

Refresh Cache

Scheduled Import Settings

Step 4: Update the Currency Rates

The currency rates must be updated with the current values before they go into effect. Follow

the instructions to update the rates manually or to import the rates automatically.

CHAPTER 66: Currency Currency Configuration

Magento Community Edition 2.0 User Guide 841

Currency Symbols

Manage Currency Symbols gives you the ability to customize the symbol associated with each

currency that is accepted as payment in your store.

Currency Symbols

To customize currency symbols:

1. On the Admin sidebar, tap Stores. Then under Currency, choose Currency Symbols.

Each currency that is currently enabled for your store appears in the Currency list.

2. Enter a custom symbol for each currency you want to use, or mark the Use Standard checkbox

to the right of each currency.

3. To override the default symbol, clear the Use Standard checkbox. Then, enter the symbol that

you want to use.

It is not possible to change the alignment of the currency symbol from left to right.

4. When complete, tap Save Currency Symbols.

5. When prompted to update the cache, tap the Cache Management link. Then, refresh any

invalid cache.

Refresh Cache

Currency Symbols CHAPTER 66: Currency

842 Magento Community Edition 2.0 User Guide

Updating Currency Rates

Currency rates can be set manually, or imported into the store. To ensure that your store has

the most current rates, you can configure the currency rates to be updated automatically on

schedule.

Before importing currency rates, complete the Currency Rate Setup to specify the currencies

that you accept, and to establish the import connection and schedule.

Updating Currency Rates

To manually update a currency rate:

1. On the Admin sidebar, click Stores. Then under Currency, choose Currency Rates.

2. Tap the rate you want to change, and enter the new value for each currency supported.

3. When complete, tap Save Currency Rates.

To import currency rates:

1. On the Admin sidebar, tap Stores. Then under Currency, choose Currency Rates.

2. Set Import Service to the currency rate provider. WebserviceX is the default provider.

3. Tap Import.

The updated rates appear in the Currency Rates list. If the rates have changed since the last

update, the old rate appears below for reference.

4. When complete, tap Save Currency Rates.

CHAPTER 66: Currency Updating Currency Rates

Magento Community Edition 2.0 User Guide 843

5. When prompted to update the cache, tap the Cache Management link. Then, refresh all

invalid caches.

Refresh Invalid Caches

To import currency rates on schedule:

1. Make sure that Cron is enabled for your store.

2. Complete the Currency Rate Setup to specify the currencies that you accept, and to establish

the import connection and schedule.

3. To verify that the rates are imported on schedule, check the Currency Rates list. Then, wait for

the duration of the frequency setting established for the schedule, and check the rates again.

Updating Currency Rates CHAPTER 66: Currency

844 Magento Community Edition 2.0 User Guide

CHAPTER 67:

Attributes

Magento uses attributes to manage the information associated with products, customers,

and product ratings. Attributes are pieces of information that might appear as fields in

forms, reports, product reviews, layered navigation, and email messages. Some attributes

are built into the system, and others can be created to address specific needs.

You can find more information about attributes in the Products and Data Transfer sections

of this guide. To learn more, see:

lUsing Product Attributes

lProduct Attribute Reference

lCustomer Attribute Reference

Magento Community Edition 2.0 User Guide 845

Product Attributes

Product attribute properties determine how an attribute can be used in the catalog, its

appearance and behavior in the store, and in data transfer operations. The properties and labels

associated with each attribute determine how it can be used, and its presentation in the store.

Properties The Properties section includes both basic and advanced attribute

properties.

Labels The label identifies an attribute in the Admin and also in the storefront

of each store view. If your store is available in multiple languages, you

can enter a different translated label for each language.

Storefront

Properties

The Storefront Properties determine how an attribute can be used in your

store, its appearance, and behavior. You can specify if attributes are

available for search, layered navigation, product comparisons, price

rules, and sorting. For text attributes, you can enable the WYSIWYG

editor, and determine if HTML tags can be used to format the values.

To learn how to use attributes while creating a product, see: Using Product Attributes.

Product Attributes Page

Product Attributes CHAPTER 67: Attributes

846 Magento Community Edition 2.0 User Guide

Properties

PROPERTY DESCRIPTION

ATTRIBUTE PROPERTIES

Default Label The label that identifies the attribute during data entry.

Catalog Input Type for

Store Owner

Determines the data type and input control that is used to manage

the product from the store Admin. Options include:

Text Field A single line input field for text.

Text Area A multiple-line input field that can display

paragraphs of text formatted with HTML.

Date An input field for date values. The date can

be typed directly into the field, or selected

from a list or calendar.

Yes/No A drop-down list with predefined options of

“Yes” and “No.”

Multiple Select A drop-down list of options that allows

multiple selections. To select more than one

option, hold down the Ctrl key and click each

item.

Dropdown A drop-down list of options that allows only

one selection.

Price An input type that can be used to create

price fields in addition to the predefined

attributes: Price, Special Price, Tier Price

and Cost.

Media Image An additional image that can be included in

the attribute set of a product.

Visual Swatch

Property Descriptions

CHAPTER 67: Attributes Product Attributes

Magento Community Edition 2.0 User Guide 847

PROPERTY DESCRIPTION

Text Swatch

Fixed Product Tax An input type that gives you the ability to

define FPT rates based on the requirements

of your locale.

Values Required To require that a value to be entered in this field before the record can

be saved, set Values Required to “Yes.” Options include:Yes/No

ADVANCED ATTRIBUTE PROPERTIES

Attribute Code (Required) A unique identifier for internal use. The Attribute Code

must begin with a letter, but can include a combination of lowercase

letters (a-z) and numbers (0-9).The code must be less than thirty

characters in length and cannot include any special characters or

spaces, although an underscore (_) can be used to indicate a space.

Scope Limits the use of an attribute to a specific store view or website.

Options include:

Store View

Website

Global

Default Value Assigns a starting value to the attribute to help during data entry. To

assign a default value for Multiple Select or Dropdown input types,

see: Creating Attributes.

A default value cannot be set for Multiple Select, Dropdown, or Fixed

Product Tax input types.

Unique Value To prevent duplicate values in a data entry field, set Unique Value to

“Yes.” Options include:Yes/No

Input Validation for Store

Owner

Performs a validation check of the data entered in the field, based on

the following options:

None

Decimal Number

Property Descriptions (cont.)

Product Attributes CHAPTER 67: Attributes

848 Magento Community Edition 2.0 User Guide

PROPERTY DESCRIPTION

Integer Number

URL

Letters

Letters (a-z, A-Z) or Numbers (0-9)

Add to Column Options Determines if the column appears in the product grid. Options: Yes /

Use in Filter Options Determines if the attribute is used as a filter control at the top of

columns in the grid. Options: Yes / No

Property Descriptions (cont.)

Storefront Properties

PROPERTY DESCRIPTION

Use in Search Select “Yes” if you want people to be able to search the catalog

based on the value of this attribute. Options include:Yes/No

The following attributes appear when Search is enabled:

Search Weight To weight the search results, set Search

Weight to a number from 1 to 5.

Visible in Advanced

Gives shoppers the ability to enter search

criteria through a form. Options

include:Yes/No

Using too many attributes can slow down

search.

Comparable on Storefront Select “Yes” to include this attribute as a row in the Compare

Products report. Options include:Yes/No

Use In Layered Navigation (Dropdown, Multiple Select and Price input types only) Includes the

attribute as a filter in the “Shop By” section of layered navigation.

Options include:

Property Descriptions

CHAPTER 67: Attributes Product Attributes

Magento Community Edition 2.0 User Guide 849

PROPERTY DESCRIPTION

No The attribute is not used in layered

navigation.

Filterable (with

results)

Lists only products that match the filter

value.

Filterable (no

results)

Lists all attribute values, even those that do

not apply to any product in the list. Layered

navigation appears on a category page only

if there are filterable attributes available.

Use In Search Results

Layered Navigation

To include the attribute in the layered navigation for search results,

select “Yes.” Options include:Yes/No

Position Determines the position of the attribute in layered navigation in

relation to other filterable attributes.

Use for Promo Rule

Conditions

To make the attribute available for use in price rules, select “Yes.”

Options include:Yes/No

Allow HTML Tags on

Storefront

(Text Field and Text Area input types only) To be able to format the

attribute value with HTMLtags, select “Yes.” Options include: Yes /

Visible on Catalog Pages

on Storefront

(Simple and virtual products only) To include the attribute on the

Additional Information tab of the product page, select “Yes.” Options

include:Yes/No

Used in Product Listing Depends on the theme. To include the attribute in product summaries

that appear in catalog listings, select “Yes.”

Used for Sorting in Product

Listing

Depending on theme, includes the attribute as a “Sort By” option for

catalog listings. Options:Yes / No

Property Descriptions (cont.)

Product Attributes CHAPTER 67: Attributes

850 Magento Community Edition 2.0 User Guide

Creating a Product Attribute

Attributes can be created while working on a product, or from the Product Attributes page. The

following example shows how to create attributes from the Stores menu.

New Attribute Properties

Process Overview:

Step 1: Describe the Basic Properties

Step 2: Describe the Advanced Properties

Step 3: Enter the Field Label

Step 4: Describe the Storefront Properties

CHAPTER 67: Attributes Product Attributes

Magento Community Edition 2.0 User Guide 851

Step 1: Describe the Basic Properties

1. On the Admin sidebar, tap Stores. Then under Attributes, choose Product.

2. Tap Add New Attribute.

Attribute Properties

3. Under Attribute Properties, enter a Default Label to identify the attribute.

4. Set Catalog Input Type for Store Owner to the type in input control to be used for data entry.

5. For Dropdown and Multiple Select input types, do the following:

a. Under Manage Options, tap Add Option.

b. Enter the first value that you want to appear in the list. You can enter one value for the

Admin, and a translation of the value for each store view. If you have only one store view,

you can enter only the Admin value and it will be used for the storefront as well.

c. Tap Add Option and repeat the previous step for each option that you want to include in

the list.

d. Select Is Default to use the option as the default value.

6. If you want to require the customer to choose an option before the product can be purchased,

set Values Required to “Yes.”

Manage Options

Product Attributes CHAPTER 67: Attributes

852 Magento Community Edition 2.0 User Guide

Step 2: Describe the Advanced Properties (if needed)

1. Enter a unique Attribute Code in lowercase characters, and without spaces.

Advanced Attribute Properties

2. Set Scope to indicate where in your store hierarchy the attribute can be used.

3. If you want to prevent duplicate values from being entered, set Unique Value to “Yes.”

4. To run a validity test of any data entered into a text field, set Input Validation for Store Owner

to the type of data that the field should contain. This field is not available for input types with

values that are selected. The test can validate any of the following:

lDecimal Number

lInteger Number

lEmail

lURL

lLetters

lLetters (a-z, A-Z) or Numbers (0-9)

Input Validation

CHAPTER 67: Attributes Product Attributes

Magento Community Edition 2.0 User Guide 853

Step 3: Enter the Field Label

1. Expand the Manage titles section.

2. Enter a Title to be used as a label for the field. If your store is available in different languages,

you can enter a translated title for each view.

Manage Titles

Step 4: Describe the Storefront Properties

1. In the panel on the left, choose Storefront Properties.

2. If the attribute is to be available for search, set Use in Search to “Yes.”

3. To include the attribute in Product Compare, set Comparable on Storefront to “Yes.”

4. For dropdown, multiple select and price fields, do the following:

a. To use the attribute as a filter in layered navigation, set Use in Layered Navigation to

“Yes.”

b. to use the attribute in layered navigation on search results pages, set Use in Search

Results Layered Navigation to “Yes,”

c. In the Position field, enter a number to indicate the relative position of the attribute in the

layered navigation block.

5. To use the attribute in price rules, set Use for Promo Rule Conditions to “Yes,”

6. To allow the text to be formatted with HTML, set Allow HTML Tags on Frontend to “Yes.”

This setting makes the WYSIWYG editor available for the field.

To include the attribute in catalog page listings, set Visible on Catalog Pages on Storefront to

“Yes.”

7. Complete the following settings if supported by your theme:

a. To include the attribute on the product detail page, set Visible on Catalog Pages on

Storefront to “Yes.”

b. To include the attribute in product listings, set Used in Product Listing to “Yes.”

c. To use attribute as a sort parameter for product listings, set Used for Sorting in Product

Listing to “Yes.”

Product Attributes CHAPTER 67: Attributes

854 Magento Community Edition 2.0 User Guide

8. When complete, tap Save Attribute.

Storefront Properties

CHAPTER 67: Attributes Product Attributes

Magento Community Edition 2.0 User Guide 855

Attribute Sets

One of the first steps when creating a product is to choose the attribute set that is used as a

template for the product record. The attribute set determines the fields that are available during

data entry, and the values that appear to the customer.

The attributes are organized into groups that determine where they appear in the product

record. Your store comes with an initial attribute set called “default” which includes a set of

commonly-used attributes. If you would like to add only a small number of attributes, you can

add them to the default attribute set. However, if you sell products that require specific types of

information, such as cameras, it might be better to create a dedicated attribute set that

includes the specific attributes that are needed to describe the product.

Attribute Sets

To create an attribute set:

1. On the Admin sidebar, tap Stores. Then under Attributes, choose Attribute Set.

2. Tap Add New Set. Then, do the following:

Product Attributes CHAPTER 67: Attributes

856 Magento Community Edition 2.0 User Guide

Edit Set Name

a. Enter a Name for the attribute set.

b. Set Based On to an existing attribute set to be used as a template.

c. Tap Save . The next page displays the following:

lThe left column shows the name of the attribute set. The name is for internal reference,

and can be changed as needed.

lThe center of the page lists the current selection of attribute groups.

lThe right column lists the selection of attributes that are currently not assigned to the

attribute set.

d. To add a new attribute to the set, drag the attribute from the Unassigned Attributes list

to the appropriate folder in the Groups column.

System attributes are marked with a dot and cannot be removed from the Groups list. They can

however, be dragged to another Group in the attribute set.

3. When complete, tap Save.

CHAPTER 67: Attributes Product Attributes

Magento Community Edition 2.0 User Guide 857

Edit Attribute Set

To create a new attribute group:

1. In the Groups column the attribute set, tap Add New.

2. Enter a Name for the new group, and tap OK.

3. Do either of the following:

lDrag Unassigned Attributes to the new group.

lDrag attributes from any other group to the new group.

The new group becomes a section of attributes in any product that is based on the attribute set.

Product Attributes CHAPTER 67: Attributes

858 Magento Community Edition 2.0 User Guide

System

In this section of the guide, you’ll learn how to

import and export data, manage security and

permissions, install extensions and integrations,

and use the many tools that are available to

maintain your store at peak performance.

Magento Community Edition 2.0 User Guide 859

Contents Data Transfer

Working with CSVFiles

Import

Export

Product Attribute Reference

Customer Attribute Reference

Integrations

Magento Marketplace

Magento Connect

Tools

Cache Management

Full Page Cache

Alternate Media Storage

Using a Database

Using a CDN

Backups

Index Management

Manual Reindexing

Indexing Modes

Web Setup Wizard

Permissions

Adding Users

Locked Users

User Roles

Security

Security Best Practices

Admin Security

CAPTCHA

Encryption Key

Session Validation

Browser Capabilities Detection

Action Log

860 Magento Community Edition 2.0 User Guide

CHAPTER 68:

System Menu

The System Menu includes tools to import and export data, install extensions, manage

system caches and indexes, manage permissions, backups, system notifications, and

custom variables.

System Menu

Magento Community Edition 2.0 User Guide 861

Menu Options

Data Transfer

The Import and Export tools give you the ability to

manage multiple records in a single operation. You

can import new items, and also update, replace, and

delete existing products and tax rates.

Extensions

Manage integrations and extensions for your store.

Tools

Manage your system resources, including cache and

index management, backups, and installation

settings.

Permissions

Magento uses roles and permissions to create different

levels of access for Admin users, which gives you the

ability to grant permission on a “need to know” basis

to people who work on your site.

862 Magento Community Edition 2.0 User Guide

CHAPTER 68: System Menu

Other Settings

Notifications

Your store has an inbox for the messages received

from Magento. The messages are rated by importance,

and might refer to system updates, patches, new

releases, scheduled maintenance, upcoming events,

and more.

Custom Variables

If you know a little basic HTML, you can create

custom variables and use a markup tag to incorporate

them into pages, blocks, banners, and email

templates.

Manage Encryption Key

The encryption key is used to protect passwords and

other sensitive data. Magento can autogenerate an

encryption key, or you can use one from another

source.

Magento Community Edition 2.0 User Guide 863

CHAPTER 68: System Menu

Notes

864 Magento Community Edition 2.0 User Guide

CHAPTER 69:

Data Transfer

The Import and Export tools give you the ability to manage multiple records in a single

operation. You can not only import new items, but also update, replace, and delete

existing sets of products. For example, you can add new products to your inventory,

update product data and advanced price data, and replace a set of existing products with

new products. If you have a large catalog of products, it’s much easier to export the data,

edit the data in a spreadsheet, and import it back into your store.

lWorking with CSVFiles

lImport

lExport

lProduct Attribute Reference

lCustomer Attribute Reference

Magento Community Edition 2.0 User Guide 865

Working with CSV Files

The comma-separated-value (CSV) file format is used as the basis of data transfer operations,

and is supported by all spreadsheet and database applications. The following file types are

supported for import and export:

Import CSV and ZIP (a compressed CSV file.)

Export CSV

Important! We recommend that you use a program that supports UTF-8 encoding, such as

Notepad++ or OpenOffice Calc, to edit CSV files. Microsoft Excel inserts additional characters into

the column header of the CSV file, which can prevent the data from being imported back into

Magento. If you work on the Mac, you can save your data in the CSV (Windows) format.

CSV files have a specific structure that must match the database. Each column heading

corresponds to the Attribute Code of the field that is represented by the column. To ensure that

the column headings can be read by Magento, first export the data from your store as a CSV

file. You can then edit the data and re-import it into Magento.

If you open an exported CSVfile in a text editor, you will see that values are separated by

commas, and multiple values are enclosed in double-quotes. During import, you can specify a

custom separator character, although a comma is the default.

Product CSV Structure

A full export of the product database contains information about each product in the catalog,

and the relationships between them. Each record has fixed selection of columns that

corresponds to the attributes in the catalog, although the order of the attributes is ignored

during the import process.

Working with CSV Files CHAPTER 69: Data Transfer

866 Magento Community Edition 2.0 User Guide

Exported Product CSV in OpenOffice Calc

The first row of the table contains the names of each attribute, which are used as column

headers. The remaining rows describe the individual product records. Any row that begins with

a value in the SKU column is the beginning of a new product record. A single product might

include several rows that contain information about multiple images or product options. The

next row that has a value in the SKU column begins a new product.

The category column contains a path for each category to which the product is assigned. The

path includes the root category, followed by a forward slash (/) between each level. By default,

the pipe “|” character is used to separate different category paths. For example:

Default Category/Gear|Default Category/Gear/Bags.

To import data, you need to include only the SKU and any columns with changes. Any blank

columns are ignored during the import process. It is not possible to add attributes during the

import process. You can include only existing attributes.

For a detailed description of each product attribute, see: Product Attribute Reference.

CHAPTER 69: Data Transfer Working with CSV Files

Magento Community Edition 2.0 User Guide 867

Exported Product CSV in Notepad++

COLUMN NAME DESCRIPTION

_<name> Column headers that begin with an underscore contain service entity

properties or complex data. Service columns are not product

attributes.

<attribute name> Column headers with an attribute code or field name identify the

column of data. A column might represent a system attribute, or one

that was created by the store administrator.

CSV Product Structure

Customer CSV Structure

The customers CSV file contains customer information from the database, and has the

following structure:

Exported Customer CSV in OpenOffice Calc

The first row of the table contains the names of the attribute columns (which are the same as

attribute codes). There are two types of column names, as shown in the following table. Other

rows contain attribute values, service data, and complex data. Each row with non-empty

Working with CSV Files CHAPTER 69: Data Transfer

868 Magento Community Edition 2.0 User Guide

values in the “email” and “_website” columns starts the description of the subsequent

customer. Each row can represent customer data with or without address data, or the address

data only. In case a row contains only the address data, values in the columns, related to the

customer profile, will be ignored and may be empty.

To add or replace more than one address for a customer, in the import file add a row for each

new address with empty customer data and the new or updated address data below the

customer data row.

For a detailed description of each customer attribute, see: Customer Attribute Reference.

Exported Customer CSV in Notepad++

COLUMN NAME DESCRIPTION

_<name> Column headers that begin with an underscore contain service entity

properties or complex data. Service columns are not customer

attributes.

<attribute name> The names of the columns with values of both system-created

attributes, and attributes created by the store administrator.

CSV Customer Structure

CHAPTER 69: Data Transfer Working with CSV Files

Magento Community Edition 2.0 User Guide 869

Data Validation

All data must pass validation before it can be imported into the store, to ensure that the values

are consistent with the system database. Validation begins when you tap the Check Data

button. During the process, all entities in the import file are verified for the following:

Attributes Column header names are verified to ensure that they match the

corresponding attributes in the system database. The value of

each attribute is checked to ensure that it meets the requirements

of the data type (decimal, integer, varchar, text, and datetime)

Complex Data Values that originate from a defined set, such as a drop-down or

multiple select input type, are verified to ensure that the values

exist in the defined set.

Service Data The values in service data columns are verified to ensure that the

properties or complex data values are consistent with what is

already defined in the system database.

Required Values For new entities, the presence of required attribute values in the

file is checked. For existing entities, there is no need to re-check

the existence of required attribute values.

Separators Although the separators aren’t visible when viewed in a

spreadsheet, data values in a CSVfile are separated by comma,

and text values are enclosed in double-quotes. During the

validation process, the separators are verified, and each set of

quotes that enclose character strings is verified to be formatted

correctly.

The results of the validation appear in the Validation Results section, and include the following

information:

lThe number of entities checked

lThe number of invalid rows

lThe number of errors found

If the data is valid, an “Import Success” message appears.

File is Valid!

Working with CSV Files CHAPTER 69: Data Transfer

870 Magento Community Edition 2.0 User Guide

If validation fails, read the description of each error, and correct the problem in the CSV file.

For example, if a row contains an invalid SKU, the import process stops, and that row, and all

subsequent rows are not imported. After correctly the problem, import the data again. If many

errors are encountered, it might take several attempts to pass validation.

MESSAGES

DATA VALIDATION

lProduct with specified SKU not found in rows: 1

lURL key for specified store already exists

l'7z' file extension is not supported

l'txt' file extension is not supported

ERRORS

lWrong field type. Type in the imported file %decimal%, expected type is %text%.

lValue is not allowed. Attribute value does not exist in the system.

lField %column name% is required.

lWrong value separator is used.

lWrong encoding used. Supported character encoding is UTF-8 and Windows-1252.

lImported file does not contain SKU field.

lSKU does not exist in the system.

lColumn name %column name% is invalid. Should start with a letter. Alphanumeric.

lImported file does not contain a header.

l%website name% website does not exist in the system.

l%storeview name% storeview does not exist in the system.

lImported attribute %attribute name% does not exist in the system.

lImported resource (image) could not be downloaded from external resource due to timeout or

access permissions.

lImported resource (image) does not exist in the local media storage.

lProduct creation error displayed to the user equal to the one seen during manual product save.

lAdvanced Price creation error displayed to the user equal to the one seen during the manual

product save.

lCustomer creation error displayed to the user equal to the one seen during the manual customer

save.

Data Validation Messages

CHAPTER 69: Data Transfer Working with CSV Files

Magento Community Edition 2.0 User Guide 871

Import

Data for all product types can be imported into the store. In addition, you can import customer

data, customer address data, and product images. Import supports the following operations:

lAdd/Update

lReplace Existing Complex Data

lDelete Entities

The size of the import file is determined by the settings in the php.ini file on the server. The

system message on the Import page indicates the current size limit.

Import

Process Overview:

Step 1: Prepare the Data

Step 2: Choose the Import Behavior

Step 3: Identify the Import File

Step 4: Check the Import Data

Import CHAPTER 69: Data Transfer

872 Magento Community Edition 2.0 User Guide

Step 1: Prepare the Data

1. On the Admin sidebar, tap System. Then under Data Transfer, choose Import.

2. Under Import Settings, set Entity Type to one of the following:

lAdvanced Pricing

lProducts

lCustomers and Addresses

lCustomers Main File

lCustomer Addresses

3. Tap Download Sample File. Then on the download menu in the lower-left corner of your

browser window, choose Open.

Download Sample File

The sample file includes column headings with placeholder data for example product types.

Downloaded Sample File

CHAPTER 69: Data Transfer Import

Magento Community Edition 2.0 User Guide 873

4. Examine the structure of the sample file. As you prepare your CSV import file, make sure that

the column headings are spelled correctly.

5. Verify that the size of your import file does not exceed the limit shown in the message.

6. If the import data includes paths to product images, make sure that the image files have been

uploaded to the appropriate location. The default location on the Magento server is:

pub/media/import.

If the images reside on an external server, make sure that you have the full URLto the

directory that contains the images.

Step 2: Choose the Import Behavior

1. Set Import Behavior to one of the following:

lAdd/Update

lReplace Existing Complex Data

lDelete Entities

2. Do the following:

a. Accept the default value of a comma (,) for the Field separator.

b. Accept the default value of a comma (,) for the Multiple value separator.

In a CSV file, a comma is the default separator. To use a different character, make sure that the

data in the CSV file matches the character that you specify.

Import Behavior

Step 3: Identify the Import File

1. Tap Choose File to select the file to import.

2. Find the CSV file that you prepared to import, and tap Open.

3. If the import data includes paths to product images, enter one of the following in the Images

File Directory field:

Import CHAPTER 69: Data Transfer

874 Magento Community Edition 2.0 User Guide

lThe path to the uploaded images on the Magento server. For example: var/import.

lThe full URL to the images on another server. For example: http://domain.com/images

To learn more about importing product images, see: Importing Product Images.

File to Import

Step 4: Check the Import Data

1. In the upper-right corner, tap Check Data.

2. Then, wait a few moments for the validation process to complete. If the import data is valid,

the following message appears:

File is Valid!

3. If the file is valid, tap Import. Otherwise, correct each problem with the data that is listed in

the message, and try to import the file again.

4. The import process continues to the end of the data, unless an error is encountered.

If an error message appears in the Validation Results, correct the problem in the data, and

import the file again. For a list of known errors, see: Import Troubleshooting.

URLKey Already Exists

A message appears when the import is complete.

CHAPTER 69: Data Transfer Import

Magento Community Edition 2.0 User Guide 875

OPERATION DESCRIPTION

Add/Update New product data is added to the existing product data for the

existing entries in the database. All fields except sku can be

updated.

New tax classes that are specified in the import data are created

automatically.

New product categories that are specified in the import file are

created automatically.

New SKUs that are specified in the import file are created

automatically

Replace Existing Complex

Data

The existing product data is replaced with new data.

Exercise caution when replacing data because the existing product

data will be completely cleared and all references in the system will

be lost.

If a SKU in the import data matches the SKU of an existing entity, all

fields, including the SKU are deleted, and a new record is created

using the CSV data.

An error occurs if the CSV file references a SKU that does not exist

in the database. You can Check Data to display error.

Delete Entities Any entities in the import data that already exist in the database are

deleted from the database.

Delete ignores all columns in the import data, except for SKU. You

can disregard all other attributes in the data.

An error occurs if the CSV file references a SKU that does not exist

in the database. You can Check Data to display error.

Import Behavior

Import CHAPTER 69: Data Transfer

876 Magento Community Edition 2.0 User Guide

Import History

Maintains a record of data that has been imported into your store, including the start date and

time, user, execution time, and a link to the imported file.

To view the import history:

1. On the Admin sidebar, tap System.

2. Under Data Transfer, choose Import History.

Import History

CHAPTER 69: Data Transfer Import

Magento Community Edition 2.0 User Guide 877

Importing Product Images

Multiple product images of each type can be imported into Magento, and associated with a

specific product. The path and file name of each product image is entered in the CSV file, and

the image files to be imported are uploaded to the corresponding path on the Magento server or

external server.

Magento creates its own directory structure for product images that is organized alphabetically.

When you export product data with existing images to a CSV file, you can see the alphabetized

path before the file name of each image. However, when you import new images, you don’t

need to specify a path, because Magento manages the directory structure automatically. Just

make sure to enter the relative path to the import directory before the file name of each image

to be imported.

To upload images, you must have login credentials and correct permissions to access to the

Magento folder on the server. With the correct credentials, you can use any SFTP utility to

upload the files from your desktop computer to the server.

Before you try to import a large amount of images, review the steps in the import method that

you want to use, and run through the process with a few products. After you understand how it

works, you’ll feel confident importing large quantities of images.

Important! We recommend that you use a program that supports UTF-8 encoding to edit CSV files,

such as Notepad++ or OpenOffice Calc. Microsoft Excel inserts additional characters into the

column header of the CSV file, which can prevent the data from being imported back into Magento.

Method 1: Import Images from the Local Server

1. On the Magento server, upload the image files to the pub/media/import folder. This is the

default folder for importing product images.

[magento installation folder]/pub/media/import

You can use a different folder on the Magento server, as long as the path to the folder is

specified during the import process.

2. In the CSV data, enter the name of each image file to be imported on the correct row, by sku,

and in the correct column according to image type (base_image,small_image,

thumbnail_image, or additional_image).

Make sure to include the relative path to the import directory before each file name, as follows:

/pub/media/import/image.jpg

Import CHAPTER 69: Data Transfer

878 Magento Community Edition 2.0 User Guide

The CSV file needs to include only the sku column and the related image columns.

CSV Image Import Data

3. Follow the instructions to import the data.

After selecting the file to import, enter the relative path following Images File Directory:

/pub/media/import

Images File Directory

If importing multiple images for a single sku, insert a blank row below the sku, and enter the

additional image file names in the appropriate columns. The additional rows are understood to

belong to the parent sku.

Method 2: Import Images from External Server

1. Upload the images to be imported to the designated folder on the external server.

2. In the CSV data, enter the full URL for each image file in the correct column by image type

(base_image,small_image,thumbnail_image, or additional_image).

http://example.com/images/image.jpg

3. Follow the instructions to import the data.

CHAPTER 69: Data Transfer Import

Magento Community Edition 2.0 User Guide 879

Import Guidelines

New Entities

Entities are added with the attribute values specified in the CSV file.

If there is no value, or there is a non-valid value, for a required attribute with no default

value set, then the entity (the corresponding row or rows) cannot be imported.

If there is no value, or there is a non-valid value, for a required attribute with the default

value set, then the entity (the corresponding row or rows) is imported, and the default

value is set for the attribute.

If the complex data is not valid, then the entity (the corresponding row or rows) cannot be

imported.

Existing Entities

For attributes that are not complex data, the values from the import file, including the

empty values for the non-required attributes, replace the existing values.

If there is no value, or there is a non-valid value, for a required attribute, then the existing

value is not replaced.

If the complex data for the entity is invalid, the entity (the corresponding row or rows)

cannot be imported, except the case, when Delete Entities was selected in the Import

Behavior drop-down menu.

Import CHAPTER 69: Data Transfer

880 Magento Community Edition 2.0 User Guide

Complex Data

If an attribute that is specified in the import file already exists, and its value is derived from a

defined set of values, the following applies:

If the value is not already included in the defined set of values, the row can be imported

and a default value, if defined, is set for the attribute.

If the value is already included in the defined set, the corresponding row cannot be

imported.

If an attribute name is specified in the import file but is not yet defined in the system, it is not

created, and its values are not imported.

Invalid Files

A file cannot be imported if all rows are invalid.

A non-existing service data or complex data name is specified in the import file, such as a

column with a “_<non-existing name>” heading.

CHAPTER 69: Data Transfer Import

Magento Community Edition 2.0 User Guide 881

Export

The best way to become familiar with the structure of your database is to export the data and

open it in a spreadsheet. Once you become familiar with the process, you’ll find that it is an

efficient way to manage large amounts of information.

To export data:

1. On the Admin sidebar, tap System. Then under Data Transfer, choose Export.

2. In the Export Settings section, specify the following:

a. Set Entity Type to one of the following:

lProducts

lCustomers Main File

lCustomer Addresses

b. Accept the default Export File Format of “CSV.”

Export Settings

3. The Entity Attributes section lists all the available attributes in alphabetical order. You can use

the standard list controls to search for specific attributes, and to sort the list. The Search and

Reset Filter controls control the display of the list, but have no effect on the selection of

attributes to be included in the export file.

Filtered Entity Attributes

Export CHAPTER 69: Data Transfer

882 Magento Community Edition 2.0 User Guide

4. To filter the exported data based on attribute value, do the following:

lTo export only records with specific attribute values, enter the required value in the Filter

column. The followng example exports only a specific SKU.

Export Product Based on SKU

lTo omit an attribute from the export, mark the Exclude checkbox at the beginning of the

row. For example, to export only the sku and image columns, select the checkbox of every

other attribute. The column appears in the export file, but without any values.

Exclude Attributes

5. Scroll down and tap Continue in the lower-right corner of the page.

Look for the download prompt in the lower-right corner of your browser. The exported CSV file

can be saved or opened in a spreadsheet. You can edit the data and import it back into your

store.

CHAPTER 69: Data Transfer Export

Magento Community Edition 2.0 User Guide 883

Export Criteria

Export filters are used to specify the data that you want to in the export file, based on attribute

value. In addition, you can specify which attribute data you want to include or exclude from

the export.

Export Criteria

Export CHAPTER 69: Data Transfer

884 Magento Community Edition 2.0 User Guide

Export Filters

You can use filters to determine which SKUs are included in the export file. For example, if you

enter a value in the Country of Manufacture filter, the exported CSV file will incude only

products manufactured in that country.

The type of filter corresponds to the data type. For date fields, you can choose the date from the

Calendar . To learn more, see: Attribute Input Types. The format of the date is determined

by the locale.

To inlcude only records with a specific value, such as a sku, type the value into the Filter field.

Some fields such as Price, Weight, and Set Product as New have a from/to range of values.

Exclude Attributes

The checkbox in the first column is used to exclude attributes from the export file. If an

attribute is excluded, the associated column in the export data is included, but empty.

EXCLUDE FILTER RESULT

No The exported file contains each attribute for all existing records.

Yes The export file contains each attribute with only the records allowed

by the filter.

No The export file does not include the column for the excluded

attribute, but does include all existing records.

Yes The export file does not include the column for the excluded

attribute, and contains only the records allowed by the filter.

Export Criteria

CHAPTER 69: Data Transfer Export

Magento Community Edition 2.0 User Guide 885

Product Attribute Reference

The following table lists the attributes from a typical product export, in the default order in

which they appear. Each attribute is represented in the CSV file as a column, and product

records are represented by rows. Columns that begin with an underscore contain service data

such as properties or option values for complex data.

The installation used to export this data has the sample data installed, and has two websites

and several store views. Although this list includes all columns that are typically exported, the

sku is the only required value. To import data, you can include only the columns with

changes. The sku should be the first column, but the order of the rest of the attributes doesn’t

matter.

ATTRIBUTE DESCRIPTION

sku (Required) The Stock-Keeping Unit is a unique,

alphanumeric identifier that is used to track inventory. A

SKU can be up to 64 characters in length. For example:

sku123

A SKU longer than 64 characters will cause import to

fail.

store_view_code Identifies the specific store view(s) where the product is

available. If blank, the product is available at the default

store view. For example: storeview1

english,spanish

attribute_set_code Assigns the product to a specific attribute set or product

template, according to product type. Once the product is

created, the attribute set cannot be changed. For

example:

default

product_type Indicates the type of product.Values include:

Simple Product CSV File Structure

Product Attribute Reference CHAPTER 69: Data Transfer

886 Magento Community Edition 2.0 User Guide

ATTRIBUTE DESCRIPTION

simple Tangible items that are generally

sold as single units or in fixed

quantities.

grouped A group of separate products

that is sold as a set.

configurable A product with multiple options

that the customer must select

before making a purchase.

Inventory can be managed for

each set of variations because

they represent a separate

product with a distinct SKU. For

example, a combination of color

and size for a configurable

product is associated with a

specific SKU in the catalog.

virtual A non-tangible product that does

not require shipping and is not

kept in inventory. Examples

include services, memberships,

and subscriptions.

bundle A customizable product set of

simple products that are sold

together.

categories Indicates each category that is assigned to the product.

Separate categories and subcategories with a forward

slash. To indicate multiple category paths, separate each

path with a pipe “|” symbol. For example:

Default Category/Gear|Default Category/Gear/Bags

Simple Product CSV File Structure (cont.)

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 887

ATTRIBUTE DESCRIPTION

product_websites The website code of each website where the product is

available. A single product can be assigned to multiple

websites, or limited to one. If specifying multiple

websites, separate each with a comma and without a

space. For example:

base

base,website2

name The product name appears in all product listings, and is

the name that customers use to identify the product.

description The product description provides detailed information

about the product, and might include simple HTMLtags.

short_description The use of the short product description depends on the

theme. It might appear in product listings and is

sometimes used in RSS feed listings sent to shopping

sites.

weight The weight of the individual product. The actual product

weight is determined by the carrier at the time of

shipment.

product_online Determines if the product is available for sale in the

store. Values include:

1 (Yes) The product is immediately

available for sale in your store.

0 (or blank) (No) The product is not included in

online catalog listings.

tax_class_name The name of the tax class that is associated with this

product.

visibility Determines if the product is visible in the catalog, and

made available for search. Values include:

Simple Product CSV File Structure (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

888 Magento Community Edition 2.0 User Guide

ATTRIBUTE DESCRIPTION

Not Visible

Individually

The product is not included in

product listings, although it might

be available as a variation of

another product.

Catalog The product appears in all

catalog listings.

Search The product is available for

search operations.

Catalog, Search The product is included in

catalog listings and is also

available for search.

price The price that the product is offered for sale in your store.

special_price The discounted price of the product during the specified

date range.

special_price_from_date The beginning date of the time period when the special

price is in effect.

special_price_to_date The last date of the time period when the special price is

in effect.

url_key The part of the URLthat identifies the product. The

default value is based on the product name. For example:

product-name

meta_title The meta title appears in the title bar and tab of the

browser and search results lists. The meta title should be

unique to the product, incorporate high-value keywords,

and be less than 70 characters in length.

meta_keywords Meta keywords are visible only to search engines, and

are ignored by some search engines. Choose high-value

keywords, separated by a comma. For example:

keyword1,keyword2,keyword3.

Simple Product CSV File Structure (cont.)

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 889

ATTRIBUTE DESCRIPTION

meta_description Meta descriptions provide a brief overview of the product

for search results listings. Ideally, a meta description

should be between 150-160 characters in length,

although the field accepts up to 255 characters.

base_image The relative path for the main image on the product page.

Magento stores files internally in an alphabetical folder

structure.You can see the exact location of each image

in the exported data. For example:

/sample_data/m/b/mb01-blue-0.jpg

To upload a new image or write over an existing image,

enter the file name, preceded by a forward slash. For

example: /image.jpg

base_image_label The label that is associated with the base image.

small_image The file name of the small image that is used on catalog

pages, preceded by a forward slash. For example:

/image.jpg

small_image_label The label associated with the small image. For example:

Small Image 1, Small Image 2

thumbnail_image The file names of any thumbnail image to appear in the

gallery on the product page, preceded by a forward slash.

For example:

/image.jpg

thumbnail_image_label The label associated with any thumbnail images. For

example:

Thumbnail 1, Thumbnail 2

created_at Indicates the date when the product was created. The

date is automatically generated when the product is

created, but can be edited later.

updated_at Indicates the date when the product was last updated.

Simple Product CSV File Structure (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

890 Magento Community Edition 2.0 User Guide

ATTRIBUTE DESCRIPTION

new_from_date Specifies the “from” date for new product listings, and

determines if the product is featured as a new product.

new_to_date Specifies the “to” date for new product listings, and

determines if the product is featured as a new product.

display_product_options_in If the product has multiple options, determines where

they appear on the product page. Values include:

Product Info Column

Block after Info Column

map_price The minimum advertised price of the product. (Appears

only if MAP is enabled.)

msrp_price The manufacturer’s suggested retail price for the product.

(Appears only if MAP is enabled.)

map_enabled Determines if Minimum Advertised Price is enabled in

the configuration. Values include:

1 (Yes) MAP is enabled.

0 (or blank) (No) MAP is not enabled.

gift_message_available Determines if a gift message can be included with the

product purchase. Values include:

1 (Yes) The option to include a gift

message is presented to the customer.

0 (or blank) (No) The option to include a gift

message is not presented to the

customer.

custom_design Lists the available themes that can be applied to the

product page.

custom_design_from Specifies the beginning date when the selected theme is

applied to the product page.

Simple Product CSV File Structure (cont.)

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 891

ATTRIBUTE DESCRIPTION

custom_design_to Specifies the end date when the selected theme is

applied to the product page.

custom_layout_update Additional XML code that is applied as a layout update to

the product page.

page_layout Determines the page layout of the product page. Values

include:

No layout updates No change is made to the page

layout.

1 column Applies a one- column layout to

the product page.

2 columns with left

bar

Applies a two-column layout with

a left sidebar to the product

page.

2 columns with

right bar

Applies a two-column layout with

a right sidebar to the product

page.

3 columns Applies a three-column layout to

the product page.

empty Applies a blank layout to the

product page.

product_options_container If the product has multiple options, determines where

they appear on the product page. Values include:

Product Info Column

Block after Info Column

msrp_display_actual_price_

type

Determines where the actual price of a product is visible

to the customer.Values include:

Simple Product CSV File Structure (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

892 Magento Community Edition 2.0 User Guide

ATTRIBUTE DESCRIPTION

In Cart Displays the actual product price

in the shopping cart.

Before Order

Confirmation

Displays the actual product price

at the end of the checkout

process, just before the order is

confirmed.

On Gesture Displays the actual product price

in a popup when the customer

clicks the “Click for price” or

“What’s this?” link.

country_of_manufacture Identifies the country where the product was

manufactured.

additional_attributes Additional attributes created for the product. For

example:

has_options=0,required_options=0

color=Black,has_options=0,required_options=0,size_

general=XS

qty The quantity of the product that is currently in stock.

out_of_stock_qty The stock level that determines the product to be out of

stock.

use_config_min_qty Determines if the default value from the configuration is

used, and corresponds to the Use Config Settings

checkbox. Values include:

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

is_qty_decimal Determines if the qty attribute has a decimal value.

Values include:

Simple Product CSV File Structure (cont.)

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 893

ATTRIBUTE DESCRIPTION

1 (Yes) The value of the qty attribute is a

decimal value.

0 (or blank) (No) The value of the qty attribute is a

whole number (integer).

allow_backorders Determines if your store allows backorders, and how

they are managed.

use_config_backorders Determines if the default configuration setting for

backorders is used, and corresponds to the state of the

Use Config Settings checkbox. Values include:

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

min_cart_qty Specifies the minimum quantity of the item that can be

purchased in a single order.

use_config_min_sale_qty Determines if the default configuration setting for

minimum quantity is used, and corresponds to the state

of the Use Config Settings checkbox.. Values include:

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

max_cart_qty Specifies the maxinum quantity of the product that can

be purchased in a single order.

use_config_max_sale_qty Determines if the default configuration setting for

maximum quantity is used, and corresponds to the state

of the Use Config Settings checkbox.. Values include:

Simple Product CSV File Structure (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

894 Magento Community Edition 2.0 User Guide

ATTRIBUTE DESCRIPTION

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

is_in_stock Indicates if the product is in stock.

notify_on_stock_below Specifies the stock level that triggers an “out of stock”

notification.

use_config_notify_stock_qty Determines if the default configuration setting is used to

trigger stock level notification, and corresponds to the

state of the Use Config Settings checkbox. Values

include:

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

manage_stock Determines if inventory control is used to manage the

product. Values include:

1 (Yes) Activates full inventory control to

manage stock levels of the product.

0 (or blank) (No) The system does not keep track of

the number of items that are currently in

stock.

use_config_manage_stock Determines if the default configuration setting for

managing stock is used, and corresponds to the state of

the Use Config Settings checkbox. Values include:

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

Simple Product CSV File Structure (cont.)

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 895

ATTRIBUTE DESCRIPTION

use_config_qty_increments Determines if the default configuration setting for

quantity increments is used, and corresponds to the

state of the Use Config Settings checkbox.. Values

include:

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

qty_increments Determines if the product is sold in quantity

increments. Options include: Yes / No

use_config_enable_qty_inc Determines if the default configuration setting to enable

quantity increments is used, and corresponds to the

state of the Use Config Settings checkbox. Values

include:

1 (Yes) The default configuration setting

is used for the value of this attribute.

0 (or blank) (No) The default configuration can be

overridden for the value of this attribute.

enable_qty_increments Determines if quantity increments are enabled for the

product.

is_decimal_divided Determines if parts of the product can be shipped

separately. Options include: Yes / No

website_id For installations with multiple websites, identifies a

specific website where the product is available. If blank,

the product is available in all websites.

related_skus Lists the sku of each product that has been identified as

aRelated Product. For example:

24-WG080,24-UG03,24-UG01,24-UG02

crosssell_skus Lists the sku of each product that has been identified

as a Cross-sell.

Simple Product CSV File Structure (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

896 Magento Community Edition 2.0 User Guide

ATTRIBUTE DESCRIPTION

upsell_skus Lists the sku of each product that has been identified

as an Upsell.

additional_images The file names of any additional image to be associated

with the product, preceded by a forward slash. For

example:

/image.jpg

additional_image_labels The labels associated with any additional images. For

example:

Label 1, Label 2

custom_options For example:

name=Color,type=drop_down,required=1,price=,price_

type=fixed,sku=,option_

title=Black|name=Color,type=drop_

down,required=1,price=,price_type=fixed,sku=,option_

title=White

SERVICE DATA FOR PRODUCT VARIATIONS

_super_products_sku The generated SKU for a configurable product variation.

For example: WB03-XS-Green

Applies to:

Configurable Products

_super_attribute_code The attribute code of a configurable product variation. For

example: color

Applies to:

Configurable Products

_super_attribute_option The value of a configurable product variation. For

example: green

Applies to:

Configurable Products

_super_attribute_price_corr A price adjustment that is associated with a configurable

product variation.

Simple Product CSV File Structure (cont.)

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 897

ATTRIBUTE DESCRIPTION

Applies to:

Configurable Products

_associated_sku The SKU of a product that is associated with a grouped

product.

Applies to:

Grouped Products

Bundle Products

_associated_default_qty Determines the quantity of the associated product that is

included. Applies to:

Configurable Products

Grouped Products

Bundle Products

_associated_position Determines the position of the associated product when

listed with other associated products. Applies to:

Configurable Products

Grouped Products

Bundle Products

Simple Product CSV File Structure (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

898 Magento Community Edition 2.0 User Guide

Complex Data

The term complex data1refers to the data that is associated with multiple product options.

The following product types use data that originates from separate products to create product

variations and multiple options.

lConfigurable

lGrouped

lBundle

If you were to export a configurable product, you would find the standard attributes that make

up a simple product, plus the additional attributes that are needed to manage complex data.

Exported Configurable Product Data

ATTRIBUTE DESCRIPTION

CONFIGURABLE PRODUCTS

configurab

le_

variation_

labels

Labels that identify product variations. For example:

Choose Color:

Choose Size:

configurab

le_

variations

Describes the values associated with a product variation. For example:

sku=sku-red

xs,color=red,size=xs,price=10.99,display=1,image=/pub/media/import/image1.

png|sku=sku-red-

m,color=red,size=m,price=20.88,display=1,image=/pub/media/import/image2.p

Complex Data Attributes

1Data that is associated with multiple product options.

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 899

ATTRIBUTE DESCRIPTION

GROUPED PRODUCTS

associated_

skus

Identifies the SKUs of the individual products that make up the group.

BUNDLE PRODUCTS

bundle_

price_type

Determines if the price of a bundle item is fixed or dynamic.

bundle_sku_

type

Determines if each item is assigned a variable, dynamic SKU, or if a fixed SKU

is used for the bundle. Options include: Fixed / Dynamic.

bundle_

weight_type

Determines if the weight of a bundle item is variable or fixed.

bundle_

values

Describes teach value associated with a bundle option. For example:

name=Bundle Option One,type=dropdown; required=1, sku=sku-

option2,price=10, price_type=fixed

Complex Data Attributes (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

900 Magento Community Edition 2.0 User Guide

Advanced Pricing

Advanced Price Import/Export allows you to quickly update pricing information for product

groups and tier prices. The process to import and export advanced price data is the same as

any other entity type. The sample CSV file contains tier and group prices for each product type

that supports advanced pricing. Making changes to advanced pricing does not affect the rest of

the product record.

Advanced Price Sample File

ATTRIBUTE DESCRIPTION

sku (Required) The Stock-Keeping Unit is a unique, alphanumeric

identifier that is used to track inventory. A SKU can be up to 64

characters in length. For example: sku123

A SKU longer than 64 characters will cause import to fail.

tier_price_website The website code identifies each website where tier pricing is

available. For example:

website1

All Websites [USD]

tier_price_

customer_group

Identifies the customers groups where tier pricing is available. For

example:

ALL GROUPS

NOTLOGGEDIN

General

Wholesale

Retailer

tier_price_qty The quantity of the product that must be ordered to receive the tier

price discount.

tier_price The discounted tier price of the product. For bundle products, tier

price is calculated as a percentage.

Advanced Pricing Attributes

CHAPTER 69: Data Transfer Product Attribute Reference

Magento Community Edition 2.0 User Guide 901

ATTRIBUTE DESCRIPTION

group_price_website The website code of each website where group pricing is available. If

specifying multiple websites, separate each with a comma and

without a space. For example:

website1

All Websites [USD]

group_price_

customer_group

Identifies the customers groups where group pricing is available. For

example:

NOTLOGGEDIN

General

Wholesale

Retailer

group_price The discounted group price of the product. For bundle products, group

price is calculated as a percentage.

Advanced Pricing Attributes (cont.)

Product Attribute Reference CHAPTER 69: Data Transfer

902 Magento Community Edition 2.0 User Guide

Customer Attribute Reference

The following tables list the attributes from a typical export of the Customers Main File and

Customer Addresses. The installation that was used to export this data has two websites and

several store views, with the sample data installed.

Each attribute, or field, is represented in the CSV file as a column, and customer records are

represented by rows. Columns that begin with an underscore are service entities that contain

properties or complex data.

ATTRIBUTE DESCRIPTION

_website

_store

confirmation

created_at

created_in

disable_auto_group_change

dob

firstname

gender

group_id

lastname

middlename

password_hash

prefix

rp_token

Customers Main File

CHAPTER 69: Data Transfer Customer Attribute Reference

Magento Community Edition 2.0 User Guide 903

ATTRIBUTE DESCRIPTION

rp_token_created_at

store_id

suffix

taxvat

website_id

password

Customers Main File (cont.)

ATTRIBUTE DESCRIPTION

_website

_email

_entity_id

city

company

country_id

fax

firstname

lastname

middlename

postcode

prefix

region

region_id

street

suffix

Customer Addresses

Customer Attribute Reference CHAPTER 69: Data Transfer

904 Magento Community Edition 2.0 User Guide

ATTRIBUTE DESCRIPTION

telephone

vat_id

vat_is_valid

vat_request_date

vat_request_id

vat_request_success

_address_default_

billing_

Identifies the default billing address. A value of 1 indicates that the

address is the default billing address of the customer. Values: 1 / 0

_address_default_

shipping_

Identifies the default shipping address. A value of 1 indicates that the

address is the default shipping address of the customer. Values: 1 / 0

Customer Addresses (cont.)

CHAPTER 69: Data Transfer Customer Attribute Reference

Magento Community Edition 2.0 User Guide 905

Notes

906 Magento Community Edition 2.0 User Guide

CHAPTER 70:

Integrations

Establishes the location of OAuth credentials and redirect URL for third-party

integrations, and identifies the available API resources that are needed for the integration.

The following path uses our Web APIs to onboard a merchant to a third-party SaaS

platform.

Integrations

Magento Community Edition 2.0 User Guide 907

Onboarding Workflow

Authorize the integration. Go to the system/integration screen, find the relevant

integration, and authorize.

Verify and establish login. When prompted, accept the access requested. If redirected

to a third-party, log in to the system, or create a new account. After a successful login,

you return to the integration page.

Receive confirmation of authorized integration. The system sends notification that

the integration has been authorized successfully. After setting up an integration and

receiving the credentials, it is no longer necessary to make calls to access or request

tokens.

908 Magento Community Edition 2.0 User Guide

Onboarding Workflow CHAPTER 70: Integrations

To add a new integration:

1. On the Admin sidebar, tap System. Then under Extensions, choose Integrations.

2. Enter the following Integration Info:

a. Enter the Name of the integration, and the contact Email address.

b. Enter the Callback URL where OAuth credentials can be sent when using OAuth for token

exchange. We strongly recommend using https://.

c. Enter the Identity Link URL to redirect the users to a third-party account with these

Magento integration credentials.

New Integration

3. In the panel on the left, choose API. Then, do the following:

a. Set Resource Access to one of the following:

lAll

lCustom

b. For custom access, mark the checkbox of each resource that is needed:

Magento Community Edition 2.0 User Guide 909

CHAPTER 70: Integrations Onboarding Workflow

Resources Needed for Custom Access

4. When complete, tap Save.

To change the APIguest access security setting:

By default, the system does not permit anonymous guest access to CMS, catalog, and other

store resources. If you need to change the setting, do the following:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Services, choose Magento Web API.

3. Expand the Web API Security Setting section.

Web API Security

4. Set Allow Anonymous Guest Access to “Yes,”

5. When complete, tap Save Config.

To learn more, see: “Restricting access to anonymous web APIs” in the Magentodeveloper

documentation.

910 Magento Community Edition 2.0 User Guide

Onboarding Workflow CHAPTER 70: Integrations

Magento Marketplace

Magento Marketplace is the next generation of the world’s largest eCommerce application store,

offering merchants a curated selection of solutions, and providing qualified developers the

tools, platform, and prime location to build a thriving business.

To learn more, Find Partners & Extensions in the Admin sidebar.

Magento Marketplace

CHAPTER 70: Integrations Magento Marketplace

Magento Community Edition 2.0 User Guide 911

Magento Connect

Magento Connect is Magento’s original marketplace for Magento extensions. There are

hundreds of extensions and themes available from all over the world. Magento out-of-the-box

supports a few of the most popular ones. However, community members are developing and

publishing new extensions in order to extend Magento with various new features.

Magento Connect

Magento Connect CHAPTER 70: Integrations

912 Magento Community Edition 2.0 User Guide

CHAPTER 71:

Tools

In this section of the guide, you will learn how to perform routine index and cache

management operations, back up the system, and use tools that help our Support team

troubleshoot and resolve issues.

lCache Management

lAlternate Media Storage

lBackups

lIndex Management

lWeb Setup Wizard

lPermissions

lSecurity

Magento Community Edition 2.0 User Guide 913

Cache Management

Magento’s cache management system is an easy way to improve the performance of your site.

Whenever a cache needs to be refreshed, a notice appears at the top of the workspace to guide

you through the process. Follow the link to Cache Management, and refresh the invalid caches.

Update Cache Message

The Cache Management page shows the status of each primary cache and its associated tag.

The large buttons in the upper-right corner can be used to flush the Magento Cache, or the all-

inclusive Cache Storage. At the bottom of the page there are additional buttons to flush the

catalog product images cache and JavaScript/CSS cache. After clearing a cache, always refresh

your browser to make sure that you can see the most recent files.

Cache Management

Cache Management CHAPTER 71: Tools

914 Magento Community Edition 2.0 User Guide

To refresh specific caches:

1. Do one of the following:

lClick the Cache Management link in the message above the workspace.

lOn the Admin sidebar, tap System. Then under Tools, choose CacheManagement.

2. For each cache to be refreshed, mark the checkbox at the beginning of the row.

3. Set Actions to “Refresh,” and tap Submit.

To perform mass actions:

1. To select a group of caches, set Mass Actions to one of the following:

lSelect All

lSelect Visible

2. Mark the checkbox of each cache to be targeted by the action.

3. Set Actions to “Refresh,” and tap Submit.

To flush the product image cache:

1. From the Cache Storage Management page, under Additional Cache Management, click Flush

Catalog Images Cache to clear pre-generated product image files.

The message, “Image cache was cleaned” appears at the top of the workspace.

2. Make sure to also clear the cache of your browser.

To flush the JavaScript/CSS cache:

1. From the Cache Storage Management page, under Additional Cache Management, click Flush

JavaScript/CSS Cache to clear any JavaScript and CSSfiles that have been merged into a

single file.

The message, “The JavaScript/CSS cache has been cleaned” appears at the top of the

workspace.

2. Make sure to also clear the cache of your browser.

CHAPTER 71: Tools Cache Management

Magento Community Edition 2.0 User Guide 915

CONTROL DESCRIPTION

Mass Actions Marks the checkbox of multiple caches. Options include:

Select All Marks the checkbox of all caches.

Unselect All Clears the checkbox of all caches.

Select Visible Marks the checkbox of all visible caches.

Unselect Visible Clears the checkbox of all visible caches.

Actions Determines the action to be applied to all selected caches. Options

include:

Enable Enables all selected caches.

Disable Disables all selected caches.

Refresh Refreshes all selected caches.

Submit Applies the action to all selected caches.

Control Descriptions

BUTTON DESCRIPTION

Flush Magento Cache Removes all items in the default Magento cache (var/cache),

according to their associated Magento tags.

Flush Cache Storage Removes all items from the cache, regardless of Magento tag. If your

system uses an alternate cache location, any cached files used by

other applications are removed in the process.

Flush Catalog Images

Cache

Removes all automatically resized and watermarked catalog images

that are stored at: media/catalog/product/cache.

If recently uploaded images aren't reflected in the catalog, try flushing

the catalog and refreshing your browser.

Flush JavaScript/CSS

Cache

Removes the merged copy of JavaScript and CSS files from the

cache. If recent changes to the style sheet or JavaScript aren't

reflected in the store, try flushing the JavaScript/CSS cache and

refreshing your browser.

Flush Static Files Cache Removes preprocessed view files and static files.

Button Descriptions

Cache Management CHAPTER 71: Tools

916 Magento Community Edition 2.0 User Guide

CACHE DESCRIPTION

Configuration Various XML configurations that were collected across modules and

merged. Associated Tag: CONFIG

System: config.xml

local.xml

Module: config.xml

Layouts Layout building instructions.

Associated Tag: LAYOUT_GENERAL_CACHE_TAG

Blocks HTML output Page blocks HTML. Associated Tag: BLOCK_HTML

Collections Data Collection data files. Associated Tag: COLLECTION_DATA

Database DDL operations Results of DDL queries, such as describing tables or indexes.

Associated Tag: DB_DDL

EAV types and attributes Entity types declaration cache. Associated Tag: EAV

Page Cache Full page caching. Associated Tag: FPC

Integrations Configuration Integration configuration file. Associated Tag: INTEGRATION

Integrations API

Configuration

Integrations API configuration file.

Associated Tag: INTEGRATION_API_CONFIG

Target Rule The target rule index.

Associated Tag: IARGET_RULE

Translations Translation files. Associated Tag: TRANSLATE

Web Services

Configuration

REST and SOAP configurations, generated WSDL file.

Associated Tag: WEBSERVICE

Cache Descriptions

CHAPTER 71: Tools Cache Management

Magento Community Edition 2.0 User Guide 917

Full-Page Cache

We currently recommend that Full Page Cache is used only in a development environment.

Magento Community Edition 2.0 uses full-page caching on the server to quickly display

category, product, and CMS pages. Full-page caching improves response time and reduces the

load on the server. Without caching, each page might need to run blocks of code and retrieve

information from the database. However, with full-page caching enabled, a fully-generated page

can be read directly from the cache. For more technical information, see: Configure and Use

Varnish

Cached content can be used to process the requests from similar types of visits. As a result,

pages shown to a casual visitor might differ from those shown to a customer. For the purposes

of caching, each visit is one of three types:

Non-sessioned During a non-sessioned visit, a shopper views pages, but does not

interact with the store. The system caches the content of each page

viewed, and serves them to other non-sessioned shoppers.

Sessioned During a sessioned visit, shoppers who interact with the store—through

activities such as comparing products or adding products to the

shopping cart—are assigned a session ID. Cached pages that are

generated during the session are used only by that shopper during the

session.

Customer Customer sessions are created for those who have registered for an

account with your store and shop while logged in to their accounts.

During the session, customers can be presented with special offers,

promotions, and prices that are based on the customer group to which

they are assigned.

Cache Management CHAPTER 71: Tools

918 Magento Community Edition 2.0 User Guide

To configure the full-page cache:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Advanced, choose System.

3. Expand the Full Page Cache section.

Full Page Cache

4. Set Caching Application to one of the following:

lBuilt-in Application

lVarnish Caching

5. To set the time-out for the page cache, enter the TTL for public content. (The default value is

86400)

6. If using Varnish, complete the Varnish Configuration section as follows:

a. In the Access list field, enter the IPaddresses that can purge the Varnish configuration to

generate a config file. Separate multiple entries with a comma. The default value is

“localhost.”

b. In the Backend host field, enter the IPaddress of the backend host that generates config

files. The default value is “localhost.”

c. In the Backend port field, identify the backend port that is used to generate config files.

The default value is: “8080.”

d. To export the configuration as a varnish.vcl file, tap the button for the version of

Varnish that you use.

lExport VCL for Varnish 3

lExport VCL for Varnish 4

CHAPTER 71: Tools Cache Management

Magento Community Edition 2.0 User Guide 919

Varnish Configuration

7. When complete, tap Save Config.

Alternate Media Storage

Magento Community Edition 2.0 gives you the option to store media files in a database on a

database server, or on a Content Delivery Network (CDN), as opposed to storing them on the

file system of the web server. The advantage of using alternate storage is that it minimizes the

effort required to synchronize media when multiple instances of the system that are deployed

on different servers that need access to the same images, CSS files, and other media files.

lDatabase

lContent Delivery Network (CDN)

Alternate Media Storage CHAPTER 71: Tools

920 Magento Community Edition 2.0 User Guide

Using a Database

By default, all images, compiled CSS files, and compiled JavaScript files of the Magento

instance are stored in the file system on the web server. You can choose to store these files in a

database on a database server. One advantage of this approach is the option of automatic

synchronization and reverse synchronization between the web server file system and the

database. You can use the default database to store media or create a new one. To be able to use

a newly created database as media storage, you must add information about it and its access

credentials to the local.xml file.

Database Workflow

1Browser requests media. A page from the store opens in the customer’s browser, and

the browser requests the media that is specified in the HTML.

2System looks for media in file system. The system searches for the media in the file

system and if found, passes it to the browser.

3System locates media in database. If the media is not found in the file system, a

request for the media is sent to the database that is specified in the configuration.

4System locates media in database. A PHP script transfers the files from the database

to the file system, and sent to the customer’s browser. The browser request for media

triggers the script to run as follows:

lIf web server rewrites are enabled for Magento and supported by the server, the PHP

script runs only when the requested media is not found in the file system.

lIf web server rewrites are disabled for Magento, or not supported by the server, the

PHP script runs anyway, even if the required media is available in the file system.

CHAPTER 71: Tools Alternate Media Storage

Magento Community Edition 2.0 User Guide 921

To use a database for media storage:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left, under Advanced, choose System.

3. In the upper-left corner set Store View to “Default Config,” to apply the configuration at the

global level.

4. Expand the Storage Configuration for Media section. Then, do the following:

Storage Configuration for Media (Database)

a. Set Media Storage to “Database.”

b. Set Select Media Database to the database you want to use.

c. Tap Synchronize to transfer the existing media to the newly selected database.

d. Enter the Environment Update Time in seconds.

5. When complete, tap Save Config.

Alternate Media Storage CHAPTER 71: Tools

922 Magento Community Edition 2.0 User Guide

Using a Content Delivery Network

Storing media files in a CDN is another alternative supported in Magento. There is no full

integration with a specific CDN, and you are responsible for choosing and configuring a CDN

on your own.

After configuring the CDN, you must complete the configuration from the Admin. The changes

can be made at either the global or website level. When a CDN isused for media storage, all

paths to media on store pages are changed to the CDN paths that are specified in the

configuration.

CDN Workflow

1Browser requests media. A page from the store opens in the customer’s browser, and

the browser requests the media that is specified in the HTML.

2Request sent to CDN; images found and served. The request is sent first to the

CDN. If the CDN has the images in storage, it serves the media files to the customer's

browser.

3Media not found, request sent to Magento web server. If the CDN doesn’t have the

media files, the request is sent to the Magento web server. If the media files are found in

the file system, the web server sends them to the customer’s browser.

Important! For security, when a CDN is used as media storage, JavaScript may not function

properly if the CDN is located outside of your subdomain.

CHAPTER 71: Tools Alternate Media Storage

Magento Community Edition 2.0 User Guide 923

To configure a content delivery network:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under General, choose Web.

3. In the upper-left corner, set Store View as needed.

4. Expand the Base URLs section. Then, do the following:

Base URLs

a. Update the Base URL for Static View Files with the URL of the location on the CDN

where static view files are stored.

b. Update the Base URL for User Media Files with the URL of the JavaScript files on the

CDN.

Both these fields can be left blank, or can start with the placeholder: {{unsecure_base_

url}}

5. Expand the Base URLs (Secure) section.

Alternate Media Storage CHAPTER 71: Tools

924 Magento Community Edition 2.0 User Guide

Base URLs (Secure)

a. Update the Secure Base URL for Static View Files with the URL of the location on the

CDN where static view files are stored.

b. Update the Secure Base URL for User Media Files with the URL of the JavaScript files on

the CDN.

Both these fields can be left blank, or can start with the placeholder: {{unsecure_base_

url}}

6. When complete,tap Save Config.

CHAPTER 71: Tools Alternate Media Storage

Magento Community Edition 2.0 User Guide 925

Backups

Magento Community Edition 2.0 gives you the ability to back up different parts of the system—

such as the file system, database, and media files—and to rollback automatically. A record for

each backup appears in the grid on the Backups page. Deleting a record from the list deletes

the archived file as well. Database backup files are compressed using the .gz format. For the

system backups and database and media backups, the .tgz format is used. As a best practice,

you should restrict access to backup tools, and back up before installing extensions and

updates.

Restrict Access to Backup Tools

Access to the Backups and Rollback management tool can be restricted by configuring user

permissions for backup and rollback resources. To restrict access, leave the corresponding

checkbox unselected. If you need to grant access to rollback resources, you must grant access to

backup resources as well.

Backup Before Installing Extensions and Updates

Always perform a backup before you install an extension or update Magento. Magento Connect

Manager (MCM) includes a backup option that you can use before installing an extension or upgrading

to a new release.

Backups

Backups CHAPTER 71: Tools

926 Magento Community Edition 2.0 User Guide

To create a backup:

1. On the Admin sidebar, tap System. Then under Tools, choose Backups.

2. In the upper-right corner, tap the button for the type of backup you want to create:

System Backup Creates a complete backup of the database and the file system. During the

process, you can choose to include the media folder in the backup.

Database and Media

Backup Creates a backup of the database and the media folder.

Database Backup Creates a backup of the database.

3. To put the store into maintenance mode during the backup, mark the checkbox. When the

backup is complete, maintenance mode is turned off automatically.

4. For a system backup, mark the Include Media folder to System Backup checkbox if you want

to include the media folder. Then when prompted, confirm the action.

CHAPTER 71: Tools Backups

Magento Community Edition 2.0 User Guide 927

Index Management

Magento reindexes automatically whenever one or more items change. Actions that trigger

reindexing include price changes, creating catalog or shopping cart price rules, adding new

categories, and so on. To optimize performance, Magento accumulates data into special tables

using indexers. As the data changes, the indexed tables must be updated—or reindexed.

Reindexing is performed as a background process, and your store remains accessible during the

processes.

Reindexing data speeds up processing, and reduces the time the customer has to wait. For

example, if you change the price of an item from $4.99 to $3.99, Magento reindexes the data to

show the price change in the store. Without indexing, Magento would have to calculate the

price of every product on the fly—taking into account shopping cart price rules, bundle pricing,

discounts, tier pricing, and so on. Loading the price for a product might take longer than the

customer is willing to wait.

The indexers can be set to either update on save, or on schedule. Reindexing is performed as a

background process that is scheduled as a cron job, and your store remains accessible during

the processes. A system message appears if a cron job is not available to update any indexers

that become invalid.

Index Management

Index Management has a slightly different presentation for flat product catalogs.

To avoid problems when multiple Admin users update objects that trigger automatic

reindexing, we recommend that you set all indexers to run on schedule as cron jobs.

Otherwise, every time an object is saved, any objects with interdependencies might

cause a deadlock. Symptoms of a deadlock include high CPU usage and MySQL

errors. As a best practice, we recommend that you use scheduled indexing .

Index Management CHAPTER 71: Tools

928 Magento Community Edition 2.0 User Guide

CHAPTER 71: Tools Index Management

Magento Community Edition 2.0 User Guide 929

To change the index mode:

1. On the Admin sidebar, tap System. Then under Tools, choose Index Management.

2. Mark the checkbox of each indexer that you want to change.

3. Set Actions to one of the following:

lUpdate on Save

lUpdate by Schedule

4. Tap Submit to apply the change to each selected indexer.

COLUMN DESCRIPTION

Indexer The name of the indexer.

Description A description of the indexer.

Mode Indicates the current update mode for each indexer. Options:

Update on Save The index is set to update whenever a

change is saved.

Update on

Schedule

The index is set to update on schedule

according to a cron job.

Status Displays one of the following:

Ready The index is up-to-date.

Scheduled Reindexing is scheduled to take place.

Running Reindexing is currently running.

Reindex Required A change has been made that requires

reindexing, but the indexers cannot be

updated automatically. Check to see if cron

is available and configured correctly.

Updated Indicates the date and time an index was last updated.

Column Descriptions

Index Management CHAPTER 71: Tools

930 Magento Community Edition 2.0 User Guide

Indexing Events

Reindexing Triggers

INDEX TYPE REINDEXING EVENT

Product Prices Add customer group

Change configuration settings

Flat catalog1product data Add store

Add store group

Add, edit, or delete attribute (for searching and filtering)

Flat catalog category data Add store

Add store group

Add, edit, or delete attribute (for searching and filtering)

Catalog category/product

index

Add, edit, or delete products (single, mass, and import)

Change product-to-category relations

Add, edit, or delete categories

Add or delete stores

Delete store groups

Delete websites

Catalog search index Add, edit, or delete products (single, mass, and import)

Add or delete stores

Delete store groups

Delete websites

Stock status index Change inventory configuration settings.

Category permissions

index

Add store, add store group, add or delete or update attribute (for

searching and filtering)

1The flat product and category indexers also influence how catalog and shopping cart price rules are indexed. If

you have a large number of SKUs (about 500,000 or more), you will notice a dramatic improvement in indexing time

for price rules. To take advantage of this improvement, you must enable Use Flat Catalog Product.

CHAPTER 71: Tools Index Management

Magento Community Edition 2.0 User Guide 931

Index Actions and Controls

ACTION RESULT TO CONTROL

Creating a new store, new

customer group, or any

action listed in “Actions

that Cause a Full

Reindex.”

Full reindex Full reindexing is performed on the

schedule determined by your Magento

cron job.

Bulk loading of items in the

following ways:

lMagento import/export

lDirect SQL query

lAny other method that

directly adds, changes,

or deletes data.

Partial reindex (only

changed items are

reindexed)

At the frequency determined by your

Magento cron job.

Changing scope (for

example, from global to

website)

Partial reindex (only

changed items are

reindexed)

At the frequency determined by your

Magento cron job.

Index Actions

Events that Trigger Full Reindexing

INDEXER EVENT

Catalog Category Flat

Indexer

Create a new web store

Create a new web store view

Create, or delete an attribute that is any of the following:

lSearchable or visible in advanced search

lFilterable

lFilterable in search

lUsed for sorting

Change an existing attribute to be any of the preceding.

Enable flat category storefront options

Full Reindex Triggers

Index Management CHAPTER 71: Tools

932 Magento Community Edition 2.0 User Guide

INDEXER EVENT

Catalog Product Flat

Indexer

Create a new web store

Create a new web store view

Create, or delete an attribute that is any of the following:

lSearchable or visible in advanced search

lFilterable

lFilterable in search

lUsed for sorting

Change an existing attribute to be any of the preceding.

Enable flat category storefront options

Stock status indexer When the following Catalog Inventory options change in the system

configuration:

Stock Options Display Out of Stock Products

Product Stock

Options

Manage Stock

Price Indexer Adding a new customer group.

When any of the following Catalog Inventory options change in the

system configuration:

Stock Options Display Out of Stock Products

Product Stock

Options

Manage Stock

Price Catalog Price Scope

Category or Product

Indexer

Create or delete a store view

Delete a store

Delete a website

Full Reindex Triggers (cont.)

CHAPTER 71: Tools Index Management

Magento Community Edition 2.0 User Guide 933

Cron (Scheduled Tasks)

Magento performs some operations on schedule by periodically running a script. You can

control the execution and scheduling of Magento cron jobs from the Admin. Store operations

that run according to a cron schedule include:

lEmail

lCatalog Price Rules

lNewsletters

lXMLSitemap Generation

lCurrency Rate Updates

In addition, you can configure the following to run according to a cron schedule:

lOrder System Grid Updates and Reindexing

lPending Payment Lifetime

Make sure that the base URLs for the store are set correctly, so the URLs that are generated

during cron operations are correct. To learn more, see: Setting Up Cron Jobs.

To configure cron:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Advanced, choose System.

3. Expand the Cron section.

Cron (Scheduled Tasks)

Cron (Scheduled Tasks) CHAPTER 71: Tools

934 Magento Community Edition 2.0 User Guide

4. Then, complete the following settings for the Index and Default groups. The settings are the

same in each section.

lGenerate Schedules Every

lSchedule Ahead for

lMissed if not Run Within

lHistory Cleanup Every

lSuccess History Lifetime

lFailure History Lifetime

lUse Separate Process

Cron Configuration for Group:Index

5. When complete, tap Save Config.

CHAPTER 71: Tools Cron (Scheduled Tasks)

Magento Community Edition 2.0 User Guide 935

Web Setup Wizard

The Setup Wizard can be used to upgrade your Magento installation, manage Magento

Marketplace extensions, and update the system configuration.

Web Setup Wizard

Web Setup Wizard CHAPTER 71: Tools

936 Magento Community Edition 2.0 User Guide

Setup Tools

Component Manager

Component Manager lists each component that is

currently installed, and can be used to synchronize

any extensions you have purchased from Magento

Marketplace with your system.

System Upgrade

The System Upgrade tool can be used to upgrade your

installation of Magento. During the process, it checks

your system for readiness, creates a backup, and then

upgrades your system.

System Config

The System Config tool can be synchronized with your

Marketplace account, based on your public and

private access keys.

CHAPTER 71: Tools Web Setup Wizard

Magento Community Edition 2.0 User Guide 937

Web Setup

The Web Setup setup is the second part of the Magento installation that checks system

readiness, establishes the database connection, and creates the initial Admin account. The

Magento setup can be rerun at any time from the System menu.

Magento Setup

To launch Magento Setup:

1. On the Admin sidebar, tap System. Then under Tools, choose Web Setup Wizard.

2. Read the Terms & Agreement. If you agree, tap Agree and Setup Magento to continue.

Step 1: Readiness Check

1. To verify that your system meets the system requirements, tap Start Readiness Check.

2. When the results appear, tap Details for more information. Then, do one of the following;

lIf your system fails the readiness check, correct the issue and tap Try Again.

lIf your system meets the requirements, tap Next.

Web Setup Wizard CHAPTER 71: Tools

938 Magento Community Edition 2.0 User Guide

Readiness Check

Step 2:Add a Database

1. To change the MySQL database or update the credentials, do the following:

a. Enter the Database Server Host. If the database resides on the same server as the

Magento code, enter “localhost.”

b. Enter the Database Server Username.

c. Enter the Database Server Password.

d. Enter the Database Name.

e. If applicable, enter the Table prefix.

2. When complete, tap Next. Your credentials must be correct to continue to the next step.

Add a Database

CHAPTER 71: Tools Web Setup Wizard

Magento Community Edition 2.0 User Guide 939

Step 3: Web Configuration

1. Under Web Configuration, do the following:

a. In the Your Store Address field, enter the full URL of your Magento store.

b. In the Magento Admin Address field, enter the full URL of the Magento Admin.

2. Expand the Advanced Options, and do the following:

a. Mark the checkbox of the HTTPS Options that apply to your system:

lUse HTTPS for Magento Storefront

lUse HTTPS for Magento Admin

b. To enable your server to use Apache Rewrites, mark the checkbox.

c. Mark the checkbox of the Encryption Key setting that applies to your system:

lI want to use a Magento generated key.

lI want to use my own encryption key.

Web Configuration

Step 4: Customize Your Store

1. To install or reinstall the Sample Data, do the following:

a. To create a sample store with sample products, mark the Use Sample Data checkbox.

b. If you are reinstalling the sample data, also mark the Clean up automatically checkbox.

2. Set Store Default Time Zone to the correct time zone for your locale.

3. Set Store Default Currency to the default currency that you accept as payment.

Web Setup Wizard CHAPTER 71: Tools

940 Magento Community Edition 2.0 User Guide

4. Set Store Default Language to the primary language of your store.

Customize Your Store

5. (Optional) Expand the Advanced Modules Configuration, and do the following:

a. To install only specific modules, clear the Select All checkbox.

b. In the list, select the checkbox of each module you want to install.

Advanced Modules Configuration

6. When complete, tap Next.

CHAPTER 71: Tools Web Setup Wizard

Magento Community Edition 2.0 User Guide 941

Step 5: Create Admin Account

1. Enter a New Username for the Admin account.

2. Enter a New E-Mail for the Admin account.

3. Enter a New Password for the Admin account. Then in the Confirm Password field, enter

your new password again.

4. When complete, tap Next.

Create Admin Account

Step 6: Install

1. When you are ready to complete the setup, tap Install Now.

Install

Web Setup Wizard CHAPTER 71: Tools

942 Magento Community Edition 2.0 User Guide

2. When the installation completes, a page appears with your Magento Admin and database

credentials, but without the passwords. You can print the page and keep it for your records.

Then, do of the following:

lLaunch Magento Storefront

lLaunch Magento Admin

3. If the installation fails to complete, view the Console Log to learn more. Then, correct the

problem and try again.

A little Housekeeping

After Setup is complete, do the following to set the recommended permissions for all files and

folders in your Magento2 installation:

1. Change to the Web user who has full permissions to the Magento2 folder. (For example, apache

or root.)

su – apache

2. Change directories to the Magento2 folder, and set the following permissions. You can copy the

code, and paste it as a single command.

find . -type d -exec chmod 700 {} \; && find . -type f -exec chmod

600 {} \; && chmod +x bin/magento

CHAPTER 71: Tools Web Setup Wizard

Magento Community Edition 2.0 User Guide 943

Notes

944 Magento Community Edition 2.0 User Guide

CHAPTER 72:

Permissions

Magento uses roles and permissions to create different levels of access to the Admin. When

your store is first set up, you receive a set of login credentials for the Administrator role

that has full permissions. However, you can restrict the level of permissions on a “need to

know” basis for other people who work on your site. For example, a designer can be given

access to only the Design tools, but not to areas with customer and order information.

In addition, you can further restrict Admin access to only a specific site, or set of sites and

their associated data. If you have multiple brands or business units with separate stores

on the same Magento installation, you can provide Admin access to each of your business

units but hide and protect their data from other Admin users.

If an Admin user’s access is restricted to specific websites and/or stores, the websites and

stores for which they are not authorized will either not be visible to them, or grayed-out as

inactive. Only the sales and other data for permitted websites and stores is shown.

All Users

Magento Community Edition 2.0 User Guide 945

Adding Users

When your store is first installed, your login credentials give you full administrative access. As

a best practice, one of the first things you should do is to create another user account with full

Administrator permissions. That way, you can use one account for your everyday

Administrative activities, and reserve the other as a “Super Admin” account in case you forget

your regular credentials or they somehow become unusable.

If there are others on your team, or service providers who need access, you can create a separate

user account for each, and assign restricted access. To limit the websites or stores that admin

users can access when they log in, you must first create a role with limited scope and access to

resources. Then, you can assign the role to a specific user account. Admin users who are

assigned to a restricted role can see and change data only for websites or stores that are

associated with the role. They cannot make changes to any global settings or data.

Step 1: Create a New User

1. On the Admin sidebar tap System. Then under Permissions, choose All Users.

2. In the upper-right corner, tap Add New User.

3. In the Account Information section, do the following:

New User Account Information

Adding Users CHAPTER 72: Permissions

946 Magento Community Edition 2.0 User Guide

a. Enter the User Name for account.

The User Name should be easy to remember. It is not case-sensitive. For example, if your

user name is “John,” you can also log in as “john.”

b. Complete the following information:

lFirst Name

lLast Name

lEmail address

This email address must be different from the one that is associated with your original

Admin account.

c. Assign a Password to the account.

The password should be seven or more characters long, and include both letters and

numbers.

d. In the Password Confirmation box, repeat the password to make sure it was entered

correctly.

e. If your store has multiple languages, set Interface Locale to the language to be used for

the Admin interface.

4. Set This Account is to “Active.”

5. Under Current User Identity Verification, enter Your Password.

Current User Identity Verification

CHAPTER 72: Permissions Adding Users

Magento Community Edition 2.0 User Guide 947

Step 2: Define the Role

1. In the panel on the left, choose User Role. The grid lists all the existing roles. Initially, the

only role available is Administrators.

2. In the Assigned column, select the Administrators option.

3. Tap Save User.

You now have two accounts with Administrator access.

Add New User Role

Adding Users CHAPTER 72: Permissions

948 Magento Community Edition 2.0 User Guide

Locked Users

For the security of your business, user accounts are locked after six failed attempts to log in to

the Admin. Any user account that is currently locked appears in the grid. The account can be

unlocked by any other user with full Administrator permissions.

In the configuration, you can set the maximum number of times an Admin user can try to login

before the account is locked. To learn more, see: Configuring Admin Security.

To unlock an admin account:

1. On the Admin sidebar, tap System. Then under Permissions, choose Locked Users.

2. In the grid, mark the checkbox of the locked account.

3. In the upper-left corner, set the Actions control to “Unlock.”

4. Tap Submit to unlock the user account.

CHAPTER 72: Permissions Locked Users

Magento Community Edition 2.0 User Guide 949

User Roles

To give someone restricted access to the Admin, the first step is to create a role that has the

appropriate level of permissions. The role can have varying levels of permissions to the

following resources:

lPrice Resources

lPromotion Resources

lProduct Resources

After the role is established you can add new users and assign the restricted role to grant them

limited access to the Admin.

Role Name

User Roles CHAPTER 72: Permissions

950 Magento Community Edition 2.0 User Guide

To define a role:

1. On the Admin sidebar, tap System. Then under Permissions, choose User Roles.

2. In the upper-left corner, tap Add New Role.

3. In the Role Information section, enter a descriptive Role Name.

4. In the panel on the left, choose Role Resources.

Role Scopes

5. Under Role Scopes , set Role Scopes to “Custom.” Then, mark the checkbox of each website

and view to which the role is to have permission to access.

6. In the Roles Resources tree, mark the checkbox of each Admin Resource that you want the role

to be able to access.

In the tree, the color of each node changes from white to gray each time the section is expanded

or collapsed. If the node is collapsed, you can click the node to show additional resources.

Important! Be sure to disable access to the Permissions tool if you are limiting access for a given

role. Otherwise, users will be able to modify their own permissions.

CHAPTER 72: Permissions User Roles

Magento Community Edition 2.0 User Guide 951

Role Resources Assigned

7. (Optional) In the panel on the left, choose Role Users. Then, assign additional Administrator

user accounts to the new role.

8. When complete, tap Save Role.

The role now appears in the grid, and can be assigned to new user accounts.

User Roles CHAPTER 72: Permissions

952 Magento Community Edition 2.0 User Guide

CHAPTER 73:

Security

In this section of the guide, you will learn security best practices, how to manage Admin

sessions and credentials, implement CAPTCHA, and manage website restrictions.

lSecurity Best Practices

lConfiguring Admin Security

lCAPTCHA

lEncryption Key

lBrowser Capabilities Detection

lAction Log

Magento Community Edition 2.0 User Guide 953

Security Best Practices

All eCommerce sites are attractive targets to hackers because of the personal and payment

information that is required to complete a sale. Even if the system does not directly process

credit card transactions, a compromised site might reroute customers to a false page, or alter

an order before it is transmitted to the payment processor.

A compromised site can have long-term consequences for both customers and merchants.

Customers might suffer financial loss and identify theft, while merchants can face damage to

their reputations, loss of merchandise, higher processing fees, revoked privileges with financial

institutions, and the threat of lawsuits.

This guide outlines a multifaceted approach to improve the security of your Magento

installation. Although there is no single way to eliminate all security risks, there are many

things that you can do to make your site a less attractive target. It is crucial for hosting

providers, system integrators, and merchants to work together to establish and maintain a

secure environment, implement methods for early detection, and determine a plan of action in

the event of a breach.

Start Right

Work with reliable hosting providers and solution integrators. When evaluating their

qualifications, ask about their approach to security. Verify that they have a secure software

development life cycle in accord with industry standards such as The Open Web Application

Security Project (OWASP), and that they test their code for security issues.

If you are starting a new site, consider launching the entire site over HTTPs. Taking the lead on

this issue, Google now uses HTTPs as a ranking factor.

For an existing installation, plan to upgrade the entire site to run over to a securely encrypted,

HTTPs channel. Although you will need to create redirects from HTTP to HTTPs, the effort will

future-proof your site. We recommend that you plan to make this change sooner, rather than

later.

Security Best Practices CHAPTER 73: Security

954 Magento Community Edition 2.0 User Guide

Protect the Environment

Protecting the environment is the most critical aspect of ensuring the security of your store.

Keep all software on the server up to date, and apply security patches as recommended. This

applies not only to Magento, but to any other software that is installed on the server, including

database software and other websites that use the same server. Any system is only as secure as

the weakest link.

Make sure that the server operating system is secure. Work with your hosting provider to

ensure that there is no unnecessary software running on the server.

Use only secure communications protocol (SSH/SFTP/HTTPS) to manage files, and

disable FTP.

Magento includes .htaccess files to protect system files when using the Apache

web server. If you use a different web server such as Nginx, make sure that all

system files and directories are protected. For an sample Nginx configuration, see:

magento-nginx.conf on GitHub.

Use strong and unique passwords, and change them periodically.

Keep the system up to date, and immediately install patches when new security issues

are discovered.

Closely monitor any issues that are reported for software components used by your

Magento installation, including the operating system, MySQL database, PHP, Redis (if

used), Apache or Nginx, Memcached, Solr, and any other components in your specific

configuration.

Limit access to cron.php file to only required users. For example, restrict access by IP

address. If possible, block access completely and execute the command using the

system cron scheduler.

Server Environment

Automate the deployment process, if possible, and use private keys for data transfer.

Limit access to the Magento Admin by updating the whitelist with the IP address of each

computer that is authorized to use the Admin and Magento Connect downloader. For

examples of how to whitelist IP addresses, see: Secure Your Magento Admin.

Do not install extensions directly on a production server.

Advanced Techniques

CHAPTER 73: Security Security Best Practices

Magento Community Edition 2.0 User Guide 955

To disable the Magento Connect downloader on the production site, either remove or

block access to the /downloader directory. You can also use the same whitelisting

methods.

Use two-factor authorization for Admin logins. There are several extensions available that

provide additional security by requiring an additional passcode that is generated on your

phone, or a token from a special device.

Review your server for “development leftovers.” Make sure there are no accessible log

files, publicly visible .git directories, tunnels to execute SQL, database dumps, phpinfo

files,or any other unprotected files that are not required, and that might be used in an

attack.

Limit outgoing connections to only those that are required, such as for a payment

integration.

Use a Web Application Firewall to analyze traffic and discover suspicious patterns, such

as credit card information being sent to an attacker.

Advanced Techniques (cont.)

Make sure that all applications running on the server are secure.

Avoid running other software on the same server as Magento, especially if it is accessible

from the Internet. Vulnerabilities in blog applications such as Wordpress can expose

private information from Magento. Install such software on a separate server or virtual

machine.

Keep all software up to date, and apply patches as recommended.

Server Applications

Make sure that the computer that is used to access the Magento Admin is secure.

Keep your antivirus software up to date, and use a malware scanner. Do not install any

unknown programs, or click suspicious links.

Use a strong password to log in to the computer, and change it periodically. Use a

password manager such as LasstPass,1Password, or Dashlane to create and manage

secure, unique passwords.

Do not save FTP passwords in FTP programs, because they are often harvested by

malware and used to infect servers.

Admin Desktop Environment

Security Best Practices CHAPTER 73: Security

956 Magento Community Edition 2.0 User Guide

Protect Magento

Your effort to protect your Magento installation starts with the initial setup, and continues

with the security-related configuration settings, password management, and ongoing

maintenance.

Use the latest version of Magento to ensure that your installation includes the most

recent security enhancements.

If for any reason you cannot upgrade to the latest version, make sure to install all security

patches as recommended by Magento. Although Magento issues security patches to fix

major issues, new product releases include additional improvements to help secure the

site.

Use a unique, custom Admin URL instead of the default “admin” or the often-used

“backend,” Although it will not directly protect your site from a determined attacker, it can

reduce exposure to scripts that try to break into every Magento site. (Never leave your

valuables in plain sight.)

Check with your hosting provider before implementing a custom Admin URL. Some

hosting providers require a standard URL to meet firewall protection rules.

Block access to any development, staging, or testing systems. Use IP whitelisting and

.htaccess password protection. When compromised, such systems can produce a data

leak or be used to attack the production system.

Use the correct file permissions. Core Magento and directory files should be set to ready

only, including app/etc/local.xml files.

Use a strong password for the Magento Admin. To learn more, see: Creating a strong

password.

Take advantage of Magento’s security-related configuration settings for Admin Security,

Password Options, and CAPTCHA.

Your Magento Installation

CHAPTER 73: Security Security Best Practices

Magento Community Edition 2.0 User Guide 957

Don’t be Taken for a Ride

Install extensions only from trusted sources. Never use paid extensions that are

published on torrent or other sites. If possible, review extensions for security issues

before installing them.

Do not click suspicious links, or open suspicious email.

Do not disclose the password to your server or to the Magento Admin, unless you are

required to do so.

Be Prepared!

Develop a disaster recovery/business continuity plan. Even a basic plan will help you get

back on track in the event of a problem.

Ensure that your server and database are automatically backed up to external location. A

typical setup requires daily incremental backups, with a full backup on a weekly basis.

Make sure to test the backup regularly to verify that it can be restored.

For a large site, simple text file dumps of the database take an unacceptable amount of

time to restore. Work with your hosting provider to deploy a professional database backup

solution.

Security Best Practices CHAPTER 73: Security

958 Magento Community Edition 2.0 User Guide

Monitor for Signs of Attack

If your system is not immediately patched after a major security breach, there is a high

probability that your site is already compromised. Complete a security review periodically to

check for signs of attack, and also when contacted by customers with security-related concerns.

Check periodically for unauthorized Admin users.

(Magento Enterprise only) Check the Admin Actions Log for suspicious activity.

Use automated log review tools such as Apache Scalp.

Work with your hosting provider to review server logs for suspicious activity, and to

implement an Intrusion Detection System (IDS) on your network.

Use a file and data integrity checking tool such as TripWire to receive notification of any

potential malware installation.

Monitor all system logins (FTP, SSH) for unexpected activity, uploads, or commands.

Security Review

CHAPTER 73: Security Security Best Practices

Magento Community Edition 2.0 User Guide 959

Follow Your Disaster Recovery Plan

In the event of a compromise, work with your internal IT security team if available, or hosting

provider, and system integrator to determine the scope of the attack. Taking into consideration

the type of compromise and the size of the store. Then, adjust the following recommendations

to your business needs.

1. Block access to the site, so the attacker cannot remove evidence or steal more information.

2. Backup the current site, which will include evidence of the installed malware or compromised

files.

3. Try to determine the scope of the attack. Was credit card information accessed? What

information was stolen? How much time has elapsed since the compromise? Was the

information encrypted? Typically you can expect the following types of attack:

Defacing of Site Site access is compromised, but often the payments information

is not. User accounts might be compromised.

Botnetting Your site becomes part of a botnet that sends spam email.

Although data is probably not compromised, your server is

blacklisted by spam filters which prevents email that you send to

customers from being delivered.

Direct Attack on Server Data is compromised, backdoors and malware are installed, and

the site no longer works. Payment information—provided that it

is not stored on the server— is probably safe.

Silent Card Capture In this most disastrous attack, intruders install hidden malware

or card capture software, or possibly modify the checkout process

to collect and send out credit card data. Such attacks can go

unnoticed for extended periods of time, and result in major

compromise of customer accounts and financial information.

4. Try to find the attack vector to determine how the site was compromised, and when. Review

server log files and file changes. Note that sometimes there are multiple different attacks on the

same system.

5. If possible, wipe and reinstall everything. In case of virtual hosting, create a new instance.

Malware might be hidden in an unsuspected location, just waiting to restore itself. Remove all

unnecessary files. Then, reinstall all required files from a known, clean source such as files from

your own version control system, or the original distribution files from magento.com.

6. Apply all the latest security patches necessary.

7. Reset all credentials, including the database, file access, payment and shipping integrations,

web services, and Admin login.

Security Best Practices CHAPTER 73: Security

960 Magento Community Edition 2.0 User Guide

8. If payment information was compromised, it might be necessary to inform your payment

processor.

9. Inform your customers about the attack and the type of information affected. If payment

information was compromised, they should look for unauthorized transactions. If personal

information, including email addresses was compromised, they might be targeted with

phishing attacks or spam.

Acknowledgments

Parts of this article were inspired by real-world solutions that were shared by community

members. The resulting article incorporates content from the community, with input from our

team.

lBryan (BJ) Hoffpauir for sharing his insight on the Magento forum, and for contributing

recommendations in the Attack Response Plan section of this article. See the original post by

beejhuff for more information.

lAnna Völkl (@rescueann), Magento developer at LimeSoda.

lRobert Mangiafico (@robfico) CTO at LexiConn.

l@dracony_gimp for his security presentation, Being Hacked is Not Fun.

lWillem de Groot for providing a sample Nginx configuration.

CHAPTER 73: Security Security Best Practices

Magento Community Edition 2.0 User Guide 961

Configuring Admin Security

For increased security, you can configure the length of keyboard inactivity before the current

session expires, and require the user name and password to be case-sensitive. For additional

security, the Admin login can be configured to require a CAPTCHA.

Security

Configuring Admin Security CHAPTER 73: Security

962 Magento Community Edition 2.0 User Guide

To configure Admin security:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left, under Advanced, choose Admin. Then, do the following:

a. To append secret key to the Admin URL to protect against exploits, set Add Secret Key to

URLs to “Yes.” This setting is enabled by default.

b. To require the user name and password to have the same upper-and lowercase characters

as those that are saved in the system, set Login is Case Sensitive to “Yes.”

c. To require Admin users to sign in again after a period of keyboard inactivity, set Admin

Session Lifetime (seconds) to a number greater than 60. To not set a limit on the length

of a session, leave the field blank.

d. In the Maximum Login Failures to Lockout Account field, enter the number of times

Admin users can try to log in before their accounts are locked.

e. In the Lockout Time (minutes) field, enter the number of minutes an Admin account is

locked before the user can try to log in again.

f. In the Password Lifetime (days) field, enter the number of days an Admin password can

be used before it expires.

g. If you want to require Admin users to change their passwords before they expire, set

Password Change to “Forced.”

3. When complete, tap Save Config.

CHAPTER 73: Security Configuring Admin Security

Magento Community Edition 2.0 User Guide 963

CAPTCHA

A CAPTCHA is a visual device that ensures that a human being, rather than a computer, is

interacting with the site. CAPTCHA is an acronym for “Completely Automated Public Turing

test to tell Computers and Humans Apart,” and can be used for both Admin and customer

account logins.

You can reload the CAPTCHA as many times as is necessary by clicking the Reload icon in the

upper-right corner of the image. The CAPTCHA is fully configurable and can be set appear

every time, or only after a number of failed login attempts.

Customer Login with CAPTCHA

CAPTCHA CHAPTER 73: Security

964 Magento Community Edition 2.0 User Guide

Admin CAPTCHA

For an extra level of security, you can add a CAPTCHA to the Admin SignIn and Forgot

Password page. Administrator users can reload the displayed CAPTCHA by clicking the Reload

icon in the upper-right corner of the image. The number of reloads is unlimited.

Admin Sign In with CAPTCHA

To configure an Admin CAPTCHA:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left, under Advanced, choose Admin.

3. In the upper-right corner, set Store View to “Default.”

4. Expand the CAPTCHA section, and do the following:

a. Set Enable CAPTCHA in Admin to “Yes.”

b. Enter the name of the Font to be used for the CAPTCHAsymbols. Default font:

LinLibertine

To add your own font, the font file must reside in the same directory as your Magento

instance, and be declared in the config.xml file of the Captcha module.

c. Select the Forms where the CAPTCHA is to be used:

lAdmin Login

lAdmin Forgot Password

d. Set Displaying Mode to one of the following:

CHAPTER 73: Security CAPTCHA

Magento Community Edition 2.0 User Guide 965

Always CAPTCHA is always required to log in the Admin.

After

number

attempts

to login

When selected displays the Number of Unsuccessful Attempts to Login field.

Enter the number of login attempts allowed. A value of 0 (zero) is similar to

setting Displaying Mode to Always. This option does not cover the Forgot

Password form. If CAPTCHA is enabled and set to be appear on this form, then

it is always included on the form.

e. Enter the Number of Unsuccessful Attempts to Login before the CAPTCHA appears. If

set to zero, the CAPTCHAis always used.

f. In the CAPTCHA Timeout (minutes) field, enter the number of minutes before the

CAPTCHAexpires. When the CAPTCHAexpires, the user must reload the page.

g. Enter the Number of Symbols used in the CAPTCHA, up to eight. For a variable number

of symbols that changes with each CAPTCHA, enter a range, such as 5-8.

h. In the Symbols Used in CAPTCHA field, specify the symbols that can be used in the

CAPTCHA. Only letters (a-z and A-Z) and numbers (0-9) are allowed. The default set of

characters does not include similar symbols such as I or 1. For best results, use symbols

that users can readily identify.

i. To require that users enter the characters exactly as shown set Case Sensitive to “Yes.”

5. When complete, tap Save Config….

CAPTCHA CHAPTER 73: Security

966 Magento Community Edition 2.0 User Guide

Admin CAPTCHA Configuration

CHAPTER 73: Security CAPTCHA

Magento Community Edition 2.0 User Guide 967

Customer CAPTCHA

Customers can be required to enter a CAPTCHA each time they log in to their accounts, or after

several unsuccessful attempts to log in. CAPTCHA can be used for the following forms in the

storefront:

lCreate User

lLogin

lForgot Password

lCheckout as Guest

lRegisterDuring Checkout

lContact Us

Customer CAPTCHA Configuration

CAPTCHA CHAPTER 73: Security

968 Magento Community Edition 2.0 User Guide

To configure a Storefront CAPTCHA:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left, under Customers, choose Customer Configuration.

3. Expand the CAPTCHA section, and do the following:

a. Set Enable CAPTCHA on Frontend to “Yes.”

b. Enter the name of the Font to be used for the CAPTCHAsymbols.

To add your own font, the font file must reside in the same directory as your Magento

instance, and be declared in the config.xml file of the CAPTCHA module.

c. Choose one of the following Forms where CAPTCHA is to be used.

lCreate User

lLogin

lForgot Password

lCheckout as Guest

lRegister during Checkout

d. Set Displaying Mode to one of the following:

Always CAPTCHA is always required to access the selected form(s).

After number

of attempts to

Enter the number of login attempts before the CAPTCHAappears. A value

of 0 (zero) is similar to “Always.” When selected, the number of

unsuccessful login attempts appears.

This option does not apply to the Forgot Password form, which always

display the CAPTCHA, if enabled,

e. Enter the Number of Unsuccessful Attempts to Login before the CAPTCHA appears. If

set to zero, the CAPTCHAis always used.

f. In the CAPTCHA Timeout (minutes) field, enter the number of minutes before the

CAPTCHAexpires. When the CAPTCHAexpires, the user must reload the page to generate

a new CAPTCHA.

g. Enter the Number of Symbols in the CAPTCHA, up to eight. For a variable number of

symbols that change with each CAPTCHA, enter a range such as 5-8.

h. In the Symbols Used in CAPTCHA field, specify the symbols that can be used in the

CAPTCHA. Only letters (a-z and A-Z) and numbers (0-9) are allowed. The default set of

characters does not include similar symbols such as I or 1. For best results, use symbols

that users can readily identify.

i. To require that the user enter the upper-and lowercase characters exactly as shown set

Case Sensitive to “Yes.”

4. When complete, tap Save Config.

CHAPTER 73: Security CAPTCHA

Magento Community Edition 2.0 User Guide 969

Encryption Key

The encryption key is used to protect passwords and other sensitive data. During the Magento

setup, you have the option to generate an encryption key, or use an another.

Encryption Key

To change the encryption key:

1. On the Admin sidebar, tap System. Then under Other Settings, choose Manage Encryption

Key.

2. Set Auto-generate Key to “Yes.”

3. Tap Change Encryption Key.

Encryption Key CHAPTER 73: Security

970 Magento Community Edition 2.0 User Guide

Session Validation

Magento Community 2.0 allows you to validate session variables as a protective measure

against possible session fixation attacks, or attempts to poison or hijack user sessions. The

Session Validation Settings determine how session variables are validated during each store

visit, and if the session IDis included in the URLof the store.

Session Validation Settings

The validation checks to see that visitors are who they say they are by comparing the value in

the validation variables against the session data that is already stored in $_SESSION data for

the user. Validation fails if the information is not transmitted as expected, and the

corresponding variable is empty. Depending on the session validation settings, if a session

variable fails the validation process, the client session immediately terminates.

Enabling all of the validation variables can help prevent attacks, but might also impact the

performance of the server. By default, all session variable validation is disabled. We recommend

that you experiment with the settings to find the best combination for your Magento

installation. Activating all of the validation variables might prove to be unduly restrictive, and

prevent access to customers who have Internet connections that pass through a proxy server, or

that originate from behind a firewall. To learn more about session variables and their use, see

the system administration documentation for your Linux system.

CHAPTER 73: Security Session Validation

Magento Community Edition 2.0 User Guide 971

To configure the Session Validation Settings:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under General, choose Web.

3. Expand the Session Validation Settings section. Then, do the following:

a. To verify that the IP address of a request matches what is stored in the $_SESSION

variable, set Validate REMOTE_ADDR to “Yes.”

b. To verify that the proxy address of an incoming request matches what is stored in the $_

SESSION variable, set Validate HTTP_VIA to “Yes.”

c. To verify that the forwarded-for address of a request matches what is stored in the $_

SESSION variable, set Validate HTTP_X_FORWARDED_FOR to “Yes.”

d. To verify that the browser or device that is used to access the store during a session

matches what is stored in the $_SESSION variable, set Validate HTTP_USER_AGENT to

“Yes.”

e. If you want a user to stay logged in while switching between stores, set Use SID on

Frontend to “Yes.”

If including SID with analytics, you must configure your analytics software to filter the SID

from URLs, so the page visit counts are correct.

4. When complete, tap Save Config.

Session Validation CHAPTER 73: Security

972 Magento Community Edition 2.0 User Guide

Browser Capabilities Detection

As is true of most websites and applications on the Internet, Magento requires that the visitor’s

browser allow both cookies and JavaScript for full operations. However, occasionally a user’s

browser is set to the highest privacy setting that prevents both cookies and JavaScript. Your

store can be configured to test the capabilities of each visitor’s browser, and to display a notice

if the settings need to be changed.

lIf the browser’s privacy settings disallow cookies, you can configure the system to

automatically redirect them to the Enable Cookies page, which explains how to make the

recommended settings with most browsers.

lIf the browser’s privacy settings disallow JavaScript, you can configure the system to display

the following message above the header of every page:

To configure browser capabilities detection:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under General, choose Web.

3. Expand the Browser Configuration Detection section, and do the following:

a. To display instructions that explain how to configure the browser to allow cookies, set

Redirect to CMS-page if Cookies are Disabled to “Yes.”

b. To display a banner above the header when JavaScript is disabled in the user’s browser, set

Show Notice if JavaScript is Disabled to “Yes.”

Browser Capabilities Detection

4. When complete, tap Save Config.

CHAPTER 73: Security Browser Capabilities Detection

Magento Community Edition 2.0 User Guide 973

Action Log

The Action Log tracks the activities of administrators who work in your store. For most events,

the available information includes the action, the name of the user who performed it, whether it

was a success or failure, and the ID of the object on which the action was performed.

Additionally the IP and date are always logged.

Admin Actions Logging

To configure the Action Log:

1. On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.

2. In the panel on the left under Advanced, choose Admin.

3. Expand the Admin Actions Logging section, and do the following:

lTo enable admin logging, mark the checkbox.

lTo disable admin logging, clear the checkbox.

4. When complete, tap Save Config.

Action Log CHAPTER 73: Security

974 Magento Community Edition 2.0 User Guide

Appendices

Magento Community Edition 2.0 User Guide 975

Contents Release Notes

Change Log

Glossary

Configuration Reference

976 Magento Community Edition 2.0 User Guide

APPENDIX A:

Release Notes

Release notes provide a detailed description of each product release, with links to

additional technical information, installation instructions, and support resources.

Magento 2.x has a quarterly product release cycle, which is represented by the first decimal

position in the version number. In addition, there might be interim patch releases to

resolve security issues, and make necessary updates to the software. Patch releases are

represented by the second decimal position in the version number. This user guide reflects

the most current version of the product, which appears in the upper-right corner of each

page.

We sometimes refer to the current quarterly release, which at this time is 2.0, or to a

specific patch release, such as 2.0.2. The designation 2.x is a general reference that

includes any future or past version of the product.

As a best practice, we recommend that you keep your Magento 2.x installation up to date,

so you can benefit from the latest features and advancements in digital commerce.You can

find the release notes for the current and previous versions of [[[Undefined variable

MyVariables.Product Name 2.x]]] online.

lMagento Enterprise Edition 2.0.4 Release Notes

lMagento Enterprise Edition 2.0.3 Release Notes

lMagento Enterprise Edition 2.0.2 Release Notes

lMagento Enterprise Edition 2.0.1 Release Notes

lMagento Enterprise Edition 2.0 Release Notes

Magento Community Edition 2.0 User Guide 977

Notes

978 Magento Community Edition 2.0 User Guide

APPENDIX B:

Change Log

Our documentation is continually updated with new topics, clarifications, and corrections

to existing content. The Change Log in the online user guide lists the major updates,

organized by month. If you can’t see the most recent changes, refresh your browser or clear

the cache. Check back every now and then to see what’s new!

Change Log

Magento Community Edition 2.0 User Guide 979

Notes

980 Magento Community Edition 2.0 User Guide

APPENDIX C:

Glossary

above the fold

The web page content that is immediately visible in the browser window; section of a page

that is displayed without the need to scroll.

Admin

The password-protected back office of your store where orders, catalog, content, and

configurations are managed.

alt text

The text that is displayed in place of an image when the user is unable to view the image.

anchor text

The visible text that is anchored to another page or page section; the literal text of a

hyperlink.

API

Application Program Interface: A software interface that lets third-party applications read

and write to a system using programming language constructs or statements.

aspect ratio

The proportional relationship between the width and height of an image.

attribute

A characteristic or property of a product; anything that describes a product. Examples of

product attributes include color, size, weight, and price.

authorization

To give a service permission to perform certain actions or to access resources.

average inventory cost

Product price, less coupons or discounts, plus freight and applicable taxes. The average is

determined by adding the beginning cost of inventory each month, plus the ending cost of

inventory for the last month of the period.

Magento Community Edition 2.0 User Guide 981

B2B

Business to Business: A type of business transaction between two business entities that are not

the final consumers of the goods or services.

B2C

Business to Consumer: Business transactions between a business entity and a consumer.

banner

Promotional graphics displayed either horizontally on the top of a web page or vertically on the

left or right margins. Website advertisements are often displayed as banners.

base currency

The primary form of currency used in store transactions.

base currency rate

The base currency rate is the default for your store.

batch processing

To perform a task or make a change to multiple items all at once, without manual repetition.

bounce rate

The percentage of visitors to your site that leave without viewing any other pages.

brand

A unique identity that defines a particular product or group of products.

breadcrumb

A navigation aid that helps the user to keep track of their location within your store.

brick and mortar

A retail business with a permanent physical location, as opposed to being entirely virtual.

broken link

A hyperlink that fails to send the user to its intended web page.

callout

A term that is sometimes used to describe a block that is defined as a layout update using XML

code.

canonical URL

The canonical meta tag redirects search engines to the correct URL, when seemingly duplicate

content is encountered on the server.

982 Magento Community Edition 2.0 User Guide

APPENDIX C: Glossary

capture

The process of converting the authorized amount into a billable transaction. Transactions cannot

be captured until authorized, and authorizations cannot be captured until the goods or services

have been shipped.

cardholder

A person who opens a credit card account and is authorized to make purchases.

cascading style sheet

The markup standard used to apply styles to HTML elements on the page.

Categories

Custom Design 273

Display Settings 271

General Information 268

Magento Community Edition 2.0 User Guide

Navigation menu

Versions of this User Manual:

Views

Navigation