Magento Community Edition 2.1 User Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 1186

Download
Open PDF In Browser	View PDF

Magento
Community Edition

User Guide

Version 2.1

Contents
GETTING STARTED

CHAPTER 1: Welcome

Resources

Join the Conversation!

CHAPTER 2: About This Release
System Requirements

Installation

Prelaunch Checklist

Your Login Credentials

For Your Records

CHAPTER 3: Your Magento Account

Creating a Magento Account

Sharing Your Account

CHAPTER 4: Quick Tour

The Path to Purchase

Home Page

Catalog Page

Search Results

Product Page

Shopping Cart

Customer Journey

Attract New Customers

Engage Your Customers

Moment of Purchase

Contents

Increase Average Order Value

Customer Retention

Loyalty & Advocacy

Success!

Basic Configuration

CHAPTER 5: Store Admin

Admin Sign In

Your Admin Account

Admin Sidebar

Admin Workspace

Dashboard

Message Inbox

Global Search

Grid Controls

Grid Layout

Actions Control

CHAPTER 6: Store Details

Store Information

Locale Options

State Options

Country Options

Merchant Location

Currency

Store Email Addresses

CHAPTER 7: Storefront Branding

Uploading Your Logo

Adding a Favicon

Changing the Welcome Message

101

102

Magento Community Edition 2.1 User Guide

iii

Contents

Store Demo Notice
CHAPTER 8: Websites, Stores & Views
Scope

107
108

Changing Scope

109

Product Scope

112

Price Scope

114

Customer Account Scope

116

Scope Quick Reference

117

Single Store Mode
CHAPTER 9: Industry Compliance

119
121

PCI Compliance Guidelines

122

123

Cookie Law Compliance

125

Cookie Restriction Mode

126

Cookie Reference

128

PRODUCTS

131

CHAPTER 10: Products Menu

133

CHAPTER 11: Product Catalog

135

Catalog Workspace

136

Catalog URLs

139

Dynamic Media URLs
Using a Flat Catalog
CHAPTER 12: Creating Products
Product Workspace
Default Field Values

104

142
144
149
150
153

Product Types

155

Simple Product

157

Configurable Product

162

Magento Community Edition 2.1 User Guide

Contents

Part 1: Creating a Configurable Product

163

Part 2: Adding Configurations

166

Grouped Product

175

Virtual Product

182

Bundle Product

187

Customizing the Bundle
Downloadable Product
Configuring Download Options

188
198
207

CHAPTER 13: Product Settings

209

Advanced Product Settings

210

Other Product Settings

211

Content

213

Configurations

214

Product Reviews

215

Images and Video

216

Search Engine Optimization

217

Related Products, Up-Sells, and Cross-Sells

219

Other PayPal Solutions

791

PayPal Payments Advanced

793

Requirements

793

Checkout Workflow

794

Checkout Workflow
Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Advanced

794
794
794
795

PayPal Payments Pro

796

Requirements

796

Checkout Workflow

796

Checkout Workflow
Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Pro

796
797
797
798

PayPal Payments Standard

799

Merchant Requirements

799

Checkout Workflow

799

Checkout Workflow

Magento Community Edition 2.1 User Guide

799

Contents

Setting Up PayPal Payments Standard
PayPal Payflow Pro

801

Requirements

801

Customer Workflow

801

Customer Workflow
Online Order Processing Workflow

801
802

Online Order Processing Workflow

802

Setting Up PayPal Payflow Pro

802

PayPal Payflow Link

803

Requirements

803

Customer Workflow

803

Customer Workflow
Order Workflow
Order Workflow
Setting Up PayPal Payflow Link

803
804
804
805

PayPal Quick Reference

806

PayPal Business Account

807

PayPal Fraud Management Filter

808

PayPal by Country

809

CHAPTER 56: Basic Payment Methods

811

Check / Money Order

812

Cash On Delivery

814

Bank Transfer

816

Purchase Order

818

Zero Subtotal Checkout

820

CHAPTER 57: Other Payment Methods
Authorize.Net Direct Post

Shipping
CHAPTER 58: Shipping Settings
Point of Origin
xvi

800

823
824

825
827
828
Magento Community Edition 2.1 User Guide

Contents

Multiple Addresses

829

Shipping Policy

830

CHAPTER 59: Basic Shipping Methods

831

Free Shipping

832

Flat Rate Shipping

834

Table Rates

836

Dimensional Weight

843

CHAPTER 60: Carriers

845

CHAPTER 61: Shipping Labels

847

Shipping Label Workflow

848

Configuring Shipping Labels

849

Creating Shipping Labels

853

Label Packages

REPORTS
CHAPTER 62: Reports Menu
Refresh Statistics

860

865
867
869

CHAPTER 63: Marketing Reports

871

CHAPTER 64: Review Reports

873

CHAPTER 65: Sales Reports

875

CHAPTER 66: Customer Reports

879

CHAPTER 67: Product Reports

881

CHAPTER 68: New Relic Reporting

883

New Relic Queries

OPERATIONS
CHAPTER 69: Stores Menu

Magento Community Edition 2.1 User Guide

885

893
895

xvii

Contents

CHAPTER 70: All Stores

897

Adding Store Views

898

Editing a Store View

900

Adding a Language

902

Translating Products

904

Translating Content

906

Adding Stores

907

Adding Websites

911

Store URLs

913

Use Secure Protocol

913

Using a Custom Admin URL

919

CHAPTER 71: Configuration

921

CHAPTER 72: Taxes

923

Tax Rules

924

Tax Classes

928

Configuring Tax Classes

929

Default Tax Destination

930

EU Place of Supply for Digital Goods

931

Fixed Product Tax
Configuring FPT

933

Price Display Settings

938

Tax Zones and Rates

941

Import/Export Tax Rates

943

Value Added Tax (VAT)

946

Configuring VAT

946

VAT Validation

949

Configuring VAT ID Validation
Tax Quick Reference

xviii

932

951
956

Tax Calculation Methods

956

Catalog Prices With or Without Tax

957

Shipping Prices With or Without Tax

957

Magento Community Edition 2.1 User Guide

Contents

Tax Amounts as Line Items

957

International Tax Guidelines

958

U.S. Tax Guidelines

960

Canadian Tax Guidelines

962

EU Tax Guidelines

967

Warning Messages

973

Calculation Settings

973

Discount Settings

974

CHAPTER 73: Currency

975

Currency Configuration

976

Currency Symbols

980

Updating Currency Rates

981

CHAPTER 74: Attributes
Product Attributes

983
984

Creating Product Attributes

989

Attribute Sets

994

System

997

CHAPTER 75: System Menu

999

CHAPTER 76: Data Transfer

1003

Working with CSV Files

1004

Product CSV Structure

1004

Customer CSV Structure

1006

Data Validation

1007

Import

1009

Import History

1014

Importing Product Images

1015

Import Guidelines

1017

Export
Export Criteria

Magento Community Edition 2.1 User Guide

1019
1021

xix

Contents

Export Filters

1022

Exclude Attributes

1022

Product Attribute Reference
Complex Data

1034

Advanced Pricing

1036

Customer Attribute Reference

1038

CHAPTER 77: Integrations

1041

Magento Marketplace

1046

Magento Connect

1047

CHAPTER 78: Permissions

1049

Adding Users

1050

Locked Users

1053

User Roles

1054

Alternate Media Storage

1057

Using a Database

1058

Database Workflow

1058

Using a Content Delivery Network

1060

CDN Workflow

1060

CHAPTER 79: Security
Security Best Practices

1023

1063
1064

Start Right

1064

Protect the Environment

1065

Protect Magento

1067

Don’t be Taken for a Ride

1067

Be Prepared!

1068

Monitor for Signs of Attack

1068

Follow Your Disaster Recovery Plan

1069

Configuring Admin Security

1071

CAPTCHA

1074

Admin CAPTCHA

1075

Customer CAPTCHA

1078
Magento Community Edition 2.1 User Guide

Contents

Encryption Key

1080

Session Validation

1081

Browser Capabilities Detection

1083

Action Log

1084

CHAPTER 80: Tools

1085

Cache Management

1086

Full-Page Cache

1090

Index Management
Index Trigger Events

1092
1094

Backups

1097

Cron (Scheduled Tasks)

1099

Advanced Developer Tools

1101

Frontend Development Workflow

1102

Using Static File Signatures

1103

Optimizing Resource Files

1104

Developer Client Restrictions

1106

Template Path Hints

1107

Translate Inline

1109

Web Setup Wizard

1113

Component Manager

1114

Web Setup

1119

APPENDICES

1125

APPENDIX A: Release Notes

1127

APPENDIX B: Change Log

1129

APPENDIX C: Glossary

1131

APPENDIX D: Configuration Reference

1141

INDEX
Magento Community Edition 2.1 User Guide

1143
xxi

Contents

About This Guide
This guide answers the “why, where, and how” questions that most merchants have when
learning to use Magento. You’ll find lots of step-by-step instructions, screenshots and
examples, plus a comprehensive online configuration reference that is linked throughout
the material. After learning the basics, you can use this guide as a springboard to more
advanced topics and resources.

Online User Guide
The online (HTML) guide is the primary user
documentation for the current release of Magento
Community Edition 2.1. The content is continually
updated to provide you with the best possible assistance.
To learn about recent additions or changes to existing
topics, see the Change Log at the end of the guide.

PDF User Guide
You’ll find the same great information in the PDF user
guide, based on the date last updated. Simply click the
link to open the PDF in your browser. You can also rightclick the download link to save the file to your computer.
See the Documentation Archive for previous versions of
the user guide. Updated: 11 May, 2017

xxii

Magento Community Edition 2.1 User Guide

GETTING STARTED

Contents
This section of the guide provides an overview
of the resources that are available to you as a
member of the Magento community. You’ll learn
about the current release, and how to log into
your Magento account. Finally, you’ll take a
guided tour of Magento from two different
perspectives, with links you can explore to learn
more about each topic.

Welcome
About This Guide
Resources
Join the Conversation!
About This Release
System Requirements
Installation
Prelaunch Checklist
Your Login Credentials
For Your Records
Your Magento Account
Creating a Magento Account
Sharing Your Account
Quick Tour
Path to Purchase
Home Page
Catalog Page
Search Results
Product Page
Shopping Cart
Customer Journey
Attract New Customers
Engage Your Customers
Moment of Purchase
Increase Average Order Value
Customer Retention
Loyalty & Advocacy
Success!
Basic Configuration

CHAPTER 1:

Welcome
Welcome to the next generation of the world’s leading digital commerce platform! Built on
open-source technology, Magento Community Edition 2.1 provides online merchants with
unparalleled flexibility and control over the look, content, and functionality of their online
stores. Magento’s intuitive Admin features powerful marketing, search engine optimization,
and product management tools that give you the power to create sites that are tailored to your
unique business needs. Robust and scalable, Magento offers you a stable, secure, and
customizable solution for your growing business.

Home Page

Magento Community Edition 2.1 User Guide

CHAPTER 1: Welcome

About This Guide
This guide answers the “why, where, and how” questions that most merchants have when
learning to use Magento. You’ll find lots of step-by-step instructions, screenshots and
examples, plus a comprehensive online configuration reference that is linked throughout the
material. After learning the basics, you can use this guide as a springboard to more advanced
topics and resources.

Magento Community Edition 2.1 User Guide

CHAPTER 1: Welcome

Resources

Resources
Magento provides a wealth of business and technical resources, self-help tools, and services to
help you succeed.

Product Documentation
Whether you’re a merchant, designer, developer, or all of
the above, this is where you’ll gain a deeper insight into
how you can leverage the power of Magento to grow your
business.

Magento Resources Library
Gain access to expert insight and online business
resources to help develop and improve your store.
Ebooks, Magento whitepapers, and webinars.

Security Center
Join Magento’s Security Alert Registry to get the latest
information on potential vulnerabilities and Security Best
Practices.

Forums
The Magento forums provide access to a network of
dedicated Magento enthusiasts who share tips, tricks
and support.

Magento Community Edition 2.1 User Guide

Resources

CHAPTER 1: Welcome

Blog
Check out the Magento blog for the latest information
about new features, trends, best practices, upcoming
events, and more!

Webinars
Don't worry if you miss a live webinar! You can find the
archived version here.

Video Archive
Catch up and review archived sessions from Imagine
2016!.

Events
Keep tabs on our calendar of upcoming events. There's
always something happening in the Magento ecosystem!

Magento Community Edition 2.1 User Guide

CHAPTER 1: Welcome

Resources

Magento Marketplace
Visit Magento’s next-generation marketplace of digital
commerce solutions. Magento Marketplace offers
merchants a curated selection of solutions, while
providing qualified developers the tools, platform, and
prime location for a thriving business.

Training & Certification
Learn how to unleash the power and flexibility of
Magento. We provide training for every role in your
business, including marketers, designers, developers,
and more. Experienced Magento professionals can
validate their real-world skills by earning Magento
certification.

Partners
Magento partners are committed to your success, and
provide custom integrations, best-in-class customer
experiences, strategic marketing initiatives, and expert
performance and scalability optimization for both onpremise and cloud-based solutions.

Expert Consulting Services
Our Expert Consulting Group (ECG) helps Magento
merchants and Solution Partners maximize their
success. Our experts offer comprehensive analysis and
best practice recommendations, from architecture
planning through post-deployment.

Magento Community Edition 2.1 User Guide

Join the Conversation!

CHAPTER 1: Welcome

Join the Conversation!
Keep up with the latest news from the ecosystem, and connect with other merchants and
developers on social media networks.

Magento Forums
This is the place to find solutions, become acquainted
with international communities, and join a special interest
chat! Share your knowledge and earn kudos from others!

Facebook
Find out what’s happening and join the discussion on our
Facebook page!

Twitter
Follow us on Twitter!

LinkedIn
Join a Magento group on LinkedIn.

Magento Community Edition 2.1 User Guide

CHAPTER 1: Welcome

Join the Conversation!

Google+
Add us to your circle on Google+.

YouTube
Learn while you watch videos
on our YouTube channel!

Meetup
Find a Magento Meetup near you!

Magento Community Edition 2.1 User Guide

CHAPTER 2:

About This Release
As a best practice, we recommend that you keep your Magento installation up to date, so you
can benefit from the latest advancements. Release notes provide a detailed description of the
changes in each product release, with links to additional technical information, installation
instructions, and support resources. To learn more about current and past releases, see Release
Information.

Magento Community Edition

Magento Community Edition 2.1 User Guide

System Requirements

CHAPTER 2: About This Release

System Requirements
For the most up-to-date information, see System Requirements in the developer
documentation.

SYSTEM REQUIREMENTS
ENVIRONMENT
Operating System

Linux x86-64

Composer

Composer is required for developers who want to contribute to code
base,or develop extensions.

Web Server

Apache 2.2 or 2.4

The apache mod_rewrite module must be
enabled. To learn more, see: Apache.

Nginx 1.8.x

(or latest mainline version)

PHP

7.0.4

Magento 2.1.2 and later only.

7.0.2 ,
7.0.6 to 7.1.0

Magento 2.1.x (all versions)

5.6.5 and later

Magento 2.1.2

5.6.x

Magento 2.1.0 and 2.1.1

Not Supported:
PHP 7.1, 5.4

Not Supported

PHP 7.0.5

Known issue that affects code
compiler.

Required PHP Extensions:
bc-math (Enterprise Edition only)
curl
gd, ImageMagick 6.3.7 (or later) or both
intl
mbstring
mcrypt
mhash
openssl
PDO_MySQL
SimpleXML
soap

Magento Community Edition 2.1 User Guide

CHAPTER 2: About This Release

System Requirements

SYSTEM REQUIREMENTS
xml
xsl
zip
Optional, but recommended
opcache

This extension is bundled in many PHP
distributions. To verify, see: CentOS or
Ubuntu.

php_xdebug2.2.0
or later

Recommended for development
environments only.

Additional configuration:
safe_mode off
memory_limit minimum 512 MB

Database

MySQL 5.7or 5.6.x
Compatible with MariaDB and Percona
Magento Enterprise Edition 2.x can use three master databases to
provide scalability for the different functional areas of checkout,
orders, and product data.

SSL

A valid security certificate is required for HTTPS.
Self-signed certificates are not supported.
Transport Layer Security (TLS) Requirements:
TSL 1.1 or later

Mail Server

PayPal and repo.magento.com require TSL
1.1 or later.

Mail Transfer Agent (MTA) or SMTP server

Supported Applications
NAME

DESCRIPTION

Reverse Proxy / Web
Accelerator

Varnish 3.5

Cache Storage

Redis 3.x

Varnish 4.x (or latest stable version.)

Memcache 1.4.x
Session Storage

Magento Community Edition 2.1 User Guide

memcached latest stable version for session storage with either
memcache or memcached PHP extensions (latest stable version)

System Requirements

CHAPTER 2: About This Release

Supported Applications (cont.)
NAME
Search

DESCRIPTION
Elasticsearch

Versions 1.7 and 2.x (recommended)
2.x supported from Linux repository.
2.0 branch supported from PHP repository.

Apache Solr
Messaging

(Enterprise Edition only)

RabbitMQ (Enterprise Edition only)

Supported Browsers
BROWSER

VERSION

Latest, latest -1*
Latest, latest -1
Latest, latest -1
Version 11 or later

Any
Any
Mac OS
Windows

Version 9 or later

Windows

iPad 2
iPad Mini
iPad with Retina Display

OS 7 or later

iPhone 4 or later
Latest, latest -1

IOS 7 or later
Android 4 or later

STOREFRONT/ADMIN
Firefox
Chrome
Safari
Microsoft Edge
STOREFRONT ONLY
Internet Explorer
DESKTOP STOREFRONT
Safari Mobile

MOBILE STOREFRONT
Safari Mobile
Chrome for Mobile

The version before the most current.

Magento Community Edition 2.1 User Guide

CHAPTER 2: About This Release

Installation

Installation
To install Magento 2 on your server, see the Installation Guide in our technical documentation.
For an overview of the second part of the installation process, see Web Setup Wizard in the
System Operations section of this guide.

Installation Guide

Magento Community Edition 2.1 User Guide

Installation

CHAPTER 2: About This Release

Prelaunch Checklist
After you complete the design, development, and testing of your store, check the following
configuration settings to make sure everything is correct before the store “goes live.” For a
comprehensive description of every configuration setting, see the Configuration Reference.

General Settings
Store URLs
Verify that the store URLs for the storefront and Admin are correct for a live production
environment.
Security Certificate
Before launching your store, install a 100% Signed and Trusted Security Certificate for
the domain specified in the Base URL.
Store Email Addresses
Complete all the email addresses that are used to send and receive email notifications,
such as new orders, invoices, shipments, credit memos, product price alerts,
newsletters, and so on. Make sure that each field contains a valid business email
address.

Marketing Settings
Email Templates
Update the default email templates to reflect your brand. Make sure to update the
configuration if you create new templates.
Sales Communications
Make sure that your invoices and packing slips include the correct business information
and reflect your brand.
Google Tools
Magento is integrated with Google API to allow your business to use Google Analytics
and Google AdWords.

Magento Community Edition 2.1 User Guide

CHAPTER 2: About This Release

Installation

Sales & Marketing Settings
Cart Options
Take a look at the cart configuration settings, to see if there’s anything that you want to
change. This is where you can set the minimum order amount and lifetime of the prices in
the cart.
Checkout Options
Take a look at the checkout options, to see if there’s anything that you want to change.
This is where you can set up terms and conditions, and configure guest checkout.
Taxes
Make sure that taxes are properly configured according to your business tax rules and
local requirements.
Shipping Methods
Enable all carriers and shipping methods to be used by the company.
PayPal
If you plan to offer your customers the convenience of paying with PayPal, open a PayPal
Merchant Account, and set up a payment method. Run some test transactions in
Sandbox Mode before the store goes live.
Payment Methods
Enable the payment methods that you plan to use, and make sure that they are properly
configured. Check the order status settings, accepted currency, allowed countries, and
so on.

System Settings
Cron (Scheduled Tasks)
Cron jobs are used to process email, catalog price rules, newsletters, customer alerts,
Google sitemaps, update currency rates, and so on, Make sure that Cron jobs are set to
run at the appropriate time interval, in minutes.

Magento Community Edition 2.1 User Guide

Installation

CHAPTER 2: About This Release

Your Login Credentials
Before you go any further, make sure that you have the information that you need to access the
Admin of your store, and your Magento account.
Storefront URL
The address for your storefront is usually the domain that is assigned to your IP
address. Some stores are installed the root, or topmost directory. Others are
installed in a directory below the root. Your store might be located in a subdomain
that is associated with your primary domain. Your store URL might look like one of
the following:
http://mydomain.com
http://www.mydomain.com/mystore
http://www.mydomain.com/mystore
http://xxx.xxx.xxx.xxx

If you don’t yet have a domain, your store URL will include a series of four numbers,
each separated by a period in “dotted quad” notation.
Admin URL
The address for your store Admin was set up during the installation. The default
address is the same as your store, but with /admin at the end. Although the
examples in this guide use the default directory, we recommend that run your
Admin from a location that is unique to your store.
http://mydomain.com/admin
http://www.mydomain.com/admin

Magento Account
Your Magento account provides access to information about your products and
services, account settings, billing history, and support resources. to access your
account, visit the Magento site and click the My Account link in the header.
Customer Account
While you’re learning your way around the store, make sure to set up a test
customer account, so you can experience the store and checkout process from the
customer’s perspective.

Magento Community Edition 2.1 User Guide

CHAPTER 2: About This Release

Installation

For Your Records
As a best practice, keep a record of the details of your installation, your login credentials, and
the email address that is associated with each account. You can print this page, write down
your credentials, and keep it in a safe, convenient place.

Store and Admin
Store URL:
Admin URL:
Admin User Name:
Admin Password:
Admin Email Address:

Magento Account
User Name:
Password:
Email Address:

Test Customer Account
User Name:
Password:
Email Address:

Installation Information
Installation Date:
Magento Version:
Encryption Key:
Database Name:
Database User Name:
Database Password:

Magento Community Edition 2.1 User Guide

CHAPTER 3:

Your Magento Account
Your Magento account has a separate login from your store, and can be accessed from either the
Magento website or from your store’s Admin. From the dashboard of your Magento account,
you can find information that is related to the products and services that you have purchased,
as well as your contact and billing information.

Your Magento Account

Magento Community Edition 2.1 User Guide

Creating a Magento Account

CHAPTER 3: Your Magento Account

Creating a Magento Account
Anyone can open a free Magento account from our website. The email address that is used to
open a Magento account can be associated with only one account, and the screen name that
you enter becomes your identity in the Magento forums.

To create a Magento account:
1.

Visit the Magento site at: http://www.magento.com

In the upper-right corner, choose My Account. Then under New Customers, tap Register.

Under Personal Information, do the following:
a.

Enter your First Name, Last Name, and Email Address.

Set My Company Primarily to the best description of what your company does. Then, set
My Role to the best description of what you do for the company.

Under Login Information, do the following:
a.

Enter a Screen Name to identify you in the Magento Community Forums.
Your screen name can be from four to fifteen characters long, can include numbers and the
underscore, but must start with a letter.

Enter a Password for your account. Then, enter it again to confirm.
Your password can be from eight to sixteen characters long, and must include at least one
capital letter, one number, and one special character or one lowercase letter.

When complete, tap Submit . Your account dashboard appears.

Magento Community Edition 2.1 User Guide

CHAPTER 3: Your Magento Account

Creating a Magento Account

Create an Account

To log in to your Magento account:
1.

Go to the Magento site: http://www.magento.com

In the upper-right corner, click My Account.

Enter the Email address that is associated with your account. Then, enter your Password.

When complete, tap Login .

To receive a new password:
1.

If you forget your password, click Forgot Your Password?

Enter the Email Address that is associated with your account, and tap Submit .
You will receive an email from Magento with a temporary password that you can use to log
into your account. Then, reset your password from the dashboard of your account.

Magento Community Edition 2.1 User Guide

Creating a Magento Account

CHAPTER 3: Your Magento Account

To reset your password:
1.

In the panel on the left, choose Account Settings. Then, tap Change Password

Enter your Current Password.
If you forgot your password, enter the temporary password that was sent to you.

Enter your New Password. Then, enter it again to confirm.
Your Magento password must be between 8-16 characters, and include at least one capital letter,
one number, and one special character or lowercase letter.

When complete, tap Save .

Change Password

Magento Account Password Requirements
FIELD
Password

DESCRIPTION
Your Magento password must be between 8-16 characters, and
include at least one capital letter, one number, and one special
character or lowercase letter.

Magento Community Edition 2.1 User Guide

CHAPTER 3: Your Magento Account

Sharing Your Account

Sharing Your Account
Your Magento account contains information that can be useful to trusted employees and service
providers who help to manage your site. As the primary account holder, you have authority to
grant limited access to your account to other Magento account holders. When your account is
shared, all sensitive information—such as your billing history or credit card information—
remains protected. It is not shared at any time with other users.
All actions taken by users with shared access to your account are your sole responsibility. Magento
Inc. is not responsible for any actions taken by users to whom you grant shared account access.

Shared Access

To set up a shared account:
1.

Before you begin, get the following information from the new user’s Magento account:
l

Account ID

Email address

In the panel on the left, under Shared Access, choose Add New User. Then, do the following:

Enter the Acct ID of the new user’s Magento account.

Enter the Email address that is associated with the new user’s Magento account.

In the Shared Information section, do the following:

Magento Community Edition 2.1 User Guide

Sharing Your Account

CHAPTER 3: Your Magento Account

Enter a Sharename to identify your shared account. Because the Sharename becomes an
option in the Switch Accounts list, it should be something that the other person will
recognize as your account.

To share your personal contact information, mark the checkbox of each item that you want
to make available to the other person:
l

Your Email

Your Phone

In the Grant Account Permissions section, mark the checkbox of each Magento product and
service that you want to share.

When complete, tap Create Shared Access .
You are notified when the new role is saved, and the new user record appears in the Manage
Permissions section of the Shared Access page. Magento also sends an email invitation with
instructions for accessing the shared account to the new user.

Manage Permissions

Magento Community Edition 2.1 User Guide

CHAPTER 3: Your Magento Account

Sharing Your Account

To access a shared account:
1.

When you receive the invitation to a shared account, log in to your own Magento account.
Your account dashboard has a new Switch Accounts control in the upper-right corner, with
options for “My Account” and the name of the shared account.

To gain access to the shared account, set Switch Accounts to the name of the shared account.
The shared account displays a welcome message and contact information. The left panel
includes only the items that you have permission to use.

Switch Accounts
3.

When you are ready to return to your own account, set Switch Accounts to “My Account.”

Magento Community Edition 2.1 User Guide

CHAPTER 4:

Quick Tour
In this quick tour, we’ll take a look at each page that customers usually visit while shopping in
your store. The path that customers follow that leads to a sale is sometimes called the “path to
purchase.” Then, we’ll take a look at the major landmarks along the journey, and how Magento
Community 2.1 can be used to attract and engage customers, increase the average order, and to
build loyalty and advocacy.

Customer Journey

Magento Community Edition 2.1 User Guide

The Path to Purchase

CHAPTER 4: Quick Tour

The Path to Purchase
The path customers follow that leads to a sale is sometimes called the “path to purchase.” In
this quick tour, we’ll take a look at pages of strategic value that customers usually visit while
shopping in your store. Then, we’ll consider different store features that can be leveraged at
each stage of the customer journey.

Home Page
Your home page is like the front window display of your
store. As the primary landing page, its design entices
visitors to come inside for a closer look.

Catalog Page
This page shows products from your catalog in either a
list or grid format. The selection can be based on a
category chosen from the main menu, a choice made in
the layered navigation on the left, or the results of a
search. Any item can be examined in more detail, or
placed directly into the shopping cart.

Magento Community Edition 2.1 User Guide

CHAPTER 4: Quick Tour

The Path to Purchase

Product Page
The product page provides detailed information about a
specific item in your catalog. Shoppers can read reviews,
add the product to their wish lists, compare it to other
products, share the link with friends, and most
importantly, place the item into their shopping carts.

Shopping Cart
The shopping cart lists each item by price and quantity
selected, and calculates the subtotal. Shoppers can
apply discount coupons, and generate an estimate of
shipping and tax charges.

Magento Community Edition 2.1 User Guide

The Path to Purchase

CHAPTER 4: Quick Tour

Home Page
Did you know that most people spend only a few seconds on a page before they decide to stay
or go somewhere else? That’s not long to make an impression! Studies show that people also
love photographs, especially of other people. Whatever design you choose, everything on your
home page should move visitors along toward the next step in the sales process. The idea is to
guide their attention in a cohesive flow from one point of interest to the next.
Callouts

Main Menu

Your Account

Feature a Brand

Offer a Promotion

Offer a Discount

Hear from an Expert

Appeal to a Lifestyle

Shop by Fabric

Recently Viewed/Compared Products

334

Set Show for Current to the website, store, or store view where the configuration applies.

In the Default Recently Viewed Products Count field, enter the number of recently viewed
products to appear in the list.

In the Default Recently Compared Products Count, enter the number of recently
compared products to appear in the list.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 20: Shopping Tools

Product Reviews

Product Reviews
Product reviews help to build a sense of community, and are considered more credible than any
advertising money can buy. In fact, some search engines give sites with product reviews a
higher ranking than those without. For those who find your site by searching for a specific
product, a product review is essentially the landing page of your store. Product reviews help
people find your store, keep them engaged, and often lead to sales.
The configuration determines whether customers must open an account with your store before
writing product reviews, or if they can submit reviews as guests. Requiring reviewers to open an
account prevents anonymous submissions, and improves the quality of reviews.

Add Your Review
Customers can write reviews for any product in your catalog. Reviews can be written from the
product page by clicking the “Add Your Review” link. For products that haven't been reviewed,
the link says, “Be the first to review this product.” The Reviews tab lists all current reviews, and
the form that is used to submit a review.
The number of stars indicates the satisfaction rating. Visitors can click the link to read the
reviews and write their own. As an incentive, customers can receive reward points for
submitting a review. When a review is submitted, it is sent to the Admin for moderation. When
approved, the review is published in your store.

Magento Community Edition 2.1 User Guide

335

Product Reviews

CHAPTER 20: Shopping Tools

Reviews Tab

To configure product reviews:
1.

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

In the panel on the left, under Catalog, select Catalog.

Expand

Set Allow Guests to Write Reviews according to your preference.

When complete, tap Save Config.

the Product Reviews section.

To moderate reviews:
1.

On the Admin sidebar, tap Marketing. Then under User Content, choose Reviews.

In the list, click a pending review to view the details, and edit if necessary.

To approve a pending review, change the Status from “Pending” to “Approved.” To reject a
review, select “Not Approved.”

336

When complete, tap Save Review.

Magento Community Edition 2.1 User Guide

CHAPTER 20: Shopping Tools

Product Reviews

Product Ratings
When customers review a product, the default ratings are quality, price, and value. In addition
to these, you can add your own custom ratings. The five-star ratings that appear on catalog
pages are averaged for each product.

Ratings

To create your own ratings:
1.

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

In the upper-right corner, tap Add New Rating .

Ratings

Magento Community Edition 2.1 User Guide

337

Product Reviews

CHAPTER 20: Shopping Tools

In the Rating Title section, enter the Default Value for the new rating. If applicable, enter the
translation for each store view.

Rating Title
4.

In the Rating Visibility section, set Visibility In to the store view where the rating is to be used.
(Hold down the Ctrl key to select multiple options.)
Ratings are not visible unless assigned to a store view.

In the Sort Order field, enter a number to determine the order of this rating when listed with
others.

Rating Visibility
6.

338

When complete, tap Save Rating .

Magento Community Edition 2.1 User Guide

Promotions

339

Contents
In this section of the guide, you will learn how to
set up product relationships, and use price rules
to trigger discounts based on a variety of
conditions. You can use price rules to offer
customer incentives, such as to:
l

340

Send your best customers a coupon for a
discount on a specific product
Offer free shipping for purchases over a
certain amount
Schedule a promotion for a period of time

Catalog Price Rules
Multiple SKUs
Cart Price Rules
Coupon Codes
Coupon Report
Free Shipping Promotion
Buy X Get Y Free
Discount with Minimum Purchase

CHAPTER 21:

Catalog Price Rules
Catalog price rules can be used to selectively offer products at a discounted price, based on a
set of conditions. Catalog price rules do not use coupon codes, because they are triggered before
a product is placed into the shopping cart.

Catalog Rules

Magento Community Edition 2.1 User Guide

341

Creating a Price Rule

CHAPTER 21: Catalog Price Rules

Creating a Price Rule
Process Overview:
Step 1: Add a New Rule
Step 2: Define the Conditions
Step 3: Define the Actions
Step 4: Test the Rule

Step 1: Add a New Rule
1.

On the Admin sidebar, tap Marketing. Then under Promotions, choose Catalog Price Rule.

In the upper-right corner, tap Add New Rule.
The form opens to the Rule Information section, with expandable sections below for Conditions
and Actions.

Rule Information
3.

342

In the Rule Information section, do the following:

Magento Community Edition 2.1 User Guide

CHAPTER 21: Catalog Price Rules

Creating a Price Rule

Complete the Rule Name and Description fields. These fields are for your internal

reference only.
b.

Select the Websites where the rule is to be available.

Set the Status of the price rule as needed. By default, the status is "Active."

Select the Customer Groups to which this rule applies.
To choose multiple groups, hold down the Ctrl key, and click each option.

Enter the From and To dates to determine when the price rule is in effect. You can either
enter the dates, or choose the dates from the Calendar ( ).
l

If you leave the dates blank, the rule is enabled as soon as the price rule is saved.

Enter a number to establish the Priority of this rule in relation to other rules.

Step 2: Define the Conditions
Most of the available conditions are based upon existing attribute values. To apply the rule to
all products, leave the conditions blank.
1.

Scroll down to Conditions, and expand

the section. The first rule begins:

Condition - Line 1
The statement has two bold links, which when tapped, display the options for that part of the
statement. If you save the condition without making additional selections, the rule applies to
all products.
l

Tap the ALL link, and chose either “ALL” or “ANY.”

Tap the TRUE link, and choose either “TRUE” or “FALSE.”

To apply the rule to all products, leave the condition unchanged.

You can create different conditions by changing the combination of these values. For this
example, the following condition is used:
If ALL of these conditions are TRUE:

Tap the Add (

) button at the beginning of the next line.

Magento Community Edition 2.1 User Guide

343

Creating a Price Rule

CHAPTER 21: Catalog Price Rules

In the list under Product Attribute, choose the attribute that you want to use as the basis
of the condition. For this example, the condition is "Attribute Set.”

Condition Line 2, Part 1
For an attribute to appear in the list, it must be configured to be used in promo rule conditions.
To learn more, see: Product Attributes.

The selected condition appears in the statement, followed by two more bold links. The
statement now says:
If ALL of these conditions are TRUE:
Attribute Set is …

Tap the is link, and choose the comparison operator that describes the condition to be
met. In this example, the options are “is” and “is not.”

Tap the (...) “more” link, and choose the attribute set upon which the condition is based.

Condition Line 2, Part 3
The selected item appears in the statement to complete the condition.
If ALL of these conditions are TRUE:
Attribute Set is Default

To add another line to the statement, tap the Add (

) button, and choose one of the

following:
l

Conditions Combination

Product Attribute

Then, repeat the process until the condition is complete.

344

Magento Community Edition 2.1 User Guide

CHAPTER 21: Catalog Price Rules

Creating a Price Rule

If at any time you want to delete part of the statement, tap the Delete (
of the line.

) button at the end

Step 3: Define the Actions
1.

Expand

the Actions section, and do the following:

Actions
2.

Under Pricing Structure Rules, set Apply to one of the following:
Apply as
percentage of
original

Discounts item by subtracting a percentage from the original price. For
example:

Apply as fixed
amount

Discounts item by subtracting a fixed amount from original price. For
example:

Enter 10 in Discount Amount for an updated price that is 10% less
than the original price.

Enter 10 in Discount Amount for an updated price that is $10 less than
the original price.
Adjust final price
to this percentage

Discounts item by defining the final price based on percentage. For
example:
Enter 10 in Discount Amount for an updated price that is 10% of the
original price.

Adjust final price
to discount value

Sets the price to a fixed amount.

Magento Community Edition 2.1 User Guide

345

Creating a Price Rule

CHAPTER 21: Catalog Price Rules

Enter the Discount Amount.

To stop processing other rules after this rule is applied, set Discard Subsequent Rules to
“Yes.” This safeguard prevents customers from receiving multiple discounts for the same
product.

Tap Save and Continue Edit.

Pricing Structure Rules

Step 4: Test the Rule
When you create a new price rule, it might take an hour or so to become available. Make sure
to allow enough time for it to get into the system. Then, test the rule to make sure that it
works correctly. Unless otherwise specified, price rules are automatically processed with other
system rules each night.As new rules are added, Magento recalculates the prices and the
priorities accordingly.

Field Descriptions
FIELD

DESCRIPTION

RULE INFORMATION

346

Rule Name

(Required) The name of the rule is for internal reference.

Description

A description of the rule should include the purpose of the rule, and
explain how it is used.

Websites

(Required) Identifies the websites where the rule can be used.

Customer Groups

(Required) Identifies the customer groups to which the rule applies.

From

Specifies the first day the price rule is in effect. If left blank, the price
rule goes into effect as soon as it is saved.

Magento Community Edition 2.1 User Guide

CHAPTER 21: Catalog Price Rules

Creating a Price Rule

Field Descriptions (cont.)
FIELD

DESCRIPTION

Specifies the last day the price rule is in effect. If left blank, the price
rule continues indefinitely.

Priority

A number that indicates the priority of this rule in relation to others.
The highest priority is number 1.

ACTIONS
Apply

Discount Amount

Determines the type of calculation that is applied to the purchase.
Options:
Apply as
percentage of
original

Applies the discount amount as a percentage
of the original price.

Apply as fixed
amount

Applies the discount amount as a fixed
amount less than the original price.

Adjust final price to
this percentage

Adjusts the final price by a percentage based
on the discount amount.

Adjust final price to
discount value

Uses the discount amount as the product
price.

(Required) The amount of discount that is offered.

Discard Subsequent Rules Determines if additional rules can be applied to this purchase. To
prevent multiple discounts from being applied to the same purchase,
select “Yes.” Options: Yes / No

Magento Community Edition 2.1 User Guide

347

Price Rule with Multiple SKUs

CHAPTER 21: Catalog Price Rules

Price Rule with Multiple SKUs
A single price rule can be applied to multiple SKUs, which makes it possible to create a variety
of promotions based on a product, brand, or category.

Step 1: Verify Storefront Properties of Attribute
Before you begin, make sure that the Storefront Properties of the SKU attribute are set to "Use
in Promo Rules."
1.

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

In the search filter at the top of the Attribute Column, enter "sku." Then, tap Search.

Click to open the attribute in edit mode.

In the panel on the left, choose Storefront Properties. Then, make sure that Use for Promo
Rule Conditions is set to "Yes,"

If you changed the value of the property, tap Save Attribute.

Step 2: Apply a Price Rule to Multiple SKUs
1.

On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.

Do one of the following:

Follow the instructions to create a cart price rule.

Open an existing cart price rule.

Expand
a.

the Conditions section, and do the following:

In the first line, set the first parameter to “ANY.”

If ANY of these conditions are TRUE
b.

Tap Add ( ) at the beginning of the next line. Then, in the list under Product Attribute,
choose SKU.

SKU is …

348

Magento Community Edition 2.1 User Guide

CHAPTER 21: Catalog Price Rules

Price Rule with Multiple SKUs

To complete the condition, click the (…) “more” link. Then, tap the Chooser button for the
list of available products.

Choose Each SKU
d.

In the list, mark the checkbox of each product that is to be included. Then, tap Save and
Apply to add the SKUs to the condition.

Multiple SKUs Added to Condition
4.

Complete the rule, including any Actions to be taken when the conditions are met.

When complete, tap Save.
When you create a new price rule, it might take an hour or so to become available. Make sure
to allow enough time for it to get into the system. Then, test the rule to make sure that it
works correctly. Unless otherwise specified, price rules are automatically processed with other
system rules each night.

Magento Community Edition 2.1 User Guide

349

350

Magento Community Edition 2.1 User Guide

CHAPTER 22:

Cart Price Rules
Cart price rules apply discounts to items in the shopping cart, based on a set of conditions. The
discount can be applied automatically as soon as the conditions are met, or when the customer
enters a valid coupon code. When applied, the discount appears in the cart under the subtotal.
A cart price rule can be used as needed for a season or promotion by changing its status and
date range.

Apply Coupon in Cart

Magento Community Edition 2.1 User Guide

351

Creating a Cart Price Rule

CHAPTER 22: Cart Price Rules

Creating a Cart Price Rule
Complete the following steps to add a new rule, describe the conditions, and define the actions.
Then, complete the labels, and test the rule.
Process Overview:
Step 1: Add a New Rule
Step 2: Describe the Conditions
Step 3: Define the Actions
Step 4: Complete the Labels
Step 6: Save and Test the Rule

Step 1: Add a New Rule
1.

On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.

Cart Price Rules
2.

352

Under Rule Information, complete the Rule Name and Description.

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Creating a Cart Price Rule

General Information
3.

If you do not want the rule to go into effect immediately, set Active to “No.”

To establish the scope of the rule, do the following:
a.

Select the Websites where the promotion is to be available.

Select the Customer Groups to which the promotion applies.
l

For the promotion to be available only to registered customers, do not select the
“NOT LOGGED IN” option.

To associate a coupon with the price rule, set Coupon to “Specific Coupon.” Then, do the
following:
a.

Enter a numeric Coupon Code that the customer must enter to receive the discount.

To set a limit on the number of times the coupon can be used, complete the following:

Magento Community Edition 2.1 User Guide

353

Creating a Cart Price Rule

CHAPTER 22: Cart Price Rules

Uses per Coupon

Determines how many times the coupon code can be used.
If there is no limit, leave the field blank.

Uses per Customer

Determines how many times the coupon code can be used
by the same registered customer who belongs to any of the
selected customer groups. The setting does not apply to
guest shoppers who are members of the NOT LOGGED IN
customer group, or to customers who shop without logging
in to their accounts. If there is no limit, leave the field
blank.

Coupon Settings
6.

Use the Calendar (

) to set the From and To date range for the promotion.

Enter a number to determine the Priority of this price rule in relation to the Action settings of
other price rules that might be active at the same time. (Number 1 has the highest priority.)

354

To apply the rule to published listings in RSS feeds, set Public In RSS Feed to “Yes.”

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Creating a Cart Price Rule

Step 2: Describe the Conditions
In this step, the conditions are described that must be met for an order to qualify for the
promotion. The rule goes into action whenever the set of conditions is met.

Conditions
1.

In the panel on the left, select Conditions. The first rule appears by default, and states:
If ALL of these conditions are TRUE:

The statement has two bold links which when tapped, display the selection of options for that
part of the statement. You can create different conditions by changing the combination of these
values. Do any of the following:

Click the ALL link, and select “ALL” or “ANY.”

Click the TRUE link and select “TRUE” or “FALSE.”

Leave the condition unchanged to apply the rule to all products.

Click Add (

) at the beginning of the next line. For this example, complete the next part of

the condition as follows:
a.

When prompted to Choose the condition to add, choose "Products Subselection."

Products Subselection
b.

When the next part of the condition appears, mouse over the line so you can see where
each link with variable values is located.

Magento Community Edition 2.1 User Guide

355

Creating a Cart Price Rule

CHAPTER 22: Cart Price Rules

If ALL of thes conditions are TRUE
c.

Click the "more" (...) link, and enter ">100." This condition requires the total quantity of
the cart to be greater than 100.

Total Quantity Value
3.

Click Add (

) at the beginning of the next line. Then add a condition that is based on

Category.

Category
a.

In the next part of the condition, click the "more" (...) link to display the input field.
Then, open the Chooser (

) to display the category tree.

Mark the checkbox of the category that you want to use as a condition for the price rule.
The condition can be based on any category that is a child of the store’s root category.

356

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Creating a Cart Price Rule

Choosing a Category for a Condition
4.

To add more conditions, click Add (

) and define another condition.

You can repeat the process as many times as needed to describe the conditions that must be
met for the price rule . Here are some examples:

Example 1: Regional Price Rule
To create a regional price rule, use one of the following cart attributes:
l

Shipping Postcode

Shipping Region

Shipping State/Province

Shipping Country

Example 2: Shopping Cart Totals
To base the condition on shopping cart totals, use one of the following cart attributes:
l

Subtotal

Total Items Quantity

Total Weight

Step 3: Define the Actions
The shopping cart price rule actions describe how prices are updated when the conditions are
met.

Magento Community Edition 2.1 User Guide

357

Creating a Cart Price Rule

CHAPTER 22: Cart Price Rules

Scroll down to Actions, and expand

the section. Then, do the following:

Cart Price Rule Actions
a.

358

Set Apply to one of the following discount options:
Percent of product price
discount

Discounts item by subtracting a percentage from the
original price. The discount applies to each qualifying item
in the cart. For example: Enter 10 in Discount Amount for
an updated price that is 10% less than the original price.

Fixed amount discount

Discounts item by subtracting a fixed amount from original
price. The discount applies to each qualifying item in the
cart. For example: Enter 10 in Discount Amount for an
updated price that is $10 less than the original price.

Fixed amount discount
for whole cart

Discounts the entire cart by subtracting a percentage from
the cart total. For example: Enter 10 in Discount Amount to
subtract 10% from the cart total.

Buy X get Y free

Defines a quantity that the customer must purchase to
receive a quantity for free. (The Discount Amount is Y.)

Enter the Discount Amount as a number, without symbols. For example, depending on
the discount option selected, the number 10 might indicate a percentage, a fixed amount,
or a quantity of items.

For a "Buy X get Y Free" discount, enter the quantity in the Discount Qty Step (Buy X)
field that the customer must purchase to receive the discount.

In the Maximum Qty Discount is Applied To field, enter the maximum quantity of the
same product that can qualify for the discount in the same purchase.

Set Apply to Shipping Amount

as follows:

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Creating a Cart Price Rule

Yes

Applies the discount amount to the subtotal and shopping
amounts separately.

Applies the discount amount only to the subtotal.

To stop processing other rules after this rule is applied, set Discard Subsequent Rules
to “Yes.” This safeguard prevents customers from receiving multiple discounts for the
same product.

To extend free shipping for orders that meet the conditions, set Free Shipping to one of
the following:
No

Free shipping is not available.

For matching items only

Free shipping is available only for items that match the
conditions of the rule.

For shipment with
matching items

Free shipping is available for any shipment that includes
matching item(s).

Define as many additional conditions as needed for the action.

When complete, tap Save and Contnue Edit.

Step 4: Complete the Labels
The label appears on the order below the subtotal to identify the discount. You can enter a
default label for all store views, or enter a different label for each view.
the section.

Scroll down to Labels, and expand

Enter the text that you want used as the Default Rule Label for All Store Views.

Default Label
3.

If your store has multiple views, or multiple websites with multiple views, enter the
appropriate label text for each. For example, if each store view is in a different language, enter
the translation of the label for each view.

Magento Community Edition 2.1 User Guide

359

Creating a Cart Price Rule

CHAPTER 22: Cart Price Rules

Step 5: Save and Test the Rule
1.

When complete, tap Save Rule.

Test the rule to make sure that it works correctly.
When you create a new price rule, it might take an hour or so to become available. Make sure
to allow enough time for it to get into the system. Then, test the rule to make sure that it
works correctly. Unless otherwise specified, price rules are automatically processed with other
system rules each night.As new rules are added, Magento recalculates the prices and the
priorities accordingly.

Cart Price Rule Saved

Field Descriptions
FIELD

DESCRIPTION

RULE INFORMATION

360

Rule Name

(Required) The name of the rule is for internal reference.

Description

A description of the rule should include the purpose of the rule, and
explain how it is used.

Status

(Required) Determines if the rule is currently active in the store.
Options: Active / Inactive

Websites

(Required) Identifies the websites where the rule can be used.

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Creating a Cart Price Rule

Field Descriptions (cont.)
FIELD

DESCRIPTION

Customer Groups

(Required) Identifies the customer groups to which the rule applies.

Coupon

(Required) Indicates if a coupon is associated with the rule. Options:
No Coupon

No coupon is associated with the rule.

Specific Coupon

A specific coupon is associated with the rule.

Auto

Coupon Code

When prompted, enter
the Coupon Code that
the customer must enter
to take advantage of the
promotion.

Use Auto
Generation

Select the checkbox to
automatically generate
multiple coupon codes
that can be used with the
promotion.

Displays the Coupons Information section to
define the format of the coupon codes to be
generated.

Uses per Coupon

The number of times the coupon code can be used.

Uses per Customer

Determines how many times the coupon code can be used by the
same registered customer who belongs to any selected customer
group. Does not apply to guest shoppers who are members of the
NOT LOGGED IN customer group, or to customers who shop
without logging in to their accounts. For no limit, leave blank.

From

The first date the coupon can be used.

The last date the coupon can be used.

Priority

A number that indicates the priority of this rule in relation to others.
The highest priority is number 1.

Public in RSS Feed

Determines if the promotion is included in your store’s public RSS
feed. Options: Yes / No.

ACTIONS
Apply

Magento Community Edition 2.1 User Guide

Determines the type of calculation that is applied to the purchase.
Options:

361

Creating a Cart Price Rule

CHAPTER 22: Cart Price Rules

Field Descriptions (cont.)
FIELD

DESCRIPTION
Percent of product
price discount

Discounts item by subtracting a percentage
from the original price.
For example: Enter 10 in Discount Amount
for an updated price that is 10% less than the
original price.

Fixed amount
discount

Discounts item by subtracting a fixed
amount from original price.
For example: Enter 10 in Discount Amount
for an updated price that is $10 less than the
original price.

362

Fixed amount
discount for whole
cart

Discounts the entire cart by subtracting a
fixed amount from the cart total.

Buy X Get Y Free
(discount amount is
Y)

Defines a quantity that the customer must
purchase to receive a quantity for free. (The
Discount Amount is Y.)

For example: Enter 10 in Discount Amount to
subtract $10 from the cart total.

Discount Amount

(Required) The amount of discount that is offered.

Maximum Qty Discount is
Applied To

Sets the maximum number of products that the discount can be
applied to in the same purchase.

Discount Qty Step (Buy X)

Sets the number of products represented by “X” in a “Buy X Get Y
Free” promotion.

Apply to Shipping Amount

Determines if the discount can be applied to the cost of shipping.
Options: Yes / No.

Discard Subsequent
Rules

Determines if additional rules can be applied to this purchase. To
prevent multiple discounts from being applied to the same purchase,
select “Yes.” Options: Yes / No

Free Shipping

Determines if free shipping is included in the promotion, and if so, for
which items. Options:
No

Free shipping is not available when a coupon
that is based on the rule is used.

For matching items
only

Free shipping is available only for specific
items in the cart that match the rule.

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Creating a Cart Price Rule

Field Descriptions (cont.)
FIELD

DESCRIPTION
For shipment with
matching items

Free shipping is available for the entire cart
when a coupon that is based on the rule is
used.

LABELS
Default Rule Label for All
Store Views

A default label that identifies the discount and can be used for all
store views.

Store View Specific Labels If applicable, a different label that identifies the discount for each
store view.

Magento Community Edition 2.1 User Guide

363

Coupon Codes

CHAPTER 22: Cart Price Rules

Coupon Codes
Coupons codes are used with cart price rules to apply a discount when a set of conditions is
met. For example, a coupon code can be created for a specific customer group, or for anyone
who makes a purchase over a certain amount. To apply the coupon to a purchase, the customer
can enter the coupon code in the cart, or possibly at the cash register of your “brick and mortar”
store. Here are a few ways that you can use coupons in your store:
l

Email coupons to customers

Produce printed coupons

Create in-store coupons for mobile users

Coupon codes can be sent by email, or included in newsletters, catalogs, and advertisements.
The list of coupon codes can be exported and sent to a commercial printer. You can also create
in-store coupons with a quick response code that shoppers can scan with their smart phones.
The QR code can link to a page on your site with more information about the promotion.

Method 1: Create a Specific Coupon
1.

Follow the instructions to create a cart price rule.

On the General Information page, set Coupon to “Specific Coupon.”
a.

Enter a Coupon Code to be used with the promotion.
The format of the code as numeric, alphanumeric or alphabetical is determined by the
configuration.

To limit the number of times the coupon can be used, complete the following:
l

Uses per Coupon

Uses per Customer

For unlimited use, leave these fields blank.

Coupon Information
c.

364

To make the coupon valid for a limited period of time, complete the From and To dates.
To select the date, tap the Calendar ( ) button next to each field. If you leave the date
range empty, the rule will never expire.

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Coupon Codes

Complete the cart price rule as needed.

Method 2: Generate a Batch of Coupons
1.

Follow the instructions to create a cart price rule.

Under Coupon Code, mark the Use Auto Generation checkbox.

To limit the number of times each customer can use the coupon, enter the number of Uses per
Customer.

Generate Auto-numbered Coupons
4.

Scroll down and expand

the Manage Coupon Codes section. Then, do the following:

In the Coupons Qty field, enter the number of coupons that you want to generate.

Enter the Code Length, not including the prefix, suffix, or separators.

Set the Code Format to one of the following:
l

Alphanumeric

Alphabetical

Numeric

(Optional) Enter a Code Prefix to be added to the beginning of the code.

(Optional) Enter a Code Suffix to be added to the end of the code.

(Optional) In the Dash Every X Characters field, enter the number of characters.between
each dash. For example, if the code is twelve characters long, and there is a dash every
four characters, it will look like this: xxxx-xxxx-xxxx. Dashes make codes easier to read
and enter.

When complete, tap Generate. The list of generated codes appears below.

Generated Codes

Magento Community Edition 2.1 User Guide

365

Coupon Codes

CHAPTER 22: Cart Price Rules

Configuring Coupon Codes
The length and format of automatically generated coupon codes is controlled by the
configuration. The characters can be set to all numbers, all letters, or a combination. You can
insert a dash at set intervals to make it easy to read, and add a .prefix and suffix to associate
the code iith a specific campaign or initiative.

Auto Generated Specific Coupon Codes

To format coupon codes:
1.

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

In the panel on the left under Customers, choose Promotions.

In the Auto Generated Specific Coupon Codes section, do the following:

366

Enter the Code Length, including prefix, sufix, and separators.

Set the Code Format to one of the following:
l

Alphanumeric

Alphabetical

Numeric

To add a Code Prefix, enter the value that you want to appear at the beginning of all
coupon codes.

To add a Code Suffix, enter the value that you want to appear at the end of all coupon
codes.

To insert a Dash Every X Characters, enter the number of characters between each dash.
Coupon codes with different dash patterns are considered to be different codes, even if the
numbers are the same.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Coupon Codes

Coupons Report
The Coupons Report can be filtered for a specific store view, time period, order status, and price
rule.

Coupon Report Filters

To run the report:
1.

On the Admin sidebar, tap Reports. Then under Sales choose Coupons.

If you have multiple store views, set Store View in the upper-left corner to establish the scope
of the report.

To refresh the sales statistics for the day, click the message at the top of the workspace.

To filter the data, do the following:
a.

Set Date Used to one of the following:
l

Order Created

Order Updated

The Order Updated report is created in real-time, and does not require a refresh.
b.

To define the period of time covered by the report, set Period to one of the following:
l

Day

Month

Year

Enter the From and To dates in M/D/YY format to define the date range of the report.

Magento Community Edition 2.1 User Guide

367

Free Shipping Promotion

To print a report for a specific order status, set Order Status to “Specified,” Then, choose
the order status from the list.

Set omit rows without data from the report, set Empty Rows to “No.”

Do one of the following:
l

CHAPTER 22: Cart Price Rules

To include all coupon activity from all price rules, set Cart Price Rule to “Any.”
To include only activity that is related to a specific price rule, set Cart Price Rule to
“Specified,” Then, select the specific cart price rule in the list.

When ready to run the report, tap Show Report. The report appears at the bottom of the page.

Free Shipping Promotion
Free shipping can be offered as a promotion, either with, or without a coupon. A free shipping
coupon, or voucher, can also be applied to customer pick-up orders, so the order can be
invoiced and “shipped” to complete the workflow.
Some shipping carrier configurations give you the ability of offer free shipping based on a
minimum order. To expand upon this basic capability, you can use shopping cart price rules to
create complex conditions based on multiple product attributes, cart contents, and customer
groups.
Process Overview:
Step 1: Enable Free Shipping
Step 2: Create a Cart Price Rule
Step 3: Complete the Labels
Step 4: Save and Test the Rule

Step 1: Enable Free Shipping
1.

Enable Free Shipping in your store’s configuration.

Complete the free shipping settings for any carrier service that you want to use for free
shipping.

368

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Free Shipping Promotion

Step 2: Create a Cart Price Rule
1.

On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.

Follow the steps below to set up the type of free shipping promotion that you want to offer.

Example 1: Free Shipping for Any Order
1.

Complete the Rule Information as follows:
a.

Enter a Rule Name for internal reference.

Enter a brief Description to describe the rule.

Set Active to “Yes.”

In the Websites box, select each site where the free shipping coupon is to be
available.

Select the Customer Groups to which the rule applies.

Set Coupon to one of the following:

To offer a free shipping promotion without a coupon, accept the default, “No Coupon”
setting.
To use a coupon with the price rule, select “Specific Coupon.” If necessary, complete the
instructions to set up a coupon.

Scroll down and expand

the Actions section. Then, do the following:

Set Apply to “Percent of product price discount.”

Set Apply to Shipping Amount to “Yes.”

Set Free Shipping to “For shipment with matching items.”

Price Rule Action

Magento Community Edition 2.1 User Guide

369

Free Shipping Promotion

CHAPTER 22: Cart Price Rules

Example 2: Free Shipping for Orders Over $Amount
1.

Complete the General Information settings as described in the previous example.

Scroll down and expand

Tap Add (

the Conditions section.

) to insert a condition. Then, do the following:

In the list under Cart Attribute, choose Subtotal.

Click the is link, and choose “equals or greater than.”

Click the (…) “more” link, and enter a threshold value for the Subtotal, such as 100,
to complete the condition.

Condition
4.

If necessary, expand

the Actions. section. Then do the following:

Set Apply to “Percent of product price discount.”

Set Apply to Shipping Amount to “Yes.”

Set Free Shipping to “For shipment with matching items.”

Actions

370

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Free Shipping Promotion

Step 3: Complete the Labels
Complete Step 4 of the cart price rule instructions to enter any labels that appear during
checkout.

Step 4: Save and Test the Rule
1.

When complete, tap Save Rule.

Magento Community Edition 2.1 User Guide

371

Buy X Get Y Free

CHAPTER 22: Cart Price Rules

Buy X Get Y Free
This example shows how to set up a cart price rule for a “Buy X, Get Y Free” promotion. The
format of the discount is as follows:
Buy X quantity of product, get Y quantity for free.

Process Overview:
Step 1: Create a Cart Price Rule
Step 2: Define the Conditions
Step 3: Define the Actions
Step 4: Complete the Label
Step 5: Save and Test the Rule

Step 1: Create a Cart Price Rule
Complete Step 1 of the cart price rule instructions to complete the rule information.

Step 2: Define the Conditions
Complete Step 2 of the cart instructions to define the conditions for the price rule. The
conditions can be triggered by purchasing a specific product, making a purchase of a certain
amount, or any other scenario.

Step 3: Define the Actions
1.

372

Expand

the Actions section, and do the following:

Set Apply to “Buy X get Y free (discount amount is Y).”

Set Discount Amount to 1. This is the quantity the customer will receive for free.

To limit the number of discounts that can be applied when the condition is met, enter the
number in the Maximum Qty Discount is Applied To field. For example, enter “1” to
discount only one item.

In the Discount Qty Step (Buy X) field, enter the quantity that the customer must
purchase to qualify for the discount. In this example, the customer must purchase two.

To prevent other discounts from being applied to the purchase, set Discard subsequent
rules to "Yes."

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Buy X Get Y Free

Buy X Get Y Free
2.

Tap Save and Continue Edit. Then, complete the rest of the rule as needed.

Step 4: Complete the Label
Complete Step 4 of the cart price rule instructions to enter the label that appears during
checkout.

Step 5: Save and Test the Rule
1.

When complete, tap Save Rule.

Magento Community Edition 2.1 User Guide

373

Discount with Minimum Purchase

CHAPTER 22: Cart Price Rules

Discount with Minimum Purchase
Cart price rules can be used to offer a percentage discount based on a minimum purchase. In
the following example, a 25% discount is applied to all purchases over $200.00 in a specific
category. The format of the discount is as follows:
X% off all Y (category) over $Z dollars

Process Overview:
Step 1: Create a Shopping Cart Rule
Step 2: Define the Conditions
Step 3: Define the Actions
Step 4: Apply the Labels
Step 5: Save and Test the Rule

Step 1: Create a Shopping Cart Rule
Follow the basic instructions to create a cart rule.

Step 2: Define the Conditions
1.

Scroll down and expand

Tap Add (

the Conditions section.

), and choose Product Attribute Combination.

Product Attribute Combination
3.

Tap Add (

) at the beginning of the next line. Then in the list under Product Attribute,

choose Category.

374

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Discount with Minimum Purchase

Category
a.

Click the (…) “more” link to display additional options.

Category IS
b.

Tap the Chooser ( ) button to see the available categories. In the category tree, mark the
checkbox of each category that you want to include. Then, press Enter to add the
categories to the condition.

Category IS
4.

Tap Add (
a.

) at the beginning of the next line, and do the following:

In the list under Cart Item Attribute, choose Price in cart.

Category IS
a.

Click the is link, and choose “equals or greater than.”

Click the (...) “more” link and enter the amount that the Price in Cart must be to meet the
condition. For example, enter 200.

Magento Community Edition 2.1 User Guide

375

Discount with Minimum Purchase

CHAPTER 22: Cart Price Rules

Enter the Price to Complete the Condition
5.

Tap Save and Continue Edit .

Step 3: Define the Actions
1.

Expand

the Actions section, and do the following:

Actions

376

Set Apply to “Percent of product price discount.”

Enter the Discount Amount. For example, enter 25 for a twenty-five percent discount.

To prevent additional promotions from being applied to the purchase, set Discard
subsequent rules to “Yes.”

Tap Save and Continue Edit . Then, complete the rule as needed.

Magento Community Edition 2.1 User Guide

CHAPTER 22: Cart Price Rules

Discount with Minimum Purchase

Step 4: Complete the Labels
Complete Step 4 of the cart price rule instructions to enter any labels that appear during
checkout.

Step 5: Save and Test the Rule
1.

When complete, tap Save Rule.

Magento Community Edition 2.1 User Guide

377

378

Magento Community Edition 2.1 User Guide

Communications

379

Contents
In this section of the guide, you will learn how to
customize email and newsletter templates, as
well as PDF invoices and packing slips. You will
also learn how to personalize the content with
variables and markup tags.

Email
Supported Email Clients
Preparing Your Email Logo
Configuring Email Templates
Sales Email
Payment Failed Email
Admin Email
Customizing Email Templates
Header Template
Footer Template
Message Templates
Email Template List
Configuring Email Communications
Sales Documents
Configuring Sales Emails
PDF Logo Requirements
Adding Reference IDs to Header
Newsletters
Configuring Newsletters
Newsletter Templates
Sending Newsletters
Managing Subscribers
RSS Feeds
Using Variables
Adding Predefined Variables
Creating Custom Variables
Markup Tags
Variable Reference

380

CHAPTER 23:

Email
Email templates define the layout, content, and formatting of automated messages sent from
your store. They are called transactional emails1 because each one is associated with a
specific type of transaction, or event.
Magento includes a set of responsive email templates that are triggered by a variety of events
that take place during the operation of your store. Each template is optimized for any screen
size, and can be viewed from the desktop, as well as on tablets and mobile devices. You will
find a variety of prepared email templates related to customer activities, sales, product alerts,
admin actions, and system messages that you can customize to reflect your brand.

1An automated email message that is sent in response to a specific event or transaction.

Magento Community Edition 2.1 User Guide

381

Supported Email Clients

CHAPTER 23: Email

Supported Email Clients
A wide range of technologies is supported by the various email clients and services available
today. Although there is some variation in the way email messages are rendered, we have found
the following services to be compatible with Magento Community Edition 2.1.

Desktop Clients
OPERATING SYSTEM

CLIENTS SUPPORTED

OS X 10.8

Apple Mail 6

OS X 10.7

Outlook 2011
Outlook 2013

Windows 8

Outlook 2010

Windows 7

Outlook 2007
Outlook 2003

Mobile Clients
OPERATING SYSTEM

CLIENTS SUPPORTED

Android 4.2, “Jelly Bean”

Native email app

Android 2.3, “Gingerbread”

Native email app

Gmail App (Android 4.2)

Native email app

Blackberry 5 OS

Native email app

IOS 8

iPhone 6
iPhone 6 Plus

IOS 7

iPad (Retina)
iPad Mini
iPhone 5s
Mail on these devices:

IOS 6

382

iPhone 5
iPhone 4s

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Supported Email Clients

Web Clients
EMAIL APPLICATION

BROWSERS SUPPORTED*

AOL Mail

Chrome
Internet Explorer
Firefox

Gmail

Chrome
Internet Explorer
Firefox

Yahoo! Mail

Chrome
Internet Explorer
Firefox

Outlook.com

Chrome
Internet Explorer
* The latest version of each browser was used for testing.

Magento Community Edition 2.1 User Guide

383

Preparing Your Email Logo

CHAPTER 23: Email

Preparing Your Email Logo
Logos can be saved as any of the following file types. Logos with transparent backgrounds can
be saved as either .GIF or .PNG files.
l

JPG/JPEG

GIF

PNG

To ensure that your logo renders well on high-resolution devices, the uploaded image should be
three times the size of the dimensions that are specified in the header template. Typically,
original logo artwork is created as a vector image, so it can be scaled up without losing
resolution. The image can then be saved in one of the supported bitmap image formats.

Logo Three Times Display Size
To take advantage of the limited vertical space in the header, make sure to crop the image to
eliminate any wasted space at the top or bottom. When editing the image, be careful to
preserve the aspect ratio1 of the logo, so the height and width resize proportionally.
As a general rule, you can make an image smaller than the original, but not larger without
losing resolution. Taking a small image and scaling it up in a photo editor lowers the
resolution of the image. For example, if the display dimensions of the logo are 168 pixels wide
by 48 pixels high in the header template, the uploaded image should be 504 pixels wide by 144
pixels high.

LOGO DIMENSIONS

1 X (DISPLAY SIZE)

3 X (IMAGE SIZE)

Width:

168 px

504 px

Height:

48 px

144 px

1The proportional relationship between the width and height of an image.

384

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Configuring Email Templates

Configuring Email Templates
The configuration determines the logo, as well as the header and footer templates that are used
for all transactional email messages that are sent from your store.

Transactional Emails

Process Overview:
Step 1: Upload Your Logo
Step 2: Select the Header and Footer Templates

Magento Community Edition 2.1 User Guide

385

Configuring Email Templates

CHAPTER 23: Email

Step 1: Upload Your Logo
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

Find the store view that you want to configure. Then in the Action column, click Edit.

Under Other Settings, expand
a.

the Transactional Emails section. Then, do the following:

To upload your prepared Logo Image, tap Upload. Find the file on your computer, and
select the file.

In the Logo Image Alt field, enter alternate text to identify the image.

Enter the Logo Width and Logo Height in pixels. Enter each value as a number, without
the “px” abbreviation. These values refer to the display dimensions of the logo in the
header, and not to the actual size of the image.

Step 2: Choose the Header and Footer Templates
If you have custom header and footer templates for your store, or for different stores, you can
specify which templates are used for each, according to the scope of the configuration.

386

Choose the Header Template to be used for all transactional email messages.

Choose the Footer Template to be used for all transactional email messages.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Configuring Email Templates

Configuring Sales Email
A number of email messages are triggered by the events related to an order, and the
configuration is similar. You must identify the store contact that appears as the sender of the
message, the email template to be used, and anyone else who is to receive a copy of the
message. Sales emails can be sent when triggered by an event, or by predetermined interval.

Sales Emails

Step 1: Update the Email Templates
Make sure that you have updated each email template to reflect your brand. For a complete
list of templates, see: Email Template List.

Step 2: Choose the Type of Transmission
1.

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

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

Expand

the General Settings section. Then, set Asynchronous Sending to one of the

following:
Disable

Sends sales email when triggered by an event.

Enable

Sends sales email at predetermined, regular intervals.

Magento Community Edition 2.1 User Guide

387

Configuring Email Templates

CHAPTER 23: Email

General Settings

Step 3: Complete the Details for Each Sales Email Message
4.

Expand

the Order section. Then, do the following:

Order

388

Verify that Enabled is set to “Yes.”

Set New Order Confirmation Email to the store contact that appears as the sender of the
message.

Set New Order Confirmation Template to the template that is used for the email that is
sent to registered customers.

Set New Order Confirmation Template for Guest to the template that is used for the
email that is sent to guests who do not have an account with your store.

In the Send Order Email Copy To field, enter the email address of anyone who is to
receive a copy of the new order email. If sending a copy to multiple recipients, separate
each address with a comma.

Set Send Order Email Copy Method to one of the following:
Bcc

Sends a “blind courtesy copy” by including the recipient in the
header of the same email that is sent to the customer. The BCC
recipient is not visible to the customer.

Separate Email

Sends the copy as a separate email.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Configuring Email Templates

Expand

the Order Comments section, and repeat these steps.

Order Comments
6.

Complete the configuration for the remaining sales emails:
l

Invoice

Shipment

Credit Memo

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

389

Configuring Email Templates

CHAPTER 23: Email

Payment Failed Email
A notification is sent to the customer if the payment method that is chosen during checkout
fails to complete the transaction.

Payment Failed Emails

Step 1: Update the Email Templates
Make sure that you have updated each email template to reflect your brand. For a complete
list of templates, see: Email Template List.

Step 2: Configure the Payment Failed Emails
1.

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

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

Expand
a.

the Payment Failed Emails section. Then, do the following:

Set Payment Failed Email Sender to the store contact that appears as the sender of the
message.

390

Set Payment Failed Email Receiver to the store contact that is to receive notification of
failed email transmissions.

Set Payment Failed Template to the template that is used for the email that is sent when
the payment method fails during checkout.

In the Send Payment Failed Email Copy To field, enter the email address of anyone who
is to receive a copy of the payment failed notification. If sending a copy to multiple
recipients, separate each address with a comma.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Configuring Email Templates

Send Payment Failed Copy Method to one of the following:
Bcc

Sends a “blind courtesy copy” by including the recipient in the
header of the same email that is sent to the customer. The BCC
recipient is not visible to the customer.

Separate Email

Sends the copy as a separate email.

When complete, tap Save Config.

Configuring Admin User Email
The Admin email template configuration determines the email templates that are sent when
users forget and reset their passwords, the store contact that appears as the sender of the
message, and how long the password recovery link remains valid.

Admin User Emails

To configure the Admin email templates:
1.

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

In the panel on the left under Advanced, choose Admin.

Expand

the Admin User Emails section. Then, do the following:

Set Forgot Password Email Template to the template that is sent when Admin users
forget their passwords.

Set Forgot and Reset Email Sender to the store contact that appears as the sender of the
message.

Set User Notification Template to the email template that is used as the default for admin
notifications.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

391

Customizing Email Templates

CHAPTER 23: Email

Customizing Email Templates
Magento includes a default email template for the body section of each message that is sent by
the system. The template for the body content is combined with the header and footer
templates to create the complete message. The content is formatted with HTML and CSS, and
can be easily edited, and customized by adding variables and frontend apps. Email templates
can be customized for each website, store, or store view. Make sure to update the system
configuration after creating a customized template, so the custom template is used instead of
the default.
The default templates include your logo and store information, and can be used without further
customization. However as a best practice, you should view each template, and make any
necessary changes before they are sent to customers.

Preview of Welcome Template

392

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Customizing Email Templates

Header Template
The email header template includes your logo that is linked to your store. In addition, you can
easily insert variables to add store contact information to the header.

Email Templates

Process Overview:
Step 1: Load the Template
Step 2: Customize and Preview the Template
Step 3: Update the Configuration

Step 1: Load the Default Template
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Tap Add New Template. Then, do the following:

Magento Community Edition 2.1 User Guide

393

Customizing Email Templates

CHAPTER 23: Email

Under Load default template, in the Template list under Magento_Email, choose
“Header.”

Default Header Template
b.

Tap Load Template.
The HTML code and variables from the template appear in the form.

Step 2: Customize the Template
1.

Under Template Information, do the following:
a.

Enter the Template Name for your custom header.

Enter a Template Subject to help organize the templates. In the grid, the list of templates
can be sorted and filtered by the Subject column.

Header Template Information
c.

394

In the Template Content box, modify the HTML as needed.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Customizing Email Templates

When working in the template code, be careful not to overwrite anything that is enclosed in
double braces.

To insert a variable, position the cursor in the code where you want the variable to appear,
and tap Insert Variable. Then, choose the variable that you want to insert.
When a variable is selected, a markup tag for the variable is inserted in the code.

Insert Variable
Although the Store Contact variables are the ones most often included in the header, you
can enter the code for any system or custom variable directly into the template.
e.
2.

If you need to make any CSS declarations, enter the styles in the Template Styles box.

When you are ready to review your work, tap Preview Template. Then, make adjustments to the
template as needed.

When complete, tap Save Template.
Your custom header now appears in the list of available Email templates.

Step 3: Update the Configuration
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

In the grid, find the store view that you want to configure. Then in the Action column, click
Edit.

Scroll down and expand

Choose the Header Template that is used as the default for email notifications.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

the Transactional Emails section.

395

Customizing Email Templates

CHAPTER 23: Email

Transactional Emails

Field Descriptions
FIELD

DESCRIPTION

LOAD DEFAULT TEMPLATE
Template

Lists the selection of available templates, and identifies the template
to be customized.

TEMPLATE INFORMATION
Template Name
Insert Variable

396

The name of your custom template.
Inserts a Store Contact Information variable into the template at the
cursor location.

Template Subject

The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.

Template Content

The content of the template in HTML.

Template Styles

Any CSS style declarations that are needed to format the template
header can be entered in the Template Styles box.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Customizing Email Templates

Footer Template
The email template footer contains the closing and signature line of the email message. You can
change the closing to fit your style, and add additional information, such as the company
name and address below your name.

Email Templates

Process Overview:
Step 1: Load the Default Template
Step 2: Customize and Preview the Template
Step 3: Update the Configuration

Step 1: Load the Default Template
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Tap Add New Template. Then, do the following:
a.

Under Load default template, in the Template list under Magento_Email, choose “Footer.”

Tap Load Template.

Default Footer Template

Magento Community Edition 2.1 User Guide

397

Customizing Email Templates

CHAPTER 23: Email

Step 2: Customize and Preview the Template
1.

Enter the Template Name for your custom footer.

Enter a Template Subject to help organize the templates. In the grid, the templates can be
sorted and filtered by the Subject column.

Footer Template Information
3.

In the Template Content box, modify the HTML as needed.
When working in the template code, be careful not to overwrite anything that is enclosed in double
braces.

To insert a variable, position the cursor in the code where you want the variable to appear, and
tap Insert Variable. Then, choose the variable that you want to insert.
When a variable is selected, a markup tag for the variable is inserted in the code.

398

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Customizing Email Templates

Insert Variable
Although the Store Contact variables are the ones most often included in the footer, you can
enter the code for any system or custom variable directly into the template.
5.

If you need to make any CSS declarations, enter the styles in the Template Styles box.

Step 3: Update the Configuration
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

In the grid, find the store view that you want to configure. Then in the Action column, click
Edit.
the Transactional Emails section.

Scroll down and expand

Choose the Footer Template that is used as the default for email notifications.

When complete, tap Save Config.

Transactional Emails

Magento Community Edition 2.1 User Guide

399

Customizing Email Templates

CHAPTER 23: Email

Field Descriptions
FIELD

DESCRIPTION

LOAD DEFAULT TEMPLATE
Template

Lists the selection of available templates, and identifies the template
to be customized.

TEMPLATE INFORMATION
Template Name
Insert Variable

400

The name of your custom template.
Inserts a Store Contact Information variable into the template at the
cursor location.

Template Subject

The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.

Template Content

The content of the template in HTML.

Template Styles

Any CSS style declarations that are needed to format the template
footer can be entered in the Template Styles box.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Customizing Email Templates

Message Template
The process of customizing the body of each message is the same as the customizing the header
or footer. The only difference is that there is a different message template for each activity or
event that triggers a notification. You can use the templates as they are, or customize them to
match your voice and brand. In addition to the template text, there's a wide selection of
variables that can be incorporated into the template.

Process Overview:
Step 1: Load the Default Template
Step 2: Customize the Template
Step 4: Update the Configuration
Step 5: Preview and Save

Step 1: Load the Default Template
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Tap Add New Template. Then, do the following:
a.

Under Load default template, in the Template list, choose the template that you want to
customize.

Tap Load Template.

Default Message Template

Step 2: Customize the Template
1.

In the Template Name field, enter a name for your custom template.

By default, the Template Subject contains the first line of the message, which is the
salutation. You can leave it as is, or enter something more descriptive.

Take note of the Currently Used For path to the template configuration. You will later follow
this path to update the configuration.

Magento Community Edition 2.1 User Guide

401

Customizing Email Templates

CHAPTER 23: Email

Message Template Information
4.

In the Template Content box, modify the HTML as needed. The content consists of a
combination of HTML tags, CSS directives, variables, and text.
When working in the template code, be careful not to accidentally type over the code that is
enclosed in double braces.

Template Message Content
5.

To insert a variable, position the cursor in the code where you want the variable to appear, and
tap Insert Variable. Then, choose the variable that you want to insert.
When a variable is selected, a markup tag for the variable is inserted in the code.

Insert Variable
In addition to the Store Contact variables, the list includes the Customer Account URL,
Customer Email, and Customer Name. However, you are not limited to the variables in this
list. You can enter the code for any system or custom variable directly into the template.
6.

402

If you need to make any CSS declarations, enter the styles in the Template Styles box.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Customizing Email Templates

Step 3: Update the Configuration
1.

In the breadcrumb trail at the top of the Template Information section, find the following
information, as it relates to your template. In this example the template configuration is
located on the Customer Configuration page, in the Create New Account Options section, and
in the Default Welcome Email field.
Page

Customer Configuration

Section

Create New Account Options

Field

Default Welcome Email

Tap the link to open the template configuration page.

Expand

the section. Then, find the field for the email template that you customized, and

specify the new template as the default.

Welcome Email Configuration

Step 4: Preview and Save the Template
1.

When you are ready to review your work, tap Preview Template. Then, make adjustments to the
template as needed.

When complete, tap Save Template.
Your custom template is now available in the list of Email templates.

Magento Community Edition 2.1 User Guide

403

Customizing Email Templates

CHAPTER 23: Email

Field Descriptions
FIELD

DESCRIPTION

LOAD DEFAULT TEMPLATE
Template

Lists the selection of available templates, and identifies the template
to be customized.

TEMPLATE INFORMATION
Template Name
Insert Variable

404

The name of your custom template.
Inserts a variable into the template at the cursor location.

Template Subject

The Template Subject appears in the Subject column, and can be
used to sort and filter the templates in the list.

Template Content

The content of the template in HTML.

Template Styles

Any CSS style declarations that are needed to format the template
can be entered in the Template Styles box.

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Email Template List

Email Template List
The list of email templates is organized alphabetically by Magento module.

Email Templates
TEMPLATE

CONFIGURATION PATH

Magento_Checkout
Payment Failed

Page:

Sales > Checkout

Section:

Payment Failed Emails

Field:

Payment Failed Template

Page:

General > Contacts

Section:

Email Options

Field:

Email Template

Magento_Contact
Contact Form

Magento_Customer
Change Email

n/a

Change Email and
Password

n/a

Forgot Password

Page:

Customers > Customer Configuration

Section:

Password Options

Field:

Forgot Email Template

Page:

Customers > Customer Configuration

Section:

Create New Account Options

Field:

Default Welcome Email

Page:

Customers > Customer Configuration

Section:

Create New Account Options

Field:

Default Welcome Email

New Account

New Account
(Magento/luma)

Magento Community Edition 2.1 User Guide

405

Email Template List

CHAPTER 23: Email

Email Templates (cont.)
TEMPLATE
New Account
Confirmation Key

New Account Confirmed

New Account Without
Password

Remind Password

Reset Password

CONFIGURATION PATH
Page:

Customers > Customer Configuration

Section:

Create New Account Options

Field:

Confirmation Link Email

Page:

Customers > Customer Configuration

Section:

Create New Account Options

Field:

Welcome Email

Page:

Customers > Customer Configuration

Section:

Create New Account Options

Field:

Default Welcome Email Without Password

Page:

Customers > Customer Configuration

Section:

Password Options

Field:

Remind Email Template

Page:

Customers > Customer Configuration

Section:

Password Options

Field:

Reset Password Template

Page:

General > Currency Setup

Section:

Scheduled Import Settings

Field:

Error Email Template

Magento_Directory
Currency Update
Warnings

Magento_Email

406

Footer

n/a

Footer (Magento/luma)

n/a

Header

n/a

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Email Template List

Email Templates (cont.)
TEMPLATE

CONFIGURATION PATH

Magento_Newsletter
Subscription Confirmation

Subscription Success

Unsubscription Success

Page:

Customers > Newsletter

Section:

Subscription Options

Field:

Confirmation Email Template

Page:

Customers > Newsletter

Section:

Subscription Options

Field:

Success Email Template

Page:

Customers > Newsletter

Section:

Subscription Options

Field:

Unsubscription Email Template

Page:

Catalog > Catalog

Section:

Product Alerts Run Settings

Field:

Error Email Template

Page:

Catalog > Catalog

Section:

Product Alerts

Field:

Price Alert Email Template

Page:

Catalog > Catalog

Section:

Product Alerts

Field:

Stock Alert Email Template

Page:

Sales > Sales Emails

Section:

Credit Memo Contents

Field:

Credit Memo Comment Email Template

Magento_ProductAlert
Cron Error Warning

Price Alert

Stock Alert

Magento_Sales
Credit Memo Update

Magento Community Edition 2.1 User Guide

407

Email Template List

CHAPTER 23: Email

Email Templates (cont.)
TEMPLATE
Credit Memo Update
(Magento/luma)

Credit Memo Update for
Guest

Credit Memo Update for
Guest (Magento/luma)

Invoice Update

Invoice Update
(Magento/luma)

Invoice Update for Guest

New Credit Memo

408

CONFIGURATION PATH
Page:

Sales > Sales Emails

Section:

Credit Memo Comments

Field:

Credit Memo Comment Email Template

Page:

Sales > Sales Emails

Section:

Credit Memo Comments

Field:

Credit Memo Comment Email Template for
Guest

Page:

Sales > Sales Emails

Section:

Credit Memo Comments

Field:

Credit Memo Comment Email Template for
Guest

Page:

Sales > Sales Emails

Section:

Invoice Comments

Field:

Invoice Comment Email Template

Page:

Sales > Sales Emails

Section:

Invoice Comments

Field:

Invoice Comment Email Template

Page:

Sales > Sales Emails

Section:

Invoice Comments

Field:

Invoice Comment Email Template for Guest

Page:

Sales > Sales Emails

Section:

Credit Memo

Field:

Credit Memo Email Template

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Email Template List

Email Templates (cont.)
TEMPLATE
New Credit Memo
(Magento/luma)

New Credit Memo for
Guest

New Credit Memo for
Guest (Magento/luma)

New Invoice

New Invoice
(Magento/luma)

New Invoice for Guest

New Invoice for Guest
(Magento/luma)

Magento Community Edition 2.1 User Guide

CONFIGURATION PATH
Page:

Sales > Sales Emails

Section:

Credit Memo

Field:

Credit Memo Email Template

Page:

Sales > Sales Emails

Section:

Credit Memo

Field:

Credit Memo Email Template for Guest

Page:

Sales > Sales Emails

Section:

Credit Memo

Field:

Credit Memo Email Template for Guest

Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template (Default Config)
Page:

Sales > Sales Emails

Section:

Invoice

Field:

Invoice Email Template

Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template (Default Config)
Page:

Sales > Sales Emails

Section:

Invoice

Field:

Invoice Email Template

Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template for Guest (Default Config)
Page:

Sales > Sales Emails

Section:

Invoice

Field:

Invoice Email Template for Guest

Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template for Guest (Default Config)

409

Email Template List

CHAPTER 23: Email

Email Templates (cont.)
TEMPLATE

New Order

New Order
(Magento/luma)

New Order for Guest

New Order for Guest
(Magento/luma)

New Shipment

New Shipment
(Magento/luma)

New Shipment for Guest

410

CONFIGURATION PATH
Page:

Sales > Sales Emails

Section:

Invoice

Field:

Invoice Email Template for Guest

Page:

Sales > Sales Emails

Section:

Order

Field:

New Order Confirmation Template

Page:

Sales > Sales Emails

Section:

Order

Field:

New Order Confirmation Template

Page:

Sales > Sales Emails

Section:

Order

Field:

New Order Confirmation Template for Guest

Page:

Sales > Sales Emails

Section:

Order

Field:

New Order Confirmation Template for Guest

Page:

Sales > Sales Emails

Section:

Shipment

Field:

Shipment Email Template

Page:

Sales > Sales Emails

Section:

Shipment

Field:

Shipment Email Template

Page:

Sales > Sales Emails

Section:

Shipment

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Email Template List

Email Templates (cont.)
TEMPLATE

New Shipment for Guest
(Magento/luma)

Order Update

Order Update
(Magento/luma)

Order Update for Guest

Order Update for Guest
(Magento/luma)

Shipment Update

Shipment Update
(Magento/luma)

Magento Community Edition 2.1 User Guide

CONFIGURATION PATH
Field:

Shipment Email Template for Guest

Page:

Sales > Sales Emails

Section:

Shipment

Field:

Shipment Email Template for Guest

Page:

Sales > Sales Emails

Section:

Order Comments

Field:

Order Comment Email Template

Page:

Sales > Sales Emails

Section:

Order Comments

Field:

Order Comment Email Template

Page:

Sales > Sales Emails

Section:

Order Comments

Field:

Order Comment Email Template for Guest

Page:

Sales > Sales Emails

Section:

Order Comments

Field:

Order Comment Email Template for Guest

Page:

Sales > Sales Emails

Section:

Shipment Comments

Field:

Shipment Comment Email Template

Page:

Sales > Sales Emails

Section:

Shipment Comments

Field:

Shipment Comment Email Template

411

Email Template List

CHAPTER 23: Email

Email Templates (cont.)
TEMPLATE
Shipment Update for
Guest

Shipment Update for
Guest (Magento/luma)

CONFIGURATION PATH
Page:

Sales > Sales Emails

Section:

Shipment Comments

Field:

Shipment Comment Email Template for
Guest

Page:

Sales > Sales Emails

Section:

Shipment Comments

Field:

Shipment Comment Email Template for
Guest

Page:

Catalog > Email to a Friend

Section:

Email Templates

Field:

Select Email Template

Page:

Catalog > XML Sitemap

Section:

Generation Settings

Field:

Error Email Template

Page:

Advanced > Admin

Section:

Admin User Emails

Field:

Forgot Password Email Template

Magento_SendFriend
Send Product Link to
Friend

Magento_Sitemap
Sitemap Generation
Settings

Magento_User
Forgot Admin Password

User Notification

412

Stores -> Configuration -> Admin -> Admin User Emails -> User
Notification Template (Default Config)
Page:

Advanced > Admin

Section:

Admin User Emails

Field:

User Notification Template

Magento Community Edition 2.1 User Guide

CHAPTER 23: Email

Configuring Email Communications

Email Templates (cont.)
TEMPLATE

CONFIGURATION PATH

Magento_Wishlist
Magento Wish List Sharing Page:

Customers > Wish List

Section:

Share Options

Field:

Email Template

Configuring Email Communications
The Mail Sending Settings give you the ability to route returned email or replies to email to a
specific address. Also, if your store is running on a Windows server, you can verify the host and
port settings.
Security Notice! We recommend that all merchants immediately set their mail sending
configuration to protect against a recently identified potential remote code execution exploit. Until
this issue is resolved, we highly recommend that you avoid using Sendmail for email
communications. In the Mail Sending Settings, make sure that Set Return Path is set to "No." To
learn more, see the Magento Security Center posting.

Mail Sending Settings

To configure email communications:
1.

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

In the panel on the left under Advanced, choose System.

Expand

the Mail Sending Settings section. Then, do the following:

If necessary, set Disable Email Communications to “No.”

If running on a Windows server, verify the following settings:

Magento Community Edition 2.1 User Guide

413

Configuring Email Communications

414

CHAPTER 23: Email

Host

localhost

Port (25)

Until the current security issue is resolved, we highly recommend that you set Set Return
Path to "No."
No

(Recommended Security Measure) Routes returned email to the
default store email address.

Yes

Routes returned email to the default store email address.

Specified

Routes returned email to the email address specified in the Return
Path Email field.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 24:

Sales Documents
In addition to the email messages related to a sale, your store generates invoices, packing slips,
and credit memos in both HTML and PDF formats. Before your store goes live, make sure to
update these documents with your logo and store address. You can customize the address
format, and also include additional information for reference.
l

Invoices

Packing Slips

Credit Memos

Magento Community Edition 2.1 User Guide

415

Preparing Your Invoice Logo

CHAPTER 24: Sales Documents

Preparing Your Invoice Logo
Unlike the logo images used in HTML, the logo for PDF invoices and other sales documents can
be a high-resolution, 300 dpi image. However, the image must be rendered to fit a space that is
200 pixels wide by 50 pixels high. Be careful to preserve the aspect ratio when you resize the
logo. Resize the logo to fit the height, and don’t worry about any unused space to the right.

200 x 50 pixels
One way to resize your logo to fit the required size is to create a new, blank image with the
correct dimensions. Then, paste your logo image and resize it to fit the height. With most
image editing programs, you can either scale it by a percentage to preserve the aspect ratio, or
hold down the shift key and manually resize the image.

To configure invoices and packing slips:
1.

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

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

Expand

the Invoice and Packing Slip Design section. Then, do the following:

Invoice and Packing Slip Design
a.

To upload the Logo for PDF Print-outs, tap Choose File. Find the logo that you have
prepared, and tap Open.

416

To upload the Logo for HTML Print View,tap Choose File. Find the logo that you have
prepared, and tap Open.

Magento Community Edition 2.1 User Guide

CHAPTER 24: Sales Documents

Preparing Your Invoice Logo

Enter your address as you want it to appear on invoices and packing slips.

When complete, tap Save Config.
For reference, a thumbnail of the uploaded image appears before each field. Don’t worry if the
thumbnail appears distorted. The proportion of the logo will be correct on the invoice.

To replace an image:
1.

Tap Choose File and choose a different logo file.

Mark the Delete Image checkbox for the image you want to replace.

Tap Save Config.

Image Formats
FORMAT

REQUIREMENTS

PDF
File Format

JPG (JPEG), PNG, TIF (TIFF)

Image Size

200 pixels wide x 50 pixels high

Resolution

300 dpi recommended

HTML
File Format

JPG (JPEG), PNG, GIF

Image Size

Determined by theme.

Resolution

72 or 96 dpi

Magento Community Edition 2.1 User Guide

417

Adding Reference IDs to Header

CHAPTER 24: Sales Documents

Adding Reference IDs to Header
The Order ID and customer IP address can be included in the header of sales documents that
accompany an order. By default, both the Order ID and customer IP address appear in the
header of invoices, shipment packing slips, and credit memos.

PDF Print-outs

To change the Order ID settting:
1.

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

In the panel on the left under Sales, choose PDF Print-outs.

Expand

the Invoice section.

Invoice

418

Set Display Order ID in Header according to your preference.

Repeat for the Shipment and Credit Memo sections.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 24: Sales Documents

Adding Reference IDs to Header

To change the customer IP address setting:
1.

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

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

Expand

the General section.

General
4.

Set Hide Customer IP to your preference.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

419

Customer Address Templates

CHAPTER 24: Sales Documents

Customer Address Templates
You can modify the template that determines the format of customer billing and shipping
addresses that appear on printed invoices, shipments, and refunds, as well as in the address
book of the customer account.

Example 1: Text Templates
For Text, Text One Line, HTML and PDF Address Templates
{{depend address attribute code}} a space, a character, or UI label
{{/depend}};
{{if address attribute code}}{{var address attribute code}} a space, a
character, or UI label
{{/if}}

Example 2: JavaScript Template
For JavaScript Address Template
#{address attribute code} or User Interface label #{address attribute code}

Address Templates

420

Magento Community Edition 2.1 User Guide

CHAPTER 24: Sales Documents

Customer Address Templates

To change the order of address fields:
1.

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

In the panel on the left, under Customers, choose Customer Configuration.

Expand

the Address Templates section. The section includes a separate set of formatting

instructions for each of the following:
l

Text

Text One Line

HTML

PDF

Edit each template as needed, using the examples for reference.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

421

422

Magento Community Edition 2.1 User Guide

CHAPTER 25:

Newsletters
Publishing a regular newsletter is considered to be one of the most powerful and affordable
marketing tools available. Magento Community Edition 2.1 gives you the ability to publish and
distribute newsletters to customers who have subscribed, plus tools to produce your newsletter,
build and manage your list of subscribers, develop content, and drive traffic to your store. You
can also use Page Hierarchy to create an archive of past issues.
You can add capabilities by integrating your Magento installation with a third-party newsletter
service provider and by adding extensions. To learn more, see Magento Connect.

Magento Community Edition 2.1 User Guide

423

Configuring Newsletters

CHAPTER 25: Newsletters

Configuring Newsletters
The first step in creating newsletters is to configure the newsletter settings for your site. You
can require customers to click a confirmation link that is sent by email to confirm the
subscription. This double opt-in1, method requires customers to confirm twice that they want
to receive your newsletter, and reduces the possibility that it might be considered to be spam.

To configure subscription options:
1.

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

In the panel on the left under Customers, choose Newsletter.

If necessary, expand

the Subscription Options section. Then, do the following:

Subscription Options

1The process for subscribing email recipients by requiring them to take a secondary step to confirm that they want

to receive emails.

424

Magento Community Edition 2.1 User Guide

CHAPTER 25: Newsletters

Configuring Newsletters

Confirm the email template and sender of the each of the following email messages that
are sent to subscribers:

Success email

Confirmation email

Unsubscribe email

To use the double opt-in process to confirm subscriptions, set Need to Confirm to “Yes.”

To allow people who do not have an account with your store to subscribe to the newsletter,
set Allow Guest Subscription to “Yes.”

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

425

Newsletter Templates

CHAPTER 25: Newsletters

Newsletter Templates
You can create as many newsletter templates as you need for different purposes. You might
send a weekly product update, a monthly newsletter, or annual holiday newsletter. Newsletter
templates can be prepared with HTML markup, or as plain text. Unlike HTML, plain text
newsletters contain no images, rich text, or formatted links. In the grid, the Template Type
column indicates whether a template is HTML or text.

Newsletter Templates

To create a newsletter template:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Newsletter
Template.

426

To add a new template, click the Add New Template button. Then, do the following:
a.

In the Template Name enter name for internal reference.

In the Template Subject field, describe the purpose of the newsletter.

In the Sender Name field , enter the name of the person who is to appear as the sender of
the newsletter.

In the Sender Email field, enter the email address of the newsletter sender.

Magento Community Edition 2.1 User Guide

CHAPTER 25: Newsletters

Newsletter Templates

At the Template Content field, tap Show / HIde Editor to display the WYSIWYG editor.
Then, update the content as needed. To learn more, see: Using the Editor.
Do not remove the unsubscribe link at the bottom of the template content. In some
jurisdictions, the link is required by law.

In the Template Styles field, enter the CSS declarations needed to format the content.

Template Information
3.

Tap Preview Template to see how it looks. Then, make any changes that are needed.

When complete, tap Save Template.
After you save a template, a Save As button appears the next time you edit the template. It
can be used to save variations of the template without overwriting the original.

To convert the template to plain text:
1.

At the top of the page, tap Convert to Plain Text. When prompted to confirm, tap OK.

To preview the plain text version of the template, tap Preview Template. The preview opens in a
new browser tab.

To save the plain text version, tap Save Template.

To restore the HTML:
1.

At the top of the page, tap Return HTML Version.

To preview the HTML version of the template, tap Preview Template. The preview opens in a
new browser tab.

To save the HTML version, tap Save Template.

Magento Community Edition 2.1 User Guide

427

Sending Newsletters

CHAPTER 25: Newsletters

Sending Newsletters
To manage the load on the server, newsletters with many subscribers are sent in a queue of
multiple batches. You can check the newsletter queue periodically to check the status, and see
how many have been processed. Any problems that occur during transmission appear on the
Newsletter Problem Report.

To send a newsletter:
1.

On the Admin menu, tap Marketing. Then under Newsletters, choose Newsletter Templates.

In the grid, find the template for the newsletter that is to be sent. Then, set the Action column
to “Queue Newsletter.”

Add to Newsletter Queue
3.

In the Queue Date Start field, select the date that the transmission is to begin from the
calendar (

In the Subscribers From list select each store view that is to be included in the email blast.

Complete the email header information as follows:
a.

Enter a brief description of the newsletter for the Subject line of the email header.

Enter the Sender Name.

In the Sender Email field, enter the email address of the sender.
The default name and email address of the sender is specified in the configuration.

428

Magento Community Edition 2.1 User Guide

CHAPTER 25: Newsletters

Sending Newsletters

If applicable, enter a note in the Message box above the instructions to unsubscribe. Do not
remove the instructions, which are required by law in many jurisdictions.

When complete, tap Save and Resume.
The newsletter appears in the queue waiting to be processed.

Newsletter Queue

To check for problems:
1.

On the Admin menu, tap Reports.

Under Marketing, choose Newsletter Problem Reports.

Magento Community Edition 2.1 User Guide

429

Managing Subscribers

CHAPTER 25: Newsletters

Managing Subscribers
As a best practice you should manage your subscription list on a regular basis, and make sure
to process any requests to unsubscribe. In some jurisdictions, it is required by law that requests
to unsubscribe are processed within a specific period of time.
If you want to use a third-party service to send newsletters, you can export your subscription
list as a CSV or XML file.

To cancel a subscription:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Newsletter
Subscribers.

Find the subscriber in the grid. Then, mark the checkbox in the first column.

Set the Action control to “Unsubscribe.” Then, tap Submit.
The status of the record changes to “Unsubscribed.”

Unsubscribe

430

Magento Community Edition 2.1 User Guide

CHAPTER 25: Newsletters

Managing Subscribers

To export the list of subscribers:
1.

From the Newsletter Subscribers list, use the filter controls to include only records with a
Status of “Subscribed,” and for the appropriate website, store, or store view.

Set the Export to control to one of the following:
l

CSV

XML

Tap Export. Then, look for the prompt at the bottom of the screen, and save the file.

Export Newsletter Subscribers

Magento Community Edition 2.1 User Guide

431

432

Magento Community Edition 2.1 User Guide

CHAPTER 26:

RSS Feeds
RSS (Really Simple Syndication) is an XML-based data format that is used to distribute
information online. Your customers can subscribe to your RSS feeds to learn of new products
and promotions. RSS Feeds can also be used to publish your product information to shopping
aggregation sites, and can be included in newsletters.
When RSS feeds are enabled, any additions to products, specials, categories, and coupons are
automatically sent to the subscribers of each feed. A link to all RSS feeds that you publish is in
the footer of your store.
The orange RSS symbol is typically used to identify an RSS feed.
The software that is required to read an RSS feed is called a feed reader1, and allows people
to subscribe to headlines, blogs, podcasts, and much more. Google Reader is one of the many
feed readers that are available online for free.

RSS Feeds

1Software that is used to read syndicated content from RSS feeds.

Magento Community Edition 2.1 User Guide

433

CHAPTER 26: RSS Feeds

To set up RSS feeds for your store:
1.

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

In the upper-right corner, set Store View to the view(s) where the feeds are to be available. If
prompted to confirm, tap OK.

In the panel on the left, under Catalog, choose RSS Feeds.

Expand

the Rss Config section. Then, set Enable RSS to “Enable.”

If necessary, clear the Use Website checkbox to change the default value.

RSS Feeds
5.

Expand

the Wish List section. Then, set Enable RSS to “Enable.”

Expand

the Catalog section and set other feeds to “Enable” as needed.

New Products

Special Products

Coupons/Discounts

Top Level Category

Catalog

434

Expand

the Order section. Then, set Customer Order Status Notification to “Enable.”

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 26: RSS Feeds

Types of RSS Feeds
RSS FEED

DESCRIPTION

Wish List

When enabled, an RSS feed link appears at the top of customer wish
list pages. Additionally, the wish list sharing page includes a
checkbox that lets you include a link to the feed from shared wish
lists.

New Products

Publishes notification of new products added to the catalog.

Special Products

Publishes notification of any products with special pricing.

Coupons / Discounts

Publishes notification of any special coupons or discounts that are
available in the store.

Top Level Category

Publishes notification of any change to the top-level category
structure of your catalog, which is reflected in the main menu.

Customer Order Status

Gives customers the ability to track their order status by RSS feed.
When enabled, an RSS feed link appears on the order.

Magento Community Edition 2.1 User Guide

435

436

Magento Community Edition 2.1 User Guide

CHAPTER 27:

Using Variables
Variables are pieces of information that can be created once and used in multiple places, such
as email templates, blocks, and content pages. Your store includes a large number of predefined
variables that can be used to personalize communications. In addition, you can create your
own custom variables.
l

Predefined Variables

Custom Variables

Magento Community Edition 2.1 User Guide

437

Adding Predefined Variables

CHAPTER 27: Using Variables

Adding Predefined Variables
Predefined variables are easy to add to content email templates and content pages to
personalize communications. The selection of available variables depends on the template.

Variables for Contact Form Template

To add a variable to an email template:
1.

On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.

Do one of the following:

Load an existing template.

Add a new template.

In the Template Content box, position the insertion point where you want the variable to
appear. Then, tap Insert Variable.

In the list of available variables, choose the one you want to insert into the template.

To preview the template in a new browser window, tap Preview. Then, return to the main
window.

438

When complete, tap Save Template.

Magento Community Edition 2.1 User Guide

CHAPTER 27: Using Variables

Adding Custom Variables

Adding 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.
{{CustomVar code= "my_custom_variable"}}

Custom Variables

To create a custom variable:
1.

On the Admin sidebar, tap System. Then under Other Settings, choose Custom Variables.

Tap Add New Variable.

Enter an identifier in the Variable Code field. Use all lowercase characters, without spaces.

Enter a Variable Name, which is used for internal reference. Then, do one of the following:
l

In the Variable HTML Value text field, enter any content you want to include, using basic
HTML tags. This option allows you to format the value.
In the Variable Plain Value field, enter the variable value as plain text.
You can drag the lower-right corner to make the boxes bigger.

Magento Community Edition 2.1 User Guide

439

Adding Custom Variables

CHAPTER 27: Using Variables

New Custom Variable
5.

440

When complete, tap Save.

Magento Community Edition 2.1 User Guide

CHAPTER 27: Using Variables

Markup Tags

Markup Tags
A markup tag is a snippet of code that contains a relative reference to an object in your store,
such as a variable, URL, image, or block. Markup tags can be incorporated into the HTML of
content pages, blocks, email templates, newsletters, and so on.
Markup tags are enclosed in double, curly braces, and can either be generated by the Widget
tool, or typed directly into HTML content. For example, rather than hard-coding the full path
to a page, you can use a markup tag to represent the store URL. The markup tags featured in
the following examples include:

Custom Variable
The Variable markup tag can be used to insert a custom variable into an email templates,
blocks, newsletters, and content pages,
{{CustomVar code= "my_custom_variable"}}

Store URL
The Store URL markup tag represents the base URL of your website, and is used as a substitute
for the first part of a full URL, including the domain name. There are two versions of this
markup tag: One that goes directly to your store, and the other with a forward slash at the end
that is used when a path is added.
{{store url='apparel/shoes/womens'}}

Media URL
The dynamic media URL markup tag represents the location and file name of an image that is
stored on a content delivery network (CDN). The tag can be used to place an image on a page,
block, banner, or email template.
{{media url='shoe-sale.jpg'}}

Magento Community Edition 2.1 User Guide

441

Markup Tags

CHAPTER 27: Using Variables

Block ID
The Block ID markup tag is one of the easiest to use, and can be used to place a block directly
on a CMS page, or even nested inside another block. You can use this technique to modify a
block for different promotions or languages. The Block ID markup tag references a block by its
identifier.
{{block id='block-id'}}

Template Tag
A template tag references a PHTML template file, and can be used to display the block on a
CMS page or static block. The code in the following example can be added to a page or block to
display the Contact Us form.
“Contact Us” Template Tag

{{block type="core/template" name="contactForm"
template="contacts/form.phtml"}}

The code in the next example can be added to a page or block to display the a list of products
in a specific category, by category ID.
“Category Product List” Template Tag

{{block type="catalog/product_list" category_id="22"
template="catalog/product/list.phtml"}}

442

Magento Community Edition 2.1 User Guide

CHAPTER 27: Using Variables

Markup Tags

Widget Code
The Widget tool can be used to display lists of products, or to insert complex links, such as one
that goes to a specific product page, based on product ID. The code that is generated includes
the block reference, location of the code module, and corresponding PHTML template. After the
code is generated, you can copy and paste it from one place to another.
The code in the following example can be added to a page or block to display the list of new
products.
“New Products Grid” Code

{{widget type="catalog/product_widget_new"
display_type="new_products" products_count="10"
template="catalog/product/widget/new/content/new_grid.phtml"}}

The code in the next example can be added to a page or block to display a link to a specific
product, by product ID.
“Link to Product” Code

{{widget type="catalog/product_widget_link" anchor_text="My Product Link"
title="My Product Link" template="catalog/product/widget/link/link_
block.phtml"
id_path="product/31"}}

Magento Community Edition 2.1 User Guide

443

Markup Tags

CHAPTER 27: Using Variables

Using Markup Tags in Links
You can use markup tags with HTML anchor tags, and link directly to any page in your store.
The link can be incorporated into content pages, blocks, banners, or email and newsletter
templates. You can also use this technique to link an image to a specific page.
Process Overview:
Step 1: Identify the Destination URL
Step 2: Add the Markup to the URL
Step 3: Complete the Anchor Tag

Step 1: Identify the Destination URL
If possible, navigate to the page that you want to link to, and copy the full URL from the
address bar of your browser. The part of the URL that you need comes after the “dot com
forward slash.” Otherwise, copy the URL Key from the CMS page that you want to use as the
link destination.
Full URL to Category Page

http://mystore.com/apparel/shoes/womens
http://mystore.com/apparel/shoes/womens.html
Full URL to Product Page

http://mystore.com/apparel/shoes/womens/nine-west-pump
http://mystore.com/apparel/shoes/womens/nine-west-pump.html
Full URL to CMS Page

http://mystore.com/about-us

444

Magento Community Edition 2.1 User Guide

CHAPTER 27: Using Variables

Markup Tags

Step 2: Add the Markup to the URL
The Store URL tag represents the base URL of your website, and is used as a substitute for the
“http address” part of the store URL, including the domain name and “dot com.” There are two
versions of the tag, which you can use, depending on the results you want to achieve.
store direct_url

Links directly to a page.

store url

Places a forward slash at the end, so additional references can be
appended as a path.

In the following examples, the URL Key is enclosed in single quotes, and the entire markup tag
is enclosed in double curly braces. When used with an anchor tag, the markup tag is placed
inside the double quotes of the anchor. To avoid confusion, you can alternate using single-and
double quotes for each nested set of quotes.
1.

If you are starting with a full URL, delete the “http address” part of the URL, up through and
including the “dot.com forward slash.” In its place, type the Store URL markup tag, up
through the opening single quote.
Store URL Markup Tag

http://mystore.com/apparel/shoes/womens
{{store url='apparel/shoes/womens'}}

Otherwise, type the first part of the Store URL markup tag, and paste the URL key or path that
you copied earlier.
Store URL Markup Tag with URL Key

{{store url='
{{store url='apparel/shoes/womens'}}

To complete the markup tag, type the closing double quotes and double braces.

Magento Community Edition 2.1 User Guide

445

Markup Tags

CHAPTER 27: Using Variables

Step 3: Complete the Anchor Tag
1.

Wrap the completed markup tag inside an anchor tag, using the markup tag instead of the
target URL. Then, add the link text, and closing anchor tag.
Markup in Anchor Tag

Link Text

Paste the completed anchor tag into the code of any CMS page, block, banner, or email
template, where you want the link to appear.
Complete Link with Markup

Shoe Sale

446

Magento Community Edition 2.1 User Guide

CHAPTER 27: Using Variables

Variable Reference

Variable Reference
Most email templates have a section of additional variables that are specific to the template.
The following are examples of some frequently used templates.

Email Template Variables
VARIABLE

MARKUP TAG

Email Footer Template

Email Header Template

Email Logo Image Alt

Email Logo Image URL

Email Logo Image Height

Email Logo Image Width

Template CSS

Store Contact Information Variables
VARIABLE

MARKUP TAG

Base Unsecure URL

Base Secure URL

General Contact Name

General Contact Email

Sales Representative
Contact Name

Sales Representative
Contact Email

Custom1 Contact Name

Custom1 Contact Email

Magento Community Edition 2.1 User Guide

447

Variable Reference

CHAPTER 27: Using Variables

Store Contact Information Variables (cont.)
VARIABLE

448

MARKUP TAG

Custom2 Contact Name

Custom2 Contact Email

Store Name

Store Phone Telephone

Store Hours

Country

Region/State

Zip/Postal Code

City

Street Address 1

Street Address 2

Store Contact Address

Magento Community Edition 2.1 User Guide

CHAPTER 27: Using Variables

Variable Reference

New Account Template Variables
VARIABLE

MARKUP TAG

Customer Account URL

Customer Email

Customer Name

New Order Template Variables
VARIABLE

MARKUP TAG

Billing Address

Email Order Note

Order ID

Order Items Grid

{{layout handle="sales_email_order_items"
order=$order area="frontend"}}

Payment Details

Shipping Address

Shipping Description

Magento Community Edition 2.1 User Guide

449

450

Magento Community Edition 2.1 User Guide

SEO & Search

451

Contents
In this section of the guide, we'll take a look at
the search capabilities of your store, what you
can learn from customer search terms, and how
to make your products easy to find. Finally,
you’ll learn best practices and techniques that
you can use to bring more traffic to your store.

Catalog Navigation
Top Navigation
Breadcrumb Trail
Product Listings
Pagination Controls
Layered Navigation
Catalog Search
Quick Search
Advanced Search
Search Results
Weighted Search
Configuring Catalog Search
Using a Flat Catalog
Meta Data
Canonical Meta Tag
Catalog URLs
SEO URL Rewrites
Configuring URL Rewrites
Automatic Product Redirects
Creating URL Rewrites
Search Terms
Popular Search Terms
Adding Search Terms
Search Terms Report
Using a Sitemap
Google Tools
Google Analytics
Google Adwords

452

CHAPTER 28:

Catalog Navigation
The term navigation1 refers to the methods shoppers use to move from page to page
throughout your store. The main menu, or top navigation of your store is actually a list of
category links, and provides easy access to the products in your catalog. You will also find
categories in the breadcrumb trail that runs across the top of most pages, and in the layered
navigation that appears on the left side of some two- or three-column pages.
For a product to be visible in your store, it must be assigned to at least one category. Each
category can have a dedicated landing page with an image, static block, a description, and a
list of products in the category. You can also create special designs for category pages that are
active only for a specific period of time such as for a holiday or promotion.

1The primary group of web page links that a customer uses to navigate around the website; the navigation links to

the most important categories or pages on an online store.

Magento Community Edition 2.1 User Guide

453

Top Navigation

CHAPTER 28: Catalog Navigation

Top Navigation
The main menu of your store is like a directory to the different departments in your store. Each
option represents a different category of products. The position and presentation of the top
navigation might vary by theme, but the way it works is essentially the same.

Top Navigation
The category structure of your catalog can influence how well your site is indexed by search
engines. The more deeply nested a category, the less likely it is to be thoroughly indexed. As a
general rule, anywhere between one and three visible levels is considered to be the most
effective. The root category counts as the first level, although it doesn't appear in the menu.
The maximum number of levels that are available in the top navigation is determined by the
configuration. In addition, there might be a limit to the number of menu levels that are
supported by your store theme. For example, the sample Luma theme supports up to five
levels, including the root.

Counting Menu Levels

454

Level 1

The first level is the root category, which in the sample data is named
“Default Category.” The root is a container for the menu, and its name
does not appear as an option in the menu.

Level 2

On a desktop display, the top navigation is the main menu that
appears across the top of the page. On a mobile device, the main
menu typically appears as a fly-out menu of options. The secondlevel options in the Luma store are “What's New,” “Women,” “Men,”
“Gear,” “Training,” and “Sale.”

Level 3

The third-level appears below each main menu option. For example,
under “Women,” the third-level options are “Tops” and “Bottoms.”

Level 4

The fourth-level options are subcategories that fly out from a thirdlevel option. For example, under “Tops,” the fourth level menu options
are “Jackets,” “Hoodies & Sweatshirts,” “Tees,” and “Bras & Tanks.”

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Top Navigation

To set the depth of the top navigation:
1.

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

In the panel on the left, expand Catalog. Then, choose Catalog.

Expand the Category Top Navigation section.
Because the depth of the top navigation has a global configuration scope, the setting applies to
all websites, stores, and store views in the Magento installation. The Category Top Navigation
configuration section is available only when Store View in the upper-left corner is set to
“Default Config.”

Default Config
4.

To limit the number of subcategories that appear in the top navigation, enter the number in the
Maximal Depth field.
The default Maximal Depth value is zero, which does not place a limit on the number of
subcategory levels.

When complete, tap Save Config .

Category Top Navigation

Magento Community Edition 2.1 User Guide

455

Breadcrumb Trail

CHAPTER 28: Catalog Navigation

Breadcrumb Trail
A breadcrumb trail is a set of links that shows where you are in relation to other pages in the
store. You can click any link in the breadcrumb trail to return to the previous page.
The breadcrumb trail can be configured to appear on content pages, as well as catalog pages.
The format and position of the breadcrumb trail varies by theme, but it is usually located just
below the header. By default, the breadcrumb trail appears on CMS pages.

Breadcrumb Trail

456

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Breadcrumb Trail

To remove the breadcrumbs from CMS pages:
1.

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

In the panel on the left under General, choose Web. Then, do the following:

Expand the Default Pages section.

Clear the Use system value checkbox.

Set Show Breadcrumbs for CMS Pages to "No."

When complete, tap Save Config .

Show Breadcrumbs for CMS Pages

Magento Community Edition 2.1 User Guide

457

Product Listings

CHAPTER 28: Catalog Navigation

Product Listings
Product listings can be set to appear by default as either a list or grid. You can also determine
how many products appear per page, and which attribute is used to sort the list. Each catalog
page with a product list has a set of controls that can be used to sort the products, change the
format of the list, sort by attribute, and advance from one page to the next.

Products Displayed as a Grid

458

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Product Listings

To configure product listings:
1.

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

Scroll down and in the panel on the left, tap Catalog. Then choose Catalog.

Expand

the Storefront section, and do the following:

Storefront
a.

Set the default List Mode to one of the following:
l

Grid Only

List Only

Grid (default) / List

List (default / Grid

In the Products per Page on Grid Allowed Values field, enter the number of products
that you want to appear per page when shown in grid format. To enter a selection of
values, separate each number by a comma.

In the Products per Page on Grid Default Value field, enter the default number of
products to appear in the grid per page.

Magento Community Edition 2.1 User Guide

459

Product Listings

CHAPTER 28: Catalog Navigation

In the Products per Page on List Allowed Values field, enter the number of products that
you want to appear per page when shown in list format. To enter a selection of values,
separate each number by a comma.

In the Products per page on List Default Value field, enter the default number of products
that appear in the list, per page.

To give customers the option to list all products, set Allow All Products on Page to “Yes.”

Set Product Listing Sorted by to the default attribute that is initially used to sort the list.

If using a flat catalog, do the following:
a.

To display a flat category listing of products, set Use Flat Catalog Category to “Yes.”

To display a flat product listing, set Use Flat Catalog Product to “Yes.”

If you want to allow dynamic references for media assets in category and product URLs, set
Allow Dynamic Media URLs in Products and Categories to “Yes.”

When complete, tap Save Config .

Page Controls
CONTROL

460

DESCRIPTION

View As

Displays the products in either a grid or list format.

Sort By

Changes the sort order of the list.

Show Per Page

Determines how many products appear per page.

Pagination Links

Navigation links to other pages.

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Pagination Controls

Pagination Controls
The Pagination settings appear at the top and bottom of the list, and control the format of the
pagination links for product listings. You can set the number of links that appear in the
control, and configure the Next and Previous links. For the pagination links to appear, there
must be more products in the list than are allowed per page in the product list configuration.

Pagination Controls

Pagination Controls
View As
Displays the list in either a Grid or List format.
Sort By
Changes the sort order of the list.
Show Per Page
Determines how many products appear per page.
Pagination Links
Navigation links to other pages.

Magento Community Edition 2.1 User Guide

461

Pagination Controls

CHAPTER 28: Catalog Navigation

To configure the pagination controls:
1.

On the Admin sidebar, tap Content. Then under Design, choose Configuration.

Find the store view that you want to configure. Then in the Action column, click Edit.

Under Other Settings, expand

the Pagination section.

Pagination
a.

In the Pagination Frame field, enter the number of links that you want to appear in the
pagination control.

In the Pagination Frame Skip field, enter the number of links that you want to skip ahead
before displaying the next set of links in the pagination control.
For example, if the pagination frame has five links, and you want to jump to the next five
links, how many links do you want to skip ahead? If you set this to four, then the last link
from the previous set will be the first link in the next set.

462

In the Anchor Text for Previous field, enter the text that you want to appear for the
Previous link. Leave blank to use the default arrow.

In the Anchor Text for Next field, enter the text that you want to appear for the Next link.
Leave blank to use the default arrow.

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Layered Navigation

Layered Navigation
Layered navigation makes it easy to find products based on category, price range, or any other
available attribute. Layered navigation usually appears in the left column of search results and
category pages and sometimes on the home page. The standard navigation includes a “Shop
By” list of categories and price range. You can configure the display of layered navigation,
including product count and price range.

Layered Navigation by Category and Price

Magento Community Edition 2.1 User Guide

463

Layered Navigation

CHAPTER 28: Catalog Navigation

Layered Navigation with Filterable Attributes
Layered navigation can be used to search for products by category or by attribute. For example,
when a shopper chooses the Mens/Shorts category from the top navigation, the initial results
include all products in the category. The list can be filtered further by choosing a specific style,
climate, color, material, pattern, or price—or a combination of values. Filterable attributes
appear in an expanding section that lists each attribute value. As an option, the list of
products with matching results can be configured to include products with, or without, a
match.
The attribute properties, combined with the product input type determines which attributes
can be used for layered navigation. Layered navigation is available only for “anchor” categories,
but can also be added to search results pages. The Catalog Input Type for Store Owner property
of each attribute must be set to “Dropdown,” “Multiple Select,” or “Price.” To make the
attributes filterable, the Use in Layered Navigation property of each must be set to either
“Filterable (with results)” or “Filterable (no results).”

Filterable Attributes In Layered Navigation

464

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Layered Navigation

The following instructions show how to set up basic layered navigation with filterable
attributes. For advanced layered navigation with price steps, see: Price Navigation.
Process Overview:
Step 1: Set Up the Attribute Properties
Step 2: Make the Category an Anchor
Step 3: Test the Results

Step 1: Set Up the Attribute Properties
1.

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

Find the attribute in the list, and open in edit mode. Then, do the following:

Filtered Search on Attribute Code
a.

In the panel on the left, choose Storefront Properties. Then, set Use In Layered
Navigation to one of the following:
Filterable (with
results)

Filterable (no
results)

Magento Community Edition 2.1 User Guide

465

Layered Navigation

CHAPTER 28: Catalog Navigation

Filterable Swatch Value with No Results
b.

Set Use In Search Results Layered Navigation to “Yes.”

Storefront Properties
3.

466

Repeat these steps for each attribute that you want to include in layered navigation.

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Layered Navigation

Step 2: Make the Category an Anchor
1.

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

In the categories tree on the left, select the category where you want to use layered navigation.

Expand

Tap Save .

the Display Settings section. Then, set Anchorto “Yes.”

Category Display Settings

Step 3: Test the Results
To test the setting, go to your store and navigate to the category from the main menu. The
selection of filterable attributes appears in the layered navigation of the category page.

Magento Community Edition 2.1 User Guide

467

Layered Navigation

CHAPTER 28: Catalog Navigation

Price Navigation
Price navigation can be used to distribute products by price range in layered navigation. You
can also split each range in intervals. There are ways to calculate price navigation:
l

Automatic (Equalize Price Ranges)

Automatic (Equalize Product Counts)

Manual

With the first two methods, the navigation steps are calculated automatically. The manual
method lets you specify a division limit for price intervals. The following example shows the
difference between price navigation steps of 10 and 100.
Iterative splitting provides the best distribution of products among price ranges. With iterative
splitting, after choosing the $0.00-$99 range, the customer can drill-down through several
sub-ranges of prices. Price-range splitting stops when the number of products reaches the
threshold set by the Interval Division Limit.

Example: Price Navigation Steps
PRICE STEP BY 10

PRICE STEP BY 100

$20.00 - $29.99 (1)

$0.00 - $99.99 (4)

$30.00 - $39.99 (2)

$100 - $199.99 (5)

$70.00 - $79.99 (1)

$400.00 - $499.99 (2)

$100.00 - $109.99 (1)

$700.00 and above (1)

$120.00 - $129.99 (2)
$150.00 - $159.99 (1)
$180.00 - $189.99 (1)
$420.00 - $429.99 (1)
$440.00 - $449.99 (1)
$710.00 and above (1)

468

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Layered Navigation

To configure price navigation:
1.

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

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

Expand
a.

the Layered Navigation section. Then, do the following:

By default, Display Product Count is set to “Yes.” The change the setting, first clear the
Use system value checkbox.

Set Price Navigation Steps Calculation to one of the following methods:

Layered Navigation

Method 1: Automatic (equalize price ranges)
Leave Price Navigation Steps Calculation set to the default, “Automatic (Equalize Price
Ranges.)” This setting uses the standard algorithm for price navigation.

Method 2: Automatic (equalize product counts)
To change the value of any of the following fields, first clear the Use system value checkbox.
1.

Set Price Navigation Steps Calculation to “Automatic (equalize product counts).”

To display a single price when multiple products with the same price, set Display Price
Interval as One Price to “Yes.”

In the Interval Division Limit field, enter the threshold for a number of products within a
price range. The range cannot be further split beyond this limit., The default value is 9.

Automatic (equalize product counts)

Magento Community Edition 2.1 User Guide

469

Layered Navigation

CHAPTER 28: Catalog Navigation

Method 3: Manual
To change the value of any of the following fields, first clear the Use system value checkbox.
1.

Set Price Navigation Steps Calculation to “Manual.”

Enter a value to determine the Default Price Navigation Step.

Enter the Maximum Number of Price Intervals allowed, up to 100.

Manual
4.

470

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

CHAPTER 28: Catalog Navigation

Layered Navigation

Configuring Layered Navigation
The layered navigation configuration determines if a product count appears in parentheses after
each atribute, and the size of the step calculation that is used in price navigation.

To configure layered navigation:
1.

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

In the panel on the left, expand the Catalog section. Then choose Catalog.

Expand the Layered Navigation section, and do the following:

Layered Navigation
a.

To display the number of products found for each attribute, set Display Product Count to
“Yes.” If necessary, first clear the Use system value checkbox.

Set Price Navigation Step Calculation to “Automatic (equalize price ranges).” If necessary,
first clear the Use system value checkbox.

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

471

472

Magento Community Edition 2.1 User Guide

CHAPTER 29:

Catalog Search
Research shows that people who use search are more likely to make a purchase than those who
rely on navigation alone. In fact, according to some studies, people who use search are nearly
twice as likely to make a purchase. In this section of the guide, we will explore how customers
search for products in your catalog, and how you can configure catalog search.
l

Quick Search

Advanced Search

Search Results

Configuring Catalog Search

Flat Catalog

Magento Community Edition 2.1 User Guide

473

Quick Search

CHAPTER 29: Catalog Search

Quick Search
The Search box in the header of the store helps visitors find products in your catalog. The
search text can be the full or partial product name, or any other word or phrase that describes
the product. The search terms that people use to find products can be managed from the
Admin.

To do a quick search:
1.

In the Search box, enter the first few letters of what you want to find.
Any matches in the catalog appear below, with the number of results found.

Either press the Enter key or tap a result in the list of matching products.

474

Magento Community Edition 2.1 User Guide

CHAPTER 29: Catalog Search

Advanced Search

Advanced Search
Advanced Search lets shoppers search the catalog based on values entered into a form. Because
the form contains multiple fields, a single search can include several parameters. The result is a
list of all products in the catalog that match the criteria. A link to Advanced Search is in the
footer of your store.

Advanced Search
Each field in the form corresponds to an attribute from your product catalog. To add a field, set
the frontend properties of the attribute to “Include in Advanced Search.” As a best practice,
include only the fields that customers are most likely to use to find a product, because having
too many will slow down the search.

Magento Community Edition 2.1 User Guide

475

Advanced Search

CHAPTER 29: Catalog Search

To use advanced search:
1.

In the footer of the store, click Advanced Search.

In the Advanced Search form, full or partial values in as many fields as necessary.

Tap Search to display the results.

Search Results
4.

If you don’t see what you are looking for in the search results, tap Modify your search and try
another combination of criteria.

476

Magento Community Edition 2.1 User Guide

CHAPTER 29: Catalog Search

Search Results

Search Results
The Search Results list includes all products that match the search criteria entered in the Quick
Search box or the Advanced Search form. Every product list in the catalog has essentially the
same controls. The only difference is that one is the result of a search query, and the other is
the result of navigation.
The results can be formatted as either a grid or list, and sorted by a selection of attributes.
Pagination controls appear if there are more products than fit on the page, and are used to
move from one page to the next. The number of records per page is determined by the Catalog
Frontend configuration. To learn more, see Product Listings.

Search Results with Pagination Controls

Magento Community Edition 2.1 User Guide

477

Search Results

CHAPTER 29: Catalog Search

Weighted Search
Product attributes that are enabled for catalog search can be assigned a weight to give them a
higher value in search results. Attributes with a greater weight are returned before those with a
lower weight. For example, if there are two attributes in the system, “color” with a search
weight of 3 and “description” with a search weight of 1. A search for the word “red,” returns a
list of products with a color attribute value of “red,” but does not return products with
descriptions that contain the word “red.” In this example, the color attribute has a greater
weight than the description attribute.

Search Weight

To set the search weight properties of an attribute:
1.

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

Find the attribute in the list, and open in edit mode.

In the panel on the left, choose Storefront Properties. Then, do the following:

478

To include the attribute in search queries, set Use in Search to “Yes.”

To establish the search value of the attribute, set Search Weight to a number from 1 to 10,
where 10 has the highest priority. If no value is entered, all attributes have a search weight
of 1.

When complete, tap Save Attribute button.

Magento Community Edition 2.1 User Guide

CHAPTER 29: Catalog Search

Search Results

Configuring Catalog Search
Magento uses the fulltext MySQL search engine. By adjusting the Catalog Search configuration,
you can control the size of valid query text.

Catalog Search

To configure catalog search:
1.

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

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

Expand

To limit the length and word count of search query text, do the following:
a.

the Catalog Search section, and do the following:

Set Minimal Query Length to the minimum number of characters that can be submitted in
a query.

Set Maximum Query Length to the maximum number of characters that can be submitted
in a query.

Accept the default, Search Engine, “MySQL.”

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

479

480

Magento Community Edition 2.1 User Guide

CHAPTER 30:

Search Terms
You can learn what your customers are looking for by examining the search terms they use to
find products in your store. If enough people look for a product that you don’t carry, perhaps
it’s time to add it to your catalog. Meanwhile, rather than have them leave them empty
handed, why not redirect them to another product in your catalog? Here are a few ways you
can leverage customer search terms:

Landing Page
The landing page for a search term can be a content page, a category page, a product detail page, or
even a page on a different site.

Synonyms
One way to improve the effectiveness of catalog search is to include different terms that people may
use to describe the same item. You don’t want to lose a sale just because someone is looking for a
“sofa,” and your product is listed as a “couch.” You can capture a broader range of search terms by
entering the words, “sofa” “davenport,” and “loveseat” as synonyms for “couch,” and direct them to the
same landing page.

Misspelled Words
Use search terms to capture common misspellings and redirect them to the appropriate page. For
example, if you sell wrought iron patio furniture, you know that many people misspell the term as “rod
iron,” or even “rot iron.” You can enter each misspelled word as a search term, and make them
synonyms for “wrought iron.” Even though the word is misspelled, the search will be directed to the
page for “wrought iron.”

Magento Community Edition 2.1 User Guide

481

Popular Search Terms

CHAPTER 30: Search Terms

Popular Search Terms
The Search Terms link in the footer of your store displays the search terms used by visitors to
your store, ranked by popularity. Search terms appear in a “tag cloud” format, where the size of
the text indicates the popularity of the term.
By default, Popular Search Terms is enabled as a search engine optimization tool, but has no
direct connection to the catalog search process. Because the Search Terms page is indexed by
search engines, any terms on the page can help improve your search engine ranking and the
visibility of your store. The URL of the Popular Search Terms page is:
mystore.com/search/term/popular/

Popular Search Terms

482

Magento Community Edition 2.1 User Guide

CHAPTER 30: Search Terms

Popular Search Terms

To configure Popular Search Terms:
1.

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

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

Expand

Clear the Use system value checkbox. Then, set Popular Search Terms as needed.

When complete, tap Save Config.

the Search Engine Optimization section.

Search Engine Optimization

Magento Community Edition 2.1 User Guide

483

Adding Search Terms

CHAPTER 30: Search Terms

Adding Search Terms
As you learn new words that people use to search for products in your catalog, you can add
them to your search terms list to direct people to the most closely matching products in your
catalog.

Search Terms

To add a new search term:

484

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose Search Terms.

Tap Add New Search Term. Then, do the following:

Magento Community Edition 2.1 User Guide

CHAPTER 30: Search Terms

Adding Search Terms

General Information
a.

Under General Information in the Search Query box, type the word or phrase that you
want to add as a new search term.

If your store is available in multiple languages, choose the applicable Store view.

To redirect the search results to another page in your store, or to another website, enter the
full URL of the target page in the Redirect URL field.

If you want this term to be available for use as a suggestion whenever a search returns no
results, set Display in Suggested Terms to “Yes.”

When complete, tap Save Search.

To edit a search term:
1.

In the Search Terms grid, click the row of any record to open the search term in edit mode.

Make the necessary changes.

When complete, tap Save Search.

To delete a search term:
1.

In the list, mark the checkbox of the term to be deleted.

In the upper-left corner of the list, set Actions to “Delete.”

When complete, tap Submit.

Magento Community Edition 2.1 User Guide

485

Search Terms Report

CHAPTER 30: Search Terms

Search Terms Report
The Search Terms report shows the number of results for each term, and the number of times
(hits) the term was used. The report data can be filtered by term, store, results, and hits, and
exported for further analysis.

To view the search terms report:
1.

On the Admin sidebar, tap Reports. Then under Marketing, choose Search Terms.

Use the controls to filter the report as needed.

Search Terms Report

486

Magento Community Edition 2.1 User Guide

CHAPTER 31:

SEO Best Practices
Search engine optimization is the practice of fine-tuning the content and presentation of a site
to improve the way the pages are indexed by search engines. Magento Community 2.1 includes
a number of features to support your ongoing SEO effort.

Commerce Resources
See the latest Magento eBooks to gain access to expert
insight and online business resources to help develop
and improve your store.

Magento Community Edition 2.1 User Guide

487

Meta Data

CHAPTER 31: SEO Best Practices

Meta Data
Your store is loaded with places where you can enter keyword-rich meta data to improve the
way search engines index your site. While setting up your store, you might enter preliminary
meta data, with the intention of finishing it later. Over time, you can fine-tune the meta data
to target the buying patterns and preferences of your customers.

Meta Tags

Meta Title
The meta title appears in the title bar and tab of your
browser, and search results listings. The meta title
should be unique to the page, and less than seventy
characters in length.

Meta Keywords
Although some search engines ignore meta keywords,
others continue to use them. The current best practice is
to incorporate high-value keywords in the meta title and
meta description.

Meta Description
Meta descriptions provide a brief overview of the page for
search results listings. Ideally, a meta description should
be between 150-160 characters in length, although the
field will accept up to 255 characters.

488

Magento Community Edition 2.1 User Guide

CHAPTER 31: SEO Best Practices

Meta Data

Canonical Meta Tag
The canonical meta tag tells search engines which page
to index when multiple URLs have identical or very
similar content.

Structured Data Markup

Rich Snippets
Rich snippets provide detailed information for search
results listings and other applications. By default,
structured data markup that is based on the schema.org
standard is added to your store’s product template. As a
result, more information is available for search engines to
include as “rich snippets” in product listings.

Magento Community Edition 2.1 User Guide

489

Meta Data

CHAPTER 31: SEO Best Practices

Canonical Meta Tag
Some search engines penalize websites that have multiple URLs that point to the same content.
The canonical meta tag tells search engines which page to index when multiple URLs have
identical or very similar content. Using the canonical meta tag can improve your site ranking
and aggregate pageviews. The canonical meta tag is placed in the block of a product or
category page. It provides a link to your preferred URL, so search engines will give it greater
weight.

Example 1: Category Path Creates Duplicate URLs
For example, if your catalog is configured to include the category path in product URLs, your
store will generate multiple URLs that point to the same product page.
http://mystore.com/gear/bags/driven-backpack.html
http://mystore.com/driven-backpack.html

Example 2: Category Page Full URL
When canonical meta tags for categories are enabled, the category page of your store includes a
canonical URL to the full category URL:
http://mystore.com/gear/bags/driven-backpack.html

Example 3: Product Page Full URL
When canonical meta tags for products are enabled, the product page includes a canonical
URL to the domain-name/product-url-key because product URL keys are globally unique.
http://mystore.com/driven-backpack.html

If you also include the category path in product URLs, the canonical URL remains domainname/product-url-key. However, the product can also be accessed using its full URL, which
includes the category. For example, if the product URL key is driven-backpack, and is
assigned to the Gear > Bags category, the product can be accessed using either URL.
You can avoid being penalized by search engines by omitting the category from the URL, or by
using the canonical meta tag to direct search engines to index either by product or category. As
a best practice, it is recommended that you enable canonical meta tags for both categories and
products.

To enable the canonical meta tag:

490

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

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

Magento Community Edition 2.1 User Guide

CHAPTER 31: SEO Best Practices

Expand

Meta Data

the Search Engine Optimization section.

To change any field values, you must first clear the Use system value checkbox after each field.

Search Engine Optimization
4.

If want search engines to index only category pages using the full category path, do the
following:

Set Use Canonical Link Meta Tag for Categories to “Yes.”

Set Use Canonical Link Meta Tag for Products to “No.”

If you want search engines to index product pages only using the domain-name/product-urlkey format, do the following:

Set Use Canonical Link Meta Tag for Products to “Yes.”

Set Use Canonical Link Meta Tag for Categories to “No.”

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

491

Using a Sitemap

CHAPTER 31: SEO Best Practices

Using a Sitemap
A sitemap improves the way your store is indexed by search engines, and is specifically
designed to find pages that might be overlooked by web crawlers. A sitemap can be configured
to index all pages and images.
When enabled, Magento creates a file called sitemap.xml that is saved to the root directory of
your installation. The configuration gives you the ability to set the frequency of the updates,
and the priority for each type of content. Your sitemap should be updated as frequently as the
content on your site changes, which might be daily, weekly, or monthly.
While your site is in development, you might include instructions in the robots.txt file for
webcrawlers to avoid indexing the site. Then before the launch, you can change the instructions
to allow the site to be indexed.
Process Overview:
Step 1: Configure and Enable the Sitemap
Step 2: Configure and Enable robots.txt (Optional)
Step 3: Submit Your Sitemap to Search Engines
Step 4: Restore the Previous Robot Instructions (Optional)

Step 1: Configure and Enable the Sitemap
Complete the XML Sitemap configuration to determine what is included, and how frequently
the sitemap is updated.

Step 2: Configure and Enable robots.txt (Optional)
Complete the Search Engine Robots configuration with instructions that direct search engines
to crawl the parts of your site that you want to be indexed.

Step 3: Submit Your Sitemap to Search Engines
You can submit your sitemap to different search engines by providing them a link to the
sitemap.xml file in the root of your Magento installation. For more information, see the
instructions for the specific search engine. Here are links to instructions for two top search
engines:
l

Google

Microsoft Bing

Step 4: Restore Previous Robot Instructions (Optional)
You can now restore either the original, or default restrictions.

492

Magento Community Edition 2.1 User Guide

CHAPTER 31: SEO Best Practices

Sitemap Configuration

Sitemap Configuration
Your sitemap should be updated as frequently as the content on your site changes, which could
be on a daily, weekly, or monthly basis. The configuration lets you set the frequency and
priority for each type of content.

Step 1: Set the Frequency and Priority of Content Updates
1.

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

In the panel on the left under Catalog, choose XML Sitemap.

Expand
a.

the Categories Options section. Then, do the following:

Set Frequency to one of the following:
l

Always

Hourly

Daily

Weekly

Monthly

Yearly

Never

In the Priority field, enter a value between 0.0 and 1.0. Zero has the lowest priority.

Categories Options
4.

Click to expand the Products Options section. Then, complete the Frequency and Priority
settings as needed.

To determine the extent that images are included in the sitemap, set Add Images into Sitemap
to one of the following:
l

None

Base Only

All

Magento Community Edition 2.1 User Guide

493

Sitemap Configuration

CHAPTER 31: SEO Best Practices

Products Options
6.

Click to expand the CMS Pages Options section. Then, complete the Frequency and Priority
settings as needed.

CMS Pages Options
7.

When complete, tap Save Config.

Step 2: Complete the Generation Settings
1.

Expand

the Generation Settings section.

Generation Settings
2.

494

To generate a sitemap, set Enabled to “Yes.” Then, do the following:
a.

Set Start Time to the hour, minute and second that you want the sitemap to be updated.

Set Frequency to one of the following:
l

Daily

Weekly

Monthly

Magento Community Edition 2.1 User Guide

CHAPTER 31: SEO Best Practices

Sitemap Configuration

In the Error Email Recipient field, enter the email address of the person who is to receive
notification if an error occurs during a sitemap update.

Set Error Email Sender to the store contact who appears as the sender of the error
notification.

Set Error Email Template to the template used for the error notification.

Step 3: Set the Sitemap File Limits
1.

Expand
a.

the Sitemap File Limits section. Then, do the following:

In the Maximum No of URLs per File field, enter the maximum number of URLs that can
be included in the sitemap. By default, the limit is 50,000.

In the Maximum File Size field, enter the largest size in bytes that is allocated for the
sitemap. The default size is 10,485,760 bytes.

Sitemap File Limits

Step 4: Set the Search Engine Submission Settings
1.

Expand

the Search Engine Submission Settings section.

If using a robots.txt file to provide instructions to search engines that crawl your site, set
Enable Submission to Robots.txt to “Yes.”

Search Engine Submission Settings
3.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

495

Search Engine Robots

CHAPTER 31: SEO Best Practices

Search Engine Robots
The Magento configuration includes settings to generate and manage instructions for web
crawlers and bots that index your site. The instructions are saved in a file called “robots.txt”
that resides in the root of your Magento installation. The instructions are directives that are
recognized and followed by most search engines.
By default, the robots.txt file that is generated by Magento contains instructions for web
crawler to avoid indexing certain parts of the site that contain files that are used internally by
the system. You can use the default settings, or define your own custom instructions for all, or
for specific search engines. There are many articles online that explore the subject in detail.

Example: Custom Instructions
Allows Full Access

User-agent:*
Disallow:
Disallows Access to All Folders

User-agent:*
Disallow: /
Default Instructions

Disallow: /lib/
Disallow: /*.php$
Disallow: /pkginfo/
Disallow: /report/
Disallow: /var/
Disallow: /catalog/
Disallow: /customer/
Disallow: /sendfriend/
Disallow: /review/
Disallow: /*SID=

496

Magento Community Edition 2.1 User Guide

CHAPTER 31: SEO Best Practices

Search Engine Robots

To configure robots.txt:
1.

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

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

Expand
a.

the Search Engine Robots section. Then, do the following:

Set Default Robots to one of the following:
INDEX, FOLLOW

Instructs web crawlers to index the site and to check back
later for changes.

NOINDEX, FOLLOW

Instructs web crawlers to avoid indexing the site, but to
check back later or changes.

INDEX, NOFOLLOW

Instructs web crawlers to index the site once, but to not
check back later for changes.

NOINDEX, NOFOLLOW

Instructs web crawlers to avoid indexing the site, and to not
check back later for changes.

If needed, enter custom instructions into the Edit Custom instruction of robots.txt file
box: For example, while a site is in development, you might want to disallow access to all
folders.

To restore the default instructions, tap Reset to Default.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

497

498

Magento Community Edition 2.1 User Guide

CHAPTER 32:

URL Rewrites
The URL Rewrite tool lets you change any URL that is associated with a product, category, or
CMS page. When the rewrite goes into effect, any links that point to the previous URL are
redirected to the new address.
The terms rewrite and redirect are often used interchangeably, but refer to slightly different
processes. A URL rewrite changes the way a URL appears in the browser. A URL redirect, on
the other hand, updates the URL that is stored on the server. A URL redirect can be either
temporary or permanent. Your store uses URL rewrites and redirects to make it easy for you to
change the URL key of a product, category, or page and preserve existing links.
By default, automatic URL redirects are enabled for your store. The "Create Permanent Redirect
for old URL" checkbox is marked under the URL key field of each product.

Create Permanent Redirect for Old URL

Magento Community Edition 2.1 User Guide

499

URL Rewrite Configuration

CHAPTER 32: URL Rewrites

URL Rewrite Configuration
URL rewrites make it possible to make existing URLs more “search engine friendly” and also
easier for humans to read. Enabling Web Server Apache Rewrites is part of the initial Magento
setup. Magento routinely uses URL rewrites to remove the file name “index.php” that normally
appears in the URL just after the root folder. When Web Server Rewrites are enabled, the
system rewrites each URL to omit “index.php.” The rewrite removes words that convey nothing
of value to search engines or customers, and has no impact on performance or site rank.
URL without Web Server Rewrite

http://www.yourdomain.com/magento/index.php/storeview/url-identifier
URL with Web Server Rewrite

http://www.yourdomain.com/magento/storeview/url-identifier

To configure URL rewrites:
1.

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

In the panel on the left under General, choose Web.

Expand

the Search Engine Optimization section.

Search Engine Optimization

500

Set Use Web Server Rewrites to your preference.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Automatic Redirects

Automatic Redirects
Your store can be configured to automatically generate a permanent redirect whenever the URL
key of a product or category changes. In the Search Engine Optimization section, the checkbox
below the URL key indicates if permanent redirects are enabled. If your store is already
configured to automatically redirect catalog URLs, making a redirect is as easy as updating the
URL key. The process to create an automatic redirect is the same for both products and
categories.

Create Permanent Redirect for Old URL

To set up automatic redirects:
1.

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

In the panel on the left under Catalog, select Catalog.

Expand the Search Engine Optimization section.

Set Create Permanent Redirect for URLs if URL Key Changed to “Yes.”

When complete, tap Save Config.

Search Engine Optimization

Magento Community Edition 2.1 User Guide

501

Automatic Redirects

CHAPTER 32: URL Rewrites

To automatically redirect product URLs:
1.

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

Find the product in the list, and click to open the record.

Expand

the Search Engine Optimization section. Then in the URL Key field, do the

following:
a.

Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not,
follow the instructions to enable automatic redirects.

Update the URL Key as needed, using all lowercase characters and hyphens instead of
spaces.

When complete, tap Save.

When prompted to refresh the cache, follow the links in the message at the top of the
workspace. The permanent redirect is now in effect for the product and any associated category
URLs.

To automatically redirect category URLs:
1.

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

Find the category in the tree, and click to open the record.

Expand

the Search Engine Optimization section. Then in the URL Key field, do the

following:
a.

Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not,
follow the instructions to enable automatic redirects.

Update the URL Key as needed, using all lowercase characters and hyphens instead of
spaces.

When complete, tap Save.

When prompted to refresh the cache, follow the links in the message at the top of the
workspace. The permanent redirect is now in effect for the category and any associated product
URLs.

502

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

Creating URL Rewrites
The URL Rewrite tool can be used to create product and category rewrites, and custom rewrites
for any page in your store. When the rewrite goes into effect, any existing links that point to the
previous URL are seamlessly redirected to the new address.
URL rewrites can be used to add high-value keywords to improve the way the product is
indexed by search engines. You can also use rewrites to create additional URLs for a temporary
seasonal change, or permanent change. Rewrites can be created for any valid path, including
CMS content pages. Internally, the system always references products and categories by their
ID. No matter how often the URL changes, the ID remains the same. Here are some ways you
can use URL rewrites:
System URL

http://www.example.com/catalog/category/id/6
Original URL

http://www.example.com/peripherals/keyboard.html
Redirected Product URL

http://www.example.com/ergonomic-keyboard.html
Additional Category URLs

http://www.example.com/all-on-sale.html
http://www.example.com/save-now/spring-sale

URL Rewrites

Magento Community Edition 2.1 User Guide

503

Creating URL Rewrites

CHAPTER 32: URL Rewrites

Product Rewrites
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although
people might still navigate to the former page from search engines or outdated links, the
redirect causes your store to switch to the new target.
If automatic redirects are enabled for your store, there is no need to create a rewrite when a
product URL Key is changed.

Add URL Rewrite for Product

Process Overview:
Step 1. Plan the Rewrite
Step 2: Create the Rewrite
Step 3. Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the "redirect to" path and "redirect from" path. The path
includes the URL Key and suffix, if applicable.
If you're not sure, open each product page in your store, and copy the path from the address
bar of your browser. When creating a product redirect, you can either include or exclude the
category path. For this example, we create a product redirect without a category path.

Product with Category Path

504

Redirect to:

gear/bags/impulse-duffle.html

Redirect from:

gear/bags/overnight-duffle.html

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

Product without Category Path
Redirect to:

impulse-duffle.html

Redirect from:

overnight-duffle.html

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under Search & SEO, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available.
a.

In the search filter at the top of the Request Path column, enter the URL key of the page
that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

In the upper-right corner of the URL Rewrites page, tap Add URL Rewrite.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “For product.”

In the grid, find the product that is the target—or destination—of the redirect. Then, click the
row.

Add URL Rewrite for a Product
7.

Below the category tree, tap Skip Category Selection. For this example, the redirect does not
include a category.

Magento Community Edition 2.1 User Guide

505

Creating URL Rewrites

CHAPTER 32: URL Rewrites

Skip Category Selection
The Add URL Rewrite for a Product page displays a link to the target in the upper-left corner,
and the Target Path field displays the system version of the path, which cannot be changed.
Initially, the Redirect Path field also displays the target path.
a.

If you have multiple store views, set Store to the view where the rewrite applies Otherwise,
a rewrite will be created for each view.

In the Request Path field, type over the default entry, and enter the URL key and suffix—if
applicable—of the original product request. This is the "Redirect from" product that you
identified in the planning step.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

506

Set Redirect Type to one of the following:
l

Temporary (302)

Permanent (301)

For your own reference, enter a brief Description of the rewrite.

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

URL Rewrite Information
8.

Before saving the redirect, review the following:
l

The link in the upper-left corner displays the name of the target product.

The Request Path contains the path for the original "redirect from" product.

When complete, tap Save.
The new product rewrite now appears at the top of the URL Rewrites grid.

URL Rewrite Saved

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

Navigate to the original "redirect from" product request page.
In the address bar of the browser, enter the path to the original "redirect from" product
immediately after the store URL. Then, press Enter.

Magento Community Edition 2.1 User Guide

507

Creating URL Rewrites

CHAPTER 32: URL Rewrites

The new target product appears instead of the original product request.

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The product that is to be redirected. Depending on your configuration,
the Request Path might include the .html or .htm suffix, and
category.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error that the Request Path already exists,
delete the existing redirect, and try again.

Target Path

The internal path that is used by the system to point to the destination
of the redirect. The target path is grayed out and cannot be edited.

Redirect

Determines the type of redirect. Options :
No

No redirect is specified.
Many operations create redirect
requests of this type. For example,
every time you add products to a
category, a redirect of the "No" type
is created each store view.

Description

508

Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

Category Rewrites
If a category is removed from your catalog, you can use a category rewrite to redirect links to
the URL of another category in your store. Think in terms of "target" and "original request," or
"redirect to" and "redirect from." Although people might still navigate to the former page from
search engines or outdated links, the redirect causes your store to switch to the new target.
If automatic redirects are enabled for your store, there is no need to create a rewrite when a
category URL Key is changed.

URL Rewrite for Category

Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the "redirect to" path and "redirect from" path. The paths
should include the URL Key and suffix, if applicable.
If you're not sure, open each category page in your store, and copy the path from the address
bar of your browser.
Category Path

Redirect to:

gear/backpacks-and-bags.html

Redirect from:

gear/bags.html

Magento Community Edition 2.1 User Guide

509

Creating URL Rewrites

CHAPTER 32: URL Rewrites

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available,
a.

In the search filter at the top of the Request Path column, enter the URL key of the
category that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “For category.” Then in the category tree, choose the target category
that is the destination of the redirect.

Category Tree
5.

In the URL Rewrite section, do the following:
a.

If you have multiple stores, select the Store where the rewrite applies.

In the Request Path field, enter the URL key of the category that the customer requests.
This is the "redirect from" category.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

510

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

Set Redirectto one of the following:
l

Temporary (302)

Permanent (301)

For your reference, enter a brief description of the rewrite.

Category Rewrite Information
6.

Before saving the redirect, review the following:
l

The link in the upper-left corner displays the name of the target category.

The Request Path contains the path for the original "redirect from" category.

When complete, tap Save button.
The new category rewrite appears at the top of the URL Rewrites grid.

New Category Rewrite

Magento Community Edition 2.1 User Guide

511

Creating URL Rewrites

CHAPTER 32: URL Rewrites

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

Navigate to the original "redirect from" category.
In the address bar of the browser, enter the path to the original "redirect from" category
immediately after the store URL. Then, press Enter.

The new target category appears instead of the original category request.

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The category that is to be redirected. Depending on your
configuration, the Request Path might include the .html or .htm
suffix, and parent category.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error that the Request Path already exists,
delete the existing redirect, and try again.

Target Path

The internal path that is used by the system to point to the destination
of the redirect. The target path is grayed out and cannot be edited.

Redirect

Determines the type of redirect. Options :
No

No redirect is specified.
Many operations create redirect
requests of this type. For example,
every time you add products to a
category, a redirect of the "No" type
is created each store view.

512

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

Field Descriptions (cont.)
FIELD

Description

Magento Community Edition 2.1 User Guide

DESCRIPTION
Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

513

Creating URL Rewrites

CHAPTER 32: URL Rewrites

CMS Page Rewrites
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "source," or "redirect to" and "redirect from." Although people
might still navigate to the former page from search engines or outdated links, the redirect
causes your store to switch to the new target.

Add URL Rewrite

Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the URL key of the "redirect to" page and "redirect from" page.
If you're not sure, open each page in your store, and copy the path from the address bar of your
browser.

CMS Page Path

514

Redirect to:

new-page

Redirect from:

old-page

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available.
a.

In the search filter at the top of the Request Path column, enter the URL key of the page
that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “for CMS page.”

Find your new target page in the grid, and open in edit mode.

Custom URL Rewrite
6.

Under URL Rewrite Information, do the following:
a.

If you have multiple store views, select the Store where the rewrite applies.

In the Request Path field, enter the URL key of the original page that the customer
requests. This is the "redirect from" page.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

Set Redirectto one of the following:

Magento Community Edition 2.1 User Guide

515

Creating URL Rewrites

CHAPTER 32: URL Rewrites

Temporary (302)

Permanent (301)

For your reference, enter a brief description of the rewrite.

Custom URL Rewrite
7.

Before saving the redirect, review the following:
l

The link in the upper-left corner displays the name of the target page.

The Request Path contains the path for the original "redirect from" page.

When complete, tap Save.
The new rewrite appears in the grid at the top of the list.

Saved URL Rewrite

516

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

Navigate to the original "redirect from" page.
In the address bar of the browser, enter the name of the original "redirect from" page
immediately after the store URL. Then, press Enter.

The new target page appears instead of the original page request.

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The CMS page that is to be redirected.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error message that the Request Path
already exists, delete the existing redirect, and try again.

Target Path

The internal path that is used by the system to point to the
destination. The target path is grayed out and cannot be edited.

Redirect

Determines the type of redirect. Options :

Description

Magento Community Edition 2.1 User Guide

No redirect is specified.

Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

517

Creating URL Rewrites

CHAPTER 32: URL Rewrites

Custom Rewrites
A custom rewrite can be used to manage miscellaneous redirects, such as redirecting a page
from your store to an external website. For example, you might have two Magento websites,
each with their own domain. You can use a custom redirect to reroute requests for a product,
category, or page to the other website. Unlike other redirect types, the target of a custom
redirect is not chosen from a list of existing pages in your store.
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although
people might still navigate to the former page from search engines or outdated links, the
redirect causes your store to switch to the new target.

Add URL Rewrite

Process Overview:
Step 1: Plan the Rewrite
Step 2: Create the Rewrite
Step 3: Test the Result

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the URL of the "redirect to" page, and the URL key of the
"redirect from" page.
If you're not sure, open each page, and copy the URL from the address bar of your browser.
Custom Path

518

Redirect to:

http://www.different-website.com/page.html

Redirect from:

cms-page

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

category.html
category/subcategory.html
product.html
category/product.html

Step 2: Create the Rewrite
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.

Before you proceed, do the following to verify that the "request path" is available:
a.

In the search filter at the top of the Request Path column, enter the URL key of the page
that is to be redirected. Then, tap Search.

If there are multiple redirect records for the page, find the one that matches the applicable
store view. Then, open the redirect record in edit mode.

In the upper-right corner, tap Delete. When prompted, tap OK to confirm.

When you return to the URL Rewrites page, tap Add URL Rewrite.

Set Create URL Rewrite to “Custom.”

Under URL Rewrite Information, do the following:
a.

If you have multiple store views, select the Store where the rewrite applies.

In the Request Path field, enter the URL key and path—if applicable—of the product,
category, or CMS page that is to be redirected.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

In the Target Path field, enter the URL of the destination. If the target is located on
another website, enter the fully qualified URL.

Set Redirectto one of the following:

Temporary (302)

Permanent (301)

For your reference, enter a brief description of the rewrite.

Magento Community Edition 2.1 User Guide

519

Creating URL Rewrites

CHAPTER 32: URL Rewrites

Custom URL Rewrite
6.

Before saving the redirect, review the following:
l

The Request Path contains the URL key or path of the original "redirect from" page.

The Target Path contains the URL of the "redirect to" page.

When complete, tap Save.
The new rewrite appears in the grid at the top of the list.

Saved URL Rewrite

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

520

Navigate to the original "redirect from" page.
In the address bar of the browser, enter the name of the original "redirect from" page
immediately after the store URL. Then, press Enter.

Magento Community Edition 2.1 User Guide

CHAPTER 32: URL Rewrites

Creating URL Rewrites

The new target page appears instead of the original page request.

Field Descriptions
FIELD
Create URL Rewrite

DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the
rewrite is created. Options:
Custom
For category
For product
For CMS page

Request Path

The path to the product, category, or CMS page that is to be
redirected. Depending on your configuration, the Request Path might
include the .html or .htm suffix.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error that the Request Path already exists,
delete the existing redirect, and try again.

Target Path

The path or URL that is the destination of the redirect.

Redirect

Determines the type of redirect. Options :
No

No redirect is specified.
Many operations create redirect
requests of this type. For example,
every time you add products to a
category, a redirect of the "No" type
is created each store view.

Description

Magento Community Edition 2.1 User Guide

Temporary (302)

Indicates to search engines that the
rewrite is for a limited time. Search
engines generally do not retain page
rank information for temporary
rewrites.

Permanent (301)

Indicates to search engines that the
rewrite is permanent. Search engines
generally retain page rank
information for permanent rewrites.

Describes the purpose of the rewrite for internal reference.

521

522

Magento Community Edition 2.1 User Guide

CHAPTER 33:

Google Tools
Your store configuration is integrated with the following Google tools to help optimize your
content, analyze your traffic, and connect your catalog to shopping aggregators and
marketplaces.
l

Google Analytics

Google Adwords

Magento Community Edition 2.1 User Guide

523

Google Analytics

CHAPTER 33: Google Tools

Google Analytics
Google Universal Analytics gives you the ability to define additional custom dimensions and
metrics for tracking, with support for offline and mobile app interactions, and access to
ongoing updates.

Google Analytics

Process Overview:
Step 1: Sign Up for Google Universal Analytics
Step 2: Complete the Magento Configuration

Step 1: Sign Up for Google Universal Analytics
Visit the Google website, and sign up for a Google Universal Analytics account.

Step 2: Complete the Magento Configuration
1.

Return to your store, and log in to the Admin. On the Admin sidebar, tap Stores. Then under
Settings, choose Configuration.

In the panel on the left, under Sales, choose Google API.

Expand

524

the Google Analytics section. Then, do the following:

Set Enable to “Yes.”

Enter your Google Analytics Account Number.

If you want to conduct A/B testing and other performance tests on your content, set
Content Experiments to “Yes.”

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 33: Google Tools

Google AdWords

Google AdWords
Google AdWords is a service that you can use to place ads in Google Search results and on the
pages of companies in the Google Display Network. The AdWords dashboard includes tools to
manage your campaigns, track response, and measure results.
Conversion tracking shows how many ad clicks lead to a sale or other valuable action. The
"Success" page that appears to your customer after an order has been submitted is used to track
conversions because it appears only after a sale. After completing the Google AdWords
configuration for your store, there is no need to copy the conversion tracking script to the
"Success" page, because Magento already has the necessary information. To learn more, see
Google AdWorlds Help.

Magento Ad in Google Search Results

Step 1: Create a Google AdWords Campaign
1.

Visit Google AdWords, and sign up for an account.

Follow the instructions to create a campaign.

To set up conversion tracking for your campaign, do the following:
a.

On the Tools tab of your AdWords dashboard, choose Conversions. Then, tap
Conversion.

When prompted for the conversion source, choose Website

Enter a name for the conversion action that you want to track. Then, tap Done.

Click Value. Then if applicable, assign a value to the conversion. For example,
l

If you make $5 on each sale, choose "Each time it happens," and assign a value of $5.

If the value of each sale varies, leave the value blank.

Then, tap Done.
e.

Tap Conversion windows, and complete the settings to determine how long the conversions
are to be tracked, the reporting category, and attribution model.

Magento Community Edition 2.1 User Guide

525

Google AdWords

CHAPTER 33: Google Tools

When complete, tap Save and Continue.

Step 2: Get Your Conversion Tag
1.

Under Install your tag, choose to count conversions on Page load.

As an option, you can add the Google Site Stats notification to the conversion page. The
notification appears in the lower corner with a link to Google's security standards and cookie
usage.

To choose how you want to manage the your AdWords tag, do one of the following:
l

If you plan to add the script to your store yourself, choose Save instructions and tag.
If you plan to have someone else add the script to your store , choose Email instructions
and tag.

When complete, tap Done.

Step 3: Configure Your Store
1.

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

If configuring Google AdWords tor a specific store view, do the following:

In the upper-left corner, choose the Store View that is to be configured.

When prompted to confirm scope switching, tap OK.

In the panel on the left, under Sales, choose Google API. Then, expand

the Google

AdWords section and do the following:

526

If necessary, clear the Use Website checkbox for each setting to be changed.

Set Enable to “Yes.”:

Enter the Conversion ID from your Google AdWords script.

Magento Community Edition 2.1 User Guide

CHAPTER 33: Google Tools

Google AdWords

Google AdWords
4.

To format the Google Sites Stat notification, do the following:
a.

Set Conversion Language to the language that is identified in your Google AdWords
script.

Enter the Conversion Format to be used for the Google Sites Stat notification on the
conversion page.
1

Displays a one-line notification with a link to more information about Google
tracking.

Displays a two-line notification with a link to more information about Google
tracking.

Displays no customer notification.

Enter the hexadecimal code for the Conversion Color that you want to use for the Google
Site Stats notification label.

Enter the encrypted text for the Conversion Label that appears on the Google Sites Stat
notification.
For example: MlEYCOKBnGoQz6CZoAM

Sample Google AdWords Tag Code

Set Conversion Value Type to one of the following:
Dynamic

Determines that a conversion has occurred based on the dynamic Order
Amount value.

Constant

Determines that a conversion has occurred based on a specific value
entered.

For a Constant conversion value type, enter a specific Value for the Order Amount to qualify as
a conversion.
6.

When complete, tap Save Config.

Step 4: Verify the Configuration
Within a few hours, the tracking status in your Google AdWords dashboard changes from
"Unverified" to "No recent conversions" or "Recording conversions." When someone clicks your
ad and makes a purchase, the conversion appears on the Conversion Actions page of your
dashboard and campaign report.

528

Magento Community Edition 2.1 User Guide

CONTENT

529

Content Elements
In this section of the guide, you’ll learn how to
create and manage content pages and blocks,
and use variables and widgets to add dynamic
content.

Content Menu
Pages
Core Content Pages
Workspace Controls
Adding a New Page
Using the Editor
Inserting a Link
Inserting an Image
Inserting a Widget
Inserting a Variable
Configuring the Editor
Adding a Lightbox or Slider
Using Media Storage
Blocks
Adding a New Block
Adding Social Plugins
Positioning Blocks on a Page
Widgets
Widget Types
Creating a Widget
New Products List
Design & Theme

530

CHAPTER 34:

Content Menu
The term content marketing1 refers to the art of promoting your products or services by
providing valuable information to your customers at no charge. The quality of your content
helps distinguish your store from others, increases your visibility to search engines, and
provides support to your customers. This soft-sell approach is often more effective than
advertising, builds credibility and trust, and can turn your store into a destination. Content is
still king.
Your content should reflect the branding of your store, and be delivered with your distinctive
visual presentation and voice to convey your message. Use pictures to tell a story. Educate,
inspire, and entertain. Keep in mind that with quality content, sometimes less is more.

Content Menu

To display the Content menu:
On the Admin sidebar, tap Content .

1The art of promoting products or services by providing valuable information at no charge.

Magento Community Edition 2.1 User Guide

531

CHAPTER 34: Content Menu

Menu Options

Pages
Create pages with text, images, blocks, variables, and
widgets, that can be incorporated into the navigation of
your store, and linked to other pages.

Blocks
Create blocks of content without writing any code.
Blocks can contain text, images, and even video, and
can be assigned to any part of the page layout.

Widgets
Display dynamic data and add blocks, links, and
interactive elements most anywhere in your store.

532

Magento Community Edition 2.1 User Guide

CHAPTER 34: Content Menu

Design
Learn to manage the visual presentation of your store,
apply themes, and schedule design changes.

Magento Community Edition 2.1 User Guide

533

534

Magento Community Edition 2.1 User Guide

CHAPTER 35:

Pages
All content can be viewed in terms of its shelf life, just as any product in a store. Did you know
that the shelf life of social media content is less than twenty-four hours? The potential shelf life
of the content you create can help you decide where to invest your resources.
Content with a long shelf life is sometimes referred to as evergreen content1. Examples of
evergreen content include customer success stories, "how to" instructions, and Frequently
Asked Questions (FAQ.) In contrast, content is perishable by nature includes events, industry
news, and press releases.

1Content that has a long shelf life.

Magento Community Edition 2.1 User Guide

535

Core Content

CHAPTER 35: Pages

Core Content
The Magento demo store has examples of core content pages to help you get started. Take a
look at the following pages in your store, to make sure that the content conveys your message,
voice, and brand.

Content Pages

Home
The demo “Home” page includes a banner, an image
carousel, several static blocks with links, and a list of
new products.

About Us
The “About Us” page is linked from the footer of your
store. You can include images, video, links to press
releases and announcements. The sample page has an
image on the right, and one of a decorative sort to
indicate the end of the page.

536

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Core Content

Customer Service
The “Customer Service” page is another node in the
page hierarchy. The two headers on the page have
content that only becomes visible when the header is
clicked.

Privacy Policy
Your store’s “Privacy Policy” page should be updated
with your own information. As a best practice, your
privacy policy should explain to your customers the
type of information that your company collects and
how it is used.

404 Not Found
The “404 Page Not Found” page is named for the
response code that is returned when a page cannot be
found. URL redirects reduce the number of times that
this page appears. However, for those times when it is
necessary, you might as well take advantage of the
opportunity to offer some links to products that the
customer might find interesting.

Magento Community Edition 2.1 User Guide

537

Core Content

CHAPTER 35: Pages

Enable Cookies
The “Enable Cookies” page appears when visitors to
your site do not have cookies enabled in their
browsers. The page provides step-by-step, illustrated
instructions to enable cookies for the most popular
browsers.

Service Unavailable
The “503 Service Unavailable" page is named for the
response code that is returned when the server is
unavailable.

538

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Core Content

Default Pages
The Default Pages configuration determines the landing page that is associated with the base
URL, and the corresponding home page. It also determines which page appears when a “Page
Not Found” error occurs, and if a breadcrumb trail appears at the top of each page.

To configure the default pages:
1.

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

In the panel on the left under General, choose Web.

Expand

the Default Pages section. Then, do the following:

Default Pages
a.

In the Default Web URL field, enter the relative path to the folder in the Magento
installation that contains the landing page. The default value is “cms.”
For a specific store view, clear the Use Default checkbox next to the Default Web URL field,
and any other default fields to be changed.

Set CMS Home Page to the CMS page to be used as the home page.

In the Default No-route URL field, enter the relative path to the folder in the Magento
installation where the page is redirected when a “404 Page Not Found” error occurs. The
default value is “cms/index/noRoute.”

Set CMS No Route Page to the CMS page that appears when a “404 Page Not Found”
error occurs.

Set CMS No Cookies Page to the CMS page that appears when cookies are disabled in the
browser.

If you want a breadcrumb trail to appear at the top of all CMS pages, set Show
Breadcrumbs for CMS Pages to “Yes.”

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

539

Workspace Controls

CHAPTER 35: Pages

Workspace Controls
The page workspace includes tools to help you quickly find the pages you need, and commands
to perform routine maintenance on individual or multiple pages. You can also quickly update
page properties from the grid.

Pages Grid

To quickly update page properties:
1.

Click any row in the grid. To select multiple records, mark the checkbox of each row that you
want to update.

Update Page Properties
2.

540

Update any of the following properties:
l

Title

URL Key

Status

Layout

When complete, tap Save.

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Workspace Controls

Workspace Controls
CONTROL
Add New Page

DESCRIPTION
Adds a new page.

Initiates a catalog search based on the current filters.

Actions

Lists all actions that can be applied to selected items in the list. To
apply an action to a page, or to multiple pages, mark the checkbox in
the first column of each record that is subject to the action. Options:
Delete
Disable
Enable
Edit

Select

The control in the header of the first column can be used to select
multiple records as the target of action. Mark the checkbox in the first
column of each record that you want to select. Options: Select All /
Deselect All
Save Edits

Edit

Magento Community Edition 2.1 User Guide

Applies the current action to selected records.
Opens the record in edit mode. You can accomplish the same thing
by clicking anywhere on the row.

541

Workspace Controls

CHAPTER 35: Pages

Columns
COLUMN
Select

DESCRIPTION
The checkbox in the first column is used to select multiple records:
Options:
Select All
Deselect All

The ID is an incrementing number that is assigned to each page.

Title

The page title appears at the top of each page.

URL Key

The URL key is similar to a file name, and identifies the page in the
URL.

Layout

Determines if the page appears with sidebars to the right or left of the
main content area. Options:
1 column
2 columns with left bar
2 columns with right bar
3 columns
Empty

542

Store View

Can be used to associate the page with a specific store view.

Status

Indicates if the page is currently online or offline. Options: Enabled /
Disabled

Created

The date the page was created.

Modified

The data the page was last modified.

Action

The actions that can be applied to an individual record include:
Edit

Opens the page in edit mode.

Delete

Deletes the page.

View

Displays the page in preview mode.

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Workspace Controls

Page Search
The Search box in the upper-left of the page grid can be used to find specific pages by keyword.
For a more advanced search, you can filter the search by multiple parameters.

Keyword Search Results

To search by keyword:
1.

Enter a search term into the page search box.

Tap Search (

) to display the results. The results include all pages that contain the keyword.

Magento Community Edition 2.1 User Guide

543

Workspace Controls

CHAPTER 35: Pages

To filter search:
1.

If necessary, click Clear All to clear the previous search criteria.

Tap the Filters (

Complete as many of the filters as necessary to describe the page(s) that you want to find.

Tap Apply Filters to display the results.

) tab to display the selection of search filters.

Filtered Search

544

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Workspace Controls

Search Filters
FILTER

DESCRIPTION

Filter the search by page record ID.

Title

Filter the search based on the page title.

URL Key

Filter the search by the URL Key.

Created

Filter the search by the date the page was created.

Modified

Filter the search based on the date the page was last modified.

Store View

Filter the search based on store view. Options: (All available Store
Views)

Layout

Filter the search based on page layout. Options:
1 column
2 columns with left bar
2 columns with right bar
3 columns
Empty

Status

Filter the search on the page status. Options: Disables / Published
Apply Filters
Cancel

Clear All

Magento Community Edition 2.1 User Guide

Applies all filters to the search.
Cancels the current search.
Clears all search filters.

545

Workspace Controls

CHAPTER 35: Pages

Page Actions
Pages can be edited, disabled, enabled, and deleted. To apply an action to an individual page,
mark the checkbox in the first column. To select or deselect all pages, use the mass actions
control at the top of the column.

Page Actions

To apply an action:
The Action column on the far right can be used to apply any of the following actions to the
individual page:
l

Edit

Delete

View

Single Page Actions

546

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Workspace Controls

Page Grid Layout
The selection of columns and their order in the grid can be changed according to your
preference. To keep the new column arrangement, you can save it as a view.

Moving a Column

To change the selection of columns:
In the upper-right corner, tap the Columns ( ) control. Then, do the following:
l

Mark the checkbox of any column you want to add to the grid.

Clear the checkbox of any column you want to remove from the grid.

To move a column:
1.

Tap the header of the column, and hold.

Drag the column to the new position, and release.

Magento Community Edition 2.1 User Guide

547

Workspace Controls

CHAPTER 35: Pages

To save a view:
1.

Tap the View (

) control. Then, tap Save Current View.

Save Current View
2.

Enter a name for the view. Then, click the arrow (

) to save all changes. The name of the view

now appears as the current view.

To change the view:
Tap the View (

) control. Then, do one of the following:

Choose the view that you want to use.

To change the name of a view, tap the Edit (

) icon. Then, update the name.

Choose a View

548

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Adding a New Page

Adding a New Page
The process of adding a new content page to your store is essentially the same for any type of
page you might want to create. You can include text, images, blocks of content, variables, and
widgets. Most content pages are designed to be read by search engines first, and by people
second. Keep the needs of each of these two very different audiences in mind when choosing the
page title, and URL, and when composing the meta data, and content.
The following instructions walk you through each step to create a basic page. Some advanced
features are skipped over, but are covered in other topics.

Pages

Process Overview:
Step 1: Add a New Page
Step 2: Complete the Content
Step 3: Complete the SEO Information
Step 4: Define the Scope
Step 5: Make Design Changes (Optional)
Step 6: Preview the Page
Step 7: Publish the Page

Step 1: Add a New Page
1.

On the Admin sidebar, tap Content. Then under Elements, choose Pages.

Tap Add New Page.

Magento Community Edition 2.1 User Guide

549

Adding a New Page

CHAPTER 35: Pages

New Page
3.

On the new page, do the following:
a.

By default, a new page is published when the record is saved. If you do not want to
publish the page immediately, set Enable Page to "No."

Enter the Page Title. The Page Title is the name that appears in the breadcrumb trail
navigation.

To schedule design changes, expand

the Custom Design Update section. Then, do the

following:
a.

Use the calendar (

) to choose the From and To dates when the design change is to be in

effect.
b.

If applicable, set New Theme to a different theme that is to be used for the page.

If applicable, set New Layout to one of the following:
l

1 column

2 columns with left bar

2 columns with right bar

3 columns

Empty

Custom Design Update

550

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Adding a New Page

Step 2: Complete the Content
1.

Expand

the Content section.

Content
2.

In the Content Heading box, type the heading that you want to appear at the top of the page.

By default, the editor opens in WYSIWYG mode with the toolbar at the top.
l

If you prefer to work directly with the HTML code, tap Show / Hide Editor.

Complete the content and format the text as needed. You can add images, variables, and
widgets as needed. To learn more, see: Using the Editor.

Tap Save and Continue Edit.

Step 3: Complete the SEO Information
1.

Expand
a.

the Search Engine Optimization section. Then, do the following:

When the page was saved, a default URL key was created that is based on the Content
Heading. You can accept the default, or enter another URL Key that consists of all
lowercase characters, with hyphens instead of spaces.

Enter a Meta Title for the page. The Meta Title should be less than seventy characters in
length, and appears in the browser title bar and tab.

Enter your choice of high-value Meta Keywords that search engines can use to index the
page. Separate multiple words with a comma. Meta keywords are ignored by some search
engines, but used by others.

In the Meta Description field, enter a brief description of the page for search results
listings. Ideally, the description should be from 150-160 characters in length, with a
maximum limit of 255.

Magento Community Edition 2.1 User Guide

551

Adding a New Page

CHAPTER 35: Pages

Search Engine Optimization
2.

Tap Save and Continue Edit.

Step 4: Define the Scope of the Page
1.

Expand

the Page in Websites section.

In the Store View list, select each view where the page is to be available. If the installation has
multiple websites, select each website and store view where the page is to be available.

Pages in Websites

Step 5: Enter Any Design Changes (Optional)
1.

Expand the

Design section. Then, do the following:

Design

552

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Adding a New Page

To change the page layout, set Layout to one of the following:
l

1 column

2 columns with left bar

2 columns with right bar

3 columns

Empty

To include additional layout instructions, enter valid XML code in the Layout Update
XML box.

Step 6: Preview the Page
1.

To return to the Pages grid, tap Save Page.

Fnd the page in the grid. Then in the Action column, select View.

To return to the grid, tap Back in the upper-left corner of the browser window.

Step 7: Publish the Page
1.

In the Action column of the grid, select Edit.

Set Enable Page to "Yes."

Tap Save Page .
Now that your page is complete, it can be added to your store navigation, linked to other
pages, or added as a link in the footer of your store. You can also use it as your new home
page.

Magento Community Edition 2.1 User Guide

553

Adding a New Page

CHAPTER 35: Pages

Switching Home Pages
You can maintain a selection of different home pages, and activate the page that you want to
use as the default home page.

To Change the Home Page:
1.

Complete the steps to add a new page.

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

In the panel on the left under General, choose Web.

Expand

the Default Pages section. Then, do the following:

Default Pages

Set CMS Home Page to the new page.

Tap Save Config.

In the message at the top of the workspace, tap the Cache Management link, and refresh any
invalid caches.

554

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Media Storage

Media Storage
Media storage helps you organize and gain access to media files that are stored on the server.
The path to the location of the files is determined by the Base URL configuration. Files in
media storage can be accessed from the editor while working on pages and static blocks. Media
storage is usually located in the file system on the same server as the Magento program files.
Alternatively, media files can be managed in a database, or located on a separate server or
content delivery network. The editor can be configured to use either static or dynamic media
URLs for catalog content in category or product descriptions.

Media Storage

To insert an image from media storage:
Open the page or block to be edited. Then, use one of the following methods to insert an image
from media storage:

Method 1: From WYSIWYG Mode
1.

On the toolbar of the WYSIWYG editor, click Insert Image (

After the Image URL field, click Browse (

Magento Community Edition 2.1 User Guide

555

Media Storage

CHAPTER 35: Pages

Insert Image (WYSIWYG Mode)
3.

In the directory tree on the left, navigate to the folder where the image is stored.

Select the tile of the image. Then, tap Insert File.

Insert File

Method 2: From HTML Mode
1.

Position the cursor in the code where the tag is to be inserted.

Tap Insert Image.

Insert Image (HTML Mode)

556

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Media Storage

To upload files to media storage:
The first two steps are the same as if you are inserting an image.
1.

On the toolbar of the WYSIWYG editor, click Insert Image (

After the Image URL field, click Browse (

In the directory tree on the left, do one of the following:
l

Navigate to the folder where you want to save the uploaded image.
Navigate to the place where you want to create a new folder, and tap Create Folder. Then,
enter the folder name, and tap OK.

To upload file(s) to media storage, tap Choose Files . Then, do the following:
a.

In the directory of your local computer, navigate to the location of the images.

Select each image that is to be uploaded.

Tap Open.
The images are uploaded to the current media storage folder on the server.

Media Storage

Magento Community Edition 2.1 User Guide

557

Using the Editor

CHAPTER 35: Pages

Using the Editor
The WYSIWYG editor gives you the ability to enter and format while working in a “What You
See Is What You Get” view of the content. If you prefer to work directly with the underlying
HTML code, you can easily change modes. The editor can be used to create content for pages,
blocks, and product descriptions. When working in the product catalog, the editor is accessed
by clicking the WYSIWYG Editor button. For a complete list of toolbar buttons, see: Using the
Editor in the online guide.

Editor Toolbar

Inserting a Link
An easy way to insert a link is to use the Link button in the editor toolbar. It doesn’t require
any knowledge of HTML, and the result is the same.

To insert a link:
1.

Highlight the text where you want to create the link. Then, in the editor toolbar, tap the Link
button.

Insert Link Button
2.

558

In the Link URL field, enter one of the following:
l

The URL Key of a page in your store.

The full URL of an external page to be linked.

Set Target to one of the following:
l

Open link in the same window

Open in a new window

In the Title field, enter the tooltip text to appear when someone hovers over the link.

Tap Insert to create the link.

Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Using the Editor

Inserting an Image
From the editor, you can insert an image that has been uploaded to Media Storage, or link to
an image that resides on another server.

Media Storage

Method 1: Insert an Image from Media Storage
1.

If necessary, tap Show / Hide Editor to work directly with the code.

Position the cursor where you want the code for the image to be inserted. Then, tap Insert
Image.

Choose the image that you want to use, and tap Insert File .

To view the image in WYSIWYG mode, tap Show / Hide Editor again.

Method 2: Insert an Image from Another Server
Use this method to insert an image that is available online, but resides on another server. You
must have the full URL of the image to complete the process.
1.

If necessary, tap Show / Hide Editor to work in WYSIWYG mode.

Position your cursor where you want the image to appear.

On the Editor toolbar, tap the Insert Image button. Then, do the following:

Magento Community Edition 2.1 User Guide

559

Using the Editor

CHAPTER 35: Pages

Insert Image Button

In the Image URL field, paste the full URL to the image on the other server.

In the Image Description field, enter a brief description of the image.

In the Title field, enter a relevant title for the image.

Tap Insert to complete the process.

Inserting a Widget
The Widget tool can be used to add a variety of content elements to the page, including links to
any content page or node, product, or category. Links can be positioned on the page in a block
format, or incorporated directly into the content. You can use the Widget tool to create links to
the following types of content:
l

Content Pages

Catalog Categories

Catalog Products

By default, links inherit their style from the style sheet of the theme.

To insert a widget:
1.

Open the content page to be edited.

In the panel on the left, choose Content. Then, use either of the following methods:

Method 1: WYSIWYG Mode
1.

Tap Show / Hide Editor to work in WYSIWYG mode.

Position the cursor in the text where you want the widget to appear.

On the editor toolbar, tap Insert Widget.

Method 2: HTML Mode
From the HTML editor, tap Insert Widget.
3.

When prompted, choose the Widget Type. This example shows how to insert a link to a
product.

4.
560

To use the product name, leave the Anchor Custom Text field empty.
Magento Community Edition 2.1 User Guide

CHAPTER 35: Pages

Using the Editor

Enter a Anchor Custom Title for best SEO practice. (The title isn't visible on the page.)

Set Template to one of the following:

To incorporate the link into text, select “Product Link Inline Template.”

To place the link on a separate line, select “Product Link Block Template.”

Tap Select Product, and do the following:
a.

In the tree, navigate to the category you want.

In the list, choose the linked product.

Click Insert Widget to place the link on the page. In the HTML, a markup tag for the link
appears at the top of the page, enclosed in double curly braces.

If needed, use Cut (Ctrl + x) and Paste (Ctrl + v) to position the markup tag in the code
where you want the link to appear.

Tap Show / Hide Editor to see the link in WYSIWYG mode.
You can continue editing the page, and incorporate other links into the content.

Inserting a Variable
Your store includes many predefined variables that can be incorporated into content pages and
other communications.

To insert a variable on a page:
1.

Do one of the following:
l

Open an existing page.

Create a new page.

In the panel on the left, choose Content. Then from the editor, do one of the following:
l

Position the cursor where you want the variable to appear, and tap Insert Variable.
If you prefer to work with the code, click Show / Hide Editor. Position the insertion point in
the text where you want the variable to appear. Then, tap Insert Variable.

In the list of available variables, choose the one you want to insert into the page.

When complete, tap Save.

Magento Community Edition 2.1 User Guide

561

Using the Editor

CHAPTER 35: Pages

Configuring the Editor
The WYSIWYG editor is enabled by default, and can be used to edit content on CMS pages and
blocks, and in products and categories. From the configuration you can activate or deactivate
the editor, and elect to use static—rather than dynamic— URLS for media content in product
and category descriptions.

WYSIWYG Options

To configure the editor:
1.

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

In the panel on the left under General, choose Content Management.

Expand

562

the WYSIWYG Options section, and do the following:

Set Enable WYSIWYG Editor to your preference. The editor is enabled by default.

Set Static URLs for Media Content in WYSIWYG for Catalog to your preference for media
content that is included in category and product field descriptions.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 36:

Content Blocks
A block is a modular unit of content that can be positioned most anywhere on the page.
Content blocks are sometimes referred to as static blocks, or CMS blocks, and can be used to
display fixed information such as text, images, and embedded video, as well as dynamic
information from a widget or that originates in a database or other source. Most elements on
the home page are blocks that can be easily managed.
You can create custom blocks of content without writing any code, and assign them to appear
in a specific place in the page layout. Blocks can also be defined and positioned by making a
layout update in XML code.

Blocks on Home Page

Magento Community Edition 2.1 User Guide

563

Adding New Blocks

CHAPTER 36: Content Blocks

Adding New Blocks
Custom blocks of content can be added to any page, group of pages, or even to another block.
You can place code for a carousel image slider in a block, and then position the block on the
home page.
The Blocks workspace uses the same basic controls as the Pages workspace to help you find
blocks and perform routine maintenance operations.

Blocks Workspace

564

Magento Community Edition 2.1 User Guide

CHAPTER 36: Content Blocks

Adding New Blocks

To create a block:
1.

On the Admin sidebar, tap Content. Then under Elements, choose Blocks.

In the upper-right corner, tap Add New Block. Then, do the following:

New Block
a.

By default the status of the new block is enabled. If you want to change the status, set
Enable Block to “No.”

Assign a Block Title for internal reference.

Assign a unique Identifier for the block. Use all lowercase characters, with underscores
instead of spaces.

Select each Store View where the block is to be available.

Complete the block Content as needed.
l

Use the editor to format text, create links and tables, images, video, and audio.

If you prefer to work with the HTML code, tap Show / Hide Editor.

When complete, tap Save Block.
The new block appears at the bottom of the list in the Blocks grid.

Magento Community Edition 2.1 User Guide

565

Adding New Blocks

CHAPTER 36: Content Blocks

Adding Social Plugins
Social networking sites have a numerous oplugins that can easily be added to your store. In
addition, there are many extensions on Magento Connect that can be used to integrate your
store with social media. The following example shows how to add a Facebook “Like” button to
your store.

Facebook Plugins

Step 1: Get the Button Code
1.

On the Facebook website, go to the button setup page.

In the URL to Like field, enter the URL of the page in your store that you want people to Like.
For example, you might enter the URL of your store’s home page. Then, do the following:

566

Choose the Layout for the button.

Enter the Width in pixels that is available on your site for the button and any associated
text message.

Set Action Type to one of the following:
l

Recommend

Tap Get Code to copy the generated code to the clipboard.

Magento Community Edition 2.1 User Guide

CHAPTER 36: Content Blocks

Adding New Blocks

Like Button Setup

Step 2: Create a Content Block
1.

Return to your store. On the Admin sidebar, tap Content. Then under Elements, choose
Blocks.

In the upper-right corner, click tap Add New Block. Then, do the following:
a.

Enter a descriptive Block Title for internal reference. For example: Facebook Like Button.

Assign a unique Identifier to the block, using all lowercase characters, and underscores
instead of spaces. For example: facebook_like_button.

If your Magento installation has multiple store views, choose each Store View where the
block is to be available.

Paste the snippet of code that you copied from the Facebook site into the Content box.

If the block is not ready to “go live,” set Enable Block to “No.”

When complete, tap Save Block.

Step 3: Place the Block
1.

On the Admin sidebar, tap Content. Then under Elements, choose Widgets.

In the upper-right corner, tap Add Widget. Then, do the following:

In the Settings section, set Type to “CMS Static Block.” Then, tap Continue.

Verify that Design Theme is set to the current theme.

Tap Continue.

In the Storefront Properties section, do the following:

Magento Community Edition 2.1 User Guide

567

Adding New Blocks

CHAPTER 36: Content Blocks

In the Widget Title field, enter a title for internal reference.

Set Assign to Store Views to “All Store Views,” or to the view where the app will be
available. To select more than one, hold the Ctrl key down and select each option.

Enter a number in the Sort Order field to determine the order of the block if it assigned to
appear in the same location on the page as other content elements. The top position is
zero.

In the Layout Updates section, tap Add Layout Update. Then, set Display On to the category,
product, or page where you want the block to appear.
For example, if you choose “All Pages,” and position the block in either the header or footer, the
block will appear in the same place on every page of the store.
To place the block on a specific page, do the following:
a.

Set Display On to “Specified Page.” Then, select the Page where you want the block to
appear.

Choose the Block Reference to identify the place on the page where the block is to be
placed.

Accept the default setting for Template, which is set to "CMS Static Block Default
Template."

Tap Save and Continue Edit.

In the panel on the left, choose Widget Options.

Tap Select Block…. Then in the list, choose the block that you want to place.

When complete, tap Save.

When prompted, follow the instructions at the top of the workspace to update the index and
page cache.
The widget now appears in the Widgets grid.

Step 4: Verify the Location in Your Store
Return to your storefront to verify that the block is in the correct location. To move the block,
you can reopen the widget try a different page or block reference.

568

Magento Community Edition 2.1 User Guide

CHAPTER 36: Content Blocks

Adding New Blocks

Adding a Lightbox or Slider
There is a wide assortment of jQuery-based image lightboxes, sliders, and carousels available
on Magento Marketplace, and some are free. A recent search on the term “slider” returned thirythree results.

Slider Extensions
To add a lightbox or slider to your store, download the extension from Magento Markeplace,
and follow the instructions from the developer.

Magento Community Edition 2.1 User Guide

569

Positioning Blocks

CHAPTER 36: Content Blocks

Positioning Blocks
The code that controls the page layout and placement of blocks is written in XML Widgets
make it easy to position a block at a specific place on the page, and even for a specific product
or category without writing any code. You can choose each option from a list, rather than
trying to remember all of the possible combinations.
The following list shows the locations by page type where blocks are typically placed. To learn
more about how areas on the page are defined, see: Standard Page Layouts.

Category and CMS Pages
BLOCK REFERENCE

570

POSITION

Breadcrumbs

The navigation aid at the top of many pages that shows your current
location as a link. Any additional content placed in the Breadcrumbs
reference floats to the right of the breadcrumbs, if displayed.

Left Column

Content is added to the left column.

Main Content Area

Content is added to the main content area.

My Cart Extra Actions

Content appears below the Cart Subtotal in the My Cart popup
located within the top link.

Navigation Bar

Content appears below the main navigation bar.

Page Bottom

Content appears at the bottom of the page.

Page Footer

Content appears above the footer of the page.

Page Header

Content appears below the header of the page.

Page Top

Content appears at the top of the page.

Right Column

Content appears in the right column.

Store Language

Content appears in the upper-left corner of the header.

Magento Community Edition 2.1 User Guide

CHAPTER 36: Content Blocks

Positioning Blocks

Product Page
BLOCK REFERENCE

POSITION

Alert URLs

Content appears below the title of the product on the product detail
page.

Bottom Block Options
Wrapper

If custom options are added, content appears below the Add to Cart
button.

Breadcrumbs

Content appears to the right of breadcrumbs—the navigation aid that
provides links as a path—that’s showcased below the navigation
bar.

Info Column Options
Wrapper

If a custom options are added, content appears to the right. The
same location applies to configurable options.

Left Column

Content appears below the left column blocks.

Main Content Area

Content appears below the main content area.

My Cart Extra Actions

Content appears below the Cart Subtotal in the My Cart popup
located within the top link.

Navigation Bar

Content appears below the main navigation bar.

Page Bottom

Content appears at the bottom of the page.

Page Footer

Content appears above the footer of the page.

Page Header

Content appears below the header of the page.

Page Top

Content appears at the top of the page.

PayPal Express Checkout
(Payflow Edition) Shortcut
Wrapper

If the PayPal payment method is enabled, content appears below the
PayPal buy button.

PayPal Express Checkout
Shortcut Wrapper

If the PayPal payment method is enabled, content appears below the
PayPal buy button.

Product Tags List

Content appears below the products tag bar.

Product View Extra Hint

Content appears below the main top price of the product.

Right Column

Content appears below the right column blocks.

Store Language

Content appears to the right of the language chooser.

Tags List Before

Content appears above the Add Your Tags field.

Magento Community Edition 2.1 User Guide

571

Positioning Blocks

CHAPTER 36: Content Blocks

Using a Widget
The CMS Static Block widget gives you the ability to place an existing content block most
anywhere in your store.

Process Overview:
Step 1: Choose the Type
Step 2: Complete the Layout Updates
Step 3: Place the Block

Step 1: Choose the Type

572

On the Admin sidebar, tap Content. Then under Elements, choose Widgets.

In the upper-right corner, tap Add Widget. Then do the following:
a.

In the Settings section, set Type to “CMS Static Block.” Then, tap Continue.

Verify that Design Theme is set to the current theme.

Tap Continue.

Magento Community Edition 2.1 User Guide

CHAPTER 36: Content Blocks

Positioning Blocks

Settings
3.

In the Storefront Properties section, do the following:
a.

In the Widget Title field, enter a descriptive title for internal reference.

Set Assign to Store Views to “All Store Views,” or to the view where the app will be
available. To select more than one, hold the Ctrl key down and select each option.

Enter a number in the Sort Order field to determine the order of the block if it assigned to
appear in the same location on the page as other content elements. The top position is
zero.

Storefront Properties

Magento Community Edition 2.1 User Guide

573

Positioning Blocks

CHAPTER 36: Content Blocks

Step 2: Complete the Layout Updates
1.

In the Layout Updates section, tap Add Layout Update. Then, do the following:

Set Display On to the category, product, or page where you want the block to appear. To place
the block on a specific page, do the following:
a.

Choose the Page where you want the block to appear.

Choose the Block Reference that identifies the place on the page where the block is to be
placed.

Accept the default setting for Template, which is set to "CMS Static Block Default
Template."

Layout Updates

Step 3: Place the Block
1.

In the panel on the left, select Widget Options.

Tap Select Block…. Then in the list, choose the block that you want to place.

When complete, tap Save.
The app now appears in the list.

When prompted, follow the instructions at the top of the workspace to update the index and
page cache.

Return to your storefront to verify that the block appears in the correct location. To move the
block, you can reopen the frontend app try a different page or block reference.

574

Magento Community Edition 2.1 User Guide

CHAPTER 36: Content Blocks

Positioning Blocks

Using a Layout Update
Blocks can be placed in the left or right sidebar of a specific page by making a layout update to
the XML code. With a few simple changes to the code, you can position the block in either
sidebar, and control its position in relation to other blocks.
The term callout1 is sometimes used to refer to a block that is defined as a layout update with
XML code. The term sidebar2 refers to the left or right columns of the page layout. When
entering layout update code, make sure to follow the syntax exactly as shown in the example.
To place a block in the sidebar, the page must have a two-or three-column layout. To learn more,
see: Page Layout.

To place a block in the sidebar of a page:
1.

On the Admin sidebar, tap Content. Then under Elements, choose Blocks.

In the grid, find the block you want to place, and take note of its Identifier. Make sure that you
have the correct spelling.

On the Admin sidebar, tap Content. Then under Elements, choose Pages.

Find the page where you want to place the block, and open the page in edit mode.

In the panel on the left, choose Design. Then, do the following:
a.

In the Layout Update XML box, enter the code for the right or left sidebar.
Code for CMS Block in Sidebar

your-block-id

Change the reference name to identify either the “right” or “left” column, according to the
layout of the page.

Change the block_id to the identifier of the block that is being placed.

When complete, tap Save Page.

1A term that is sometimes used to describe a block that is defined as a layout update using XML code.
2The right or left column of a two-column page layout.

Magento Community Edition 2.1 User Guide

575

576

Magento Community Edition 2.1 User Guide

CHAPTER 37:

Widgets
A widget is a snippet of code that makes it possible to display a wide range of content and
place it at specific block references in your store. Many display real-time, dynamic data and
create opportunities for your customers to interact with your store. The Widget tool makes it
easy to place existing content such as blocks with images and text, and interactive elements
most anywhere in your store.
You can use widgets to create landing pages for marketing campaigns, display promotional
content at specific locations throughout the store. Widgets can also be used to add interactive
elements and action blocks for external review systems, video chats, voting, and subscription
forms, or to provide navigation elements for tag clouds and image sliders.

New Product List Widget

Magento Community Edition 2.1 User Guide

577

Widget Types

CHAPTER 37: Widgets

Widget Types
Widgets
TYPE

DESCRIPTION

CMS Page Link

Displays a link to a selected page. Allows you to specify custom text
and title. When the link is complete, it can be used in content pages
and blocks.

CMS Static Block

Displays a block of content at a specific location on a page.

Catalog Category Link

Displays either an inline or block-style link to a selected catalog
category. When the link is complete, it can be used in content pages
and blocks.

Catalog New Products List Displays a block of products which have been designated as new, for
the duration of time specified in the product record.

578

Catalog Product Link

Displays either an inline or block-style link to a selected catalog
product. When the link is complete, it can be used in content pages
and blocks.

Catalog Products List

Displays a list of products from the catalog.

Orders and Returns

Gives customers the ability to submit their own requests for returned
merchandise authorization.

Recently Compared
Products

Displays the block of recently compared products. You can specify
the number of products included, and format them as a list or product
grid.

Other PayPal Solutions

Other PayPal Solutions
PayPal is a global leader in online payments and a fast and secure way for your customers to
pay online. With PayPal and Magento Community Edition 2.1, you can accept payments from
all major debit and credit cards. PayPal offers additional convenience without extra effort,
because even your customers who don’t have a PayPal account can pay for their purchases with
PayPal. In this guide, PayPal payments solutions are organized as follows:
l

Other PayPal Solutions

CHAPTER 55: Recommended Solutions

PayPal All-In-One Payment Solutions
In the United States, PayPal offers the following PCI-compliant solutions to meet the needs of
your growing business.
l

PayPal Payments Advanced

PayPal Payments Pro

PayPal Payments Standard

PayPal All-In-Payment Solutions

PayPal Payment Gateways
PayPal offers a choice of two payment gateway solutions for your business. You can let PayPal
host your checkout on its secure payment site, or you can take control of the entire payment
experience with a completely customizable solution.
l

PayPal Payflow Pro

PayPal Payflow Link

PayPal Payment Gateways

792

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

Other PayPal Solutions

PayPal Payments Advanced
PayPal Payments Advanced is a PCI-compliant solution that lets your customers pay by debit
or credit card without leaving your site. It includes an embedded checkout page that can be
customized to create a seamless and secure checkout experience.

PayPal Payments Advanced
Even customers without a PayPal account can make purchases through PayPal’s secure
payment gateway. Accepted cards include Visa, MasterCard, Switch/Maestro, and Solo credit
cards in the United States and United Kingdom. For additional convenience, PayPal Express
Checkout is included with PayPal Payments Advanced.
You can have two PayPal solutions active at the same time: Express Checkout, plus any All-InOne or Payment Gateway solution. If you change payment solutions, the one that was used
previously is disabled.
PayPal Payments Advanced cannot be used for orders created from the Admin of your store.

Requirements
PayPal Business Account
If you manage multiple Magento websites, you must have a separate PayPal merchant
account for each website.

Magento Community Edition 2.1 User Guide

793

Other PayPal Solutions

CHAPTER 55: Recommended Solutions

Checkout Workflow
Customer Chooses Payment Method. During checkout, the customer chooses to pay
with PayPal Payments Advanced. The Pay Now button appears instead of the Place
Order button.
Pay Now. The customer taps Pay Now, and a PayPal-hosted form appears. The
customer enters the card information, and the card is verified. If successful, the order
confirmation page appears.
Pay with PayPal. The form also includes the Pay with PayPal button, which redirects
the customer to the PayPal site, where payment can be made with PayPal Express
Checkout.
Troubleshooting. If the transaction fails for any reason, an error message appears on
the checkout page and the customer is instructed to try again. Any issues are managed
by PayPal.

Order Processing Workflow
Processing orders with PayPal Payments Advanced is the same as for any regular PayPal order.
Orders are invoiced and shipped, and credit memos generated for both online and offline
refunds. However, multiple online refunds are not available for orders paid with PayPal
Payments Advanced.
Customer Places Order. In the final stage of checkout, the customer taps the Place
Order button.

PayPal Responds. PayPal evaluates the request. If found to be valid, PayPal
processes the transaction.

794

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

Other PayPal Solutions

Magento Sets Order Status. Magento receives response from PayPal, and sets the
order status to one of the following:
Processing

The transaction was successful.

Pending Payment

The system did not receive any response from PayPal.

Canceled

The transaction was not successful for some reason.

Suspected Fraud

The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.

Merchant Fulfills Order. The merchant invoices and ships the order.

Setting Up PayPal Payments Advanced
For step-by-step configuration instructions, see PayPal Payments Advanced in the Magento
Community Edition 2.1online user guide.

Setting Up PayPal Payments Advanced

Magento Community Edition 2.1 User Guide

795

Other PayPal Solutions

CHAPTER 55: Recommended Solutions

PayPal Payments Pro
PayPal Payments Pro brings you all the benefits of a merchant account and payment gateway
in one, plus the ability to create your own, fully customized checkout experience. PayPal
Express Checkout is automatically enabled with PayPal Payments Pro, so you can tap into
more than 110 million active PayPal users.

PayPal Payments Pro
For merchants outside the US, this method is called “PayPal Website Payments Pro.”

You can have two PayPal solutions active at the same time: PayPal Express Checkout, plus any
one of the All-In-One solutions. If you change payment solutions, the one used previously is
automatically disabled.

Requirements
PayPal Merchant Account (with Direct Payments Activated)

Checkout Workflow
Customer Goes to Checkout. Customer adds products to cart, and taps Proceed to
Checkout.

Customer Chooses Payment Method. During checkout, customer chooses the
PayPal Direct Payment option, and enters the credit card information.
l

If paying with PayPal Payments Pro, the customer stays on your site during the
checkout process.
If paying with PayPal Express Checkout, the customer is redirected to the PayPal
site to complete the transaction.

At the customer’s request, the store administrator can also create an order from the
Admin, and process the transaction with PayPal Payments Pro.

796

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

Other PayPal Solutions

Order Processing Workflow
Order Placed. The order can be processed either the Admin of your store, or from your
PayPal merchant account.

Payment Action. The payment action specified in the configuration is applied to the
order. Options include:
Authorize

Magento creates a sales order with the “Processing” status. In
this case, the amount of money to be authorized is pending
approval.

Sale

Magento creates both a sales order and invoice.

Capture

PayPal transfers the order amount from the buyer’s balance,
bank account or credit card to the merchant’s account.

Invoicing. An invoice is created in Magento after PayPal sends an instant payment
notification message to Magento.
Make sure that instant payment notifications are enabled in your PayPal merchant
account.

If required, an order can be partially invoiced for a specified quantity of products. For
each partial invoice submitted, a separate Capture transaction with a unique ID becomes
available, and a separate invoice is generated.
Authorization-only payment transactions are closed only after the full order amount is
captured.
An order can be voided online at any time until the order amount is fully invoiced.
Returns. If for any reason the customer returns the purchased products and claims a
refund, as with order amount capturing and invoice creation, you can create an online
refund either from the Admin or from your PayPal merchant account.

Magento Community Edition 2.1 User Guide

797

Other PayPal Solutions

CHAPTER 55: Recommended Solutions

Setting Up PayPal Payments Pro
For step-by-step configuration instructions, see PayPal Payments Pro in the Magento
Community Edition 2.1 online user guide.

Setting Up PayPal Payment Pro

798

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

Other PayPal Solutions

PayPal Payments Standard
PayPal Payments Standard is the easiest way to accept payments online. You can offer your
customers the convenience of payment both by credit card and PayPal by simply adding a
checkout button to your store.

PayPal Payments Standard
For merchants outside the US, this method is called “PayPal Website Payments Standard.”

With PayPal Payments Standard, you can swipe credit cards on mobile devices. There is no
monthly fee, and you can get paid on eBay. Supported credit cards include Visa, MasterCard,
Discover, and American Express. In addition, customers can pay directly from their personal
PayPal accounts. PayPal Payments Standard is available in all countries on the PayPal
worldwide reference list.

Merchant Requirements
PayPal Business Account

Checkout Workflow
For customers, PayPal Payments Standard is a one-step process if the credit card information
the their personal PayPal accounts is up to date.
Customer Places Order. The customer taps the “Pay Now” button to complete the
purchase.

PayPal Processes the Transaction. The customer is redirected to the PayPal site to
complete the transaction.

Magento Community Edition 2.1 User Guide

799

Other PayPal Solutions

CHAPTER 55: Recommended Solutions

Setting Up PayPal Payments Standard
PayPal Payments Standard cannot be used simultaneously with any other PayPal method, including
Express Checkout. If you change payment solutions, the one used previously is disabled.

For step-by-step configuration instructions, see PayPal Payments Standard in the online user
guide.

Setting Up PayPal Payments Standard

800

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

Other PayPal Solutions

PayPal Payflow Pro
PayPal Payflow Pro gateway, formerly known as Verisign, is available for customers of the
United States, Canada, Australia, and New Zealand. Unlike other PayPal payment methods,
merchants are charged a fixed monthly fee, plus a fixed fee for each transaction, regardless of
their number.

Configure

Requirements
PayPal Business Account
The PayPal Payflow Pro gateway links the merchant account at PayPal with the
merchant’s website, and acts both as a gateway and a merchant account.
If you manage multiple Magento websites, you must have a separate PayPal merchant
account for each website.

Customer Workflow
Customer Goes to Checkout. During checkout, the customer chooses to pay with
PayPal PayFlow Pro, and enters the credit card information.
Customers are not required to have personal PayPal accounts. However, depending on
the merchant country, customers can also use their personal PayPal account to pay for
the order.
Customer Submits Order. The customer submits the order, and the order information
is sent to PayPal for processing. The customer does not leave the checkout page of your
site.
PayPal Completes the Transaction. Payments are accepted at the time the order is
placed. Depending on the payment action specified n the configuration, either a sales
order or a sales order and an invoice is created.

Magento Community Edition 2.1 User Guide

801

Other PayPal Solutions

CHAPTER 55: Recommended Solutions

Online Order Processing Workflow
Administrator Submits Online Invoice. The store administrator submits an online
invoice. and as a result a corresponding transaction and an invoice is created.

PayPal Receives the Transaction. The order information is sent to PayPal. A record of
the transaction and an invoice is generated. You can view all Payflow Pro Gateway
transactions in your PayPal merchant account.

Partial invoices and partial refunds are not supported by PayPal Payflow Pro.

Setting Up PayPal Payflow Pro
For step-by-step configuration instructions, see PayPal Payflow Pro in the Magento Community
Edition 2.1online user guide.

PayPal Payflow Pro

802

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

Other PayPal Solutions

PayPal Payflow Link
PayPal PayFlow Link is available for merchants in the United States and Canada only.
Customers are not required to have a personal PayPal account, and enter their credit card
information in a form that is hosted by PayPal. The information is never stored on your
Magento server. PayFlow Link cannot be used for orders that are created from the Admin.

Configure
Credit memos are supported for both online and offline refunds. However, multiple online
refunds are not supported.

Customer Workflow
Customer Goes to Checkout. During checkout, the customer chooses to pay with
PayPal PayFlow link, and enters the credit card information.
The customer is not required to have a personal PayPal account.
Customer Chooses Pay Now. The customer taps the Pay Now button to submit the
order.

Customer Enters Credit Card Info. The customer enters the credit card information on
a form that is hosted by PayPal/
If the customer clicks the Cancel Payment link, the customer returns to the Payment
Information stage of checkout, and the order status changes to “Canceled.”
Customer Submits the Order. The credit card information is submitted directly to
PayPal, and is not retained anywhere on the Magento site.

Magento Community Edition 2.1 User Guide

803

Other PayPal Solutions

CHAPTER 55: Recommended Solutions

Order Workflow
PayPal Receives Request. PayPal receives the request from the customer to Pay
Now.

PayPal Verifies the Payment Information. PayPal verifies the credit card information,
and assigns the appropriate status.
Payment Verified: If verified, the “Pending Payment” the applicable status is initially
assigned to the order until the transaction is settled.
Processing

The transaction was successful.

Pending Payment

The system did not receive any response from PayPal.

Canceled

The transaction was not successful for some reason.

Suspected Fraud

The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.

Cancel Payment. If the customer clicks the Cancel Payment link, the customer returns
to the Payment Information stage of checkout, and the order status changes to
“Canceled.”
Customer Is Redirected to Confirmation Page. If the transaction completes
successfully, the customer is redirected to the order confirmation page in your store.
If the transaction fails on any reason, an error message appears on the checkout page
and the customer is directed to repeat the checkout process. These situations are
managed by PayPal.
Merchant Fulfills Order. The merchant invoices, and ships the order as usual.

804

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

Other PayPal Solutions

Setting Up PayPal Payflow Link
For step-by-step configuration instructions, see PayPal Payflow Link in the Magento
Community Edition 2.1online user guide.

PayPal Payflow Link Setup

Magento Community Edition 2.1 User Guide

805

PayPal Quick Reference

CHAPTER 55: Recommended Solutions

PayPal Quick Reference
PAYPAL SOLUTION

DESCRIPTION

EXPRESS CHECKOUT
PayPal Express Checkout
ALL-IN-ONE SOLUTIONS
PayPal Payments Advanced (Includes Express
Checkout)

Allows you to accept payments with a
PCI-compliant checkout that keeps
customers on your site.

PayPal Payments Pro (Includes Express Checkout)
PayPal Website Payments Pro (Outside US)

Allows you to accept payments with a
completely customizable checkout.

PayPal Payments Standard (Includes Express
Checkout)

Adds PayPal as an additional payment
method to your checkout page.

PayPal Website Payments Standard (Outside US)
PAYMENT GATEWAYS
PayPal Payflow Pro (Includes Express Checkout)

Connects your merchant account with a
fully customizable gateway that lets
customers pay without leaving your site.

PayPal Payflow Link (Includes Express Checkout)

Connects your merchant account with a
PCI-compliant gateway that lets
customers pay without leaving your site.

OTHER PAYPAL SOLUTIONS
PayPal Integral Evolution
PayPal Pasarela Integral
PayPal Pro
PayPal Website Payments Plus
PayPal Website Payments Pro Hosted Solution
PayPal Payments Pro Hosted Solution (includes Express Checkout)

806

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

PayPal Business Account

PayPal Business Account
To offer PayPal as a payment method in your store, you must have a PayPal business account
and/or a PayPal Payflow account. The account requirements are specified in the description of
each PayPal solution. Your PayPal merchant account is also used to manage any fraud filters
that are applied to purchases made from your store.
Customers who use PayPal Express Checkout or Express Checkout for Payflow Pro must have a
PayPal buyer account. PayPal Payments Standard (which is some countries is called Website
Payments Standard) can be used directly or through a buyer account, provided that the
merchant enables PayPal Account Optional. By default, this parameter is enabled. Customers
can choose to enter their credit card information, or create a buyer account with PayPal. When
disabled, customers must first create a PayPal buyer account before making a purchase.
Website Payments Pro, Website Payments Pro Payflow Edition, Payflow Pro Gateway, and
Payflow Link require customers to enter credit card information during checkout.

Magento Community Edition 2.1 User Guide

807

PayPal Business Account

CHAPTER 55: Recommended Solutions

PayPal Fraud Management Filter
PayPal fraud management filters make it easier to detect and respond to fraudulent
transactions, and can be configured to flag, hold for review, or deny riskier payments. Magento
order status values changed according to the fraud filter settings.

Filter Actions
ACTION
Review

DESCRIPTION
If you set the filter action to “Review,” the suspected order receives the
status ”Payment Review” when the order is placed. You can review the order
and approve, or cancel the payment in the Admin, or on the PayPal side.
When you click the Accept Payment or the Deny Payment buttons, no new
transactions for the order are created.
If you change the status of the transaction on the PayPal site, you must click
the Get Payment Update button in the upper-right corner of the Order page in
the Admin to apply the changes. If you click Accept Payment or Deny
Payment, the changes made at the PayPal site are applied.

Deny

If you set the filter action to “Deny,” the suspected order cannot be placed by
the customer, because the corresponding transaction is rejected by PayPal.
To deny the payment from the Admin, click the Deny Payment button in the
upper-right corner of the page. The order status changes to “Canceled,” the
transaction is reverted, and funds are released on the customer’s account.
The corresponding information is added in the Comments History section of
the order view.

Flag

808

If you set the filter action to “Flag”, the suspected order gets the status
”Processing” when it is placed. The corresponding transaction is marked with
a “flag” in the list of the merchant account transactions.

Magento Community Edition 2.1 User Guide

CHAPTER 55: Recommended Solutions

PayPal Business Account

PayPal by Country
PayPal Payment Solutions
COUNTRY
Australia

PAYPAL PAYMENT SOLUTION
PayPal Website Payments Standard
PayPal Payflow Pro
PayPal Website Payments Pro Hosted Solution
PayPal Express Checkout

Canada

PayPal Website Payments Standard
PayPal Website Payments Pro
PayPal Payflow Pro
PayPal Payflow Link (includes Express Checkout)
PayPal Express Checkout

France

PayPal Integral Evolution
PayPal Website Payments Standard
PayPal Express Checkout

Germany

PayPal Express Checkout

Hong Kong SAR China

PayPal Website Payments Pro Hosted Solution
PayPal Website Payments Standard
PayPal Express Checkout

Italy

PayPal Pro
PayPal Payments Standard
PayPal Express Checkout

Japan

PayPal Website Payments Plus
PayPal Website Payments Standard
PayPal Express Checkout

New Zealand

PayPal Payflow Pro
PayPal Website Payments Standard
PayPal Express Checkout

Spain

PayPal Pasarela Integral
PayPal Website Payments Standard
PayPal Express Checkout

Magento Community Edition 2.1 User Guide

809

PayPal Business Account

CHAPTER 55: Recommended Solutions

PayPal Payment Solutions (cont.)
COUNTRY
United Kingdom

PAYPAL PAYMENT SOLUTION
PayPal Payments Pro Hosted Solution (includes Express
Checkout)
PayPal Payments Standard
PayPal Express Checkout

United States

PayPal Payments Advanced (Includes Express Checkout)
PayPal Payments Pro (Includes Express Checkout)
PayPal Payments Standard+
PayPal Payflow Pro (Includes Express Checkout)
PayPal Payflow Link (Includes Express Checkout)
PayPal Express Checkout

OTHER COUNTRIES
PayPal Express Checkout and PayPal Website Payments Standard are available in the following
countries:
Argentina, Austria, Belgium, Brazil, Bulgaria, Chile, Costa Rica, Cyprus, Czech Republic,
Denmark. Dominican Republlic, Ecuador. Estonia, Finland. French Guiana. Gibraltar. Greece.
Guadeloupe, Hungary, Iceland. India. Indonesia. Ireland. Israel, Jamaica, Latvia. Leichtenstein.
Lithuania. Luxembourg, Malaysia. Malta. Martinique. Mexico, Netherlands. Norway, Philippines.
Poland. Portugal, Réunion, Romania, San Marino, Singapore, Slovakia, Slovenia, South Africa,
South Korea,, Sweden, Switzerland, Taiwan, Thailand, Turkey, United Arab Emirates, Uruguay,
Venezuela, Vietnam

810

Magento Community Edition 2.1 User Guide

CHAPTER 56:

Basic Payment Methods
The payment methods covered in this section are built in to Magento, and do not require the
services of a third-party payment processing company.

Offline Payments
Magento supports a number of offline payment methods,
including payment by check or money order, and cash on
delivery (COD),

Online Payments
Bank transfer is a basic payment method that is included
with all Magento stores.

Magento Community Edition 2.1 User Guide

811

Check / Money Order

CHAPTER 56: Basic Payment Methods

Check / Money Order
Magento Community Edition 2.1 allows you to accept payments by check or money order. The
Check / Money Order payment method is enabled for your story by default. You can accept
checks and money orders from only specific countries, and fine-tune the configuration with
minimum and maximum order total limits.

Check / Money Order

812

Magento Community Edition 2.1 User Guide

CHAPTER 56: Basic Payment Methods

Check / Money Order

To configure payment by check or money order:
1.

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

In the panel on the left under Sales, choose Payment Methods.

Expand

the Check / Money Order section. Then, do the following:

To accept payment by check or money order, set Enabled to “Yes.”

Enter a Title to identify the Check / Money Order payment method during checkout.

Set New Order Status to "Pending” until receipt of payment is confirmed.

Set Payment from Applicable Countries to one of the following:
All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

In the Make Check Payable To field, enter the name of the party to whom the check must
be payable.

In the Send Check To field, enter the street address or PO Box where the checks are
mailed.

Set Minimum Order Total and Maximum Order Total to the order amounts required to
qualify for this payment method.
An order qualifies if the total falls between, or exactly matches, the minimum or maximum total
values.

Enter a Sort Order number to determine the position of Check / Money Order in the list of
payment methods that is shown during checkout. (0 = first, 1 = second, 2 = third, and so
on.)

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

813

Cash On Delivery

CHAPTER 56: Basic Payment Methods

Cash On Delivery
Magento Community Edition 2.1 allows you to accept COD payments for purchases. You can
accept COD payment from only specific countries, and fine-tune the configuration with
minimum and maximum order total limits.
The shipping carrier receives payment from the customer at the time of delivery, which is then
transferred to you. You can make an adjustment for any fee charged by the carrier service in
your shipping and handling charges.

Cash On Delivery Payment

814

Magento Community Edition 2.1 User Guide

CHAPTER 56: Basic Payment Methods

Cash On Delivery

To set up cash on delivery payments:
1.

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

In the panel on the left, under Sales, select Payment Methods.

Expand

the Cash On Delivery Payment section. Then, do the following:

To activate Cash On Delivery Payment, set Enabled to “Yes.”

Enter a Title to identify the COD payment method during checkout.

Set New Order Status to “Pending” until receipt of payment is confirmed.

Set Payment from Applicable Countries to one of the following:
All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

Enter the Instructions for accepting delivery of a COD order.

Set Minimum Order Total and Maximum Order Total to the order amounts that are
required to qualify for COD payment.
An order qualifies if the total is between, or matches, the minimum or maximum order total.

Enter a Sort Order number to determine the sequence in which Cash On Delivery is listed
with other payment methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

815

Bank Transfer

CHAPTER 56: Basic Payment Methods

Bank Transfer
Magento Community Edition 2.1 allows you to accept payment that is transferred from a
customer’s bank account and deposited into your merchant bank account.

Bank Transfer Payment

816

Magento Community Edition 2.1 User Guide

CHAPTER 56: Basic Payment Methods

Bank Transfer

To configure bank transfer payments:
1.

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

In the panel on the left, under Sales, choose Payment Methods.

Expand

the Bank Transfer Payment section. Then, do the following:

To activate bank transfers, set Enabled to “Yes.”

Enter a Title to identify the Bank Transfer Payment method during checkout.

Set New Order Status to “Pending” until payment is authorized.

Set Payment from Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

Enter the Instructions your customers must follow to set up a bank transfer. Depending on
the country where your bank is located and the requirements of the bank, you might need
to include the following information:
l

Bank account name

Bank account number

Bank routing code

Bank name

Bank address

Set Minimum Order Total and Maximum Order Total to the amounts required to qualify to
use this payment method.
An order qualifies if the total falls between, or exactly matches, the minimum or maximum total
values.

Enter a Sort Order number to determine the position of Bank Transfer in the list of payment
methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

817

Purchase Order

CHAPTER 56: Basic Payment Methods

Purchase Order
A purchase order (PO) allows commercial customers to pay for authorized purchases by
referencing the PO number. The purchase order is authorized and issued in advance by the
company that is making the purchase. During checkout, the customer chooses Purchase Order
as the method of payment. Upon receipt of your invoice, the company processes the payment
in their accounts payable system, and pays for the purchase.
Before accepting payment by purchase order, always establish the credit worthiness of the
commercial customer.

Purchase Order

818

Magento Community Edition 2.1 User Guide

CHAPTER 56: Basic Payment Methods

Purchase Order

To configure payment by purchase order:
1.

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

In the panel on the left, under Sales, choose Payment Methods.

Expand

the Purchase Order section. Then, do the following:

To activate this payment method, set Enabled to “Yes.”

Enter a Title to identify this payment method during checkout.

Set New Order Status to “Pending” until payment is authorized.

Set Payment from Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

Set Minimum Order Total and Maximum Order Total to the amounts required to qualify
for this payment method.
An order qualifies if the total falls between, or exactly matches, the minimum or maximum total
values.

Enter a Sort Order number to determine the position of Purchase Order in the list of
payment methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

819

Zero Subtotal Checkout

CHAPTER 56: Basic Payment Methods

Zero Subtotal Checkout
Zero Subtotal Checkout is available only for orders created from the Admin, and can be used for
orders with a subtotal of zero that are taxed after a discount is applied. For example, Zero
Subtotal Checkout might be used in the following situations:
l

A discount covers the entire price of the purchase, with no additional charge for shipping.
The customer adds a downloadable or virtual product to the shopping cart, and the price
equals zero.

The price of a simple product is zero, and the Free Shipping method is available.

A coupon code covers the full price of products and shipping.

To save time, zero subtotal orders can be set to invoice automatically.

Zero Subtotal Checkout

820

Magento Community Edition 2.1 User Guide

CHAPTER 56: Basic Payment Methods

Zero Subtotal Checkout

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

In the panel on the left, under Sales, select Payment Methods.

Click to expand the Zero Subtotal Checkout section. Then, do the following:
a.

Enter a Title to identify the Zero Subtotal method during checkout.

Set Enabled to “Yes” to activate Zero Subtotal Checkout.

If orders typically wait for authorization, set New Order Status to “Pending” until payment
is authorized.
The order is waiting for authorization.

Processing

Payment has been authorized, and the transaction is being
processed.

Set Automatically Invoice All Items to “Yes” if you want to automatically invoice all items
that have a zero balance.

Set Payment from Applicable Countries to one of the following:

Pending

All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

Enter a Sort Order number to determine the position of Zero Subtotal Checkout in the list
of payment methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

821

822

Magento Community Edition 2.1 User Guide

CHAPTER 57:

Other Payment Methods
Magento Community Edition 2.1 supports the following payment solution that offer merchant
services in all parts of the world. Unlike some payment solutions that transfer control to
another site to complete the transaction, a payment gateway makes it possible for you to accept
credit card payments directly from your store without the customer leaving your site.
l

Authorize.Net Direct Post

Magento Community Edition 2.1 User Guide

823

Authorize.Net Direct Post

CHAPTER 57: Other Payment Methods

Authorize.Net Direct Post
Authorize.Net handles all steps in the transaction process — such as payment data collection,
data submission, and response to the customer — while the customer remains in your store.
Authorize.Net Direct Post can be used with orders created from the Admin as well as from the
store.

Customer Workflow
Customer chooses payment method. During checkout, the customer chooses
Authorize.Net Direct Post as the payment method.

Customer submits the order. The customer enters the credit card information, reviews
the order, and taps the Place Order button.

Authorize.Net completes the transaction. Authorize.Net validates the card
information, and processes the transaction.
l

If successful, the customer is redirected to the order confirmation page.
If the transaction fails, an error message appears, and the customer can try a different
card, or choose a different payment method.

Setting Up Authorize.Net Direct Post
For step-by-step configuration instructions, see Authorize.Net Direct Post in the Magento
Community Edition 2.1online user guide.

Authorize.Net Direct Post

824

Magento Community Edition 2.1 User Guide

Shipping

825

Contents
Studies show that stores offering customers a
choice of several shipping methods have higher
conversion rates than those that use a single
method for all shipments. In this section of the
guide, you will learn how to set up a variety of
shipping methods and carriers, and print
shipping labels.

Shipping Settings
Shipping Policy
Basic Shipping Methods
Free Shipping
Flat Rate
Table Rate
Dimensional Weight
Carriers
Shipping Labels
Shipping Label Workflow
Configuring Shipping Labels
Creating Shipping Labels

826

CHAPTER 58:

Shipping Settings
The shipping configuration establishes the point of origin for all shipments, your shipping
policy, and the handling of shipments to multiple addresses.
l

Point of Origin

Shipping to Multiple Addresses

Shipping Policy

Shipping Settings

Magento Community Edition 2.1 User Guide

827

Point of Origin

CHAPTER 58: Shipping Settings

Point of Origin
The point of origin is used to calculate the charge for shipments made from your store or
warehouse, and also determines the tax rate for products sold. When calculating EU taxes,
make sure that the Default Tax Destination Calculation for each store view corresponds to the
Shipping Settings point of origin.

Origin

To establish the point of origin:
1.

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

In the panel on the left, under Sales, choose Shipping Settings.

Expand

828

the Origin section, and complete the following:

Country

Region / State

ZIP / Postal Code

City

Street Address (and line 2, if needed)

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

CHAPTER 58: Shipping Settings

Multiple Addresses

Multiple Addresses
The Multiaddress Shipping options enable customers to ship an order to multiple addresses
during checkout, and determine the maximum number of addresses to which an order can be
shipped.

To configure multiple address shipping:
1.

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

In the panel on the left under Sales, choose Multishipping Settings.

Expand

the Options section. Then, do the following:

Set Allow Shipping to Multiple Addresses to “Yes.”

Enter the Maximum Qty Allowed for Shipping to Multiple Addresses.

When complete, tap Save Config.

Multiaddress Shipping Options

Magento Community Edition 2.1 User Guide

829

Shipping Policy

CHAPTER 58: Shipping Settings

Shipping Policy
To display your shipping policy during checkout, complete the Shipping Policy Parameters in
the configuration.

Shipping Policy Parameters

To configure your shipping policy:
1.

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

In the panel on the left, under Sales, choose Shipping Settings.

Expand

830

the Shipping Policy Parameters section, and do the following:

Set Apply Custom Shipping Policy to “Yes.”

Either paste or enter your Shipping Policy into the text box.

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

CHAPTER 59:

Basic Shipping Methods
Magento Community Edition 2.1 supports a wide range of shipping methods and carriers. In
this chapter you will learn how to set up that shipping methods that do not require an
account with a third-party provider.
l

Free Shipping

Flat Rate

Table Rates

Dimensional Weight

Magento Community Edition 2.1 User Guide

831

Free Shipping

CHAPTER 59: Basic Shipping Methods

Free Shipping
Free shipping is one of the most effective promotions you can offer. It can be based on a
minimum purchase, or set up as a cart price rule that is applied when a set of conditions is
met. If both apply to the same order, the configuration setting takes precedence over the cart
rule.
Check your shipping carrier configuration for any additional settings that may be required for free
shipping.

Free Shipping

Step 1: Configure Free Shipping

832

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

In the panel on the left, under Sales, choose Shipping Methods.

Expand

the Free Shipping section. Then, do the following:

Set Enabled to “Yes.”

Enter a Title to identify the Free Shipping method during checkout.

Magento Community Edition 2.1 User Guide

CHAPTER 59: Basic Shipping Methods

Free Shipping

Enter a Method Name to describe this shipping method.

Enter the Minimum Order Amount to qualify for free shipping.
To use Free Shipping with Table Rates, make the Minimum Order Amount so high that it is
never met. This prevents Free Shipping from going into effect, unless it is triggered by a price
rule.

In the Displayed Error Message box, type the message to appear if free shipping becomes
unavailable.

Set Ship to Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use free shipping.

Specific Countries

After choosing this option, the Ship to Specific Countries list
appears. Select each country in the list where free shipping can be
used.

Set Show Method if Not Applicable to one of the following:
Yes

Always shows the Free Shipping method, even when not applicable.

Shows the Free Shipping method only when applicable.

Enter a Sort Order number to determine the position of free shipping in the list of
shipping methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Step 2: Enable Free Shipping in the Carrier Configuration
Make sure to complete any configuration that is required for each carrier that you plan to use
for free shipping. For example, if your UPS configuration is otherwise complete, make the
following settings to enable and configure free shipping:
1.

From the Shipping Methods configuration, click to expand the UPS section.

Expand

To require a minimum order for free shipping, set Free Shipping with Minimum Order

the UPS section. Then, set Free Method to “Ground.”

Amount to “Enable.”
4.

Enter the required amount in the Minimum Order Amount for Free Shipping field.

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

833

Flat Rate Shipping

CHAPTER 59: Basic Shipping Methods

Flat Rate Shipping
Flat rate is a fixed, predefined charge that can be applied per item, or per shipment. Flat rate is
a simple shipping solution, especially when used with the flat-rate packaging that is available
from some carriers.

Flat Rate

To set up flat rate shipping:
1.

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

In the panel on the left, under Sales, choose Shipping Methods.

Expand
a.

the Flat Rate section. Then, do the following:

Set Enabled to “Yes.”
Flat Rate appears as an option in the Estimate Shipping and Tax section of the shopping
cart, and also in the Shipping section during checkout.

834

Magento Community Edition 2.1 User Guide

CHAPTER 59: Basic Shipping Methods

Flat Rate Shipping

Enter a descriptive Title for the Flat Rate method.

Enter a Method Name to appear next to the calculated rate in the shopping cart. The
default method name is “Fixed.” If you charge a handling fee, you can change the Method
Name to “Plus Handling,” or something else that is suitable.

To describe how flat rate shipping can be used, set Type to one of the following:
None

Disables the payment type. The Flat Rate option is listed in the
cart, but with a rate of zero—which is the same as free shipping.

Per Order

Charges a single flat rate for the entire order.

Per Item

Charges a single flat rate for each item. The rate is multiplied by the
number of items in the cart, regardless of whether there are multiple
quantities of the same, or of different items.

Enter the Price that you want to charge for flat rate shipping.

If charging an additional handling fee, set Calculate Handling Fee to one of the following:
l

Fixed

Percent

Then, enter the Handling Fee rate according to the method used to calculate the fee. For
example, if the fee is calculating based on a percentage, enter 0.06 for 6 percent. If using a
fixed amount calculation, enter the fee as a decimal.
g.

In the Displayed Error Message box, type the message that appears if Flat Rate Shipping
becomes unavailable.

Set Ship to Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use flat rate shipping.

Specific Countries

After choosing this option, the Ship to Specific Countries list
appears. Select each country in the list where flat rate shipping can
be used.

Enter a Sort Order number to determine the position of the Flat Rate in the list of
shipping methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

835

Table Rates

CHAPTER 59: Basic Shipping Methods

Table Rates
The table rate shipping method references a table of data to calculate shipping rates based on a
combination of conditions, including:
l

Weight v. Destination

Price v. Destination

# of Items v. Destination

For example, if your warehouse is in Los Angeles, it costs less to ship to San Diego than to
Vermont. You can use table rate shipping to pass the savings on to your customers.
The data that is used to calculate tables rates is prepared in a spreadsheet and imported into
your store. When the customer requests a quote, the results appear in the shipping estimate
section of the shopping cart.
Only one set of table rate data can be active at a time.

Table Rate in Shopping Cart

836

Magento Community Edition 2.1 User Guide

CHAPTER 59: Basic Shipping Methods

Table Rates

Process Overview:
Step 1: Complete the Default Settings
Step 2: Prepare the Table Rate Data
Step 3: Import the Table Rate Data
Step 4: Verify the Rates

Step 1: Complete the Default Settings
The first step is to complete the default settings for table rates. You can complete this step
without changing the scope of the configuration.
1.

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

In the panel on the left under Sales, choose Shipping Methods.

Expand
a.

the Table Rates section. Then, do the following:

Set Enabled to “Yes.”
If necessary, clear the Use system value checkbox to edit for any field to be edited.

Enter the Title that you want to appear for table rates section during checkout. (The
default title is “Best Way.”)

Enter the Method Name that you want to appear as a label next to the calculated rate in
the shopping cart.

Set Condition to one of the following calculation methods:

Weight v. Destination

Price v. Destination

# of Items v. Destination

For orders that include virtual products, set Include Virtual Products in Price Calculation
to “Yes” if you want to be able to include the virtual product(s) in the calculation.
Because virtual products—such as services—have no weight, they cannot change the result of
a calculation that is based on the Weight v. Destination condition. However, virtual products
can change the result of a calculation that is based on either the Price v. Destination or # of
Items vs Destination condition.

If charging a handling fee, set Calculate Handling Fee to one of the following:
l

Fixed

Percent

Then, enter the Handling Fee rate according to the method used to calculate the fee.

Magento Community Edition 2.1 User Guide

837

Table Rates

CHAPTER 59: Basic Shipping Methods

If the handling fee is based on a percent, enter the whole number without the percent sign.

In the Displayed Error Message box, type the message that appears when this method is
not available.

Set Ship to Applicable Countries to one of the following:

All Allowed
Countries

Customers from any country specified in your store configuration
can use table rate shipping.

Specific Countries

After choosing this option, the “Ship to Specific Countries” list
appears. Select each country where customers can use table rate
shipping.

Enter a Sort Order number to determine where table rates appear in the list of shipping
methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Table Rates

838

Magento Community Edition 2.1 User Guide

CHAPTER 59: Basic Shipping Methods

Table Rates

Step 2: Prepare the Table Rate Data
1.

In the upper-left corner, set Store View to “Main Website,” or to any other website where the
configuration applies. When prompted to confirm, tap OK.
The Export and Import options now appear in the Table Rates section, with “Use Default”
checkboxes to the right of each option.
To change any of the current settings, you must first clear the “Use Default” checkbox next to the
field.

To change the Condition, clear the Use Default checkbox. Then, choose another option.

Tap Export CSV . Then, save the tablerates.csv file to your computer.

Export CS
4.

Open the file in a spreadsheet. Then, complete the table with appropriate values for the
shipping calculation condition.
l

Use an asterisk (*) as a wildcard to represent all possible values in any category.

The Country column must contain a valid three-character code for each row.

Sort the data by Region/State so the specific locations are at the top of the list, and the
wildcard locations at the bottom. This will process the rules with the absolute values first,
and the wildcard values later.

Magento Community Edition 2.1 User Guide

839

Table Rates

CHAPTER 59: Basic Shipping Methods

Weight vs. Destination (Australia)
5.

When complete, save the tablerates.csv file.

Step 3:Import the Table Rate Data
1.

Return to the Table Rates section of your store configuration.

In the upper-left corner, set Store View to the website where this method will be used.

Next to the Import field, tap Choose File . Select your completed tablerates.csv file, and import
the rates.

Import Table Rates
4.

840

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 59: Basic Shipping Methods

Table Rates

Step 4: Verify the Rates
To make sure that the table rate data is correct, go through the payment process with several
different addresses to make sure the shipping and handling rates are calculated correctly.

Example 1: Price v. Destination
This example uses the Price v. Destination condition to create a set of three different shipping
rates based on the amount of the order subtotal for the continental United States, Alaska, and
Hawaii. The asterisk (*) is a wildcard that represents all values.

COUNTRY

REGION /
STATE

ZIP / POSTAL
CODE

ORDER
SUBTOTAL
(and above)

SHIPPING
PRICE

USA

100

USA

100

USA

100

USA

Magento Community Edition 2.1 User Guide

841

Table Rates

CHAPTER 59: Basic Shipping Methods

Example 2: Weight v. Destination
This example uses the Weight v. Destination condition to create different shipping rates based on the
weight of the order.

COUNTRY

REGION /
STATE

ZIP / POSTAL
CODE

WEIGHT (AND

ABOVE)

SHIPPING
PRICE

AUS

39.95

AUS

19.95

AUS

VIC

19.95

AUS

VIC

5.95

AUS

39.95

AUS

19.95

AUS

29.95

AUS

9.95

Example 3: Restrict Free Shipping to the Continental United States
1.

Create a tablerates.csv file that includes all the state destinations to which you are willing to
provide free shipping.

Complete the table rate configuration with the following settings:

SETTING

VALUE

Condition

Price v. Destination

Method Name

Free Shipping

Ship to Applicable Countries

Specific Countries

Ship to Specific Countries

Select only United States

Show method if not applicable No
3.

842

Set Store View to the main website. Then, tap Import to import the tablesrates.csv file.

Magento Community Edition 2.1 User Guide

CHAPTER 59: Basic Shipping Methods

Dimensional Weight

Dimensional Weight
Dimensional weight, sometimes called volumetric weight, is a common industry practice that
bases the transportation price on a combination of weight and package volume. In simple
terms, dimensional weight is used to determine the shipping rate based on the amount of space
a package occupies in the cargo area of the carrier. Dimensional weight is typically used when a
package is relatively light compared to its volume.
All major carriers now apply dimensional weight to some shipments. However, the manner in
which dimensional weight pricing is applied varies from one carrier to another.
l

DHL

FedEx

UPS

USPS

We recommend that you become familiar with the method used by each carrier to determine
and apply dimensional weight. If your company has a high volume of shipments, even a slight
difference in shipping price can translate to thousands of dollars over the course of a year.
Magento’s native shipping configuration does not include support for dimensional weight.

Magento Community Edition 2.1 User Guide

843

844

Magento Community Edition 2.1 User Guide

CHAPTER 60:

Carriers
If you have a commercial account with a supported carrier, you can offer your customers the
convenience of choosing that carrier during checkout. The rates are automatically downloaded,
so you do not need to look up the information.
Before you can offer your customers a selection of shipping carriers, you must first complete the
shipping settings to establish the point of origin for your store. Then, complete the
configuration for each carrier service that you want to offer. The configuration options vary for
each carrier. However, all require that you first open a shipping account with the carrier, and
enter your account number or user ID, and the gateway URL to their system into the
configuration of your store. See Magento Connect for additional shipping services for your
Magento Community Edition 2.1 installation.

Magento Community Edition 2.1 User Guide

845

CHAPTER 60: Carriers

See the online user guide for step-by-step configuration instructions for the following carriers:

UPS
United Parcel Service offers domestic and international
shipping services by land and air to more than 220
countries.

USPS
The United States Postal Service is the independent
postal service of United States government. USPS
offers domestic and international shipping services by
land and air.

FedEx
Offers domestic and international shipping services by
land and air to more than 220 countries.

DHL
Offers integrated international services and tailored,
customer-focused solutions for managing and
transporting letters, goods and information.

846

Magento Community Edition 2.1 User Guide

CHAPTER 61:

Shipping Labels
Magento Community Edition 2.1 includes a high level of integration with major shipping
carriers, which gives you access to carrier shipping systems to track orders, create shipping
labels, and more. Shipping labels can be created for regular shipments and products with
return merchandise authorization. In addition to the information provided by the shipping
carrier, the label also includes the Magento order number, number of the package, and the total
quantity of packages for the Magento shipment.

USPS Priority Shipping Label

Magento Community Edition 2.1 User Guide

847

Shipping Label Workflow

CHAPTER 61: Shipping Labels

Shipping Label Workflow
Shipping labels can be produced at the time a shipment is created, or later. Shipping labels are
stored in PDF format and are downloaded to your computer.
Administrator submits shipping label request. The store Administrator completes
the information necessary to generate labels, and submits the request.

Request sent to carrier. Magento contacts the shipping carrier, and creates an order in
the carrier’s system. A separate order is created for each package that is shipped.

Carrier sends label and tracking number. The carrier sends the shipping label and
tracking number for the shipment.
l

A single shipment with multiple packages receives multiple shipping labels.
If you generate the same shipping labels multiple times, the original tracking numbers
are preserved.
For returned products with RMA numbers, the old tracking numbers are replaced with
new ones.

Administrator downloads and prints the label. After the shipping label is generated,
the new shipment is saved and the label can be printed. If the shipping label cannot be
created due to problems with the connection or any other reason, the shipment is not
created.
Depending on your browser settings, the PDF file can be opened and printed. Each label
appears on a separate page in the PDF.

848

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Configuring Shipping Labels

Configuring Shipping Labels
The following settings must be made at the product level, as well as in the configuration of
each carrier that is used to print labels. To print labels, all carriers require that you open an
account. Then, complete the configuration in your store for each carrier that you plan to use.

Step 1: Verify the Country of Manufacture
The country of manufacture is required for all products that are shipped internationally by
USPS and FedEx, If you have many products that need to be updated, you can either import
the updates, or use the Inventory grid to update multiple records.
1.

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

Method 1: Update a Single Record
a.

In the grid, find the product to be updated, and open in edit mode.

In the panel on the left under Advanced Settings, choose Autosettings.

Update the Country of Manufacture field.

When complete, tap Save.

Country of Manufacture

Magento Community Edition 2.1 User Guide

849

Configuring Shipping Labels

CHAPTER 61: Shipping Labels

Method 2: Update Multiple Records
a.

In the grid, mark the checkbox of each product to be updated. For example, all products
that are manufactured in China.

Set the Actions control to “Update Attributes.” Then, tap Submit.

In the Update Attributes form, find the Country of Manufacture field and mark the
Change checkbox. Then, choose the country.

When complete, tap Save.

Step 2: Verify the Store Information
1.

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

In the panel on the left, under Sales, choose Shipping Settings. then, do the following:
a.

Expand

the Origin section, and verify that the following fields are complete:

Street Address

The street address of the place from which shipments are sent. For
example, the location of your company or warehouse. This field is
required for shipping labels.

Street Address
Line 2

Any additional address information, such as the floor, entrance and
so on. We strongly recommend that you use this field.

Origin
b.

850

In the panel on the left under Sales, choose Shipping Methods. Then, expand
USPS section, and verify that the following fields are complete:

the

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Configuring Shipping Labels

Secure Gateway
URL

Magento automatically enters the gateway URL.

Password

The password is provided by USPS, and gives you access to their
system through Web Services.

Length, Width

The default dimensions of the package. To make these fields
appear, set Size to “Large.”

Height, Girth
c.

Expand

the FedEx section, and verify that the following fields are complete:

Meter Number

Key

Password

This information is provided by the carrier, and is required to gain access to their system
through Web Services.
d.

In the panel on the left under General, choose General. Expand
section, and verify that the following fields are complete:

the Store Information

Store Name

The name of the store or store view.

Store Contact
Telephone

The telephone number of the primary contact for the store or store
view.

Country

The country where your store is based.

VAT Number

If applicable the Value Added Tax number of your store. (Not
required for stores based in the U.S.)

Store Contact
Address

The street address of the primary contact for the store or store view.

If you have multiple stores, and the contact information differs from the default, set Store
View for each, and verify that the information is complete. If the information is missing,
you’ll get an error when you try to print the labels.

Magento Community Edition 2.1 User Guide

851

Configuring Shipping Labels

CHAPTER 61: Shipping Labels

Store Information
3.

When complete, tap Save Config.

Carrier Requirements
CARRIER

852

REQUIREMENTS

USPS

Requires a USPS account.

UPS

Requires a UPS account. Shipping labels are available only for shipments
that originate in the U.S. Specific credentials are required for stores outside
the US.

FedEx

Requires a FedEx account. For stores outside of the U.S., shipping labels
are supported for international shipments only. FedEx does not allow
domestic shipments that originate outside of the U.S

DHL

Requires a DHL account. Shipping labels are supported only for shipments
that originate in the U.S.

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Creating Shipping Labels

Creating Shipping Labels
To create shipping labels, you must first set up your shipping carrier account to support labels.
Then, follow the prompts to enter a description of the package and its contents.
Process Overview:
Step 1: Contact Your Shipping Carriers
Step 2: Update the Configuration for Each Carrier
Step 3: Create Shipping Labels
Step 4: Print the Labels

Step 1: Contact Your Shipping Carriers
Before you begin, make sure that your shipping accounts are set up to process labels. Some
carriers might charge an additional fee to add shipping labels to your account.
1.

Contact each carrier that you use to activate shipping labels for your store.

Follow the instructions provided by each carrier to add shipping label support to your account.
FedEx

Contact FedEx Web Services regarding their label evaluation process.

USPS

Contact uspstechsupport@esecurecare.net to request that API Signature
Confirmation V3 be enabled for your live USPS API Access account.

UPS

Contact UPS to confirm your account type supports shipping labels. To
generate shipping labels, you must use the UPS XML option.

DHL

Contact the DHL Resource Center to learn more about their services or send
an inquiry through their Contact Center.

Step 2: Update the Configuration for Each Carrier
1.

Make sure that your Store Information is complete.

Follow the instructions below for each carrier account that has been activated for label printing.

Magento Community Edition 2.1 User Guide

853

Creating Shipping Labels

CHAPTER 61: Shipping Labels

UPS Configuration
United Parcel Service ships both domestically and internationally. However, shipping labels
can be generated only for shipments that originate within the United States.
1.

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

In the panel on the left under Sales, choose Shipping Methods.

Expand

the UPS section. Then, verify that your UPS Shipper Number is correct. Your

Shipper Number appears only when United Parcel Service XML is enabled.
4.

When complete, tap Save Config.

USPS Configuration
The United States Postal Service ships both domestically and internationally.
1.

Continuing in the Shipping Methods configuration, expand

the USPS section. Then, do

the following:
a.

Verify that the Secure Gateway URL is entered. The correct URL should be entered
automatically.

854

Enter the Password provided to you by USPS.

Set Size to “Large.” Then, enter the following dimensions:
l

Length

Width

Height

Girth

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Creating Shipping Labels

FedEx Configuration
FedEx ships domestically and internationally. Stores located outside the United States can
create FedEx labels for international shipments only.
1.

Continuing in the Shipping Methods configuration, expand

the FedEx section. Then,

make sure that the following FedEx credentials are correct:

Meter Number

Key

Password

When complete, tap Save Config.

DHL Configuration
DHL provides international shipping services.
1.

Continuing in the Shipping Methods configuration, expand

the DHL section. Then, do the

following:

Verify that the Gateway URL is entered. The correct URL should be entered automatically.

Make sure that the following credentials are complete:
l

Access ID

Password

Account Number

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

855

Creating Shipping Labels

CHAPTER 61: Shipping Labels

Step 3: Create Shipping Labels
Process Overview:
Method 1: Create Label for New Shipment
Method 2: Create Label for Existing Shipment

Method 1: Create Label for New Shipment
1.

On the Admin sidebar, tap Sales. Then under Operations, choose Orders.

Find the order in the grid, and open the record. The status of the order must be either
“Pending” or “Processing.”

In the upper-right corner, tap Ship. Then, confirm the shipping information according to
carrier requirements.

In the lower-right corner, mark the Create Shipping Label checkbox. Then, tap Submit
Shipment, and do the following:
a.

To add products from the order to the package, tap Add Products. The Quantity
column shows the maximum number of products that are available for the package.

Mark the checkbox of each product to be added to the package, and enter the
Quantity of each. Then, tap Add Selected Product(s) to Package.

To add a new package, tap Add Package.

To delete a package, tap Delete Package.
If you use a package type other than the default, or require a signature, the cost of shipping
might differ from what you have charged the customer. Any difference in the cost of shipping is
not reflected in your store.

When complete, tap OK.

If you need to cancel an order, tap Cancel. A shipping label will not be created, and the Create
Shipping Label checkbox is cleared.
Magento connects to the shipping carrier system, submits the order, and receives a shipping
label and tracking number for each package.
l

856

If the label is successfully created, the shipment is submitted, the tracking number
appears in the form, and the label is ready to print.
If the carrier cannot create the label due to the problems with connection, or for any
other reason, the shipment is not processed.

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Creating Shipping Labels

Method 2: Create Label for Existing Shipment
1.

On the Admin sidebar, tap Sales. Then under Operations, choose Orders.

Find the order in the grid, and open the Shipping form. Then, do the following:
a.

In the Shipping and Tracking Information section, tap Create Shipping Label.

Distribute the ordered product(s) to the appropriate package(s), and tap OK.

To review the package information, tap Show Packages.

Magento connects to the shipping carrier system, submits an order, and receives a shipping
label and a tracking number.
If a shipping label for this shipment already exists in the system, it is replaced with a new one.
However, existing tracking numbers are not replaced. Any new tracking number is added to
the existing one.

Step 4: Print the Labels
Shipping labels are generated in PDF format, and can be printed from the Admin. Each label
includes the order number and package number.
Because an individual shipment order for each package is created, multiple shipping labels might
be received for a single shipment.

Process Overview:
Method 1: Print Label from Shipment Form
Method 2: Print Labels for Multiple Orders

Magento Community Edition 2.1 User Guide

857

Creating Shipping Labels

CHAPTER 61: Shipping Labels

Method 1: Print Label from Shipment Form
1.

On the Admin sidebar, tap Sales. Then, do one of the following:
l

Choose Orders. Find the order in the grid, and open the record. In the panel on the left,
choose Shipments. Then, open the shipment record.
Choose Shipments. Find the order in the grid, and open the record.

To download the PDF file, go to the Shipping and Tracking section of the form, and tap
Print Shipping Label. Depending on your browser settings, the shipping labels can be
viewed and printed directly from the PDF file.

The Print Shipping Label button appears only after the carrier generates labels for the
shipment. If the button is missing, click Create Shipping Label. The button appears after
Magento receives the label from the carrier.

Method 2: Print Labels for Multiple Orders
1.

On the Admin sidebar, tap Sales. Then, choose one of the following:
l

Orders

Shipments

In the grid, mark the checkbox of each order with shipping labels to be printed.

Set the Actions control to "Print Shipping Labels."

Tap Submit.

A complete set of shipping labels is printed for each shipment that is related to the selected
orders.

Required Carrier Configuration Settings
SETTING
Type

DESCRIPTION
Package types differ by carrier and method. The default package
type for each carrier is initially selected.
USPS does not require the package type for domestic shipments.

858

Customs Value

(International shipments only) The declared value or sales price of the
contents of an international shipment.

Total Weight

The total weight of all products added to the package is calculated
automatically. The value can also be changed manually, and entered
as pounds or kilograms.

Length, Width, Height

(Optional) The package dimensions are used for custom packages
only. You can specify the measurements units as inches or
centimeters.

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Creating Shipping Labels

Required Carrier Configuration Settings (cont.)
SETTING

DESCRIPTION
Not Required

No confirmation of delivery is sent to the
store by the shipping carrier.

No Signature

A delivery confirmation without the signature
of the recipient is sent to the store by the
shipping carrier.

Signature Required

The shipping carrier obtains the signature of
the recipient and provides the store with a
printed copy.

Direct

(FedEx Only) FedEx obtains a signature from
someone at the delivery address. If no one is
available to sign for the package, the carrier
tries to deliver the package at another time.

Indirect

(FedEx Residential Deliveries Only) FedEx
obtains the signature of someone, possibly a
neighbor or building manager, at the delivery
address. The recipient can leave a signed
FedEx door tag to authorize the package to
be left without anyone present to sign for it.

Contents

(USPS Only) Select one of the following
descriptions of the package:
Gift
Documents
Commercial Sample
Returned Goods
Merchandise
Other

Magento Community Edition 2.1 User Guide

Explanation

(USPS Only) A detailed description of the
package contents.

Adult Required

The shipping carrier obtains the signature of
an adult recipient and provides the store with
a printed copy.

859

Creating Shipping Labels

CHAPTER 61: Shipping Labels

Label Packages
The Create Packages window appears when you choose to create a shipping label. You can start
configuring the first package immediately.

To configure a package:
1.

Complete the fields as described below.
If you select the non-default value in the Type field or choose to require a signature confirmation,
the price of a shipment may differ from the one you charged to the customer.

To view a list of shipped products and add them to the package, tap Add Products.
The Qty column shows the maximum quantity that is available to add. For the first package,
the number is the total quantity of the product to be shipped.

Specify the products and quantities. To add the products to the package, tap Add Selected
Product(s) to Package.
l

To add a new package, tap Add Package. You can add several packages, and edit them at
the same time.
To delete a package, tap Delete Package.

After products are added to the package, the quantity cannot be edited directly.

To increase the quantity:
1.

Tap Add Selection .

Enter the additional quantity.

The number is added to the previous quantity of the product in the package.

860

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Creating Shipping Labels

To decrease the quantity:
1.

Delete the product from the package.

Tap Add Selection.

Enter the new, smaller value.

After you distribute all products, the total number of the packages you are going to use equals
the number of the last package in the list. The OK button is disabled until all shipped items are
distributed to packages, and all necessary information is complete.
4.

When complete, tap OK to generate the labels.
If you need to stop the process, tap Cancel. The packages are not saved, and the shipping label
process is canceled.

Magento Community Edition 2.1 User Guide

861

Creating Shipping Labels

CHAPTER 61: Shipping Labels

Field Descriptions
FIELD
Type

DESCRIPTION
Specifies the type of a package. Select one of the predefined values.
Available package types are different for each shipping carrier.
When the Create Packages pop-up window opens, the default
package for the shipping carrier appears in the Type field. If you
select a package that is not designed by a shipping carrier, you must
enter the dimensions of the package.
For shipping labels created for DHL, FedEx, and UPS shipments, the
“Type of Goods” field is set to “Merchandise.” For USPS, the Type
field reflects the value from the Contents field in the Create
Packages window.

862

Total Weight

The total weight of a package. The field is pre-populated with the total
weight of products in a package. The unit of measurement can be set
to either pounds or kilograms.

Length

The length of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The unit of
measurement can be set to either inches or centimeters.

Magento Community Edition 2.1 User Guide

CHAPTER 61: Shipping Labels

Creating Shipping Labels

Field Descriptions (cont.)
FIELD

DESCRIPTION

Width

The width of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The measurement
units can be specified using the drop-down menu next to the Height
field; select between inches and centimeters.

Height

The height of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The measurement
units can be specified using the drop-down menu next to the Height
field; select between inches and centimeters.

Signature

Confirmation Defines delivery confirmation. Options:
Not Required

No delivery confirmation letter is sent to you.

No Signature

A delivery confirmation letter without a
recipient’s signature is sent to you.

Signature Required

The shipping carrier obtains the recipient’s
signature and provides you with its printed
copy.

Adult Required

The shipping carrier obtains the adult
recipient’s signature and provides you with
its printed copy.

Direct (FedEx only)

FedEx obtains a signature from someone at
the delivery address and reattempts delivery
if no one is available to sign for the package.

Indirect (FedEx
only)

FedEx obtains a signature in one of three
ways: (1) from someone at the delivery
address; (2) from a neighbor, building
manager or other person at a neighboring
address; or (3) the recipient can leave a
signed FedEx Door Tag authorizing release
of the package without anyone present.
Available for residential deliveries only.
The options may vary slightly for different
shipping methods. For the most up to date
information refer to shipping carrier’s
resources.

Magento Community Edition 2.1 User Guide

863

Creating Shipping Labels

CHAPTER 61: Shipping Labels

Field Descriptions (cont.)
FIELD
Contents

DESCRIPTION
(Available for USPS shipments only) Description of the package
contents. Options:
Gift
Documents
Commercial Sample
Returned Goods
Merchandise
Other

Explanation

864

(USPS shipments only) Detailed description of the package content.

Magento Community Edition 2.1 User Guide

REPORTS

865

Contents
In this section of the guide, you will learn how to
filter data and online generate reports. The report
data can be opened in a spreadsheet or imported
into other applications.

Reports Menu
Statistics
Marketing
Reviews
Sales
Customers
Products
New Relic Reporting
New Relic Queries

866

CHAPTER 62:

Reports Menu
Magento Community Edition 2.1 provides a wide selection of reports to keep you informed on
your marketing efforts, sales products, and customer activity. The Reports menu provides easy
access to current information about your sales, products, customers, and promotions.

Reports Menu

To display the Reports menu:
On the Admin sidebar, tap Reports .

Magento Community Edition 2.1 User Guide

867

CHAPTER 62: Reports Menu

Menu Options

Marketing Reports
A selection of marketing reports, including Products in Cart, Search Terms, Abandoned Carts, and
Newsletter Problem Reports.

Review Reports
The selection of product review reports includes By Customer and By Product.

Sales Reports
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and PayPal
Settlement.

Customer Reports
The selection of customer reports includes Order Total, Order Account, and New.

Product Reports
The selection of product reports includes Views, Bestsellers, Low Stock, Ordered, and Downloads.

Statistics
Statistics is a tool that reduces the performance impact of generating reports by calculating and storing
statistical data. Rather than recalculate the statistics every time a report is generated, the stored statistics
are used until you refresh the statistics.

868

Magento Community Edition 2.1 User Guide

CHAPTER 62: Reports Menu

Refresh Statistics

Refresh Statistics
To reduce the performance impact of generating sales reports, Magento calculates and stores
the required statistics for each report. Rather than recalculate the statistics every time a report
is generated, the stored statistics are used, unless you refresh the statistics. To include the
most recent data, the report statistics must be refreshed before a sales report is generated.

Refresh Statistics

To refresh report statistics:
1.

On the Admin sidebar, tap Reports. Then under Statistics, choose Refresh Statistics.

In the list, mark the checkbox of each report to be refreshed.

Set the Actions control to one of the following:

Refresh Lifetime Statistics

Refresh Statistics for the Last Day

When complete, tap Submit .

Magento Community Edition 2.1 User Guide

869

870

Magento Community Edition 2.1 User Guide

CHAPTER 63:

Marketing Reports
Marketing reports provide information about the status of shopping carts, the use of search
terms, and newsletter transmissions.

Products in Cart Report

Magento Community Edition 2.1 User Guide

871

CHAPTER 63: Marketing Reports

Reports

Products in Cart
The Products in Cart Report lists all products currently in
shopping carts, and includes the name and price of each
item, the number of carts with the item, and the number
of times each item has been ordered.

Search Terms
The Search Terms Report shows what your customers
are looking for in each store view. The report includes the
number of matching items found in the catalog, and how
many times the search term has been used.

Abandoned Carts
The Abandoned Carts Report lists all registered
customers who have abandoned carts that have not yet
expired. The report includes the customer name and
email address, the number of products in the cart and
subtotal, the date created, and date last updated.

Newsletter Problems
The Newsletter Problems Report includes information
about any newsletter queue that failed to transmit
successfully. The report includes the name of each
subscriber, and queue date and subject, the information
about the error.

872

Magento Community Edition 2.1 User Guide

CHAPTER 64:

Review Reports
The Review Reports provide information about product reviews by customer and by product.
l

By Customers

By Products

Review Report by Product

Magento Community Edition 2.1 User Guide

873

CHAPTER 64: Review Reports

Reports

By Customers
The Customer Reviews Report lists all customer who
have submitted product reviews. The report includes the
number of reviews submitted by each customer, and a
link to the list of reviews.

By Products
The Product Reviews Report lists all products that have
been reviewed by customers. The report includes the
number of reviews and average rating, the product was
last reviewed, and a link to the list of reviews for each
product.

874

Magento Community Edition 2.1 User Guide

CHAPTER 65:

Sales Reports
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and
PayPal Settlement.

Shipping Report

Magento Community Edition 2.1 User Guide

875

CHAPTER 65: Sales Reports

Reports

Orders
The Orders Report can be filtered by time interval, date
and status. The report includes the number of orders
placed and canceled, with totals for sales, amounts
invoiced, refunded, tax collected, shipping charged, and
discounts.

Tax
The Tax Report can be filtered by time interval, date, and
status. The report includes the tax rule applied, tax rate,
number of orders, and amount of tax charged.

Invoiced
The Invoice Report can be filtered by time interval, date,
and status. The report includes the number of orderss
and invoices during the time period, with amounts
invoiced, paid, and unpaid.

876

Magento Community Edition 2.1 User Guide

CHAPTER 65: Sales Reports

Shipping
The Shipping Report can be filtered by time interval, date,
and status. The report includes the number of orders for
carrier or shipping method used,with amounts for total
sales shipping and and total shipping.

Refunds
The Refunds Report can be filtered by time interval, date,
and status. The report includes the number of refunded
orders, and total amount refunded online and offline.

Coupons
The Coupons Report can be filtered by time interval,
date, and status. The report includes each coupon code
used during the specified time interval, related price rule,
and number of times used with totals and subtotals for
sales and discounts.

PayPal Settlement
The PayPal Settlement Report can be filtered by date,
merchant account, transaction ID, invoice ID, or PayPal
reference ID. The report includes the type of event, such
as a debit card transaction, the start and finish dates,
gross amount, and related fees. The report can be
automatically updated with the most current data from
PayPal.

Magento Community Edition 2.1 User Guide

877

878

Magento Community Edition 2.1 User Guide

CHAPTER 66:

Customer Reports
Customer reports provide insight into customer activity during a specified period of time or
date range.

Order Total Report

Magento Community Edition 2.1 User Guide

879

CHAPTER 66: Customer Reports

Reports

Order Total
The Order Total Report shows customer orders for a
specified time interval or date range. The report includes
the number of orders per customer, average order
amount, and total amount.

Order Count
The Order Count Report shows the number of orders per
customer for a specified time interval or date range. The
report includes the number of orders per customer,
average order amount, and total amount.

New Accounts
The New Accounts Report shows the number of new
customer accounts opened during a specified time
interval or date range.

880

Magento Community Edition 2.1 User Guide

CHAPTER 67:

Product Reports
The product reports give you insight regarding products viewed and ordered, bestsellers, stock
levels, and downloads.

Product Views Report

Magento Community Edition 2.1 User Guide

881

CHAPTER 67: Product Reports

Reports

Product Views
The Product Views Report shows the products that have
been viewed during a time interval or range of dates. The
report includes the product name, price, and number of
views.

Bestsellers
The Bestsellers Report shows the five top-selling five
during an interval of time or date range. The report
includes the product name, price, and quantity ordered.

Low Stock
The Low Stock Report lists all products with stock levels
within a specified range.

882

Magento Community Edition 2.1 User Guide

CHAPTER 68: New Relic Reporting

Ordered Products
The Ordered Products Report lists all products ordered
for a specified time interval or date range. The report
includes the product name and quantity ordered.

Downloads
The Downloads Report lists all downloads during the
specified time interval or date range. The report includes
the product name, download link, and SKU, with the
number of purchases and downloads.

CHAPTER 68:

New Relic Reporting
New Relic is a SaaS based subscription service that provides detailed real-time visibility into
business and performance metrics for data-driven decision making.

Step 1: Sign Up for a New Relic Account
1.

Visit the New Relic website, and sign up for an account. You can also sign up for a free trial
account.

Follow the instructions on the site. When prompted choose the product that you want to
install first.

While you are in your account, locate the following credentials that you will need to complete
the configuration:
Account ID

From your New Relic account dashboard, the Account ID is the number in
the URL after: /accounts

Application ID

From your New Relic account dashboard, tap New Relic APM. In the menu,
choose Applications. Then, choose your application. The Application ID is
the number in the URL after: /applications/

Magento Community Edition 2.1 User Guide

883

CHAPTER 68: New Relic Reporting

New Relic API Key

From your New Relic account dashboard, tap Account Settings. In the menu
on the left under Integrations, choose Data Sharing. Your API key can be
created, regenerated, or deleted from this page.

Insights API Key

From your New Relic account dashboard, tap Insights. In the menu on the
left under Administration, choose API Keys. Your Insights API Key(s) appear
on this page. If necessary, click the plus sign (+) next to Insert Keys to
generate a key.

Step 2: Install the New Relic Agent on Your Server
To use New Relic APM Pro to gather and transmit data, the PHP agent must be installed on
your server.
1.

When prompted to choose a web agent, tap PHP.

Follow the instructions to set up the PHP agent on your server. If you need help, see: New Relic
for PHP.

Make sure that cron is running on your server. To learn more, see: Configure and run cron.

Step 3: Configure Your Store
1.

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

In the panel on the left under General, choose New Relic Reporting. Then, do the following:

New Relic Reporting

884

Set Enable New Relic Integration to “Yes.”

In the Insights API URL, replace the percent (% symbol with your New Relic Account ID.

Magento Community Edition 2.1 User Guide

CHAPTER 68: New Relic Reporting

New Relic Queries

Enter your New Relic Account ID.

Enter your New Relic Application ID.

Enter your New Relic API Key.

Enter you Insights API Key.

In the New Relic Application Name field, enter a name to identify the configuration for
internal reference.

When complete, tap Save Config.

Step 4: Enable Cron for New Relic Reporting
1.

Expand

the Cron section.

Cron
2.

Set Enable Cron to”Yes.

When complete, tap Save Config.

New Relic Queries
New Relic Insights data is based on statements that are written in New Relic Query Language
(NRQL), as well as any custom parameters that you might include. Data can be returned from
adhoc queries, or by queries saved to your dashboard. To learn more, see the NRQL Reference in
the New Relic documentation.

Admin Events
Active Admin Users
Widget Name:

Active Admin Users

Description:

Returns the number of active admin users.

SELECT uniqueCount(AdminId)
FROM Transaction
WHERE appName='' SINCE 15 minutes ago

Magento Community Edition 2.1 User Guide

885

New Relic Queries

CHAPTER 68: New Relic Reporting

Currently Active Admins
Widget Name:

Currently Active Admins

Description:

Returns the names of active admin users.

SELECT uniques(AdminName)
FROM Transaction
WHERE appName='' SINCE 15 minutes ago

Recent Admin Activity
Widget Name:

Recent Admin Activity

Description:

Returns the number of recent admin actions.

SELECT count(AdminId)
FROM Transaction
WHERE appName ='' FACET AdminName SINCE 1 day ago

Latest Admin Activity
Widget Name:

Latest Admin Activity

Description:

Returns detail information about recent admin actions, including the admin
username, duration, and application name.

SELECT AdminName, duration, name
FROM Transaction
WHERE appName='' AND AdminName IS NOT NULL
AND AdminName != 'N/A' LIMIT 50

Cron Events
Category Count
Widget Name:

Category Count

Description:

Returns the number of application events by category during the specified
time period.

SELECT average(CatalogCategoryCount)
FROM Cron

886

Magento Community Edition 2.1 User Guide

CHAPTER 68: New Relic Reporting

New Relic Queries

WHERE CatalogCategoryCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Current Catalog Count
Widget Name:

Current Catalog Count

Description:

Returns the average number of application events in the catalog by category
during the specified time period.

SELECT average(CatalogCategoryCount)
FROM Cron
WHERE CatalogCategoryCount IS NOT NULL
AND CatalogCategoryCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

Active Products
Widget Name:

Active Products

Description:

Returns the number of application events by product during the specified
time period.

SELECT average(CatalogProductActiveCount)
FROM Cron
WHERE CatalogProductActiveCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Active Product Count
Widget Name:

Active Product Count

Description:

Returns the average number of active application events by product during
the specified time period.

SELECT average(CatalogProductActiveCount)
FROM Cron
WHERE CatalogProductActiveCount IS NOT NULL
AND CatalogProductActiveCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

Magento Community Edition 2.1 User Guide

887

New Relic Queries

CHAPTER 68: New Relic Reporting

Configurable Products
Widget Name:

Configurable Products

Description:

Returns the average number of application events forconfigurable products
during the specified time period.

SELECT average(CatalogProductConfigurableCount)
FROM Cron
WHERE CatalogProductConfigurableCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Configurable Product Count
Widget Name:

Configurable Product Count

Description:

Returns the average number of application events by configurable product
during the specified time period.

SELECT average(CatalogProductConfigurableCount)
FROM Cron
WHERE CatalogProductConfigurableCount IS NOT NULL
AND CatalogProductConfigurableCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

Product Count (all)
Widget Name:

Product Count (all)

Description:

Returns the total number of application events for all products.

SELECT average(CatalogProductCount)
FROM Cron
WHERE CatalogProductCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Current Product Count (all)

888

Widget Name:

Current Product Count (all)

Description:

Returns the average number of application events for all products during the
specified time period.

Magento Community Edition 2.1 User Guide

CHAPTER 68: New Relic Reporting

New Relic Queries

SELECT average(CatalogProductCount)
FROM Cron
WHERE CatalogProductCount IS NOT NULL
AND CatalogProductCount > 0
AND appName = '>' SINCE 2 minutes ago LIMIT 1

Customer Count
Widget Name:

Customer Count

Description:

Returns the average number of application events by customer.

SELECT average(CustomerCount)
FROM Cron
WHERE CustomerCount IS NOT NULL
AND CustomerCount > 0
AND appName = '' TIMESERIES 2 minutes

Currrent Customer Count
Widget Name:

Current Customer Count

Description:

Returns the average number of customers during the specified time
period.

SELECT average(CustomerCount)
FROM Cron
WHERE CustomerCount IS NOT NULL
AND CustomerCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

Module Status
Widget Name:

Module Status

Description:

Returns the average number of times application modules are enabled,
disabled, or installed during the specified time period.

SELECT average(ModulesDisabled), average(ModulesEnabled), average

Magento Community Edition 2.1 User Guide

889

New Relic Queries

CHAPTER 68: New Relic Reporting

(ModulesInstalled)
FROM Cron
WHERE appName = '' TIMESERIES 2 minutes

Current Module Status
Widget Name:

Current Module Status

Description:

Returns the average number of times modules were enabled, disabled, or
installed during the specified time period.

SELECT average(ModulesDisabled), average(ModulesEnabled), average
(ModulesInstalled)
FROM Cron
WHERE appName = '' SINCE 2 minutes ago LIMIT 1

Website and Store Counts
Widget Name:

Website and Store Counts

Description:

Returns the average number of application events by website and store
during the specified time period.

SELECT average(StoreViewCount), average(WebsiteCount)
FROM Cron
WHERE appName = '' TIMESERIES 2 minutes

Current Website and Store Counts
Widget Name:

Current Website and Store Counts

Description:

Returns the average number of current application events during the
specified tim e period.

SELECT average(StoreViewCount), average(WebsiteCount)
FROM Cron
WHERE appName = '' SINCE 2 minutes ago LIMIT 1

890

Magento Community Edition 2.1 User Guide

CHAPTER 68: New Relic Reporting

New Relic Queries

Cron - All Data from Event
Widget Name:

Cron - All Data from Event

Description:

Returns all application event data.

SELECT *
FROM Cron
WHERE appName = ''

Customers
Active Customer Count
Widget Name:

Active Customer Count

Description:

Returns the number of active customers during the specified time period.

SELECT uniqueCount(CustomerId)
FROM Transaction
WHERE appName = '' SINCE 15 minutes ago

Active Customers
Widget Name:

Active Customers

Description:

Returns the names of active customers during the specified time period.

SELECT uniques(CustomerName)
FROM Transaction
WHERE appName='' SINCE 15 minutes ago

Top Customers
Widget Name:

Top Customers

Description:

Returns the top customers during the specified time period.

SELECT count(CustomerId)
FROM Transaction
WHERE appName = '' FACET CustomerName SINCE 1 day ago

Magento Community Edition 2.1 User Guide

891

New Relic Queries

CHAPTER 68: New Relic Reporting

Recent Admin Activity
Widget Name:

Recent Admin Activity

Description:

Returns a defined number of records of recent activity, that include the
customername and duration of visit.

SELECT CustomerName, duration, name
FROM Transaction
WHERE appName=''
AND CustomerName IS NOT NULL
AND CustomerName != 'N/A' LIMIT 50

Orders
Number of Orders Placed
Widget Name:

Number of Orders Placed

Description:

Returns the number of orders placed during the specified time period.

SELECT count(`Order`)
FROM Transaction SINCE 1 day ago

Total Order Value
Widget Name:

Total Order Value

Description:

Returns the total number of line items ordered during the specified time
period.

SELECT sum(LineItemCount)
FROM Transaction SINCE 1 day ago

Total Line Items Ordered
Widget Name:

Total Line Items Ordered

Description:

Returns the total number of line items ordered during the specified time
period.

SELECT sum(LineItemCount)
FROM Transaction SINCE 1 day ago

892

Magento Community Edition 2.1 User Guide

OPERATIONS

893

Stores

EU Tax Guidelines
Warning Messages

In this section of the guide, you’ll learn how to
set up a store hierarchy, create attributes, and
manage the settings used by each store to
calculate taxes, and currency rates,
Stores Menu
All Stores
Adding Store Views

Currency Configuration
Currency Symbols
Updating Currency Rates
Attributes
Product Attributes

Editing a Store View

Creating an Attribute

Adding a Language

Attribute Sets

Translating Products
Translating Content
Adding Stores
Adding Websites
Store URLs
Using a Custom Admin URL
Configuration
Taxes
Tax Rules
Tax Classes
Configuring Tax Classes
Default Tax Destination
EU Place of Supply for Digital Goods
Fixed Product Tax
Configuring FPT
Price Display Settings
Tax Zones and Rates
Import/Export Tax Rates
Value Added Tax (VAT)
Configuring VAT
VAT ID Validation
Configuring VAT ID Validation
Tax Quick Reference
International Tax Guidelines
U.S. Tax Guidelines
Canadian Tax Guidelines

894

Currency

CHAPTER 69:

Stores Menu
The Stores menu manages settings that are used less frequently, but referenced throughout your
Magento installation, including setting up the store hierarchy, configuration, sales and order
settings, tax and currency, product attributes, product review ratings, and customer groups.

Stores Menu

To display the Stores menu:
On the Admin sidebar, tap Stores .

Magento Community Edition 2.1 User Guide

895

CHAPTER 69: Stores Menu

Menu Options

All Stores
Manage the hierarchy of websites, stores and store
views in your Magento installation, and all configuration
settings. In addition, you can set up the Terms and
Conditions of a sale, and manage order status settings.

Taxes
Set up the tax rules for your store, define customer and
product tax classes, and manage tax zones and rates.
You can also import tax rate data into your store.

Currency
Manage the rates for the currencies that are accepted as
payment in your store, and customize the currency
symbols that appear in product prices and sales
documents.

Attributes
Manage attributes that are used for product information
and product ratings. You can create new attributes, edit
existing attributes, and manage attribute sets.

Other Settings
Manage the tax class that is assigned to each customer
group.

896

Magento Community Edition 2.1 User Guide

CHAPTER 70:

All Stores
When Magento Community Edition 2.1 is installed, a hierarchy that includes a main website,
store, and store view is created. You can create additional websites, stores, and store views, as
needed. For example, in addition to your main website, you might have a additional websites
with a different domain. Within each website, you can have multiple stores, and within each
store, separate store views. Many installations have one website and one store, but with
multiple store views to support different languages.
Before you begin, plan your store hierarchy in advance because it is referred to throughout the
configuration. Each store can have a separate root category, which makes it possible to have an
entirely different set of main menu options for each store.

Store Hierarchy

Magento Community Edition 2.1 User Guide

897

Adding Store Views

CHAPTER 70: All Stores

Adding Store Views
Store views are typically used to make the store available in different locales. Shoppers can use
the language chooser in the header of the store to change the store view.

Multiple Store Views

To create a new store view:
1.

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

All Stores

898

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Adding Store Views

Tap Create Store View . Then, do the following:

Store View Information

Set Store to the parent store of this view.

Enter a Name for this store view. The name appears in the language chooser in the store
header. For example: Spanish.

Enter a Code in lowercase characters to identify the view. For example: spanish.

To activate the view, set Status to “Enabled.”

(Optional) Enter a Sort Order number to determine the sequence in which this view is
listed with other views.

When complete, tap Save Store View .

Magento Community Edition 2.1 User Guide

899

Adding Store Views

CHAPTER 70: All Stores

Editing a Store View
Because the view name appears in the language chooser, you might eventually want to change
the name of the default view to something more descriptive. The Name field is simply a label,
and can be easily changed.
If your Magento installation has a multisite or multistore setup, do not change the store Code
field without verifying that the value is not referenced in the index.php file. If you do not have
access to the server to examine the file, ask a developer for help.

FIELD

ORIGINAL VALUE

UPDATED VALUE

Name

Default Store View

English

Code

default

english

To edit a store view:
1.

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

In the Store View column of the grid, click the name of the view that you want to edit.
When editing the default view, the Store and Status fields are not available.

Editing the Default View

900

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Adding Store Views

Update the following fields as applicable:
l

Store (non-default views only)

Name

Code (only if not used in index.php)

Status (non-default views only)

Sort Order

When complete, tap Save Store View.

Stores

Magento Community Edition 2.1 User Guide

901

Adding Store Views

CHAPTER 70: All Stores

Adding a Language
Most of the text that appears to be hard-coded on pages throughout your store can be instantly
changed to a different language by changing the locale of the view. Changing the locale doesn’t
actually translate the text word-for-word, but simply references a different translation table
that provides the interface text that is used throughout the store. The text that can be changed
includes navigational titles, labels, buttons, and links such as “My Cart” and “My Account.”
You can also use the Inline Translation tool to touch up text in the interface.
Language packs can be found under "Translations & Localization" on Magento Marketplace.
New extensions are continually added to Marketplace, so check back often!

Step 1: Install a Language Pack
Follow the standard instructions to install the language pack extension from Component
Manager.

Step 2: Create a Store View for the Language
1.

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

Tap Create Store View. Then, do the following:
a.

Choose the Store that is the parent of the view.

Enter a Name for the store view. For example: Portuguese.
In the header of the store, the name appears in the “language chooser.”

902

Enter a Code in lowercase characters to identify the view. For example: portuguese.

To activate the view, set Status to “Enabled.”

(Optional) Enter a Sort Order number to determine the sequence in which this view is
listed with other views.

When complete, tap Save Store View.

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Adding Store Views

Step 3: Change the Locale of the Store View
1.

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

In the upper-left corner, set Store View to the specific view where the configuration is to apply.
When prompted to confirm scope switching, tap OK.

Expand

the Locale Options section.

Clear the Use Website checkbox after the Locale field. Then, set Locale to the language that
you want to assign to the view.
If there are several variations of the language available, make sure to choose the one for the
specific region or dialect.

When complete, tap Save Config.
After you change the language of the locale, the remaining content that you have created,
including product names and descriptions, categories, CMS pages, and blocks must be
translated separately for each store view.

Magento Community Edition 2.1 User Guide

903

Adding Store Views

CHAPTER 70: All Stores

Translating Products
If your store has multiple views in different languages, the same products are available in each
store view. You can use the same basic product information, such as SKU, price, and inventory
level, regardless of language. Then, translate only the product name, description fields, and
meta data as needed for each language.
Process Overview:
Step 1: Translate Product Fields
Step 2: Translate Field Labels
Step 3: Translate All Categories

Step 1: Translate Product Fields
1.

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

In the grid, find the product to be translated, and open in edit mode.

In the upper-left corner set Store View to the view for the translation. When prompted to
confirm, tap OK .

For each field to be edited, do the following:
a.

Clear the Use Default Value checkbox to the right of the field.

Either paste or type the translated text into the field.

Make sure to translate all text fields, including image labels and Alt text, Search Engine
Optimization fields and any Custom Options information.
5.

When complete, tap Save .

Step 2: Translate Field Labels

904

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

In the list, find the attribute to be translated, and open in edit mode.

In the panel on the left, choose Manage Labels.

In the Manage Titles section, enter a translated label for each store view.

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Adding Store Views

Enter Translated Labels
5.

When complete, tap Save Attribute .

Step 3: Translate All Categories
1.

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

In the upper-left corner set Store View to the view for the translation. When prompted to
confirm, tap OK .

In the tree, find the category to be translated and open in edit mode.

On the General Information tab, translate the following fields:

Name

Description

Page Title

Meta Keywords

Meta Description

To translate the URL Key, do the following:
a.

Clear the Use Default Value checkbox to the right of the field.

Enter the translated text.

Make sure that the Create Permanent Redirect for old URL checkbox is selected

Translate URL Key
6.

When complete, tap Save Category .

Repeat the process for all categories used in the store.

Magento Community Edition 2.1 User Guide

905

Adding Store Views

CHAPTER 70: All Stores

Translating Content
If your store has multiple views in different languages, and you have set the locale for each
view to a different language, the result is a partially translated site. The next step is to create a
translated version of each page that is available from the specific store view. The Store View
column of the Manage Pages list shows each view that has a translated version of the page.
To translate a content page, you must create a new page that has the same URL Key as the
original, but is assigned to the specific store view. Then, update the page for the specific view
with the translated text. The following example shows how to create a translated version of the
“About Us” page for the Spanish store view.

To create a translated page for a view:
1.

On the Admin sidebar, tap Content. Then under Elements, choose Pages.

In the grid, find the page to be translated, and open in edit mode.

Copy the URL Key to the clipboard. Then, press the Back button to return to the Pages grid.

Tap Add New Page. Then, do the following:
a.

Enter the translated Page Title.

Paste the URL Key that you copied from the original page.

In the Store View box, choose the store view where the page is to be available.

In the panel on the left, choose Content. Then, complete the translated text for the page.

On the Design tab, set the column Layout of the page.

On the Meta Data tab, enter the translated text for the Keywords and Description.

When complete, tap Save Page. Then when prompted, refresh any invalid caches.

To verify the translation, go to the storefront and use the language chooser to change the store
view.
Notice that there are still some elements on the page that need to be translated, including the
company footer links block, the welcome message, and product information.

906

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Adding Stores

Adding Stores
A single installation of Magento can have multiple stores that share the same Admin. Stores
that are under the same website have the same IP address and domain, use the same security
certificate, and share a single checkout process.
The important thing to understand is that the stores use the same Magento code, and share the
same Admin. Each store can have a separate catalog, or share the same catalog. Each store can
have a separate root category, which makes it possible to have a different main menu for each
store. Stores can have different branding, presentation, and content. Before you begin, take
some time to plan your store hierarchy with future growth in mind, because it is used
throughout the configuration.

Multiple Stores
Here are some examples of how URLs can be configured for multiple stores:
yourdomain.com/store1

Each store has a different path, but shares the same domain.

yourdomain.com/store2
store1.yourdomain.com

Each store has a different subdomain of the primary domain.

store2.yourdomain.com

Process Overview:
Step 1: Choose the Store Domain
Step 2: Create the New Store
Step 3: Create a Default Store View
Step 4: Configure the Store URL

Magento Community Edition 2.1 User Guide

907

Adding Stores

CHAPTER 70: All Stores

Step 1: Choose the Store Domain
The first step is to choose how you want to position the store. Will the stores share the same
domain, each have a subdomain, or have distinctly different domains? For each store, do one
of the following:
l

To place the store one level below the primary domain, you don’t have to do anything.

Set up a subdomain of your primary domain.

Set up a different primary domain.

Step 2: Create the New Store
1.

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

Tap Create Store. Then, do the following:
a.

Choose the Web Site that is to be the parent of the new store. If the installation has only
one web site, accept the default, “Main Website.”

Enter a Name for the new store. The name is for internal reference only.

Set Root Category to the root category that defines the category structure for the main
menu of the new store. If you have already created a specific root category for the store,
select it. Otherwise, select “Default Category.” You can come back later and update the
setting.

Store Information
3.

When complete, tap Save Store .

New Store

908

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Adding Stores

Step 3: Create a Default Store View
1.

Tap Create Store View . Then, do the following:
a.

Set Store to the new store you created.

Enter a Name for the view. For example, "English."

Enter a Code for the view in lowercase characters.

Set Status to "Enabled."

In the Sort Order field, enter a number to determine the store's position when listed with
other stores.

Tap Save Store View .
If you were to open your store in edit mode, you would see that it now has a default view.

New Store with Default View

Step 4: Configure the Store URL
1.

On the menu bar, tap Stores. Then under Settings, choose Configuration.

In the panel on the left under General, choose Web.

In the upper-left corner, set Store View to the view that you created for the new store. When
prompted to confirm scope switching, tap OK .

Magento Community Edition 2.1 User Guide

909

Adding Stores

CHAPTER 70: All Stores

Choose the New Store View
4.

Expand

the Base URLs section. Then, do the following:

After the Base URL field, clear the Use Website checkbox.

Enter the Base URL for the store.

Base URLs
5.

Expand

the Secure Base URLs section, and repeat the previous step as needed to

configure the store’s secure URL.
6.

910

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Adding Websites

Adding Websites
Multiple websites can be set up that use the same Magento installation. The websites can be set
up to use the same domain, or different domains. If you want each store to have a dedicated
checkout process under its own domain, each store must have a distinct IP address and
separate security certificate.

Multiple Websites

Step 1: Create a New Website
1.

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

Tap Create Website . Then, do the following:

Website Information

Magento Community Edition 2.1 User Guide

911

Adding Websites

CHAPTER 70: All Stores

In the Name field, enter the domain of the new website. For example, “domain.com.”

Enter a Code that will be used on the server to point to the domain.
The code must begin with a lowercase (a-z) letter, and can include any combination of
letters (a-z), numbers (0-9), and the underscore (_) symbol.

(Optional) Enter a Sort Order number to determine the sequence in which this site is
listed with other sites. Enter a zero to make this site appear at the top of the list.

To make this the default website for your Magento installation, mark the Set as Default
checkbox.

When complete, tap Save Website .

Set up each store and store view that is needed for the new website.

Step 2: Configure the Store URL
Follow the instructions to configure the store URLs.

912

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Store URLs

Store URLs
Each website in a Magento installation has a base URL that is assigned to the storefront, and
another URL that is assigned to the Admin. Magento uses variables to define internal links in
relation to the base URL, which makes it possible to move an entire store from one location to
another without updating the links. Standard base URLs begin with http, and secure base
URLs begin with https.
Base URL

http://www.yourdomain.com/magento/

Secure Base URL

https://www.yourdomain.com/magento/

URL with IP address

http://###.###.###.###/magento/
https://###.###.###.###/magento/

Important! Do not change the Admin URL from the default Base URL configuration. To change the
Admin URL or path, see: Using a Custom Admin URL.

Use Secure Protocol
The base URLs for your store were initially set up during the Web Configuration step of the
Magento installation. If a security certificate was available at the time, you could specify for
secure (https) URLs to be used for the store, Admin, or both. If your Magento installation
includes multiple stores, or if you plan to later add more stores, you can include the store code
in the URL. All Magento resources and operations can be used with secure protocol.
If a security certificate wasn't available for the domain at the time of the installation, make sure
to update the configuration before launching your store. After a security certificate is
established for your domain, you can configure either or both base URLs to operate with
encrypted Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocol.
Magento strongly recommends for all pages of a production site, including content and product
pages, to be transmitted with secure protocol.

Magento can be configured to deliver all pages over https by default. If your store has been
running up until now with standard protocol, you can improve security by enabling
HTTP Strict Transport Security (HSTS). and by upgrading any insecure page requests that are
received by the store. HSTS is an opt-in protocol that prevents browsers from rendering
standard http pages that are transmitted with unsecure protocol for the specificed domain.
Because search engines might have already indexed each page of your store with standard http
URLs, you can configure Magento to automatically upgrade any unsecure page requests to
https, so you don't lose any traffic. When Magento is configured to use secure URLs for both
the store and Admin, two additional fields appear that allow you to enable HSTS.

Magento Community Edition 2.1 User Guide

913

Store URLs

CHAPTER 70: All Stores

To configure the base URL:
1.

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

In the panel on the left, under General, choose Web.

Expand

the Base URL section, and do the following:

Enter the fully qualified Base URL for your store. Make sure to end the URL with a

forward slash, so it can be extended with additional URL Keys from your store. For
example:
http://yourdomain.com/

Do not change the placeholder in the Base Link URL field. It is a placeholder that is used to
create relative links to the base URL.

(Optional) To specify an alternate location for the Base URL for Static View Files, enter
the path starting with the following placeholder:
{{unsecure_base_url}}

(Optional) To specify an alternate location for the Base URL for User Media Files, enter
the path starting with the following placeholder:
{{unsecure_base_url}}

For a typical installation, there is no need to update the paths for the static view files or
media files because they are relative to the base URL.

Base URLs
Placeholders enclosed in double braces are markup tags for variables.

914

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Store URLs

To configure the secure base URL:
If your domain has a valid security certificate, you can configure the URLs of both the
storefront and Admin to transmit data over a secure (https) channel. Without a valid security
certificate, your store cannot operate with secure (SSL/TLS) protocol.
1.

Expand

the Base URLs (Secure) section. Then, do the following:

Base URLs (Secure)
a.

Enter the full Secure Base URL, followed by a forward slash. For example:
https://yourdomain.com/

Do not change the placeholder in the Secure Base Link URL field. It is used to create
relative links to the secure base URL.

(Optional) To specify an alternate location for the Secure Base URL for Static View Files,
enter the path starting with the following placeholder:
{{secure_base_url}}

(Optional) To specify an alternate location for the Secure Base URL for User Media Files,
enter the path starting with the following placeholder:
{{secure_base_url}}

Magento Community Edition 2.1 User Guide

915

Store URLs

CHAPTER 70: All Stores

To enhance security, set both of the following options to "Yes."
l

Use Secure URLs on Storefront

Use Secure URLs in Admin

When the following additional fields appear , do the following:

Enhanced Security Settings
a.

If you want your store to display only secure https page requests, set Enable HTTP Strict
Transport Security (HSTS) to "Yes."

916

To upgrade any requests for standard unsecured http pages to secure https, set Upgrade
Insecure Requests to "Yes."

When complete, tap Save Config .

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Store URLs

To include the store code in URLs:
1.

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

In the panel on the left, under General, choose Web.

Expand

Set Add Store Code to your preference.

the URL Options section.

URL with Store Code

http://www.yourdomain.com/magento/[store-code]/index.php/url-identifier
URL without Store Code

http://www.yourdomain.com/magento/index.php/url-identifier

URL Options

Magento Community Edition 2.1 User Guide

917

Store URLs

CHAPTER 70: All Stores

When complete, tap Save Config .

After the setting is saved, you will be prompted to refresh the cache. Tap the Cache
Management link in the message at the top of the workspace. Then, follow the instructions to
refresh the cache.

Refresh Cache

918

Magento Community Edition 2.1 User Guide

CHAPTER 70: All Stores

Store URLs

Using a Custom Admin URL
As a security best practice, Magento recommends that you use a unique, custom Admin URL
instead of the default “admin” or a common term such as “backend”. Although it will not
directly protect your site from a determined bad actor, it can reduce exposure to scripts that try
to gain unauthorized access.
Check with your hosting provider before implementing a custom Admin URL. Some hosting providers
require a standard URL to meet firewall protection rules.

In a typical Magento installation, the Admin URL and path is immediately below the Magento
base URL. The path to the store Admin is one directory below the root.

Default Base URL
http://yourdomain.com/magento/

Default Admin URL and Path
http://yourdomain.com/magento/admin

Although it is possible to change the Admin URL and path to another location, any mistake
removes access to the Admin, and must be corrected from the server.
As a precaution, do not try to change the Admin URL by yourself unless you know how to edit
configuration files on the server.

Method 1: Change from the Magento Admin
1.

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

In the panel on the left, under Advanced, choose Admin.

Expand

the Admin Base URL section. Then, do the following:

Clear the first Use system value checkbox. Then, set Use Custom Admin URL to “Yes”.

Clear the next Use system valuel checkbox. Then, enter the Custom Admin URL in the
following format:
http://yourdomain.com/magento/

Important! The Admin URL must be in the same Magento installation, and have the same
document root as the storefront.
c.

Clear the next Use system valuel checkbox. Then, set Custom Admin Path to “Yes”.

Magento Community Edition 2.1 User Guide

919

Store URLs

CHAPTER 70: All Stores

Clear the next Use system valuel checkbox. Then, enter the Custom Admin Path.
The path that you enter is appended to the Custom Admin URL after the last forward
slash.
sample_custom_admin

Admin Base URL
4.

When complete, tap Save Config.

After the changes are saved, Sign Out of the Admin. Then, log back in using the new Admin
URL and path.

Method 2: Change from the Server Command Line
1.

Open the app/etc/env.php file in a text editor, and change the name of the [admin] path.
Make sure to use only lowercase characters. Then, save the file.
On the server, the admin path is located in the app/etc/env.php file. Look for the
argument in the section:
Default Admin Path

#
New Admin Path

Use one of the following methods to clear the Magento cache:
l

920

On the Admin sidebar, tap System. Under Tools, choose Cache Management. Then, tap
Flush Magento Cache.
On the server, navigate to the var/cache folder, and delete the contents of the cache folder.

Magento Community Edition 2.1 User Guide

CHAPTER 71:

Configuration
The online Configuration Reference has field descriptions for every configuration setting in
Magento Community Edition 2.1. To learn how to apply configuration settings to specific store
views, see: Scope.

Configuration

Configuration Tabs

General
Includes basic configuration settings for the store, URLs,
theme, currency, email addresses, store contacts, editor,
and dashboard reports.

Catalog
Determines product and inventory settings, controls
sitemap and RSS feed generation, and specifies the
email template that is used to share products with
friends.

Magento Community Edition 2.1 User Guide

921

CHAPTER 71: Configuration

Customers
Establishes basic customer account and login options,
newsletter settings, ,wish list, and the format of autogenerated coupon codes.

Sales
Determines checkout and tax settings, payment and
shipping options, sales email and PDF print-outs, and
Google API settings.

Services
Configures Magento API settings, including SOAP and
OAuth.

Advanced
Determines default Admin settings, various system
configuration settings, advanced module controls, and
developer tools.

922

Magento Community Edition 2.1 User Guide

CHAPTER 72:

Taxes
In this section of the guide, you will learn how to set up taxes according to the requirements of
your locale. You can set up tax classes for products and customer groups, and create tax rules
that combine product and customer classes, tax zones, and rates. In addition, you'll learn more
advanced topics such as setting up fixed product taxes, compound taxes, and displaying
consistent prices across international borders. If you are required to collect a value-added tax,
you will learn how to set up your store to automatically calculate the appropriate amount with
validation.
Magento provides a variety of options to define taxes. Tax classes are used to define “tax rules.”
Tax rules are a combination of a Product Class, a Customer Class and a Tax Zone and Rate.
Magento also supports the calculation of Value-Added Tax (VAT) for business-to-business
transactions in the European Union.

Magento Community Edition 2.1 User Guide

923

Tax Rules

CHAPTER 72: Taxes

Tax Rules
Tax rules incorporate a combination of product class, customer class and tax rate. Each
customer is assigned to a customer class, and each product is assigned a product class.
Magento analyzes the shopping cart of each customer and calculates the appropriate tax
according to the customer and product classes, and the region (based on the customer’s
shipping address, billing address or shipping origin).
When numerous taxes must be defined, you can simplify the process by importing them.

Tax Rules

Step 1: Complete the Tax Rule Information
1.

On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Rules.

In the upper-right corner, tap Add New Tax Rule .

Under Tax Rule Information, enter a Name for the new rule.

Choose the Tax Rate that applies to the rule. If you need to edit an existing tax rate, do the
following:

924

Hover over the tax rate, and tap the Edit

icon.

Update the form as needed, and tap Save .

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Rules

Tax Rule Information
To enter tax rates, use either of the following methods:

Method 1: Enter Tax Rates Manually
1.

Tap Add New Tax Rate.

Complete the form as needed. For more information, see: Tax Zones and Rates.

When complete, tap Save .

New Tax Rate

Magento Community Edition 2.1 User Guide

925

Tax Rules

CHAPTER 72: Taxes

Method 2: Import Tax Rates
1.

Scroll down to the section at the bottom of the page.

To import tax rates, do the following:

Tap Choose File, and navigate to the CSV file with the tax rates to be imported.

Tap Import Tax Rates.

To export tax rates, tap Export Tax Rates.
To learn more, see: Import/Export Tax Rates.

Import / Export Tax Rates

Step 2: Complete the Additional Settings
4.

Tap Additional Settings to open the section. Then, do the following:
a.

Choose the Customer Tax Class to which the rule applies.
l

icon. Then, update the form as needed, and

To create a new tax class, tap Add New Tax Class. Then, complete the form as needed,
and tap Save .

Choose the Product Tax Class to which the rule applies.
l

926

To edit a customer tax class, tap the edit
tap Save .

To edit a product tax class, tap the edit
tap Save .

icon. Then, update the form as needed, and

To create a new tax class, tap Add New Tax Class. Then, complete the form as needed,
and tap Save .

In the Priority field, enter a number to indicate the priority of this tax, when more than
one tax applies. If two tax rules with the same priority apply, then the taxes are added
together. If two taxes with different priority settings apply, then the taxes are
compounded.

If you want taxes to be based on the order subtotal, mark the Calculate off Subtotal Only
checkbox.

In the Sort Order field, enter a number to indicate the order of this tax rule when listed
with others.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Rules

Additional Settings
5.

When complete, tap Save Rule .

Magento Community Edition 2.1 User Guide

927

Tax Classes

CHAPTER 72: Taxes

Tax Classes
Tax classes can be assigned to customers, products, and shipping. Magento analyzes the
shopping cart of each customer and calculates the appropriate tax according to the class of the
customer, the class of the products in the cart, and the region (as determined by the customer’s
shipping address, billing address or shipping origin). New tax classes can be created when a
tax rule is defined.

Customer
You can create as many customer tax classes as you
need, and assign them to customer groups. For example,
in some jurisdictions, wholesale transactions are not
taxed, but retail transactions are. You can associate
members of the Wholesale Customer group with the
Wholesale tax class.

Product
Product classes are used in calculations to determine the
correct tax rate is applied in the shopping cart. When you
create product, it is assigned to a specific tax class. For
example, food might not be taxed, or be taxed at a
different rate.

Shipping
If your store charges an additional tax on shipping, you
should designate a specific product tax class for
shipping. Then in the configuration, specify it as the tax
class that is used for shipping.

928

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Classes

Configuring Tax Classes
The tax class that is used for shipping, and the default tax classes for products and customers
are set in the Sales configuration.

Tax Classes

To configure tax classes:
1.

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

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

Expand

the Tax Classes section. Then, choose the tax class for each of the following:

Set Tax Class for Shipping

Default Tax Class for Product

Default Tax Class for Customer

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

929

Tax Classes

CHAPTER 72: Taxes

Default Tax Destination
The default tax destination settings determine the country, state, and ZIP or postal code that
are used as the basis of tax calculations.

Default Tax Destination Calculation

To configure the default tax destination for calculations:
1.

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

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

Expand

930

the Default Tax Destination Calculation section. Then, do the following:

Set Default Country to the country upon which tax calculations are based.

Set Default State to the state or province that is used as the basis of tax calculations.

Set Default Post Code to the ZIP or postal code that is used as the basis of local tax
calculations.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Classes

EU Place of Supply for Digital Goods
European Union (EU) merchants must report their digital goods sold by quarter to each
member country. Digital goods are taxed based on the customer's billing address. The law
requires merchants to run a tax report and identify the relevant tax amounts for digital goods,
as opposed to physical goods.
Merchants must report all digital goods sold by EU member countries on a quarterly basis to a
central tax administration, along with payment due for tax collected during the period.
Merchants who have not yet reached the threshold (50k/100k Euro of annual business) must
continue to report physical goods sold to the EU states where they have registered VAT
numbers.
Merchants who are audited for taxes paid for digital goods, must provide two pieces of
supporting information to establish the customer place of residence.
l

The customer’s billing address and a record of a successful payment transaction can be used
to establish the customer place of residence. (Payment is accepted only if the billing address
matches payment provider information.)
The information can also be captured directly from the data store in the Magento database
tables.

To collect digital goods tax information:
1.

Load the tax rates for all EU member countries.

Create a digital goods product tax class.

Assign all your digital goods to the digital goods product tax class.

Create tax rules for your physical goods, using physical product tax classes, and associate them
with the appropriate tax rates.

Create tax rules for your digital goods, using use the product tax class for digital goods, and
associate them with the appropriate tax rates for EU member countries.

Run the tax report for the appropriate period, and collect the required digital goods
information.

Export the tax amounts that are related to the tax rates for the digital goods product tax class.

See also:
European Commission Taxation and Customs Union
EU 1015 Place of Supply Changes

Magento Community Edition 2.1 User Guide

931

Fixed Product Tax

CHAPTER 72: Taxes

Fixed Product Tax
Some tax jurisdictions have a fixed tax that must be added to certain types of products. You
can set up a fixed product tax (FPT) as needed for your store's tax calculations. For example, in
some countries FPT can be used to set up a Waste Electrical and Electronic Equipment
Directive (WEEE) tax, also known as "ecological tax" or "eco tax," that is collected on certain
types of electronics to offset the cost of recycling. This tax is a fixed amount, rather than a
percentage of the product price.
Fixed product taxes apply at the item level, based on the product. In some jurisdictions this
tax is subject to an additional % tax calculation. Your tax jurisdiction might also have rules
about how the product price appears to customers, either with or without tax. Be sure that you
understand the rules, and set your FPT display options accordingly.
We recommend that you exercise caution when quoting FPT prices in email, because the
difference in price can affect customer confidence in their orders. For example, if you display
Order Review prices without showing FPT, customers who buy items with associated FPT will
see a total that includes the FPT tax amount, but without an itemized breakdown. The
difference in price might lead some customers to abandon their carts because the total differs
from the amount expected.

FPT Display Prices
FPT
Not Taxed

Taxed

932

DISPLAY SETTING AND CALCULATION
Excluding FPT

FPT appears as a separate row in the cart, and the
value is used in appropriate tax calculations.

Including FPT

FPT is added to the base price of an item; but is not
included in tax- rule-based calculations.

Excluding FPT,
FPT Description,
Final Price

Prices appeare without FPT amount or description.
FPT is not included in tax-rule-based calculations.

Excluding FPT

FPT appears as a separate row in the cart, and the
value is used in appropriate tax calculations.

Including FPT

FPT is included in the price of an item, and no change
to tax calculations is required.

Excluding FPT,
FPT Description,
Final Price

Prices appear without the FPT amount or description.
However, FPT is included in tax-rule-based
calculations.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Fixed Product Tax

Configuring FPT
The Fixed Product Tax input type creates a section of fields for managing tax for each region.
The following instructions show how to set up a fixed product tax for your store, using “eco
tax” as an example. After setting the scope for the tax and the countries and states where the
tax applies, and depending on the options you choose, the input fields can change according to
the local requirements. To learn more, see: Creating Attributes.
Process Overview:
Step 1: Enable Fixed Product Tax
Step 2: Create an FPT Attribute
Step 3: Add the FPT Attribute to an Attribute Set
Step 4: Apply FPT to Products

Step 1: Enable Fixed Product Tax
1.

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

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

Expand

the Fixed Product Taxes section. Then, do the following:

Set Enable FPT to “Yes.”

To determine how fixed product taxes are used in store prices, choose the FPT setting for
each of the following price display locations. (The options are the same for each location.)
l

Product View Page

Sales Modules

Emails

OPTIONS
Including FPT Only
Including FPT and FPT description
Excluding FPT. Including FPT description and final price
Excluding FPT
c.

Set Apply Tax to FPT as needed.

Set Include FPT in Subtotal as needed.

Magento Community Edition 2.1 User Guide

933

Fixed Product Tax

CHAPTER 72: Taxes

Fixed Product Taxes
4.

When complete, tap Save Config.

Step 2: Create an FPT Attribute
1.

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

In the upper-right corner, tap Add New Attribute. Then, do the following:
a.

Enter a Default Label to identify the attribute.

Set Catalog Input for Store Owner to “Fixed Product Tax.”

Attribute Properties
3.

Expand
a.

the Advanced Attribute Properties section. Then, do the following:

In the Attribute Code field, enter a unique identifier in lowercase, without spaces or
special characters. The maximum length is 30 characters. You can leave the field blank to
the text from the Default Label field.

934

If you want the FPT field to appear in the Inventory grid, set Add to Column Options to
“Yes.”

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Fixed Product Tax

If you want to be able to filter products in the grid based on the value of the FPT field, set
Use in Filter Options to “Yes.”

Advanced Attribute Properties
4.

(Optional) In the panel on the left, choose Manage Labels. Then, enter a label to use instead of
the default label for each store view.

Manage Labels
5.

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

Magento Community Edition 2.1 User Guide

935

Fixed Product Tax

CHAPTER 72: Taxes

Step 3: Add the FPT Attribute to an Attribute Set
1.

On the Admin sidebar, tap Stores. Then under Attributes, choose Attribute Set.

In the list, tap the attribute set to open the record in edit mode.

Drag the FPT attribute from the list of Unassigned Attributes on the right to the Groups list
in the center column.
Each group folder corresponds to a section of product information. You can place the attribute
wherever you want it to appear when the product is open in edit mode.

Edit Attribute Set

936

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Fixed Product Tax

When complete, tap Save.

Repeat this step for each attribute set that needs to include fixed product tax.

Step 4: Apply FPT to Specific Products
1.

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

Open the product that needs a fixed product tax in edit mode.

Find the FPT section of fields that you added to the attribute set. Tap Add Tax, and do the
following:

Fixed Product Tax for Belgium
a.

If your Magento installation has multiple websites, choose the appropriate Website and
base currency. In this example, the field is set by default to “All Websites [USD],”

Set Country/State to the region where the fixed product tax applies.

Enter the fixed product tax as a decimal amount in the Tax field.

To add more fixed product taxes, tap Add Tax, and repeat the process.

When complete, tap Save.

Magento Community Edition 2.1 User Guide

937

Price Display Settings

CHAPTER 72: Taxes

Price Display Settings
The price display settings determine if product and shipping prices include or exclude tax, or
show two versions of the price; one with, and the other without tax.
If the product price includes tax, the tax appears only if there is a tax rule that matches the tax
origin, or if a customer address matches the tax rule. Events that can trigger a match include
when a customer creates an account, logs in, or generates a tax and shipping estimate from the
shopping cart.
Important! Showing prices that include and exclude tax can be confusing to the customer. To avoid
triggering a warning message, see the guidelines for your country, and recommended settings. to
avoid warning messages.

Price Display Settings

Step 1: Configure Price Display Settings
1.

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

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

Expand
a.

938

the Price Display Settings section. Then, do the following:

Set Display Product Prices in Catalog to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Price Display Settings

Step 2: Configure Shopping Cart Display Settings
1.

Expand

the Shopping Cart Display Settings section. Then, do the following:

Shopping Cart Display Settings
a.

Set Display Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Subtotal to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Amount to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set the following to “Yes” or “No” according to your preference:
l

Include Tax in Order Total

Display Full Tax Summary

Display Zero Tax Subtotal

Magento Community Edition 2.1 User Guide

939

Price Display Settings

CHAPTER 72: Taxes

Step 3: Configure Order, Invoice & Credit Memo Display Settings
1.

Expand

the Orders, Invoices, Credit Memos Display Settings section. Then, do the

following:

Orders, Invoices, Credit Memos Display Settings
a.

940

Set Display Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Subtotal to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Amount to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set the following to “Yes” or “No” according to your preference:
l

Include Tax in Order Total

Display Full Tax Summary

Display Zero Tax Subtotal

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Zones and Rates

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.

In the upper-right corner, tap Add New Tax Rate.

Enter a Tax Identifier.

To apply the tax rate to a single ZIP or postal code, enter the code in the Zip/Post Code field.

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.

To apply the tax rate to a range of ZIP or postal codes, do the following::
a.

Mark the Zip/Post is Range checkbox.

Enter the first ZIP or postal code in the range.

Enter the last ZIP or postal code in the range.

Choose the State where the tax rate applies.

Magento Community Edition 2.1 User Guide

941

Tax Zones and Rates

CHAPTER 72: Taxes

Choose the Country where the tax rate applies.

Enter the Rate Percent that is used for the tax rate calculation.

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.

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.

942

Make the necessary changes to the Tax Rate Information.

Update the Tax Titles as needed.

When complete, tap Save Rate .

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Zones and Rates

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.

Tap Export Tax Rates . Look for the download file in the lower-left corner of the browser
window.

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:
l

Code

Country

State

Zip/Post Code

Rate

Range From

Range To

A column for each store view

Exported Tax Rate Data
4.

Open the new tax rate data in a second instance of the spreadsheet, so you can see both, side
by side.

Magento Community Edition 2.1 User Guide

943

Tax Zones and Rates

CHAPTER 72: Taxes

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:
l

TaxRegionName

CombinedRate

StateRate

CountyRate

CityRate

SpecialRate

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.

Rename the column headers to match the Magento export data.

Delete any columns that have no data. Otherwise, the structure of the import file should match
the original Magento export data.

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.

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 .

944

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Zones and Rates

Step 3: Import the Tax Rates
1.

On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export Tax
Rates.

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.

Magento Community Edition 2.1 User Guide

945

Value Added Tax (VAT)

CHAPTER 72: Taxes

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.

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

946

On the Admin menu, select Sales > Tax > Product Tax Classes.

Click the Add New button and create three new classes:

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

VAT Standard

VAT Reduced

VAT Zero

Value Added Tax (VAT)

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.

Click the Add New Tax Rate button. Add new rates as follows:

NEW TAX RATE
VAT Standard

VAT Reduced

SETTINGS
Tax Identifier:

VAT Standard

Country and State:

United Kingdom

Rate Percent:

20.00

Tax Identifier:

VAT Reduced

Country and State:

United Kingdom

Rate Percent:

5.00

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.

Add new tax rules as follows:

NEW TAX RULE
VAT Standard

Magento Community Edition 2.1 User Guide

SETTINGS
Name:

VAT Standard

Customer Tax Class:

Retail Customer

Product Tax Class:

VAT Standard

Tax Rate:

VAT Standard Rate

947

Value Added Tax (VAT)

NEW TAX RULE
VAT Reduced

CHAPTER 72: Taxes

SETTINGS
Name:

VAT Reduced

Customer Tax Class:

Retail Customer

Product Tax Class:

VAT Reduced

Tax Rate:

VAT Reduced Rate

Click the Save Rule button for each rate.

Step 5: Apply Tax Classes to Products
1.

On the Admin menu, select Catalog > Manage Products.

Open a product from your catalog in edit mode.

On the General page, find the Tax Class field. Then, select the VAT Class that applies to the
product.

948

When complete, click the Save button.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Value Added Tax (VAT)

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.
l

VAT is charged if the merchant and customer are located in the same EU country.
VAT 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.

Magento Community Edition 2.1 User Guide

949

Value Added Tax (VAT)

CHAPTER 72: Taxes

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.

VAT Validation Checkout Workflow

950

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Value Added Tax (VAT)

Configuring VAT ID Validation
To configure VAT ID validation, you must first set up the customer groups that are needed,
and create the related tax classes, rates, and rules. Then, enable VAT ID validation for the
store, and complete the configuration.
The following examples show how tax classes and rates are used for VAT ID Validation. Take a
look at the examples, and then follow the instructions to set up the tax classes and rules that
are needed for your store.

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

Magento Community Edition 2.1 User Guide

A class for intra-union customers.

951

Value Added Tax (VAT)

CHAPTER 72: Taxes

TAX RULE #4 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)
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%.

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:
l

Domestic

Intra-EU

Invalid VAT ID

Validation 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:
l

Customer Tax Classes

Product Tax Classes

Tax Rates

Create the tax rules that you need to use VAT ID Validation effectively.

952

Tax rules include tax rates and tax classes.

Tax classes are assigned to customer groups.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Value Added Tax (VAT)

Step 3: Enable and Configure VAT ID Validation
1.

On the Admin sidebar, tap Stores. Under Settings, choose Configuration.

If necessary, set the Store View for the configuration.

In the panel on the left under Customers, choose Customer Configuration.

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.

Magento Community Edition 2.1 User Guide

953

Value Added Tax (VAT)

CHAPTER 72: Taxes

Default Group

Default Value for Disable Automatic Group Changes Based on VAT ID

Show VAT Number on Frontend

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.

If needed, set Store View to the applicable store view.

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

Expand

the Store Information section. Then, do the following:

Store Information

954

Select your Country.

Enter your VAT Number. Then, tap Validate VAT Number. The result appears immediately.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Value Added Tax (VAT)

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.

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

955

Tax Quick Reference

CHAPTER 72: Taxes

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.

Tax Configuration Options
SETTING

956

CALCULATION AND DISPLAY

Unit Price

Magento calculates the tax for each item and displays prices taxinclusive. 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.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Tax Quick Reference

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 Configuration Options
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.

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
Tax Configuration Options
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 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.

Magento Community Edition 2.1 User Guide

957

International Tax Guidelines

CHAPTER 72: Taxes

International Tax Guidelines
U.S. Tax Configuration
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?

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.

UK B2C 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).

U.K. B2B Tax Configuration
TAX OPTION

958

RECOMMENDED SETTING

Load catalog prices

Excluding tax

FPT

Yes, including FPT and description

Tax based on

Shipping address

Tax Calculation

On item

Tax shipping?

Yes

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

International Tax Guidelines

U.K. B2B Tax Configuration (cont.)
TAX OPTION

RECOMMENDED SETTING

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.

Canada Tax Configuration
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

Magento Community Edition 2.1 User Guide

959

International Tax Guidelines

CHAPTER 72: Taxes

U.S. Tax Guidelines
These recommended settings can be used for most tax configurations for stores within the
United States.

Tax Classes
TAX CLASS
Tax Class for Shipping

RECOMMENDED SETTING
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

Shopping Cart Display Settings
SETTING
Display Prices

960

RECOMMENDED SETTING
Excluding Tax

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

SETTING

International Tax Guidelines

RECOMMENDED SETTING

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
Enable FPT

Magento Community Edition 2.1 User Guide

RECOMMENDED SETTING
No, except in California.

961

International Tax Guidelines

CHAPTER 72: Taxes

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.
l

Fixed product tax is included for relevant goods as a product attribute.
In 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.

Click to expand each section, and complete the following settings:

Tax Calculation Settings
FIELD

RECOMMENDED SETTING

Tax Calculation Method Based On Total

962

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)

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

International Tax Guidelines

Tax Classes
FIELD
Tax Class for Shipping

RECOMMENDED SETTING
Shipping (shipping is taxed)

Default Tax Destination Calculation
FIELD

RECOMMENDED SETTING

Default Country

Canada

Default State

(as appropriate)

Default Postal Code

* (asterisk)

Shopping Cart Display Settings
FIELD

RECOMMENDED SETTING

Include Tax in Grand Total

Yes

Display Full Tax Summary

Yes

Display Zero in Tax Subtotal Yes

Fixed Product Taxes
FIELD

RECOMMENDED SETTING

Enable FPT

Yes

All FPT Display Settings

Including FPT and FPT description

Apply Discounts to FPT

Apply Tax to FPT

Yes

Include FPT in Subtotal

Magento Community Edition 2.1 User Guide

963

International Tax Guidelines

CHAPTER 72: 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.

Manage Tax Zones & Rates
FIELD

RECOMMENDED SETTING

Tax Identifier

Canada-GST

Country

Canada

State

* (asterisk)

Zip/Post is Range

Zip/Post Code

* (asterisk)

Rate Percent

5.0000

Step 3: Set Up Canadian Provincial Sales Tax (PST)
Set up another tax rate for the applicable province.

Tax Rate Information
FIELD

964

RECOMMENDED SETTING

Tax Identifier

Canada-SK-PST

Country

Canada

State

Saskatchewan

Zip/Post is Range

Zip/Post Code

* (asterisk)

Rate Percent

5.0000

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

International Tax Guidelines

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.

Tax Rule Information
FIELD

RECOMMENDED SETTING

Name

Retail-Canada-GST

Customer Tax Class

Retail Customer

Product Tax Class

Taxable Goods
Shipping

Tax Rate

Canada-GST

Priority

Calculate off subtotal only

Select this checkbox.

Sort Order

Magento Community Edition 2.1 User Guide

965

International Tax Guidelines

CHAPTER 72: Taxes

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.

Tax Rule Information
FIELD

RECOMMENDED SETTING

Name

Retail-Canada-PST

Customer Tax Class

Retail Customer

Product Tax Class

Taxable Goods
Shipping

Tax Rate

Canada-SK-PT

Priority

Calculate off subtotal only

Select this checkbox.

Sort Order

Step 6: Save and Test the Results

966

When complete, click the Save Config button.

Return to your storefront, and create a sample order to test the results.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

International Tax Guidelines

EU Tax Guidelines
The following example depicts a store based in France that sells > 100k Euros in France and >
100k Euros in Germany.
l

Tax calculations are managed at the website level.
Currency conversion and tax display options are controlled individually at the store view
level, (Click the Use Website checkbox to override the default).
By setting the default tax country you can dynamically show the correct tax for the
jurisdiction.
Fixed product tax is included for relevant goods as a product attribute.
It 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.

Create a VAT-Reduced product tax class.

Create a VAT-Free product tax class.

Magento Community Edition 2.1 User Guide

967

International Tax Guidelines

CHAPTER 72: Taxes

Step 2: Create Tax Rates for France and Germany
Create the following tax rates:

Tax Rates
TAX RATE
France-StandardVAT

France-ReducedVAT

Germany-StandardVAT

Germany-ReducedVAT

968

SETTING
Country:

France

State/Region:

ZIP/Postal Code:

Rate:

20%

Country:

France

State/Region:

ZIP/Postal Code:

Rate:

Country:

Germany

State/Region:

ZIP/Postal Code:

Rate:

19%

Country:

Germany

State/Region:

ZIP/Postal Code:

Rate:

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

International Tax Guidelines

Step 3: Set Up the Tax Rules
Create the following tax rules:

Tax Rules
TAX RULE
Retail-France-StandardVAT

Retail-France-ReducedVAT

Retail-GermanyStandardVAT

Retail-GermanyReducedVAT

Magento Community Edition 2.1 User Guide

SETTING
Customer Class:

Retail Customer

Tax Class:

VAT-Standard

Tax Rate:

France-StandardVAT

Priority:

Sort Order:

Customer Class:

Retail Customer

Tax Class:

VAT Reduced

Tax Rate:

France-ReducedVAT

Priority:

Sort Order:

Customer Class:

Retail Customer

Tax Class:

VAT-Standard

Tax Rate:

Germany-StandardVAT

Priority:

Sort Order:

Customer Class:

Retail Customer

Tax Class:

VAT-Reduced

Tax Rate:

Germany-ReducedVAT

Priority:

Sort Order:

969

International Tax Guidelines

CHAPTER 72: Taxes

Step 4: Set Up a Store View for Germany
1.

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

Under the default website, create a store view for Germany. Then, do the following:

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

In the upper-left corner, set Default Config to the French store.

On the General page, expand
country to “France.”

Complete the locale options as needed.

the Countries Options section, and set the default

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:

General Settings
FIELD

RECOMMENDED SETTING

TAX CLASSES
Tax Class for Shipping

Shipping (shipping is taxed)

CALCULATION SETTINGS

970

Tax Calculation Method Based
On

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

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

International Tax Guidelines

General Settings (cont.)
FIELD
Apply Tax On

RECOMMENDED SETTING
Custom Price (if available)

DEFAULT TAX DESTINATION CALCULATION
Default Country

France

Default State
Default Postal Code

* (asterisk)

SHOPPING CART DISPLAY SETTINGS
Include Tax in Grand Total

Yes

FIXED PRODUCT TAXES
Enable FPT

Yes

All FPT Display Settings

Including FPT and FPT description

Apply Discounts to FPT

Apply Tax to FPT

Yes

Include FPT in Subtotal

Yes

Magento Community Edition 2.1 User Guide

971

International Tax Guidelines

CHAPTER 72: Taxes

Step 6: Configure Tax Settings for Germany
1.

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

In the upper-right corner, set Store View to the view to the German store. When prompted to
confirm, tap OK.

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

In the Default Tax Destination Calculation section, do the following:
a.

Clear the Use Website checkbox after each field,

Update the following values to match your site's Shipping Settings point of origin.
l

Default Country

Default State

Default Post Code

This setting ensures that tax is calculated correctly when product prices include tax.

Default Tax Destination Calculation
5.

972

When complete, tap Save Config.

Magento Community Edition 2.1 User Guide

CHAPTER 72: Taxes

Warning Messages

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
Tax Excluded
PRICE DISPLAY

UNIT PRICE

ROW TOTAL

TOTAL

Tax Class for Shipping Shipping (is taxed)
Excluding tax

Including tax

Including and
Excluding tax

Warning

Catalog Prices: Including Tax
Tax Included
PRICE DISPLAY

UNIT PRICE

ROW TOTAL

TOTAL

Excluding tax

Including tax

Including and
Excluding tax

Warning

Magento Community Edition 2.1 User Guide

973

Warning Messages

CHAPTER 72: Taxes

Calculation Settings

Discount Settings
We strongly recommend that you use the following settings to avoid issues when configuring
taxes in relation to discounts.

Recommended Settings
FIELD
Apply Customer Tax
Apply Discount on Prices

974

RECOMMENDED SETTING
After Discount
US and Canada

Excluding Tax

Including Tax

Magento Community Edition 2.1 User Guide

CHAPTER 73:

Currency
Magento Community Edition 2.1 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.1 User Guide

975

Currency Configuration

CHAPTER 73: Currency

Currency Configuration
Before setting up individual currency rates, you must first set the scope of the base currency,
By default, it is set to global, which applies the base currency setting to the entire store
hierarchy. If you have a multisite installation of Magento, you can manage multiple base
currencies by setting the scope to the website level.
Then, specify which currencies you accept, and the currency that you want to use for the
display of prices in your store. In the following illustration, the scope of the base currency is set
at the website level, so each website can have a different base currency.

Scope of Base Currency

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

976

Magento Community Edition 2.1 User Guide

CHAPTER 73: Currency

Currency Configuration

Step 1: Choose the Accepted Currencies
1.

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

In the panel on the left under General, choose Currency Setup.

Expand

the Currency Options section, and do the following:

Set Base Currency to the primary currency that you use for online transactions.

Set Default Display Currency to the currency that you use to display pricing in your store.

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.

Set Catalog Price Scope to either “Global” or “Website.”

Price

Magento Community Edition 2.1 User Guide

977

Currency Configuration

CHAPTER 73: Currency

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.

Expand

the WebserviceX section.

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
the Scheduled Import Settings section.

Continuing with Currency Setup, expand

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.”

Set Start Time to the hour, minute, and second that the rates will be updated according to
the schedule.

To determine how often the rates are updated, set Frequency to one of the following:
l

Daily

Weekly

Monthy

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.

Set Error Email Sender to the store contact that appears as the sender of the error
notification.

Set Error Email Template to the email template used for the error notification.

When complete, tap Save Config.

When prompted to update the cache, tap the Cache Management link. Then, refresh the
invalid cache.

978

Magento Community Edition 2.1 User Guide

CHAPTER 73: Currency

Currency Configuration

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.

Magento Community Edition 2.1 User Guide

979

Currency Symbols

CHAPTER 73: Currency

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.

Enter a custom symbol for each currency you want to use, or mark the Use Standard checkbox
to the right of each currency.

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.

When complete, tap Save Currency Symbols.

When prompted to update the cache, tap the Cache Management link. Then, refresh any
invalid cache.

Refresh Cache

980

Magento Community Edition 2.1 User Guide

CHAPTER 73: Currency

Updating Currency Rates

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.

Tap the rate you want to change, and enter the new value for each currency supported.

When complete, tap Save Currency Rates.

To import currency rates:
1.

On the Admin sidebar, tap Stores. Then under Currency, choose Currency Rates.

Set Import Service to the currency rate provider. WebserviceX is the default provider.

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.

When complete, tap Save Currency Rates.

Magento Community Edition 2.1 User Guide

981

Updating Currency Rates

CHAPTER 73: Currency

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.

Complete the Currency Rate Setup to specify the currencies that you accept, and to establish
the import connection and schedule.

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.

982

Magento Community Edition 2.1 User Guide

CHAPTER 74:

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:
l

Using Product Attributes

Product Attribute Reference

Customer Attribute Reference

Magento Community Edition 2.1 User Guide

983

Product Attributes

CHAPTER 74: Attributes

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

984

Magento Community Edition 2.1 User Guide

CHAPTER 74: Attributes

Product Attributes

Properties
Property Descriptions
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:

Magento Community Edition 2.1 User Guide

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

Displays a swatch that depicts the color,
texture, or pattern of a configurable product.
A visual swatch can be filled with a
hexadecimal color value, or display an
uploaded image that represents the color,
material, texture, or pattern of the option.

985

Product Attributes

CHAPTER 74: Attributes

Property Descriptions (cont.)
PROPERTY

Values Required

DESCRIPTION
Text Swatch

A text-based representation of a configurable
product option that is frequently used for
size. Text swatches can also include
hexadecimal color values.

Fixed Product Tax

An input type that gives you the ability to
define FPT rates based on the requirements
of your locale.

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 Product Attributes.
A default value cannot be set for Multiple Select, Dropdown, or Fixed
Product Tax input types.

986

Unique Value

Requires the attribute value to be different from all other values
entered in the same attribute, within the context of the scope setting.
Unique value should be enabled for any attribute that is used as an
ID number. For example, because SKU is used to identify products
throughout the hierarchy, it has a unique value with a global scope.
Options: Yes / No

Input Validation for Store
Owner

Performs a validation check of the data entered in the field, based on
the following options:

Magento Community Edition 2.1 User Guide

CHAPTER 74: Attributes

Product Attributes

Property Descriptions (cont.)
PROPERTY

DESCRIPTION
None
Decimal Number
Integer Number
Email
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 /
No

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

Storefront Properties
Property Descriptions
PROPERTY
Use in Search

DESCRIPTION
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 10.

Visible in Advanced Gives shoppers the ability to enter search
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:

Magento Community Edition 2.1 User Guide

987

Product Attributes

CHAPTER 74: Attributes

Property Descriptions (cont.)
PROPERTY

DESCRIPTION
No

The attribute is not available to be used as a
filter in layered navigation.

Filterable (with
results)

Layered navigation includes only those
filters for which matching products can be
found. Any attribute value that already
applies to all products shown in the list does
not appear as an available filter. Attribute
values with a count of zero (0) product
matches are also omitted from the list of
available filters.
The filtered list of products includes only
those that match the filter. The products list
is updated only if the selected filter(s)
change what is currently shown.

Filterable (no
results)

Layered navigation includes filters for all
available attribute values and their product
counts, including those with zero (0) product
matches. If the attribute value is a swatch,
the value appears as a filter, but is crossed
out.

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 /
No

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 Depending on theme, includes the attribute as a “Sort By” option for
Listing
catalog listings. Options: Yes / No

988

Magento Community Edition 2.1 User Guide

CHAPTER 74: Attributes

Product Attributes

Creating Product Attributes
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. To learn how to add
attributes while working on a product, see: Using Product Attributes.
Any attribute that is used as a drop-down list of values for a configurable product must have
the following properties:

PROPERTY

VALUE

Catalog Input Type for Store Owner Dropdown
Scope

Global

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

Magento Community Edition 2.1 User Guide

989

Product Attributes

CHAPTER 74: Attributes

Step 1: Describe the Basic Properties
1.

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

Tap Add New Attribute .

Attribute Properties
3.

Under Attribute Properties, enter a Default Label to identify the attribute.

Set Catalog Input Type for Store Owner to the type in input control to be used for data entry.

For Dropdown and Multiple Select input types, do the following:

Under Manage Options, tap Add Option .

Tap Add Option and repeat the previous step for each option that you want to include in
the list.

Select Is Default to use the option as the default value.

If you want to require the customer to choose an option before the product can be purchased,
set Values Required to “Yes.”

Manage Options

990

Magento Community Edition 2.1 User Guide

CHAPTER 74: Attributes

Product Attributes

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.

If you want to prevent duplicate values from being entered, set Unique Value to “Yes.”

Decimal Number

Integer Number

URL

Letters

Letters (a-z, A-Z) or Numbers (0-9)

Input Validation
5.

To add this attribute to the product grid, set the following options to "Yes."

Magento Community Edition 2.1 User Guide

991

Product Attributes

CHAPTER 74: Attributes

Add to Column Options

Includes the attribute as a column in the Products grid.

Use in Filter Options

Adds a filter control to the column header in the Products grid.

Step 3: Enter the Field Label
1.

Expand

the Manage titles section.

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.

If the attribute is to be available for search, set Use in Search to “Yes.”

To include the attribute in Product Compare, set Comparable on Storefront to “Yes.”

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.”

to use the attribute in layered navigation on search results pages, set Use in Search
Results Layered Navigation to “Yes,”

In the Position field, enter a number to indicate the relative position of the attribute in the
layered navigation block.

To use the attribute in price rules, set Use for Promo Rule Conditions to “Yes,”

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.”

992

Complete the following settings if supported by your theme:

Magento Community Edition 2.1 User Guide

CHAPTER 74: Attributes

Product Attributes

To include the attribute on the product detail page, set Visible on Catalog Pages on
Storefront to “Yes.”

To include the attribute in product listings, set Used in Product Listing to “Yes.”

To use attribute as a sort parameter for product listings, set Used for Sorting in Product
Listing to “Yes.”

When complete, tap Save Attribute .

Storefront Properties

Magento Community Edition 2.1 User Guide

993

Product Attributes

CHAPTER 74: Attributes

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:

994

On the Admin sidebar, tap Stores. Then under Attributes, choose Attribute Set.

Tap Add New Set. Then, do the following:

Magento Community Edition 2.1 User Guide

CHAPTER 74: Attributes

Product Attributes

Edit Set Name
a.

Enter a Name for the attribute set.

Set Based On to an existing attribute set to be used as a template.

Tap Save . The next page displays the following:
l

The left column shows the name of the attribute set. The name is for internal reference,
and can be changed as needed.
The center of the page lists the current selection of attribute groups.
The right column lists the selection of attributes that are currently not assigned to the
attribute set.

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.

When complete, tap Save.

Magento Community Edition 2.1 User Guide

995

Product Attributes

CHAPTER 74: Attributes

Edit Attribute Set

To create a new attribute group:
1.

In the Groups column the attribute set, tap Add New.

Enter a Name for the new group, and tap OK.

Do either of the following:
l

Drag Unassigned Attributes to the new group.

Drag 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.

996

Magento Community Edition 2.1 User Guide

System

997

Contents

Encryption Key
Session Validation

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.

Browser Capabilities Detection
Action Log
Tools
Cache Management

System Menu

Full Page Cache

Data Transfer

Index Management
IndexTrigger Events

Working with CSV Files
Data Validation
Import

Cron (Scheduled Tasks)
Developer Tools

Import History

Frontend Development Workflow

Product Images

Using Static File Signatures

Import Guidelines

File Optimization

Export
Export Criteria
Product Attribute Reference
Complex Data
Advanced Pricing
Customer Attribute Reference
Integrations
Magento Marketplace
Magento Connect
Permissions
Adding Users
Locked Users
User Roles
Alternate Media Storage
Using a Database
Using a CDN
Security
Security Best Practices
Configuring Admin Security
CAPTCHA
998

Backups

Developer Client Restrictions
Template Path Hints
Translate Inline
Web Setup Wizard
Component Manager
Web Setup

CHAPTER 75:

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

To display the System menu:
On the Admin sidebar, tap System .

Magento Community Edition 2.1 User Guide

999

CHAPTER 75: System Menu

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.

Support
The Support Tools can be used as a resource during
the development and optimization processes, and as
a diagnostic tool to help our Support team identify
and resolve issues with your system.

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.

1000

Magento Community Edition 2.1 User Guide

CHAPTER 75: System Menu

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 that was the target of the
action.

Other Settings
Manage the notifications in your inbox, create custom
variables, and generate a new encryption key.

Magento Community Edition 2.1 User Guide

1001

1002

Magento Community Edition 2.1 User Guide

CHAPTER 76:

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.
l

Working with CSV Files

Import

Export

Product Attribute Reference

Customer Attribute Reference

Magento Community Edition 2.1 User Guide

1003

Working with CSV Files

CHAPTER 76: Data Transfer

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.

Exported Product CSV in OpenOffice Calc

1004

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Working with CSV Files

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.

Exported Product CSV in Notepad++

CSV Product Structure
COLUMN NAME

DESCRIPTION

Column headers that begin with an underscore contain service entity
properties or complex data. Service columns are not product
attributes.

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.

Magento Community Edition 2.1 User Guide

1005

Working with CSV Files

CHAPTER 76: Data Transfer

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
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++

CSV Customer Structure
COLUMN NAME

1006

DESCRIPTION

Column headers that begin with an underscore contain service entity
properties or complex data. Service columns are not customer
attributes.

The names of the columns with values of both system-created
attributes, and attributes created by the store administrator.

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Working with CSV Files

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:
l

The number of entities checked

The number of invalid rows

The number of errors found

If the data is valid, an “Import Success” message appears.

File is Valid!
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.

Magento Community Edition 2.1 User Guide

1007

Working with CSV Files

CHAPTER 76: Data Transfer

Data Validation Messages
MESSAGES
DATA VALIDATION
l

Product with specified SKU not found in rows: 1

URL key for specified store already exists

'7z' file extension is not supported

'txt' file extension is not supported

ERRORS
l

Wrong field type. Type in the imported file %decimal%, expected type is %text%.

Value is not allowed. Attribute value does not exist in the system.

Field %column name% is required.

Wrong value separator is used.

Wrong encoding used. Supported character encoding is UTF-8 and Windows-1252.

Imported file does not contain SKU field.

SKU does not exist in the system.

Column name %column name% is invalid. Should start with a letter. Alphanumeric.

Imported file does not contain a header.

%website name% website does not exist in the system.

%storeview name% storeview does not exist in the system.

Imported attribute %attribute name% does not exist in the system.

Imported resource (image) does not exist in the local media storage.

Product creation error displayed to the user equal to the one seen during manual product save.

1008

Imported resource (image) could not be downloaded from external resource due to timeout or
access permissions.

Advanced Price creation error displayed to the user equal to the one seen during the manual
product save.
Customer creation error displayed to the user equal to the one seen during the manual customer
save.

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Import

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:
l

Add/Update

Replace Existing Complex Data

Delete 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

Magento Community Edition 2.1 User Guide

1009

Import

CHAPTER 76: Data Transfer

Step 1: Prepare the Data
1.

On the Admin sidebar, tap System. Then under Data Transfer, choose Import.

Under Import Settings, set Entity Type to one of the following:

Advanced Pricing

Products

Customers and Addresses

Customers Main File

Customer Addresses

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

1010

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Import

Examine the structure of the sample file. As you prepare your CSV import file, make sure that
the column headings are spelled correctly.

Verify that the size of your import file does not exceed the limit shown in the message.

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:
l

Add/Update

Replace Existing Complex Data

Delete Entities

Do the following:
a.

Accept the default value of a comma (,) for the Field separator.

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.

Find the CSV file that you prepared to import, and tap Open .

Magento Community Edition 2.1 User Guide

1011

Import

CHAPTER 76: Data Transfer

If the import data includes paths to product images, enter one of the following in the Images
File Directory field:
l

The path to the uploaded images on the Magento server. For example: var/import.

The 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 .

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.

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.

1012

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Import

Import Behavior
OPERATION
Add/Update

DESCRIPTION
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.

Magento Community Edition 2.1 User Guide

1013

Import

CHAPTER 76: Data Transfer

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.

Under Data Transfer, choose Import History.

Import History

1014

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Import

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_images).
For images in the default import folder(/pub/media/import), do not include the path before the
filename in the CSV data.

The CSV file must include only the sku column and the related image columns.

Magento Community Edition 2.1 User Guide

1015

Import

CHAPTER 76: Data Transfer

CSV Import Image from Default Location
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.

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_images).
http://example.com/images/image.jpg

1016

Follow the instructions to import the data.

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Import

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.

Magento Community Edition 2.1 User Guide

1017

Import

CHAPTER 76: Data Transfer

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 _ heading.

1018

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Export

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.

In the Export Settings section, specify the following:
a.

Set Entity Type to one of the following:
l

Products

Customers Main File

Customer Addresses

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

Magento Community Edition 2.1 User Guide

1019

Export

CHAPTER 76: Data Transfer

To filter the exported data based on attribute value, do the following:
l

To 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
l

To 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.

1020

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Export

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

Magento Community Edition 2.1 User Guide

1021

Export

CHAPTER 76: Data Transfer

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.

Export Criteria
EXCLUDE

1022

FILTER

RESULT

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.

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.

Magento Community Edition 2.1 User Guide

CHAPTER 76: Data Transfer

Product Attribute Reference

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.

Simple Product CSV File Structure
ATTRIBUTE
sku

DESCRIPTION
(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

Magento Community Edition 2.1 User Guide

Indicates the type of product.Values:
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.

1023

Product Attribute Reference

CHAPTER 76: Data Transfer

Simple Product CSV File Structure (cont.)
ATTRIBUTE

Magento Community Edition 2.1 User Guide

Navigation menu

Versions of this User Manual:

Views

Navigation