Magento Open Source User Guide, Version 2.2 Guide

User Manual:

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

Download
Open PDF In Browser	View PDF

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 an Account

Sharing Your Account

CHAPTER 4: Quick Tour

Path to Purchase

Home Page

Catalog Page

Search Results

Product Page

Shopping Cart

Customer Journey

Attract New Customers

Engage Your Customers

Increase Average Order Value

Contents

Moment of Purchase

Retain Customers

Build 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

Admin Session Lifetime

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

100

Adding a Favicon

103

Welcome Message

106

Magento Commerce User Guide

iii

Contents

107

Store Demo Notice

109

CHAPTER 8: Websites, Stores & Views
Scope

112

Changing Scope

113

Catalog Scope

116

Product Scope

117

Price Scope

119

Customer Account Scope

121

Scope Quick Reference

122

Single Store Mode
CHAPTER 9: Industry Compliance

124
127

PCI Compliance Guidelines

128

GDPR Compliance

129

Google Analytics Settings for GDPR

130

134

Cookie Law Compliance

136

Cookie Restriction Mode

137

Cookie Reference

139

Magento 2.x Default Cookies

139

Google Analytics Cookies

143

CATALOG
CHAPTER 10: Catalog Menu

145
147

Menu Options

148

Catalog URLs

149

CHAPTER 11: Products Grid

153

CHAPTER 12: Creating Products

157

Product Workspace

111

158

Magento Commerce User Guide

Contents

Default Field Values

161

Product Types

163

Simple Product

165

Configurable Product

170

Part 1: Creating a Configurable Product

171

Part 2: Adding Configurations

175

Grouped Product

183

Virtual Product

190

Bundle Product

195

Customizing the Bundle
Downloadable Product
Configuring Download Options

196
206
215

CHAPTER 13: Product Settings

217

Advanced Product Settings

218

Other Product Settings

219

Content

221

Configurations

222

Product Reviews

223

Images and Videos

224

Search Engine Optimization

225

Related Products, Up-Sells, and Cross-Sells

227

Other PayPal Solutions

930

PayPal Payments Advanced

932

Requirements

932

Checkout Workflow

933

Checkout Workflow

xvi

873

933

Magento Commerce User Guide

Contents

Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Advanced

933
933
934

PayPal Payments Pro

935

Requirements

935

Checkout Workflow

936

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

936
937
937
938

PayPal Payments Standard

939

Merchant Requirements

939

Checkout Workflow

939

Checkout Workflow
Setting Up PayPal Payments Standard

939
940

PayPal Payflow Pro

941

Requirements

941

Customer Workflow

942

Customer Workflow
Online Order Processing Workflow

942
942

Online Order Processing Workflow

942

Setting Up PayPal Payflow Pro

943

PayPal Payflow Link

944

Requirements

944

Customer Workflow

944

Customer Workflow
Order Workflow
Order Workflow
Setting Up PayPal Payflow Link
PayPal Reference

944
945
945
946
947

PayPal Business Account

948

PayPal Credit®

949

Magento Commerce User Guide

xvii

Contents

PayPal Fraud Management Filter

953

PayPal by Country

954

CHAPTER 60: Other Payment Methods
Klarna

958

Klarna Customer Experience

959

Setting Up Klarna

960

Managing Your Account

965

Amazon Pay

968

Amazon Pay Customer Experience

969

Setting Up Amazon Pay

972

Using Amazon Seller Central

978

Managing Amazon Pay Transactions

980

Amazon Pay Resources

982

Authorize.Net Direct Post
CHAPTER 61: Basic Payment Methods

984
985

Check / Money Order

986

Cash On Delivery

988

Bank Transfer

990

Purchase Order

992

Zero Subtotal Checkout

994

CHAPTER 62: Fraud Protection
Signifyd Guaranteed Fraud Protection

997
997

Shipping

999

CHAPTER 63: Shipping Settings

1001

Point of Origin

1002

Multiple Addresses

1003

Shipping Policy

1004

CHAPTER 64: Basic Shipping Methods
Free Shipping
xviii

957

1007
1008
Magento Commerce User Guide

Contents

Flat Rate

1010

Table Rates

1012

Dimensional Weight

1019

CHAPTER 65: Magento Shipping
Quick Look

1021
1022

Customer Experience

1024

Shipping Methods

1024

Click & Collect

1024

Setting Up Magento Shipping

1025

Locations

1031

Shipping Partners

1036

Packaging

1040

Shipping Experience Rules

1044

Troubleshooting

1048

CHAPTER 66: Carriers

1049

CHAPTER 67: Shipping Labels

1051

Shipping Label Workflow

1052

Configuring Shipping Labels

1053

Creating Shipping Labels

1057

Label Packages

REPORTS
CHAPTER 68: Reports Menu

1064

1069
1071

Menu Options

1072

Refresh Statistics

1073

CHAPTER 69: Marketing Reports
Reports
CHAPTER 70: Review Reports
Reports
Magento Commerce User Guide

1075
1076
1077
1078
xix

Contents

CHAPTER 71: Sales Reports
Reports
CHAPTER 72: Customer Reports
Reports
CHAPTER 73: Product Reports
Reports

BUSINESS INTELLIGENCE

1080
1083
1084
1085
1086

1089

CHAPTER 74: Advanced Reporting

1091

CHAPTER 75: BI Essentials

1099

Dashboards

1103

Report Builder

1106

Visual Report Builder

1107

Filters

1112

Formulas

1116

Manage Data

1122

Metrics

1123

Filter Sets

1129

Export Data
CHAPTER 76: New Relic Reporting
New Relic Queries
CHAPTER 77: Marketing Automation

1133
1137
1139
1147

OPERATIONS

1149

Stores

1150

CHAPTER 78: Stores Menu

1079

1151

Magento Commerce User Guide

Contents

Menu Options

1152

CHAPTER 79: All Stores

1153

Adding Store Views

1154

Editing a Store View

1156

Adding a Language

1158

Translating Products

1160

Translating Content

1162

Adding Stores

1163

Adding Websites

1167

Store URLs

1169

Use Secure Protocol

1169

Using a Custom Admin URL

1174

CHAPTER 80: Configuration

1177

Configuration Tabs

1177

CHAPTER 81: Taxes

1179

Vertex Cloud
Your Vertex Account
General Tax Settings
Cross-Border Price Consistency
Tax Rules
Tax Classes

1181
1182
1185
1190
1192
1196

Configuring Tax Classes

1197

Adding New Tax Classes

1198

Default Tax Destination

1200

EU Place of Supply for Digital Goods

1201

Fixed Product Tax
Configuring FPT

1202
1203

Price Display Settings

1208

Tax Zones and Rates

1211

Import/Export Tax Rates
Value Added Tax (VAT)
Magento Commerce User Guide

1213
1216
xxi

Contents

Configuring VAT

1217

VAT ID Validation

1220

Configuring VAT ID Validation
Tax Quick Reference

1227

International Tax Guidelines

1229

U.S. Tax Guidelines

1231

Canadian Tax Guidelines

1233

EU Tax Guidelines

1238

Warning Messages

1244

Calculation Settings

1244

Discount Settings

1245

CHAPTER 82: Currency

1247

Currency Configuration

1248

Currency Symbols

1252

Updating Currency Rates

1253

CHAPTER 83: Attributes
Product Attributes

System
CHAPTER 84: System Menu
Menu Options

1255
1256

1261
1263
1264

CHAPTER 85: Data Transfer

1267

Working with CSV Files

1268

Data Validation
Import

1271
1273

Import History

1278

Importing Product Images

1279

Import Guidelines

1281

Export
Export Criteria

xxii

1222

1283
1285

Magento Commerce User Guide

Contents

Export Filters

1286

Exclude Attributes

1286

Data Transfer Examples

1287

Importing Configurable Products

1287

Importing Tier Prices

1293

Product Attribute Reference

1296

Complex Data

1307

Advanced Pricing Data

1309

Customer Attribute Reference

1311

CHAPTER 86: Integrations

1315

Onboarding Workflow

1316

Magento Marketplace

1320

CHAPTER 87: Permissions

1321

Adding Users

1322

Locked Users

1326

User Roles

1327

Role Resources

1330

Alternate Media Storage

1332

Using a Database

1333

Database Workflow

1333

Using a Content Delivery Network

1335

CDN Workflow

1335

CHAPTER 88: Security

1339

Security Scan

1340

Security Best Practices

1344

Start Right

1344

Protect the Environment

1345

Protect Magento

1347

Don’t be Taken for a Ride

1347

Be Prepared!

1348

Monitor for Signs of Attack

1348

Magento Commerce User Guide

xxiii

Contents

Follow Your Disaster Recovery Plan

1349

Security Action Plan

1350

Configuring Admin Security

1351

CAPTCHA

1354

Admin CAPTCHA

1355

Customer CAPTCHA

1358

Encryption Key

1360

Session Validation

1362

Browser Capabilities Detection

1364

CHAPTER 89: Tools
Cache Management

1366

Full-Page Cache

1372

Index Management
Index Trigger Events

xxiv

1365

1374
1376

Backups

1379

Cron (Scheduled Tasks)

1381

Developer Tools

1383

Amazon Logs

1383

Frontend Development Workflow

1384

Using Static File Signatures

1385

Optimizing Resource Files

1386

Developer Client Restrictions

1389

Template Path Hints

1390

Translate Inline

1392

Setup Wizard

1396

Setup Tools

1397

Extension Manager

1398

Module Manager

1402

System Upgrade

1407

Web Setup

1408

Magento Commerce User Guide

Contents

APPENDICES

1415

APPENDIX A: Release Notes

1417

APPENDIX B: Change Log

1419

APPENDIX C: Glossary

1421

APPENDIX D: Configuration Reference

1431

INDEX

Magento Commerce User Guide

1433

xxv

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
Commerce. 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 are here!)
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.
To page through the PDF as a book, set your reader’s
View > Page Display to “Two Page View”. See the
Documentation Archive for previous versions of the user
guide. Updated: 2 November, 2017

xxvi

Magento Commerce 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 Commerce 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.

Magento Advantage

Magento Commerce User Guide

Resources

CHAPTER 1: Welcome

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 Commerce User Guide

CHAPTER 1: Welcome

Resources

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 Commerce User Guide

Resources

CHAPTER 1: Welcome

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 Commerce User Guide

CHAPTER 1: Welcome

Join the Conversation!

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.

Google+
Add us to your circle on Google+.

Magento Commerce User Guide

Join the Conversation!

CHAPTER 1: Welcome

YouTube
Learn while you watch videos
on our YouTube channel!

Meetup
Find a Magento Meetup near you!

Magento Commerce 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 Commerce

Magento Commerce 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

Supported

Not Supported

7.0.2

7.0.0

7.0.4

7.0.1

7.0.6 - 7.0.x

7.0.3

7.1.x

7.0.5

Required PHP Extensions:
bc-math (Magento Commerce only)
curl
gd, ImageMagick 6.3.7 (or later) or both

intl
mbstring
mcrypt
mhash
openssl

SimpleXML
soap
xml
xsl
zip

PDO_MySQL
Optional, but recommended

Magento Commerce User Guide

CHAPTER 2: About This Release

System Requirements

SYSTEM REQUIREMENTS
opcache

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

php_xdebug2.2.0

Recommended for development
environments only.

or later

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

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

Elasticsearch

Versions 5.x, 2.x, and 1.7
2.x supported from Linux repository.
2.0 branch supported from PHP repository.

Apache Solr
Messaging

Magento Commerce User Guide

(Enterprise Edition only)

RabbitMQ (Enterprise Edition only)

System Requirements

CHAPTER 2: About This Release

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 Commerce User Guide

CHAPTER 2: About This Release

Installation

Installation
To download and install the latest release of Magento 2.x on your server, see the Installation
and Configuration in our technical documentation. The Magento installation can be deployed
to run in either production or developer mode. Some tools and configuration settings are
designed specifically for developers, and can be accessed only while the store is running in
developer mode. To learn more, see: Magento Modes.
The Magento installation consists of the following steps:
l

Set Up Your Environment

Get the Magento Software

Complete the Web Setup

Verify

To update an existing installation, see Web Setup Wizard in the System section of this guide.

Installation and Configuration

Magento Commerce 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 Commerce 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 Commerce 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 Commerce 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 Commerce 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 Commerce User Guide

Creating an Account

CHAPTER 3: Your Magento Account

Creating an 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 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 Commerce User Guide

CHAPTER 3: Your Magento Account

Creating an 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 Commerce User Guide

Creating an 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 Commerce 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 Commerce 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 Commerce 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 Commerce 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 consider how
Magento Commerce for B2B can be used to attract and engage customers, increase the average
order, and build loyalty and advocacy.

Customer Journey

Magento Commerce User Guide

Path to Purchase

CHAPTER 4: Quick Tour

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 Commerce User Guide

CHAPTER 4: Quick Tour

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 Commerce User Guide

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

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 Commerce User Guide

367

Product Reviews

CHAPTER 21: Shopping Tools

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.

368

Magento Commerce User Guide

CHAPTER 21: Shopping Tools

Product Reviews

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.”

When complete, tap Save Review.

Magento Commerce User Guide

369

Product Reviews

CHAPTER 21: Shopping Tools

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

370

Magento Commerce User Guide

CHAPTER 21: Shopping Tools

Product Reviews

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.

When complete, tap Save Rating .

Magento Commerce User Guide

371

372

Magento Commerce User Guide

Promotions

373

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.

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

374

CHAPTER 22:

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 Commerce User Guide

375

Creating a Price Rule

CHAPTER 22: 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: Apply and 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.

In the Rule Information section, do the following:
a.

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

376

Select the Websites where the rule is to be available.

Magento Commerce User Guide

CHAPTER 22: Catalog Price Rules

Creating a Price Rule

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 (

Magento Commerce User Guide

) button at the beginning of the next line.

377

Creating a Price Rule

CHAPTER 22: 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.

378

Magento Commerce User Guide

CHAPTER 22: 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 of the regular* price. For
example:

Apply as fixed
amount

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

Enter 10 in Discount Amount for an final** price that is marked down
10% from the regular price.

Enter 10 in Discount Amount for a final price that is $10 less than the
regular price.
Adjust final price
to this percentage

Adjusts the final price by a percentage of the regular price. For example:

Adjust final price
to discount value

Sets the final price to a fixed, discounted amount. For example:

Enter 50 in Discount Amount for a final price that is marked down 50%
from the regular price.

Enter 20 in Discount Amount for a final price of $20.00.
*

Regular price refers to the base product price without any advanced
pricing (special/tier/group) or promotional discounts.
**

Final price refers to the discounted price that appears in the shopping
cart.

Magento Commerce User Guide

379

Creating a Price Rule

CHAPTER 22: 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.

Pricing Structure Rules

Step 4: Apply and Test the Rule
To apply the rule, do one of the following:
l

Tap Save and Apply.

Tap Save. Then from the Catalog Price Rules page, tap Apply Rules.

Price rules are automatically processed with other system rules each night.When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly. As new rules are added, Magento recalculates the prices and the
priorities accordingly.

380

Magento Commerce User Guide

CHAPTER 22: Catalog Price Rules

Creating a Price Rule

Field Descriptions
FIELD

DESCRIPTION

RULE INFORMATION
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: Yes / No

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.

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.

CONDITIONS
Specifies the conditions that must be met before the catalog price
rule goes into action. If left blank, the rule applies to all products.
ACTIONS
Apply

Magento Commerce User Guide

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

Discounts item by subtracting a percentage
of the regular* price.

Apply as fixed
amount

Discounts item by subtracting a fixed
amount from the regular price.

Adjust final price to
this percentage

Adjusts the final price by a percentage of the
regular price.

381

Creating a Price Rule

CHAPTER 22: Catalog Price Rules

Field Descriptions (cont.)
FIELD

DESCRIPTION
Adjust final price to
discount value

Sets the final price to a fixed, discounted
amount.
*Regular price refers

to the base product
price without any advanced pricing
(special/tier/group) or promotional discounts.
**Final price refers

to the discounted price
that appears in the shopping cart.
Discount Amount

(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

382

Magento Commerce User Guide

CHAPTER 22: Catalog Price Rules

Price Rule with Multiple SKUs

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 …
c.

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

Magento Commerce User Guide

383

Price Rule with Multiple SKUs

CHAPTER 22: Catalog Price Rules

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.
Price rules are automatically processed with other system rules each night.When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly.

384

Magento Commerce User Guide

CHAPTER 23:

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 Commerce User Guide

385

Creating a Cart Price Rule

CHAPTER 23: 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 5: 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.

Tap Add New Rule. Then, do the following:

Cart Price Rules

386

Under Rule Information, complete the Rule Name and Description.

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

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Creating a Cart Price Rule

Rule Information
3.

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

If you want the promotion to be available only to registered customers, do not choose
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 Commerce User Guide

387

Creating a Cart Price Rule

CHAPTER 23: 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.

To learn more, see: Coupon Codes.

Coupon Settings
5.

Use the Calendar (

) to choose 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 which are active at the same time. (Number 1 has the highest priority.)

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

This is a good time to save your work. Tap Save and Continue Edit.
After the rule is saved, the name of the price rule appear at the top of the page.

388

Magento Commerce User Guide

CHAPTER 23: 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 Commerce User Guide

389

Creating a Cart Price Rule

CHAPTER 23: 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.

390

Magento Commerce User Guide

CHAPTER 23: 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 Commerce User Guide

391

Creating a Cart Price Rule

CHAPTER 23: Cart Price Rules

Scroll down to Actions, and expand

the section. Then, do the following:

Cart Price Rule Actions
a.

392

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 fixed amount
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 Commerce User Guide

CHAPTER 23: 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 determine if free shipping is applied to orders that meet the conditions, set Free
Shipping to one of the following:

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).

In the Add Rewards Points field, enter the number of points the customer earns whenever
the cart price rule is applied. (If reward points aren’t enabled, leave this field blank.)

Define as many additional conditions as needed for the action.

When complete, tap Save and Continue Edit.

Step 4: Complete the Labels
The label appears in the totals section of the order to identify the discount. The label text is
enclosed in parentheses, after the word, “Discount”. You can enter a default label for all store
views, or enter a different label for each view.

Discount Label in Totals Section of Order
1.

Scroll down to Labels, and expand

the section.

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

Default Label

Magento Commerce User Guide

393

Creating a Cart Price Rule

CHAPTER 23: Cart Price Rules

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.

Step 5: Save and Test the Rule
1.

When complete, tap Save Rule.

Test the rule to make sure that it works correctly.
Price rules are automatically processed with other system rules each night.When you create a
new price rule, allow enough time for it to get into the system. Then, test the rule to make sure
that it works correctly. As new rules are added, Magento recalculates the prices and the
priorities accordingly.

394

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Creating a Cart Price Rule

Field Descriptions
FIELD

DESCRIPTION

RULE INFORMATION
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.

Active

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

Websites

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

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 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.

Magento Commerce User Guide

395

Creating a Cart Price Rule

CHAPTER 23: Cart Price Rules

Field Descriptions (cont.)
FIELD

DESCRIPTION

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.

CONDITIONS
Specifies the conditions that must be met before the cart price rule
goes into action. If left blank, the rule applies to all products in the
cart.
ACTIONS
Apply

Determines the type of calculation that is applied to the purchase.
Options:
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.

396

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.

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Creating a Cart Price Rule

Field Descriptions (cont.)
FIELD

DESCRIPTION

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

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

Rules
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.

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, specifies a different label to identify the discount for
each store view.

Magento Commerce User Guide

397

Coupon Codes

CHAPTER 23: 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.

398

To make the coupon valid for a 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 not expire.

Complete the cart price rule as needed.

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Coupon Codes

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.

Magento Commerce User Guide

399

Coupon Codes

CHAPTER 23: Cart Price Rules

Generated Codes

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:
a.

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

Set the Code Format to one of the following:

400

Alphanumeric

Alphabetical

Numeric

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

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

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 Commerce User Guide

401

Coupon Codes

CHAPTER 23: Cart Price Rules

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

Coupon Report Filters

402

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Coupon Codes

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.

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

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.

Magento Commerce User Guide

403

Free Shipping Promotion

CHAPTER 23: Cart Price Rules

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.

404

Magento Commerce User Guide

CHAPTER 23: 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 Commerce User Guide

405

Free Shipping Promotion

CHAPTER 23: 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

406

Magento Commerce User Guide

CHAPTER 23: 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 Commerce User Guide

407

Buy X Get Y Free

CHAPTER 23: 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. This is the
first of two conditions that can be added to the rule, and determines when the rule is triggered.
It can be based upon a combination of product attributes, products, and cart attributes. If left
blank, the rule is triggered for every cart.

Condition

Step 3: Define the Actions
1.

408

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 three.

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Buy X Get Y Free

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

Buy 3 Get 1 Free
2.

To apply the rule only to specific items in the cart, complete the condition to describe the cart
item(s) and/or product attribute(s) that are required for the promotion. The following example
uses the SKU to apply the rule to all associated variations of a configurable product.

Condition for Cart Items
3.

To include Free Shipping, choose one of the following options:
l

For matching items only

For shipment with matching items

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 Commerce User Guide

409

Buy X Get Y Free

CHAPTER 23: Cart Price Rules

Examples
Buy X Get Y Free is processed as a single action, with a “row total” dependency. All items must
be from the same SKU to qualify for the promotion. For example:
Buy X quantity of product from category A, get Y quantity of the same product
for free.

To limit the free product to categories A, B, and C, set the action as follows:
If ALL of these conditions are TRUE:
Category is one of A, B, C

To limit the free items from any category A, B, C and receive Y from SKUs D123, E123, F123, set
the action as follows:
If ALL of these conditions are TRUE:
SKU is one of D123, E123, F123

Use the following formula to determine the correct value for the Maximum Qty Discount:
Formula = (X+Y) * (M/Y)
Where
X = number of items purchased
Y = number of free items
M = Maximum number of free items allowed

For example:
Buy 5 Get 2 Free with maximum of 4 free items allowed.
Where
X = 5
Y = 2
M = 4
Maximum Qty Discount = (5+2)*(4/2)=(7)*(2)=14

Buy 5 Get 3 Free with maximum of 9 free items allowed.

410

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Buy X Get Y Free

Where
X = 5
Y = 3
M = 9
Maximum Qty Discount = (5+3)*(9/3)=24

Buy 20 Get 2 Free with maximum of 20 free items allowed.
Where
X = 20
Y = 2
M = 20
Maximum Qty Discount = (20+2)*(20/2)=(22)*(10)=220

Magento Commerce User Guide

411

Discount with Minimum Purchase

CHAPTER 23: 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.

Category
a.

412

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

Magento Commerce User Guide

CHAPTER 23: Cart Price Rules

Discount with Minimum Purchase

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.

Enter the Price to Complete the Condition
5.

Tap Save and Continue Edit .

Magento Commerce User Guide

413

Discount with Minimum Purchase

CHAPTER 23: Cart Price Rules

Step 3: Define the Actions
1.

Expand

the Actions section, and do the following:

Actions

414

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 Commerce User Guide

CHAPTER 23: 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 Commerce User Guide

415

416

Magento Commerce User Guide

Communications

417

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
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

418

CHAPTER 24:

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 Commerce User Guide

419

Supported Email Clients

CHAPTER 24: 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 Commerce.

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

420

iPhone 5
iPhone 4s

Magento Commerce User Guide

CHAPTER 24: 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 Commerce User Guide

421

Preparing Your Email Logo

CHAPTER 24: 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.

422

Magento Commerce User Guide

CHAPTER 24: 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

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.

Magento Commerce User Guide

423

Configuring Email Templates

CHAPTER 24: Email

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.
1.

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.

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:

424

Magento Commerce User Guide

CHAPTER 24: Email

Configuring Email Templates

Disable

Sends sales email when triggered by an event.

Enable

Sends sales email at predetermined, regular intervals.

General Settings

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

Expand

the Order section. Then, do the following:

Order
a.

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:

Magento Commerce User Guide

425

Configuring Email Templates

CHAPTER 24: Email

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
5.

Expand

Sends the copy as a separate email.

the Order Comments section, and repeat these steps.

Order Comments
6.

426

Complete the configuration for the remaining sales emails:
l

Invoice

Shipment

Credit Memo

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 24: Email

Configuring Email Templates

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.

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 Commerce User Guide

427

Configuring Email Templates

CHAPTER 24: Email

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
4.

Sends the copy as a separate email.

When complete, tap Save Config.

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

428

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 Commerce User Guide

CHAPTER 24: Email

Customizing Email Templates

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

Magento Commerce User Guide

429

Customizing Email Templates

CHAPTER 24: Email

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:
a.

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

Default Header Template

430

Magento Commerce User Guide

CHAPTER 24: Email

Customizing Email Templates

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.

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.

Insert Variable

Magento Commerce User Guide

431

Customizing Email Templates

CHAPTER 24: Email

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

the Transactional Emails section.

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

When complete, tap Save Config.

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

432

Magento Commerce User Guide

CHAPTER 24: Email

Customizing Email Templates

Field Descriptions (cont.)
FIELD
Template Name
Insert Variable

DESCRIPTION
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 Commerce User Guide

433

Customizing Email Templates

CHAPTER 24: Email

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

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.

434

Magento Commerce User Guide

CHAPTER 24: Email

Customizing Email Templates

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.

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.

Magento Commerce User Guide

435

Customizing Email Templates

CHAPTER 24: Email

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

the Transactional Emails section.

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

When complete, tap Save Config.

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

436

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 Commerce User Guide

CHAPTER 24: Email

Customizing Email Templates

Message Templates
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 Commerce User Guide

437

Customizing Email Templates

CHAPTER 24: 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.

438

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

Magento Commerce User Guide

CHAPTER 24: 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 Commerce User Guide

439

Configuring Email Communications

CHAPTER 24: 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

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.

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

440

Magento Commerce User Guide

CHAPTER 24: Email

Configuring Email Communications

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
a.

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

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

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

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.

In the panel on the left under Sales, choose Sales Emails. Then, do the following:
a.

Expand the General Settings section.

Set Asynchronous sending to “Enable.”

General Settings
5.

When complete, tap Save Config.

Magento Commerce User Guide

441

442

Magento Commerce User Guide

CHAPTER 25:

Marketing Automation
Marketing Automation is a cloud-based tool powered by dotmailer that produces professional,
personalized email communications and reports using data from your Magento store.
Dotmailer gives you the ability to:
l

Create customized email communications

Import contacts

Schedule campaigns

Create rules to add logic and automate your campaigns

Changes in the Latest Release
Release 2.2.4
New Features
l

Support for custom transactional email templates

Transactional email can now be set at store level

Validation for CSV files deleted during cron jobs

Abandoned Cart report

Setting Up dotmailer
To add dotmailer to your store, you must first sign up for a free trial account. Then, follow the
instructions to complete the setup and gain access to the dotmailer dashboard.

Step 1: Sign Up for a Free Trial
1.

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

In the panel on the left under Dotmailer, choose API Credentials.

Click the banner to start a free 14-day trial.

Magento Commerce User Guide

443

Setting Up dotmailer

CHAPTER 25: Marketing Automation

Free dotmailer Trial
4.

Complete the form, and click Create an Account.

Create an Account
5.

When you receive an account activation email from dotmailer, click the activation link to get
started. Then, do the following:
a.

Follow the prompts to complete the onboarding process. Then, tap Let’s go!

Onboarding
b.

444

Follow the prompts to read the Welcome message. Then, tap Build your first campaign.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Setting Up dotmailer

Welcome
c.
6.

Dotmailer is now enabled, and your API Username and API Password appear in the Settings
section of the Magento configuration.

Settings
7.

When complete, tap Save Config.
Dotmailer is now integrated with your Magento installation.

Step 2: Log in to Your dotmailer Account
Go to the dotmailer site, and log into your new account. Then, check your email and follow the
instructions to verify your account. When your account is verified, your dotmailer dashboard
appears.
The Settings icon at the bottom of the sidebar provides access to your account details and
administrative tasks.

Magento Commerce User Guide

445

Setting Up dotmailer

CHAPTER 25: Marketing Automation

Edit Account Login Credentials
1.

Tap the Settings icon at the bottom of the sidebar. Then at the top of the menu, click Edit
details.

Edit Account Details

View /Edit Account Details
1.

Tap the Settings icon at the bottom of the sidebar. Then on the menu, choose Account.

Account Details
2.

Add a New User
1.

Tap the Settings icon at the bottom of the sidebar. Then on the menu, choose Access.

Enter the Email address of the new user.

Under Permissions, do one of the following:
l

Mark the “All permissions” checkbox.

Mark the checkbox of each permission to be granted the new user.

When complete, tap Save.

An invitation is sent to the email address of the new user. To activate the account, the new
user must do the following:

446

Open the account activation message from dotmailer.

Click the activation link.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Setting Up dotmailer

Add a New API User
1.

Tap the Settings icon at the bottom of the sidebar. Then on the menu, choose Access.

dotmailer Settings - Access
2.

Tap New user. Then, do the following:
a.

Accept the randomly-generated Email address. Each API user must have a unique email
address.

In the Description field, describe how the account is to be used.

To enter the password, do one of the following:
l

Click the Password field. Then, choose an existing password.

Enter a new password.

Then, enter the password again to confirm.
d.

Verify that the Status “Enabled” option is selected.

When complete, tap Save.
The new API user is added to the list.

API Users

Magento Commerce User Guide

447

Creating a Campaign

CHAPTER 25: Marketing Automation

At some point while working with your free trial, you’ll be asked to verify your account. When
prompted, click the free trial message above the header, and follow the instructions. Until then,
your account will be shown as “unverified.”

Dotmailer Dashboard

Step 3: Complete the Magento Configuration
(This is the Drop-down text)

Creating a Campaign
Dotmailer includes a large selection of professionally-designed email and newsletter templates
for a variety of promotions and events. You can use one of their prepared templates, or design
your own.
In this example, we will rework a prepared template for the Magento Luma demo store. The
purpose of the example is to introduce you to different types of content building blocks and
editing techniques.

Step 1: Create a Campaign
1.

On the Welcome page, click create a quick tester campaign. Notice that the Campaigns option
is now active in the main menu, and the email icon is highlighted in the sidebar.

Hover over the thumbnail image, to show the Select and Preview buttons. Then, do the
following:

448

Tap Preview (

) to see a mockup of the template.

Tap Select to choose the template for your campaign.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Template Preview
3.

Enter a Campaign name, and accept the default Campaign location as the folder where the
campaign will be saved. Then, tap Continue.

Campaign Name
4.

To complete the setup of your simple test campaign, do the following:
a.

Enter a Subject line for the email. Subject lines can be personalized for each recipient by
using a placeholder. To learn how to add data fields, see Step 5.

Enter your Friendly from name that will appear in the header instead of your email
address.

In the From address field, choose the email address that is to appear as the sender of the
message. The list includes all email addresses that are associated with your account.

Magento Commerce User Guide

449

Creating a Campaign

CHAPTER 25: Marketing Automation

(Optional) All replies to your campaign are automatically stored in your dotmailer
account. If you would like to send each reply to specific individuals, enter each
Forwarding address, separated by comma.

(Optional) In the Campaign tags field, enter as many tags as needed to filter your
campaigns for reporting purposes. Press the Tab key to separate multiple tags.

Campaign Details
As you type, the Preview section shows how your message will appear in the inbox of each
recipient. Notice how your “Friendly from name” is used to distinguish it from other email.

Campaign Preview
5.

Above the Campaign details section, click the Campaign settings tab. For this test campaign,
we will use the default settings. Tap Save.

Campaign Settings

450

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Step 2: Edit the Campaign Content
1.

Before you get started, it’s important to know that you can save your work at any time. If you
log out and continue your work later, you can find the most recently saved version of your
campaign in the menu under Campaigns > My Campaigns. To continue editing, find your
campaign in the list, and click its name.

The content editor uses building blocks to represent each type of content that can be added to
the template. The Build tab of the sidebar on the left displays the selection of building blocks
that you can drag and drop into position. For this example, we will replace the sample content
in the template with content of our own.

The following instructions walk you through each section of the template, and introduce
editing and formatting tools, and techniques.

Complete the Preheader (Optional)
The space above the header can be used to enter a brief message. Click the text box, and enter
the text that you want to appear above the header.

Preheader Text

Upload Your Logo
1.

On the Build tab, choose Images. To upload your logo, click Manage. Then, click here to
upload the image. Choose the image that you want to upload. Image manager is similar
to Media Storage, and is used to organize the images that are available in your dotmailer
account.
It is recommended to limit the combined size of all images in a campaign to less than 100kb.

Image Manager
2.

To organize your images, click New folder. Then, enter a name for the untitled folder. The
new folder is nested below the original parent folder.
You can create as many folders as needed, and organize them any way you want. Over
time, you will upload many images to your account, and it’s important to organize them
in a way that makes them easy to find.

Magento Commerce User Guide

451

Creating a Campaign

CHAPTER 25: Marketing Automation

In the sidebar, click the parent folder that contains the logo that you uploaded. Then,
drag the image to the new folder. Then, click Close (X) in the upper-right corner to return
to the content editor.

New Folder
4.

The logo that you uploaded appears in the sidebar, where it can be dragged into position.
Drag and drop your logo to replace the placeholder image.

Edit and Format Text
The next section of the template represents your store’s menu. However, it’s actually a building
block with a multi-column layout, similar to a table. The text in each cell can be edited and
formatted separately. The Columns building block can be used in many ways to control the
text layout.
1.

Click the menu area, so you can see the multi-column layout. The Columns building
block is located in the sidebar under Layout.

Click each cell and enter the menu options for your store. Then, use the toolbar to change
the font, size, and style of the text, as needed.

Add Links
To link each menu option in the template to your store, do the following:
1.

452

Open your store In another window, and click the first menu option. Then, copy the full
URL.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

In the template, select the text for the first menu option. Then in the toolbar, click the
Hyperlink ( ) tool.

In the Link (URL) field, paste the link that you copied from your store.

If you want to later be able to track how many people click the link, enter a code for that
menu option. Then, tap Insert.

Repeat these steps to link each menu option to your store.

Add a Link

Change the Background Color
1.

In the sidebar, choose the Styles tab. Notice that Background layers is set to “Table row
(tr).” In the underlying HTML of the template, the menu background is actually a row in
a table.

In the template, hover over the menu background to highlight the entire row.

In the sidebar under the color picker, enter the hexadecimal code for the background color
of your store’s menu. In the Magento Luma store, the background color of the menu is
#f0f0f0.

Tap Save colour to save the color in the My colors section of the sidebar.

Magento Commerce User Guide

453

Creating a Campaign

CHAPTER 25: Marketing Automation

Background Color

454

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Replace the Banner
1.

On the Build tab of the sidebar, under Images, click Add Image ( + ).

Choose the banner image that you want to upload. After a moment, the image appears in
the sidebar.

From the sidebar, drag the new banner to replace the placeholder.

Banner

Add Featured Products
Dotmailer gives you the ability to dynamically incorporate data from your store into a
template. However, for this simple example, product data is added as static images with links
to your store. Although this template includes two rows of products, only one row is included
to reduce the number of images. The “Shop Now” blocks was also removed from the template,
because it didn’t introduce any new editing techniques.
1.

Upload the image for each featured product.

Edit the text, as needed, for each featured product.
The price can be updated as any other text field. To change the currency, simply type a
dollar sign, or any other currency symbol that is needed.

To update the product buttons, do the following:
a.

Click the button to display its settings appear in the sidebar.

Paste the Button URL for the corresponding product detail page. Then, update the
color and formatting as needed.

Repeat these steps for each product button.

Magento Commerce User Guide

455

Creating a Campaign

CHAPTER 25: Marketing Automation

Button Settings

Add Social Media Links
1.

In the template, scroll down to the social media placeholder.

In the building blocks sidebar under Tools, drag the Social Links building block into
position in the template. The empty building block appears either above or below the
placeholder.

Social Media Building Block
3.

456

Click the empty building block to open the Social links settings. Then, do the following:
a.

Mark the checkbox of each social link that you want to include in the template.

For each social link, paste the URL of your company profile page.

When complete, tap Apply.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Social Links
4.

To adjust the format and spacing of the buttons, click anywhere in the social links
building block. You can experiment with these settings to adjust the size and format of
the buttons. To make your buttons look like the template, do the following:
a.

In the sidebar under Label position, set Horizontal alignment to “Center.”

Under Spacing, set Horizontal to “15px” and Vertical to “None.”

To delete the placeholder social media links, click Close ( X ) in the upper-right
corner.

Formatting the Social Media Links

Magento Commerce User Guide

457

Creating a Campaign

CHAPTER 25: Marketing Automation

Complete the Footer
The information at the bottom of the template is important, and in many countries is required
by law. You must provide a mechanism for recipients to unsubscribe, and clearly identify the
sender of the email.

Footer Information
1.

Do not change the “Unsubscribe” and “Forward this email “links, because they contain
code that manages each operation. However, you can format the text if you like.

Click the Footer info text block, and enter your company information, including your
registration number, if applicable, so recipients know who has sent the email.

Click the Company registered address text block, and complete the information. In this
example, we added a link to the Contact Us page on our site.

The template is now fully customized for your store. Tap Save.

Step 3: Send a Test
1.

To test your campaign, tap Test send in the template header.

To send the test email to yourself, mark the checkbox of the email address that is associated
with your dotmailer account.

458

To add more recipients, click Add another email address. Then, do the following:
a.

Enter the Email address, First name and Last name of the recipient. Then, tap Add.

Repeat these steps to add as many recipients as you want.

Mark the checkbox of each additional recipient that is to receive the test email.

When you are ready to send the test campaign, tap Test Send. If prompted, tap Save and send.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Send a Test of Your Email Campaign
5.

Check your email to see how it looks!

Step 4: Review the Summary Report
The Summary Report validates the campaign, lists any errors that are found, and suggests
areas for improvement.
In addition to the Summary Report, the Reports menu has a selection of Marketing
Automation reports.
1.

On the Campaigns menu, choose My Campaigns.

My Campaigns
2.

In the record for your test campaign, click Summary (

) to view the summary report.

This report says that the quality of the text content needs to be improved.

Magento Commerce User Guide

459

Creating a Campaign

CHAPTER 25: Marketing Automation

Summary Report

Step 5: Add a Personal Note
In this step, we’ll add a personal note with a link, and then do another test run.
1.

460

Drag a text building block from the sidebar to the template. Then, do the following:
a.

Enter the word “Hi” to begin the greeting.

In the toolbar at the top of the template, tap Data Fields.

In the list of data fields, choose First name.

Complete the note, and add a link. Then, Save your work.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Personalized Greeting

Step 6: Preview the Campaign
1.

In the button bar at the top of the workspace, tap Preview.

Desktop Preview
2.

In the upper-right corner, click Phone (

), and choose Portrait.to see how the message looks

on a mobile device.

Magento Commerce User Guide

461

Creating a Campaign

CHAPTER 25: Marketing Automation

Phone Preview
3.

462

Close the preview.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Import Your Contacts
Your dotmailer account is synced with your store, and maintains up-to-date address books of
your customers, guests, and subscribers.

To view your contacts:
1.

On the dotmailer menu, choose Campaigns > My Campaigns.
The contact list includes customer, guest and subscription data that is automatically imported
from your store.

Address Books
2.

To view the import report, click the Notifications bell ( ) near the bottom of the sidebar.
Whenever the data is updated, the number of updated imports appears in red.
There are two recent imports. available. Although this list doesn’t tell you what they are, one is
your list of customers, and the other is your list of subscribers.

In the first message, click import report.

Notifications Report
4.

In the Notifications list, click import report.

Magento Commerce User Guide

463

Creating a Campaign

CHAPTER 25: Marketing Automation

The Contacts import report includes a summary of all subscribers as well as duplicates,
failures, soft and hard bounces, invalid email addresses, and those who have unsubscribed, or
have been blocked, globally suppressed, or otherwise blacklisted. You can use this report to help
keep your data clean.

Import Report
5.

After reading the report, tap Go to address book. This import contains your subscribers, and
the other one contains your customers.

Subscriber Address Book
6.

In the main menu, return to Contacts > My Contacts. This time, click the Magento_
Customers address book.

464

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Customer Address Book Actions
7.

To see all the things you can do with your customer data from dotmailer, click More actions.
Using what we’ve covered so far, you should be able to create a newsletter campaign and send
it to your list of subscribers.

Magento Commerce User Guide

465

Creating a Campaign

CHAPTER 25: Marketing Automation

Schedule Your Campaign
You now have a campaign and a list of customers. The next step is to schedule the campaign,
and send it on its way.

To schedule a campaign:
1.

On the dotmailer menu, choose Campaigns > My Campaigns.

Send Your Campaign
2.

Find your test campaign in the list, and in the last column, click Send (

). Then, do the

following:
a.

With Select address books or queries marked under step 1, choose the address book that
is the target of the campaign. For this test campaign, mark the Magento_Customers
checkbox.

Choose the Address Book
b.

466

Complete the options to select when you want to send the campaign.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Schedule the Campaign
c.

If you want to remail the campaign, select “Yes.” By default, campaigns are not sent a
second time.

Remail Options
d.

Tap Save & continue.

Take one last look at the report before you send the campaign. Then, scroll down to the
bottom and tap Send campaign immediately. When prompted to confirm, tap Send.

Send Immediately
3.

Congratulations! Your campaign is on its way!

Your Campaign Is On Its Way
4.

To see the results, tap Check out the campaign report.

Magento Commerce User Guide

467

Creating a Campaign

CHAPTER 25: Marketing Automation

Campaign Report
5.

On the menu, choose Dashboard to see your progress. You have completed the first four tasks,
and a notification is waiting for you at the bottom of the sidebar.

Dashboard

468

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Automate Your Campaign
dotmailer includes three prepared automation templates, plus a blank template that you can
use to create custom programs. When setting up an automated campaign, you can use existing
campaigns, or create placeholders for new ones. This example uses a prepared template to
create a simple Welcome campaign with a follow-up message that is sent a week later.

Choose a Template

Step 1: Create a New Program
1.

On the dotmailer menu, choose Automation. Then, tap New program.

My Programs
2.

To choose the Welcome program template, hover over the tile and tap Select. Then, do the
following:

When prompted, enter the Program name. For now, you can accept the Programs folder
location. Then, tap Continue.
The Edit program workspace includes a flowchart of the program logic. Each box in the
diagram is a node. The panel on the left has a selection of nodes that can be added to the
program. You can create sophisticated automations using these simple building blocks.

Magento Commerce User Guide

469

Creating a Campaign

CHAPTER 25: Marketing Automation

Edit Program

Step 2: Complete the Start Options
1.

In the flowchart, click the Start node.
The panel on the left provides an overview of the process, and walks you through each step.

Start
2.

470

Under 1. Enrolment scheduling, tap Set enrolment schedule.
a.

By default, the Welcome program is scheduled to run Daily at 11:00 AM. ‘

For this example, accept the default scheduling. Then, tap Apply.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Enrollment Scheduling
3.

Under 2. Enrolment rule, tap Trigger from contact date field.
The options describe the event that triggers the rule. For this program, the welcome email
campaign will be triggered whenever a new account is created.
Complete the trigger description as follows:

Trigger from Date

Accept the option to Trigger from contact date field.

To determine when contacts are added to the program, accept the default entry, default
entry 0 days after.

Set the Date field to ACCOUNT_CREATED_DATE.

When complete, tap Apply.

Under 3. Enrolment limits, tap Set enrolment limits. Then, do the following:

Magento Commerce User Guide

471

Creating a Campaign

CHAPTER 25: Marketing Automation

For this program, accept the default option to re-enrol contacts every day they meet the
start criteria.
This option ensures that every person who signs up for a new account will be included in
the next scheduled mailing.

b.
5.

Tap Apply.

Review the options in the Start panel. Then, tap Apply.

Enrolment Limits

Step 3: Choose the Campaign
1.

In the flowchart, click the Campaign node. Then, do the following:
a.

To choose an existing campaign, tap Select campaign.

Send Campaign

472

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Tap Create campaign.

Enter the Campaign name, and accept the Campaigns folder as the default Campaigns
location.

Tap Create.

Create Campaign
2.

Tap Apply.
The name of the new campaign appears in the Campaign box.

Step 4: Set the Delay
You can add a delay to the program to wait a number of days, or until a specific time of day,
before sending a follow-up campaign.
1.

In the flowchart, click the Delay node.

Accept the default Wait period of 7 days. Then, tap Apply.

Magento Commerce User Guide

473

Creating a Campaign

CHAPTER 25: Marketing Automation

Delay

Step 5: Create a Follow-Up Campaign
1.

In the flowchart, click the next Campaign node.

Enter the Campaign name, and accept the Campaigns folder as the default Campaigns
location.

Tap Create. Then, tap Apply.
Your follow-up campaign is added to the workflow.

Step 6: Define the End of the Program
All programs have defined starting and end points.

474

Click the End node.

For this example, you can accept the default name of the end point.

Tap Apply.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Creating a Campaign

Step 7: Edit Your Campaign
If you added placeholders for new campaigns, you still need to complete the definition of each
campaign. However, if you used existing campaigns, your Welcome program is good to go!
1.

On the Automation menu, choose Trigger campaign content.

Find the campaign in the list, and click Edit (

My Campaigns

Magento Commerce User Guide

475

Exclusion Rules

CHAPTER 25: Marketing Automation

Exclusion Rules
An exclusion rule can be created to exclude abandoned cart and review emails from being sent
under certain conditions. A rule describes the conditions that must be met to trigger the action.
For example, a rule might exclude all abandoned carts with a subtotal that is equal or less than
10. To learn more, see Exclusion Rules in the dotmailer help centre.

Dotmailer Exclusion Rules

To add a new rule:
1.

On the Admin sidebar, choose Marketing. Under Marketing Automation, choose Exclusion
Rules. Then, tap Add New Rule.

476

On the Rule Information tab, do the following:
a.

Enter a descriptive Rule Name.

Set Rule Type to one of the following:
l

Abandoned Cart Exclusion Rule

Review Email Exclusion Rule

Leave Status set to “Inactive” for now. You can later change it to “Active.”

Choose the Websites where the rule applies.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Exclusion Rules

Rule Information
3.

On the Conditions tab, set Conditions Combination Match to one of the following:
l

ANY

ALL

Exclusion Rule Conditions

Magento Commerce User Guide

477

Exclusion Rules

CHAPTER 25: Marketing Automation

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

Choose the Attribute that is the subject of the conditional statement.

Under Condition, choose the operator.

Enter the Value that is needed to complete the condition.

Conditions
d.
5.

478

For multiple conditions, tap Add New Condition. Then, repeat these steps.

When complete, tap Save.

Magento Commerce User Guide

CHAPTER 25: Marketing Automation

Automation Studio

Automation Studio
The Automation Studio option in the Marketing menu is a shortcut to the Dotmailer Developer
configuration settings.

Dotmailer Developer Configuration

To access Automation Studio:
On the Admin sidebar, choose Marketing. Then under Marketing Automation, choose
Automation Studio.

Magento Commerce User Guide

479

480

Magento Commerce User Guide

CHAPTER 26:

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 Commerce User Guide

481

Preparing Your Invoice Logo

CHAPTER 26: 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 dot per inch (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.

482

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

Magento Commerce User Guide

CHAPTER 26: 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 Commerce User Guide

483

Adding Reference IDs to Header

CHAPTER 26: 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

484

Set Display Order ID in Header according to your preference.

Repeat for the Shipment and Credit Memo sections.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 26: 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 Commerce User Guide

485

Customer Address Templates

CHAPTER 26: 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

486

Magento Commerce User Guide

CHAPTER 26: 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 Commerce User Guide

487

488

Magento Commerce User Guide

CHAPTER 27:

Newsletters
Publishing a regular newsletter is considered to be one of the most powerful and affordable
marketing tools available. Magento Commerce 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 Commerce User Guide

489

Configuring Newsletters

CHAPTER 27: 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.

490

Magento Commerce User Guide

CHAPTER 27: 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 Commerce User Guide

491

Newsletter Templates

CHAPTER 27: 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.

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.

Template Information

492

Magento Commerce User Guide

CHAPTER 27: 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 Commerce User Guide

493

Sending Newsletters

CHAPTER 27: 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.

Add to Newsletter Queue

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.”

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.

494

Magento Commerce User Guide

CHAPTER 27: Newsletters

Sending Newsletters

Queue Information
6.

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 Commerce User Guide

495

Managing Subscribers

CHAPTER 27: 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

496

Magento Commerce User Guide

CHAPTER 27: 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 Commerce User Guide

497

498

Magento Commerce User Guide

CHAPTER 28:

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 Commerce User Guide

499

CHAPTER 28: 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

500

Expand

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

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 28: 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 Commerce User Guide

501

502

Magento Commerce User Guide

CHAPTER 29:

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 Commerce User Guide

503

Adding Predefined Variables

CHAPTER 29: 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.

504

When complete, tap Save Template.

Magento Commerce User Guide

CHAPTER 29: 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 Commerce User Guide

505

Adding Custom Variables

CHAPTER 29: Using Variables

New Custom Variable
5.

506

When complete, tap Save.

Magento Commerce User Guide

CHAPTER 29: Using Variables

Markup Tags

Markup Tags
A markup tag is a directive that contains snippet of code with a relative reference to an object
in your store, such as a variable, URL, image, or block. Markup tags can be used anywhere the
editor is available and 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 Commerce User Guide

507

Markup Tags

CHAPTER 29: 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 class="Magento\Contact\Block\ContactForm"
name="contactForm" template="Magento_Contact::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"}}

508

Magento Commerce User Guide

CHAPTER 29: 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 Commerce User Guide

509

Markup Tags

CHAPTER 29: 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

510

Magento Commerce User Guide

CHAPTER 29: 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 Commerce User Guide

511

Markup Tags

CHAPTER 29: 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

512

Magento Commerce User Guide

CHAPTER 29: Using Variables

Markup Tags

Dynamic Media URLs
A dynamic media URL is a relative reference to an image or other media asset. When enabled,
dynamic media URLs can be used to link directly to assets on your server, or to files stored on a
content delivery network. The use of dynamic media URLs can impact catalog performance,
and the editor can be configured to use either static or dynamic media URLs for catalog
product and category descriptions.
As with all markup tags, the code is enclosed in double curly braces. The format of a dynamic
media URL looks like this:
{{media url="path/to/image.jpg"}}

To configure dynamic media URLs:
1.

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

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

the Storefront

section, and do the following:

Storefront

Magento Commerce User Guide

513

Markup Tags

CHAPTER 29: Using Variables

Scroll down to Allow Dynamic Media URLs in Products and Categories. Then, clear the
Use system value checkbox.

b.
3.

Set Allow Dynamic Media URLs in Products and Categories to your preference.

When complete, tap Save Config.

To use static URLs by default for media files:
By default, images inserted into the catalog from media storage have relative, dynamic URLs.
If you prefer to use a static URL, you can change the configuration setting.
1.

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

In the panel on the left under General, choose Content Management.

Expand

the WYSIWYG Options section.

WYSIWYG Options

514

Set Use Static URLs for Media Content in WYSIWYG for Catalog to “Yes.”

When complete,tap Save Config.

Magento Commerce User Guide

CHAPTER 29: 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 Commerce User Guide

515

Variable Reference

CHAPTER 29: Using Variables

Store Contact Information Variables (cont.)
VARIABLE

516

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 Commerce User Guide

CHAPTER 29: 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 Commerce User Guide

517

518

Magento Commerce User Guide

CHAPTER 30:

Social
Your Magento store can be connected to social networks either by using the Magento Social
Facebook connector, or by installing a Marketplace extension. In addition, you can easily add
social plugins such as the “Like” button to CMS blocks that can be incorporated into pages
throughout your store.
l

Connect to Facebook

Marketplace Extensions

Adding Social Plugins

Magento Commerce User Guide

519

Connect to Facebook

CHAPTER 30: Social

Connect to Facebook
Magento Social is an integration that establishes a connection between your store and your
Facebook account, and creates a shopping page with products from your catalog. When
shoppers click a product on your Facebook page, they are redirected to the corresponding
product page in your Magento store. All transactions take place from your Magento store.

Magento Social
The capacity and features that are available for your Facebook shopping page are determined by
your Magento Social account. For a free account, only nine products are initially added to the
page. To support an unlimited number of products, you must upgrade your Magento Social
account.

Before You Begin
If your browser is set to disable popups, it must be updated to permit the popups that are used
during the configuration of the Facebook connector. The following procedure shows how to add
the URL that generates the necessary popups to the whitelist in Chrome. The process is similar
for other browsers.
1.

In the upper-right corner of the browser window, click the three dots to display the menu.
Then, choose Settings.

Scroll down to the bottom of the page, and click Advanced.

In the Privacy and security section, expand Content Settings. Then, expand the Popups
section, and do the following:
a.

Under Allow, tap ADD.

Enter the URL for your store, and click ADD.

Enter the following URL, and click ADD.
https://fbapp.ezsocialshop.com

Step 1: Activate Magento Social

520

On the Admin sidebar, tap Marketing. Then under Social, choose Connect to Facebook.

Under Step 1, tap Integrations page to establish your Magento Social connection.

Magento Commerce User Guide

CHAPTER 30: Social

Connect to Facebook

Step 1: Activate Magento Social
3.

Find Magento Social in the Integrations grid, and click Activate.

Activate Magento Social
4.

When prompted to approve access to the following API resources, tap Allow.

Magento Commerce User Guide

521

Connect to Facebook

CHAPTER 30: Social

API Resources
5.

When the “Success” message appears, tap Close.

Activation Successful
6.

When you return to the Integrations grid, the status of Magento Social is “Active.” If necessary
in the future, you can repeat these steps to Reauthorize the integration.

522

Magento Commerce User Guide

CHAPTER 30: Social

Connect to Facebook

Sent for Activation

Step 2: Launch Your Store
1.

Keeping your Magento window open, open a new browser tab, and sign in to your Facebook
account. Then, return to the Magento tab.

On the Admin sidebar, tap Marketing. Then again under Social, choose Connect to Facebook.

On the “Connect your store to Facebook” page under Step 2, tap Launch Store.

Step 2: Launch Your Store
4.

When prompted to “Turn your Magento store into a Facebook store,” tap Connect Magento to
Facebook.

Magento Commerce User Guide

523

Connect to Facebook

CHAPTER 30: Social

Connect Your Store to Facebook
5.

At the Log In with Facebook window, tap Continue as [username].

Tap OK to let Shopial manage your pages.

Let Shopial Manage Pages
7.

524

At the “Head to Facebook” page,” tap Create a Facebook page. Then, do the following:

Magento Commerce User Guide

CHAPTER 30: Social

Connect to Facebook

Create a Facebook Page
a.

Under Create a Page, tap Brand or Product.

Refresh
b.

Under Choose a Category, select “App page”.
The categories listed are not integrated with your Magento Social page. At this time, Magento
Social does not support choosing specific products from your catalog.

Enter a Name for your Magento Social page.

Tap Get Started.

Get Started
e.

Return to the tab with the “Head to Facebook” page, and tap Refresh.

When the Congratulations message appears, tap Close to see your new Facebook shop.

Magento Commerce User Guide

525

Connect to Facebook

CHAPTER 30: Social

Congratulations!
g.

Your initial store has nine products from your Magento catalog. To finish the page, you
can add a profile photo, cover image, and description.

Magento Store on Facebook
8.

Whenever you want to return to your Magento store page from other pages in your Facebook
account, do the following:

526

In the panel on the left, click See more to display the full list of options.

Choose the last option, Store.

Magento Commerce User Guide

CHAPTER 30: Social

Connect to Facebook

Step 3: Upgrade Your Magento Social Store
Your Magento Social account determines the number of products that can be added to a single
Magento Social page. To create multiple pages, you must open a separate Magento Social
account for each page.
1.

If necessary, Sign in to your Facebook account. In the panel on the left, click See more. Then,
choose Store.

In the green message, click See plans and pricing here.

See Plans and Pricing
3.

On the Upgrade tab of the Magento Social section, choose one of the following account types.
Then, tap Upgrade.
l

Lite

Pro

Unlimited

Upgrade Levels
4.

In the Order Information section, do the following:

Magento Commerce User Guide

527

Connect to Facebook

CHAPTER 30: Social

If you have a coupon, enter the Coupon Code.

Tap Recalculate.

Order Information
5.

Complete the Customer Information.

Customer Information
6.

Complete the Credit Card Information. Then, review the information and tap Submit.

Credit Card Information

528

Magento Commerce User Guide

CHAPTER 30: Social

Connect to Facebook

Reauthorizing Magento Social
If you need to repeat the process after setting up your store for the first time, do the following:
1.

On the Admin sidebar, tap Marketing. Then under Social, choose Connect to Facebook.

Under Step 1, tap Integrations page to establish your Magento Social connection.

Step 1: Activate Magento Social
3.

Find Magento Social in the Integrations grid, and tap Reauthorize.

Reauthorize
4.

When prompted to approve access to the following API resources, tap Reauthorize.

Troubleshooting
1.

If the “Unable to Connect” page appears, complete the following instructions to refresh your
request and activate your token.
a.

On the Admin sidebar, choose System. Then under Extensions, choose Integrations.

Find Magento Social in the list, and click either Activate. or Reauthorize.

Magento Commerce User Guide

529

Connect to Facebook

CHAPTER 30: Social

Return to the “Unable to connect” page, and tap Refresh.

Unable to Connect
2.

If your store is still not connected, complete the following instructions to manually insert your
consumer key.
a.

Find Magento Social in the Integrations grid, and click the Information (

) icon to

display the Integration Info.
b.

Under Current User Identity Verification, enter Your Password that is used to log in to
the Admin.

Under Integration Details, select the entire value of the Consumer Key field, and copy it
to the clipboard.
To copy the selected key, either right-click and choose Copy from the context menu, or
press Ctrl+C.

Copy Consumer Key
d.

530

Return to the “Unable to connect” page, and paste the Consumer Key value into the text
box. Then, tap Send.

Magento Commerce User Guide

CHAPTER 30: Social

Connect to Facebook

Send Consumer Key
3.

You should now be able to continue with Step 2: Launch Your Store.

Magento Commerce User Guide

531

532

Magento Commerce User Guide

SEO & Search

533

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

534

CHAPTER 31:

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. To learn more
about category display options, see: Display Settings.
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.

Catalog Navigation

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 Commerce User Guide

535

Top Navigation

CHAPTER 31: 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

536

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 Commerce User Guide

CHAPTER 31: Catalog Navigation

Top Navigation

To set the top navigation:
See “Creating Categories” to define the category structure of the main menu. For a multistore
installation, a different main menu can be assigned as the root category for each store.

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 Commerce User Guide

537

Breadcrumb Trail

CHAPTER 31: 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

538

Magento Commerce User Guide

CHAPTER 31: 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 Commerce User Guide

539

Product Listings

CHAPTER 31: 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

540

Magento Commerce User Guide

CHAPTER 31: 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 Commerce User Guide

541

Product Listings

CHAPTER 31: 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

542

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 Commerce User Guide

CHAPTER 31: 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. The “Used for Sorting in Product
Listing” storefront property determines which product attributes can
be used to sort the list.
Show Per Page
Determines how many products appear per page.
Pagination Links
Navigation links to other pages.

Magento Commerce User Guide

543

Pagination Controls

CHAPTER 31: 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.

544

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 Commerce User Guide

CHAPTER 31: 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 Commerce User Guide

545

Layered Navigation

CHAPTER 31: Catalog Navigation

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

546

Magento Commerce User Guide

CHAPTER 31: 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 Commerce User Guide

547

Layered Navigation

CHAPTER 31: Catalog Navigation

Filterable Swatch Value with No Results
b.

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

Storefront Properties
3.

548

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

Magento Commerce User Guide

CHAPTER 31: 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 Commerce User Guide

549

Layered Navigation

CHAPTER 31: 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)

550

Magento Commerce User Guide

CHAPTER 31: 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 Commerce User Guide

551

Layered Navigation

CHAPTER 31: 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.

552

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 31: 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 Commerce User Guide

553

554

Magento Commerce User Guide

CHAPTER 32:

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 Commerce User Guide

555

Quick Search

CHAPTER 32: 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.

556

Magento Commerce User Guide

CHAPTER 32: 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 Commerce User Guide

557

Advanced Search

CHAPTER 32: 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.

558

Magento Commerce User Guide

CHAPTER 32: 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 Commerce User Guide

559

Weighted Search

CHAPTER 32: 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:

560

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 Commerce User Guide

CHAPTER 32: Catalog Search

Configuring Catalog Search

Configuring Catalog Search
Magento uses the 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 Commerce User Guide

561

562

Magento Commerce User Guide

CHAPTER 33:

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 Commerce User Guide

563

Popular Search Terms

CHAPTER 33: 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

564

Magento Commerce User Guide

CHAPTER 33: 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 Commerce User Guide

565

Adding Search Terms

CHAPTER 33: 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:
1.

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

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

General Information

566

Magento Commerce User Guide

CHAPTER 33: Search Terms

Adding Search Terms

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 Commerce User Guide

567

Search Terms Report

CHAPTER 33: 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

568

Magento Commerce User Guide

CHAPTER 34:

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 Commerce for B2B
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 Commerce User Guide

569

Meta Data

CHAPTER 34: 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 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.

570

Magento Commerce User Guide

CHAPTER 34: 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.

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 Commerce User Guide

571

Meta Data

CHAPTER 34: 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:

572

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

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

Magento Commerce User Guide

CHAPTER 34: 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 Commerce User Guide

573

Using a Site Map

CHAPTER 34: SEO Best Practices

Using a Site Map
A site map 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 site map can be configured
to index all pages and images.
When enabled, Magento creates a file called sitemap.xml that is saved to your installation in
the location that you specify. The configuration gives you the ability to set the frequency of the
updates, and the priority for each type of content. Your site map 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.
For technical information, see: Add sitemap and robots.txt in the developer documentation.

Site Map in Grid

Process Overview:
Step 1: Configure the Site Map
Step 2: Generate the Site Map
Step 3: Configure and Enable robots.txt (Optional)
Step 4: Submit Your Site Map to Search Engines
Step 5: Restore the Previous Robot Instructions (Optional)

Step 1: Configure the Site Map
Complete the XML Sitemap configuration to determine what is included, and how frequently
the site map is updated.

574

Magento Commerce User Guide

CHAPTER 34: SEO Best Practices

Using a Site Map

Step 2: Generate the Site Map
1.

On the Admin menu, choose Marketing. Then under SEO & Search, choose Site Map.

Tap Add Site Map. Then, do the following:

Site Map
a.

Enter the site map Filename. For example: sitemap.xml

Enter the Path to determine where the site map file is to reside on the server. Make sure
that the path is writeable.
/sitemap/

Places the site map file in a directory called “sitemap.”

Places the site map file at the base path, or root of your Magento
installation.

New Site Map
3.

When complete, tap Save & Generate.
It might take a few minutes for the site map to appear in the grid.

Magento Commerce User Guide

575

Using a Site Map

CHAPTER 34: SEO Best Practices

Step 3: 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 4: Submit Your Site Map to Search Engines
You can submit your site map to different search engines by providing them the link to the
sitemap.xml file in your Magento installation. To copy the link, do the following:
1.

In the Site Map grid, right-click the URL in the Link for Google column.

On the menu, choose Copy Link Address.
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 5: Restore Previous Robot Instructions (Optional)
You can now restore either the original, or default restrictions.

Column Descriptions
COLUMN

576

DESCRIPTION

The sequential record number of the current site map.

Filename

The file name of the site map.

Path

The location where the site map resides on the server. For example:
/sitemap/

Places the site map file in a directory called
“sitemap,” one level below the root of the
Magento installation.

Places the site map file at the base path, or
root of the Magento installation.

Link for Google

The URL of the site map that is to be submitted to Google and other
search engines.

Last Generated

Indicates the date and time the site map was last generated.

Store View

The store view where the site map applies.

Action

Generate

Regenerates the site map.

Magento Commerce User Guide

CHAPTER 34: SEO Best Practices

Site Map Configuration

Site Map Configuration
Your site map 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 Commerce User Guide

577

Site Map Configuration

CHAPTER 34: 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.

578

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 Commerce User Guide

CHAPTER 34: SEO Best Practices

Site Map 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 Site Map 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 Commerce User Guide

579

Search Engine Robots

CHAPTER 34: 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=

To configure robots.txt:

580

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

Find the Global configuration in the first row of the grid, and click Edit.

Magento Commerce User Guide

CHAPTER 34: SEO Best Practices

Search Engine Robots

Global Design Configuration
3.

Scroll down and expand

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

Search Engine Robots
a.

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 Configuration.

Magento Commerce User Guide

581

582

Magento Commerce User Guide

CHAPTER 35:

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 Commerce User Guide

583

Configuring URL Rewrites

CHAPTER 35: URL Rewrites

Configuring URL Rewrites
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

584

Set Use Web Server Rewrites to your preference.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 35: URL Rewrites

Automatic Product Redirects

Automatic Product 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 Commerce User Guide

585

Automatic Product Redirects

CHAPTER 35: 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.

586

Magento Commerce User Guide

CHAPTER 35: 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 Commerce User Guide

587

Creating URL Rewrites

CHAPTER 35: 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

588

Redirect to:

gear/bags/impulse-duffle.html

Redirect from:

gear/bags/overnight-duffle.html

Magento Commerce User Guide

CHAPTER 35: 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 Commerce User Guide

589

Creating URL Rewrites

CHAPTER 35: 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.

590

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 Commerce User Guide

CHAPTER 35: 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.

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

Magento Commerce User Guide

591

Creating URL Rewrites

CHAPTER 35: URL Rewrites

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

592

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 Commerce User Guide

CHAPTER 35: 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 Commerce User Guide

593

Creating URL Rewrites

CHAPTER 35: 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.

594

Set Redirectto one of the following:

Magento Commerce User Guide

CHAPTER 35: URL Rewrites

Temporary (302)

Permanent (301)

Creating URL Rewrites

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

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:

Magento Commerce User Guide

595

Creating URL Rewrites

CHAPTER 35: URL Rewrites

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.

Description

596

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 Commerce User Guide

CHAPTER 35: URL Rewrites

Creating 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
Redirect to:

new-page

Redirect from:

old-page

Magento Commerce User Guide

597

Creating URL Rewrites

CHAPTER 35: 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.

598

Set Redirect to one of the following:

Magento Commerce User Guide

CHAPTER 35: URL Rewrites

Temporary (302)

Permanent (301)

Creating URL Rewrites

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

Magento Commerce User Guide

599

Creating URL Rewrites

CHAPTER 35: 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

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.

Custom Rewrites

600

Magento Commerce User Guide

CHAPTER 35: URL Rewrites

Creating URL 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

Redirect to:

http://www.different-website.com/page.html

Redirect from:

cms-page
category.html
category/subcategory.html

Magento Commerce User Guide

601

Creating URL Rewrites

CHAPTER 35: URL Rewrites

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:

602

Temporary (302)

Permanent (301)

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

Magento Commerce User Guide

CHAPTER 35: URL Rewrites

Creating 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

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 Commerce User Guide

603

Creating URL Rewrites

CHAPTER 35: 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

604

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 Commerce User Guide

CHAPTER 36:

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 Content Experiments

Google AdWords

Magento Commerce User Guide

605

Google Analytics

CHAPTER 36: 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

606

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 Commerce User Guide

CHAPTER 36: Google Tools

Google Analytics

Google Content Experiments
The following example shows how to set up an A/B test of products, categories, or content
pages using Google Analytics Content Experiments. We recommend that you keep two browser
tabs open while working through the instructions, because you will need to bounce back and
forth between the Magento Admin and your Google Analytics account.
Google Content Experiments has been deprecated, and will eventually be replaced by Google
Optimize.

Step 1: Enable Content Experiments (Magento)
1.

Follow the instructions to enable Google Analytics with Content Experiments in the Magento
configuration.

Enable Content Experiments

Step 2: Set Up the Variations (Magento)
Create multiple variations of the same product, cateogory, or page.
l

Each variation must have a unique URL key.

Each variation must have the same store view selected.

You can create up to ten variations of each entity that you want to test. For products, use Save
& Duplicate to save time.

Step 3: Set Up the Experiment (Google)
You must have the appropriate permissions to the Google account to create an experiment.

Open another browser tab, and log into your Google Analytics account. If necessary, navigate
to the Account and Property.

In the sidebar on the left, choose Admin. Then, do one of the following:

Magento Commerce User Guide

607

Google Analytics

CHAPTER 36: Google Tools

Choose an Existing View
In the header of the View column, click the down arrow, and choose the view that is to
provide the data for the experiment.

Create a New Reporting View
1.

In the header of the View column, tap Create View. Then, do the following:
a.

Identify the experiment location as one of the following:
l

Website

Mobile app

Enter a descriptive Reporting View Name.

Specify the Reporting Time Zone.

When complete, tap Create View. Then, click the back arrow to return to the previous
page.

New Reporting View
3.

In the panel on the left under Reports, choose Behavior > Experiments.

Tap Create experiment. Then, do the following:

608

Specify the percentage of traffic to redirect.

Specify the Original Page URL and the URLs of each page variation that you want to test.

Complete the other options. If you need help see: .Configure & Modify Experiments.

When the experiment is set up, tap Manually Insert the Code. Then, copy the code snippet.

Magento Commerce User Guide

CHAPTER 36: Google Tools

Google Analytics

Step 4: Paste Code Snippet (Magento)
1.

Return to the Admin of your Magento installation. Then, open the original version of the
product, category, or page in edit mode.

Expand the View Optimization section for the product, category, or page. Then, paste the code
snippet that you copied from Google Analytics into the Experiment Code text box.
Do not paste the code snippet into any of the variations.

Product View Optimization
3.

When complete, tap Save.

Step 5: Review and Start the Experiment (Google)
1.

Return to your Google Analytics account.

Review the experiment settings.

If ready to begin, tap Start Experiment. Otherwise, tap Save for Later.

Magento Commerce User Guide

609

Google AdWords

CHAPTER 36: Google Tools

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.

610

Tap Conversion windows, and complete the settings to determine how long the conversions
are to be tracked, the reporting category, and attribution model.

When complete, tap Save and Continue.

Magento Commerce User Guide

CHAPTER 36: Google Tools

Google AdWords

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:
a.

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.

Google AdWords
4.

To format the Google Sites Stat notification, do the following:

Magento Commerce User Guide

611

Google AdWords

CHAPTER 36: Google Tools

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.

Magento Commerce User Guide

613

614

Magento Commerce User Guide

CONTENT

615

Contents
In this section of the guide, you’ll learn how to
create content and manage the presentation of
your store.

616

Content Elements
Design & Theme

CHAPTER 37:

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 Commerce User Guide

617

Menu Options

CHAPTER 37: 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.

Design
Learn to manage the visual presentation of your store,
apply themes, and schedule design changes.

618

Magento Commerce User Guide

Content Elements

619

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

620

CHAPTER 38:

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 content 1. 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.

About Us

1Content that has a long shelf life.

Magento Commerce User Guide

621

Core Content

CHAPTER 38: Pages

Core Content
The Magento demo store has examples of core content pages to help you get started. All of the
pages can be modified to meet your needs. Take a look at the following pages in your store, to
make sure that the content conveys your message, voice, and brand.

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.

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.

622

Magento Commerce User Guide

CHAPTER 38: Pages

Core Content

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.

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.

Magento Commerce User Guide

623

Core Content

CHAPTER 38: Pages

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.

624

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 Commerce User Guide

CHAPTER 38: Pages

Workspace Controls

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.

Update any of the following properties:
l

Title

URL Key

Status

Layout

When complete, tap Save.

Magento Commerce User Guide

625

Workspace Controls

CHAPTER 38: Pages

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

626

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.

Magento Commerce User Guide

CHAPTER 38: Pages

Workspace Controls

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

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:

Magento Commerce User Guide

Edit

Opens the page in edit mode.

Delete

Deletes the page.

View

Displays the page in preview mode.

627

Workspace Controls

CHAPTER 38: Pages

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:

628

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 Commerce User Guide

CHAPTER 38: Pages

Workspace Controls

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

Magento Commerce User Guide

629

Workspace Controls

CHAPTER 38: Pages

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

630

Applies all filters to the search.
Cancels the current search.
Clears all search filters.

Magento Commerce User Guide

CHAPTER 38: Pages

Workspace Controls

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

Magento Commerce User Guide

631

Workspace Controls

CHAPTER 38: Pages

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:

632

Tap the header of the column, and hold.

Drag the column to the new position, and release.

Magento Commerce User Guide

CHAPTER 38: Pages

Workspace Controls

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

Magento Commerce User Guide

633

Adding a New Page

CHAPTER 38: Pages

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

634

On the Admin sidebar, tap Content. Then under Elements, choose Pages.

Tap Add New Page.

Magento Commerce User Guide

CHAPTER 38: Pages

Adding a New Page

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

Magento Commerce User Guide

635

Adding a New Page

CHAPTER 38: Pages

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.

636

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 Commerce User Guide

CHAPTER 38: Pages

Adding a New Page

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
a.

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

Magento Commerce User Guide

637

Adding a New Page

CHAPTER 38: Pages

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.

638

Magento Commerce User Guide

CHAPTER 38: Pages

Adding a New Page

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.

Magento Commerce User Guide

639

Media Storage

CHAPTER 38: Pages

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

640

Magento Commerce User Guide

CHAPTER 38: 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:

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 Commerce User Guide

641

Media Storage

CHAPTER 38: Pages

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 (

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

642

Magento Commerce User Guide

CHAPTER 38: Pages

Media Storage

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)

Magento Commerce User Guide

643

Using the Editor

CHAPTER 38: Pages

Using the Editor
The 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 on product detail, the editor is accessed by clicking the
Show/ Hide 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.

644

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 Commerce User Guide

CHAPTER 38: 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:

Insert Image Button

Magento Commerce User Guide

645

Using the Editor

CHAPTER 38: Pages

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.

646

To use the product name, leave the Anchor Custom Text field empty.

Enter a Anchor Custom Title for best SEO practice. (The title isn't visible on the page.)

Set Template to one of the following:
l

To incorporate the link into text, select “Product Link Inline Template.”

To place the link on a separate line, select “Product Link Block Template.”

Magento Commerce User Guide

CHAPTER 38: Pages

Using the Editor

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. In addition, you can include your own custom variables that are
specific to your needs.

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 Commerce User Guide

647

Using the Editor

CHAPTER 38: 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

648

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 Commerce User Guide

CHAPTER 39:

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 Commerce User Guide

649

Adding New Blocks

CHAPTER 39: 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

650

Magento Commerce User Guide

CHAPTER 39: 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 Commerce User Guide

651

Adding New Blocks

CHAPTER 39: Content Blocks

Adding Social Plugins
Social networking sites have a numerous plugins 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:

652

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 Commerce User Guide

CHAPTER 39: 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 Commerce User Guide

653

Adding New Blocks

CHAPTER 39: 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.

654

Magento Commerce User Guide

CHAPTER 39: 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.

Slider Extensions
To add a lightbox or slider to your store, download the extension from Magento Markeplace,
and follow the instructions to install the extension. For additional help, see the documentation
provided by the developer.

Magento Commerce User Guide

655

Positioning Blocks

CHAPTER 39: 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

656

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 Commerce User Guide

CHAPTER 39: 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 Commerce User Guide

657

Positioning Blocks

CHAPTER 39: 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

658

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 Commerce User Guide

CHAPTER 39: 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 Commerce User Guide

659

Positioning Blocks

CHAPTER 39: 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.

660

Magento Commerce User Guide

CHAPTER 39: 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 callout 1 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 Commerce User Guide

661

662

Magento Commerce User Guide

CHAPTER 40:

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 Commerce User Guide

663

Widget Types

CHAPTER 40: Widgets

Widget Types
Widgets
TYPE

DESCRIPTION

CMS Page Link

Displays a link to a specific CMS 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.

664

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 guests the ability to check the status of their orders and submit
requests to return merchandise. The widget appears only for guests
and customers who are not logged in to their accounts.

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

CHAPTER 59: Recommended 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 Commerce, 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

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

Magento Commerce User Guide

931

Other PayPal Solutions

CHAPTER 59: Recommended 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.

932

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal 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.

Magento Commerce User Guide

933

Other PayPal Solutions

CHAPTER 59: Recommended 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
Commerceonline user guide.

Setting Up PayPal Payments Advanced

934

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal 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)

Magento Commerce User Guide

935

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

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.

936

Magento Commerce User Guide

CHAPTER 59: 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 Commerce User Guide

937

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

Setting Up PayPal Payments Pro
For step-by-step configuration instructions, see PayPal Payments Pro in the Magento
Commerce online user guide.

Setting Up PayPal Payment Pro

938

Magento Commerce User Guide

CHAPTER 59: 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 Commerce User Guide

939

Other PayPal Solutions

CHAPTER 59: 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

940

Magento Commerce User Guide

CHAPTER 59: 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.

Checkout with PayPal

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.

Magento Commerce User Guide

941

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

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.

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.

942

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

Setting Up PayPal Payflow Pro
For step-by-step configuration instructions, see PayPal Payflow Pro in the Magento
Commerceonline user guide.

PayPal Payflow Pro

Magento Commerce User Guide

943

Other PayPal Solutions

CHAPTER 59: Recommended 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.

944

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal 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.

Magento Commerce User Guide

945

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

Setting Up PayPal Payflow Link
For step-by-step configuration instructions, see PayPal Payflow Link in the Magento
Commerceonline user guide.

PayPal Payflow Link Setup

946

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

PayPal Reference
PAYPAL SOLUTION

DESCRIPTION

EXPRESS CHECKOUT
PayPal Express Checkout

During checkout, the customer is
redirected to the secure PayPal site to
complete the payment information.

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)

Magento Commerce User Guide

947

PayPal Reference

CHAPTER 59: Recommended Solutions

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.

948

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

PayPal Credit®
PayPal Credit offers your customers quick access to financing, so they can buy now and pay
over time, at no additional cost to you. You are not charged when customers choose PayPal
Credit, and pay only your normal PayPal transaction fee.
On July 2, 2018, Synchrony Bank becomes the issuing bank for PayPal Credit — a change that
brings a significant expansion of available offerings. To learn more, see: PayPal Credit: The
shortest distance between you and higher sales.

According to a recent study, nearly 40% of PayPal Credit users say they spent more online
because financing was available. Plus, their transactions are up to 68% larger than credit/debit
purchases. 1 To learn more, see PayPal Credit on the PayPal website.
Give your sales a boost when you advertise financing. PayPal helps turn browsers into buyers
with financing with PayPal Credit®. Your customers can pay over time, while you get paid up
front – at no additional cost to you. Use PayPal’s free banner ads that let you advertise PayPal
Credit ® financing as a payment option when your customers check out with PayPal. The
PayPal Advertising Program has been shown to generate additional purchases as well as
increase consumer's average purchase sizes by 15% or more.
You can easily add free, ready-made banner ads to pages of your stie, and the PayPal Credit
button to your shopping cart during checkout to remind your customers that financing is
readily available.

PayPal Credit Button
Add a PayPal Credit button to your cart to make it easier
for your customers to make a purchase.

PayPal Credit Banners
Use banners on your home page, product pages, and
shopping cart to turn “window shoppers” into buyers.

For US merchants, PayPal Credit is included as a PayPal Express Checkout option, and is
available with PayPal All-In-One Solutions (Payment Advanced, Payments Pro, and Payments
Standard) and PayPal Payment Gateways (PayFlow Pro and PayFlow Link). Before you
configure PayPal Credit for your Magento store, make sure it is enabled in your PayPal account.

To enable PayPal Credit:
Give your customers access to financing with PayPal Credit®, at no additional cost to you. You

Magento Commerce User Guide

949

PayPal Reference

CHAPTER 59: Recommended Solutions

get paid up front, even though customers can pay over time. A pre-integrated payment button
lets customers pay quickly with PayPal Credit ®.
1.

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

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

For any of the following Recommended Solutions, tap Configure.
l

PayPal Express Checkout

Any PayPal All-In-One Solution with PayPal Express Checkout

PayPal Express Checkout
4.

Complete the Required PayPal Settings. Then, expand

Set Enable PayPal Credit to “Yes”.

Tap Save Config.

Advertise PayPal Credit.

Enable PayPal Credit

To enable PayPal Credit banners:
1.

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

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

For any of the following Recommended Solutions, tap Configure.

PayPal Express Checkout

Any PayPal All-In-One Solution with PayPal Express Checkout

Expand

the Required PayPal Settings section. Then, expand

the Advertise PayPal

Credit section.

950

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

Advertise PayPal Credit
5.

Click the Get Publisher ID from PayPal button and follow the directions to get your account
information. Then, enter your Publisher ID.

Expand
a.

To place a banner on the page, set Display to “Yes”.

Set Position to one of the following:

the Home Page section. Then, do the following:

Header (center)

Sidebar (right)

Set Size to one of the following:
l

190 x 100

234 x 60

300 x 50

468 x 60

728 x 90

800 x 66

Repeat the previous step for each of the following sections:
l

Catalog Category Page

Catalog Product Page

Checkout Cart Page

Magento Commerce User Guide

951

PayPal Reference

CHAPTER 59: Recommended Solutions

When complete, tap Save Config.

Banner Sizes
These examples do not represent the actual size of the banners, but show their relative shape
and proportion.
1 As reported in Neilsen’s PayPal Credit Average Order Value Study for activity occurring from

April 2015 to March 2016 (small merchants) and October 2015 to March 2016 (midsize
merchants), which compared PayPal Credit transactions to credit and debit card transactions
on websites that offer PayPal Credit as a payment option or within the PayPal Wallet. Nielsen
measured 284890 transactions across 27 mid and small merchants. Copyright Nielsen 2016.

952

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

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

Magento Commerce User Guide

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.

953

PayPal Reference

CHAPTER 59: Recommended Solutions

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

954

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

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

Magento Commerce User Guide

955

956

Magento Commerce User Guide

CHAPTER 60:

Other Payment Methods
Magento Commerce supports the following payment solutions 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

Klarna

Amazon Pay

Authorize.Net Direct Post

Magento Commerce User Guide

957

Klarna

CHAPTER 60: Other Payment Methods

Klarna
Klarna lets your customers choose how they want to pay, and supports the purchase with
buyer protection and excellent customer service.

Pay Now
Customers can pay in full quickly and securely with
Direct Bank Transfer/Direct Debit.

Pay Later
Customers can buy now, and pay later. You get paid
immediately, and Klarna takes care of the rest.

Slice It
Customers can spread the cost of their purchases over
time at a low interest rate. Klarna’s credit application
process takes less than thirty seconds to complete.

958

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

Klarna Customer Experience
Klarna appears as a payment method during checkout. if enabled in the configuration. If data
sharing is used, Klarna can instantly prequalify the customer, and present the available
solutions.

To pay with Klarna:
1.

Select Slice it. Pay over time with Klarna.

Pay Over Time with Klarna
2.

Do one of the following:
l

Add the purchase to your Klarna account.

Apply for Klarna credit, and receive an instant decision.

Klarna During Checkout
3.

After the terms of the credit are approved, place your order.

Magento Commerce User Guide

959

Klarna

CHAPTER 60: Other Payment Methods

Setting Up Klarna
To offer your customers the benefit of paying with Klarna, you must first sign up for a Klarna
account and gain access to the Klarna Merchant Portal. Then, complete the Klarna
configuration from the Admin of your Magento store.

Klarna Merchant Portal

Step 1: Set Up Your Klarna Account
1.

Visit the Klarna website, and sign up for an account. Then, sign in to your account on the
Klarna Merchant Portal.

To generate your API Credentials for Klarna’s Playground environment, do one of the following:
l

Tap the Settings icon.

In the main menu, choose Settings.

Then, do the following:

960

On the API Credentials tab, tap Generate new API credentials.

Copy your credentials, and save them to a notepad. You will need them later to complete
the Magento configuration.

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

Generate API Credentials
3.

On the Store Settings tab, do the following:
a.

Take note of your Store ID in the upper-left corner of the page. Copy and paste the value
into Notepad, along with your API credentials.

If the image files are ready, upload your logo and icon. Otherwise, you can complete this
step later.

Complete the following store information:
l

Store name

Homepage URL

Customer Support Email

Customer Support Phone

Store Settings

Magento Commerce User Guide

961

Klarna

CHAPTER 60: Other Payment Methods

Step 2: Configure Magento
1.

Open another browser tab, and log in to the Admin of your Magento store.

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

In the upper-left corner, choose the Store View where the configuration applies. If your
installation has only one view, accept the “Default Config” setting.

In the panel on the left, under Sales, choose Payment Methods. Under Other Payment
Methods, expand

the Klarna section. Then, tap Configure.

Klarna
5.

Expand
a.

the Klarna API section. then, do the following:

Set API Version to one of the following:
l

Klarna Payments (Europe)
Supported countries: AT, DE, DK, FI, NL, NO, SE

Klarna Payments (North America)

In the Merchant ID/EID field, enter the Store ID from your Klarna account.

Enter the Password/Shared secret from your Klarna account.

To use the Klarna Playground for test transactions, set Test Mode to “Yes.”

To generate a record of interactions while testing the integration, set Debug Mode to
“Yes.”
Turn Debug Mode off before going live with Klarna in your production store.

Klarna API

962

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Expand

Klarna

the Klarna Payments section. then, do the following:

Set Enable this Solution to “Yes.”

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.

(U.S. Only) If you want Klarna to prepare set of personalized credit options for each
customer, set Data sharing to “Yes.”

Enter a Sort Order number to determine the position of Klarna in the list of payment
methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

Klarna Payments
7.

If you want to stop here, tap Save Config. Then when prompted, click the Cache Management
link at the top of the page to refresh all invalid caches.

Step 3: Complete the Design Settings (Optional)
You can complete the Klarna Payment Design Settings now, or at a later time. You might use a
color picker to experiment with different colors for each element to match your store’s theme.
The results might vary, depending on theme.
Enter the hexadecimal value of the color that you want to use for each element.
l

Details color

Button color

Button text color

Checkbox color

Magento Commerce User Guide

963

Klarna

CHAPTER 60: Other Payment Methods

Checkbox check mark color

Header color

Link color

Border color

Selected border color

Text color

Secondary text color

Border radius

Klarna Payments Design
8.

When complete, tap Save Config. Then when prompted, click the Cache Management link at
the top of the page to refresh all invalid caches.

964

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

Managing Your Account
The Klarna Merchant Portal makes it easy to manage orders, view transactions, and generate
reconciliation reports. You can also manage your Klarna account settings, and add new users to
your account.
All orders are captured from the Magento Admin. However, Klarna supports post-order
processing from the Magento Admin for the following events:

EVENT

ACTION

Canceled Order

Sends cancel to Klarna.

Full/Partial Capture

Sends capture to Klarna.

Full/Partial Refund

Sends refund to Klarna.

Klarna Merchant Portal

To manage orders:
Do one of the following:
l

In the main menu, choose Orders.

On the Klarna dashboard, choose Orders.

Then, do any of the following:

Find an Order
1.

To filter the list, set Status to one of the following:

Magento Commerce User Guide

965

Klarna

CHAPTER 60: Other Payment Methods

Unacknowledged

Uncaptured

Captured

Cancelled

Show
2.

To find a specific order, enter any of the following into the Search for order box:
l

Customer name and email

Merchant reference

Klarna reference

Order ID

Export Orders

966

Tap Export all (CSV).

Look for the export file in the lower-left corner of the browser window. Then, open the file
in your spreadsheet.

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

Exported Orders

Magento Commerce User Guide

967

Amazon Pay

CHAPTER 60: Other Payment Methods

Amazon Pay
Amazon Pay and Login with Amazon offer your customers a secure and convenient way to pay
that is easy to set up, and that helps to increase conversions and sales. Customers who log in
to your store with their Amazon credentials can speed through checkout using the payment
and shipping information that is already stored in their Amazon accounts.

Shop Safely
Customer purchases are protected by Amazon’s A-to-z
Guarantee. Customer password and payment
information is never shared.

Speed Through Checkout
During checkout, shipping and payment information is
read directly from the customer’s Amazon Payments
account.

968

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

Amazon Pay Customer Experience
Customers can speed through checkout by using the payment methods and shipping addresses
that are available in their Amazon accounts. Your store can be configured to show the Amazon
Pay button on product pages, and in the cart sidebar, shopping cart, and during checkout.

Amazon Pay on Product Page

To place an order with Amazon Pay:
1.

To begin the checkout process, tap Amazon Pay. Then when prompted, enter your Amazon
credentials.

Shipping Addresses
2.

Choose the shipping address from your Amazon Address Book.

Magento Commerce User Guide

969

Amazon Pay

CHAPTER 60: Other Payment Methods

The pagination indicator shows how many addresses are available. However, only four can be
viewed at a time.
l

Click the arrow (

) to view all available options.

To add a new address to the Address Book, click Add new.

If you prefer, click Return to standard checkout.

Amazon Pay Address Book
3.

Choose the Shipping Method that you want to use for the order. Then, tap Next.

During the Review & Payments checkout step, the standard Magento payment methods are
replaced with the payment methods that are available in your Amazon account.

Review & Payments
The pagination indicator shows how many payment methods are available. However, only four
can be viewed at a time.

970

Click the arrow (

) to view all available options.

Choose the Payment Method that you want to use for the purchase.

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

Amazon Pay Payment Method
5.

Enter a Discount Code, if applicable.

Review the order. Then, tap Place Order.

Magento Commerce User Guide

971

Amazon Pay

CHAPTER 60: Other Payment Methods

Setting Up Amazon Pay
Amazon Pay and Login with Amazon work together to create a great buyer experience. To learn
more, see the Amazon Pay and Login with Amazon documentation for Magento 2.

To set up Amazon Pay:
1.

On the Admin menu, choose Stores. Then under Settings, choose Configuration. Then, do the
following:
In the upper-right corner, set the Store View chooser to establish where the Amazon Pay

configuration applies.
b.

In the panel on the left under Sales, choose Payment Methods. Then under Other
the Amazon Pay section.
Payment Methods, expand

Amazon Pay
2.

Under Amazon Pay, tap Register or Connect an Amazon Pay Account.
Do not use your personal Amazon account for Amazon Pay.

972

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

If you do not yet have an Amazon merchant account, choose Create a new signin, and tap
Select. Then, follow the onscreen instructions to create a new account.

Create Amazon Pay Account
b.

If you already have an Amazon merchant account, choose Use existing Amazon signin,
and tap Select. Then, complete the following sections:

Credentials
1.

Expand
the Credentials section. Your credentials are transferred automatically from
your Amazon Pay account to the Magento Admin. Your credentials can also be found in
Amazon Seller Central in both Production and Sandbox modes.
To use test credentials from the Amazon Pay Sandbox, do the following:
a.

Get your Test Credentials for the Amazon Pay Sandbox.

In the Magento Amazon Pay configuration under Credentials, mark the Test
Credentials checkbox.

Enter the following credentials that you copied from the Amazon Pay Sandbox on
Amazon Seller Central:

Merchant Id

Access Key Id

Secret Access Key

Client ID

Client Secret

Set Sandbox to “Yes.”
When you are through testing and ready to go live with Amazon Pay, return to the
configuration and clear the Test Credentials checkbox. Then, set Sandbox to “No”
and tap Save Config.

Magento Commerce User Guide

973

Amazon Pay

CHAPTER 60: Other Payment Methods

Verify the Payment Region for the store.

Credentials
3.

When complete, tap Save Config.
Look for the message, “Your Amazon configuration is valid” at the top of the Configuration
page.

974

If your credentials are valid, continue with the configuration.

Otherwise, correct your credentials, and try again.

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

Options
1.

Expand

Set Enable Amazon Pay to “Yes.”

Set Enable Login with Amazon to “Yes.”

Set Payment Action to one of the following:

the Options section.

Charge on
Shipment

(Default) Amazon receives a capture request and charges the
customer when an invoice is created in Magento.

Charge on Order

Amazon creates the invoice and charges the customer when the
order is placed.

Set Authorization Mode to one of the following to determine the method that is used to
transmit authorization data.
Synchronous

(Default) Makes the disposition of an authorization available within
a couple of seconds.

Asynchronous

The status of sales order is “Pending” while the disposition of
authorization is outstanding.

Synchronous if
Possible

(Recommended) Uses synchronous authorization if possible, and
switches to asynchronous processing as needed, for some declines.
The change in processing modes is transparent to the user.

Set Update Mechanism to one of the following:
Data Polling via
Cron job

(Default) Uses the standard Magento notification process that is
scheduled by Cron job.

Instant Payment
Notifications

(IPN) Sends notifications to the Instant Payment Notification URL.

Options

Magento Commerce User Guide

975

Amazon Pay

CHAPTER 60: Other Payment Methods

Advanced Settings
1.

Expand the Frontend section. Then, do the following as applicable:
a.

(Optional) If your store is available in multiple languages, you can display the text
on the Amazon Pay button in a different language for each store view. To override the
default display language for the current store view, enter one of the following
language parameters in the Button Display Language field:
en-GB

English (Great Britain)

de-DE

German (Germany)

fr-FR

French (France)

it-IT

Italian (Italy)

sp-SP

Spanish (Spain)

To learn more, see Language in the Amazon Pay Integration Guide.
b.

Set Button Color to one of the following:
l

Gold

Light Gray

Dark Gray

To learn more, see the Merchant Tools page on the Amazon Pay website.
c.

976

Set Button Size to one of the following:
l

Small

Medium

Large

Extra Large

Choose “Yes” for each feature that you want to enable for the current store view:
l

Amazon Pay button on Product Page

Amazon Pay button in minicart

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

Frontend
2.

Expand the Sales Options section. Then, enter the Store Name.

Sales Options
3.

When complete, tap Save Config.

In the message at the top of the page to refresh cache types, click Cache Management. Then,
do the following:
a.

Mark the checkbox of each invalid cache.

With the control set to “Refresh,” tap Submit.

Magento Commerce User Guide

977

Using Amazon Seller Central

CHAPTER 60: Other Payment Methods

Using Amazon Seller Central
Use the chooser at the top of the page to change the view of Amazon Seller Central. The options
include all the Amazon resources that are associated with your account. Each view is a separate
dashboard with specific resources for the view.

Amazon Seller Central (Production View)

To change views:
Set the chooser to the view that you want to see. The following views relate to the Magento
integration of Amazon Pay:
l

Amazon Pay (Sandbox View)

Amazon Pay (Production View)

To find your credentials:
To run test transactions from the Amazon Pay Sandbox, you must copy the keys from your
account on Amazon Seller Central. Then, enter the keys into the Magento Amazon Pay
configuration. Your credentials can be found in both the Production and Sandbox views of
Amazon Seller Central.
1.

Set the chooser to one of the following:

978

Amazon Pay (Production View)

Amazon Pay (Sandbox View)

On the main menu, under Integration, choose MWS Access Keys. Then, do the following:

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Using Amazon Seller Central

Amazon Seller Central (Sandbox View)
a.

In the page header, tap Copy your keys.

Copy Your Keys
b.

Your keys are formatted as a JSON string, with each item enclosed in double quotes. Copy
your keys, and paste them into Notepad. Then, Close the box. You will need them to
complete the Amazon Pay configuration for Sandbox Mode in the Magento Admin.
Your keys are confidential, and should not be shared.

Your Credentials

Magento Commerce User Guide

979

Using Amazon Seller Central

CHAPTER 60: Other Payment Methods

Managing Amazon Pay Transactions
All purchases made in your store and processed by Amazon Pay can be viewed from the
Amazon Pay website. If you receive a request for a refund, follow the normal Magento process to
issue a credit memo and make a refund. The Credit Memo button appears after a sales order is
invoiced.

Invoice with Credit Memo Button

To issue a refund:
1.

On the Admin sidebar, choose Sales. Then on the menu, choose Orders.

Find the completed order to be refunded. Then in the Action column, click View.

In the button bar, tap Credit Memo.

Scroll down to the bottom of the page, and confirm the Refund Totals.

When complete, tap Refund Online.
For more detailed instructions, see: Issuing a Credit Memo.

To view Amazon Pay activity:
1.

Go to pay.amazon.com.

In the header at the Sign In prompt, choose Merchants. Then, do the following:

Merchant Sign In
3.

980

When prompted, do the following:
a.

Enter your email address or mobile number.

Enter your password.

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

c.
4.

Using Amazon Seller Central

Tap Sign in.

To view orders from a specific region, choose the region from the Account Activity control.

Orders from Region
5.

To find an order, click Can’t find an order? Then, choose the Amazon service that processed
the order.

Can’t find an order?

Magento Commerce User Guide

981

Using Amazon Seller Central

CHAPTER 60: Other Payment Methods

Amazon Pay Resources
Amazon Seller Central has a wealth of information and tools to help you manage your Amazon
Pay account. To learn more, see the online help and documentation on Amazon Seller Central.

Amazon Pay Website

To find help:
1.

In the upper-right corner, click Help.

Amazon Seller Central

982

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Using Amazon Seller Central

In the header, set the integration chooser to “Amazon Pay (Sandbox View).”
l

The Getting Started Guide in the center of the page offers step-by-step instructions for
implementing Amazon Pay.

You’ll find additional guides for developers In the right sidebar under Documentation, and
additional resources under Help and FAQ.

Getting Started Guide

Magento Commerce User Guide

983

Authorize.Net Direct Post

CHAPTER 60: 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
Commerceonline user guide.

Authorize.Net Direct Post

984

Magento Commerce User Guide

CHAPTER 61:

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 Commerce User Guide

985

Check / Money Order

CHAPTER 61: Basic Payment Methods

Check / Money Order
Magento Commerce 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

986

Magento Commerce User Guide

CHAPTER 61: 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 Commerce User Guide

987

Cash On Delivery

CHAPTER 61: Basic Payment Methods

Cash On Delivery
Magento Commerce 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

988

Magento Commerce User Guide

CHAPTER 61: 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 Commerce User Guide

989

Bank Transfer

CHAPTER 61: Basic Payment Methods

Bank Transfer
Magento Commerce allows you to accept payment that is transferred from a customer’s bank
account and deposited into your merchant bank account.

Bank Transfer Payment

990

Magento Commerce User Guide

CHAPTER 61: 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 Commerce User Guide

991

Purchase Order

CHAPTER 61: 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

992

Magento Commerce User Guide

CHAPTER 61: 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 Commerce User Guide

993

Zero Subtotal Checkout

CHAPTER 61: 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

994

Magento Commerce User Guide

CHAPTER 61: 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 Commerce User Guide

995

996

Magento Commerce User Guide

CHAPTER 62:

Fraud Protection
Fraud protection services and filters examine submitted orders before the transaction is
processed to detect fraudulent orders and protect you from the expense of chargebacks.
Magento supports the following fraud protection solutions:
l

PayPal Fraud Management Filter

Fraud Protection Solutions on Magento Marketplace

Signifyd Guaranteed Fraud Protection
Signifyd Guaranteed Fraud Protection automates your order review process so you can accept
more orders and maximize revenue without chargeback losses. Signifyd automatically reviews
orders for fraud, and indicates which orders to ship, and which to reject. The results of the
Signifyd Guarantee Decision appear as a column in the Orders grid.
Signifyd’s Guaranteed Fraud Protection protects every approved order with a financial
guarantee against fraudulent chargebacks, so you can grow your business without fear of fraud.

Step 1: Sign Up for a Signifyd Account
1.

Complete Signifyd’s Guaranteed Fraud Protection form to contact their Sales team.

Follow their one-click installation instructions to install Signifyd on your server.

Complete the Signifyd configuration for your Magento installation.

Step 2: Configure Your Magento Store
1.

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

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

Under Signifyd, expand

Magento Commerce User Guide

the Configuration section. Then, do the following:

997

Signifyd Guaranteed Fraud Protection

CHAPTER 62: Fraud Protection

Signifyd Configuration

998

Set Enable this Solution to “Yes”.

From the Settings page of your Signifyd console, enter the API Key .

Do not change the default API URL, unless instructed to do so.

If you want Magento to keep a log of all interactions between your store and Signifyd, set
Debug to “Yes”.

The Webhook URL is the location of the handler that synchronizes Signifyd’s guarantee
decisions with your store, and cannot be changed from the Admin.

When complete, tap Save Config.

Magento Commerce User Guide

Shipping

999

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

1000

CHAPTER 63:

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 Commerce User Guide

1001

Point of Origin

CHAPTER 63: 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

1002

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 Commerce User Guide

CHAPTER 63: 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 Commerce User Guide

1003

Shipping Policy

CHAPTER 63: Shipping Settings

Shipping Policy
A shipping policy should explain your company's business rules and guidelines for shipments.
For example, if you have price rules that trigger free shipping, you can explain the terms in
your shipping policy.
To display your shipping policy during checkout, complete the Shipping Policy Parameters in
the configuration. The text appears when customers click the “See our shipping policy” link
during checkout.

Shipping Policy During Checkout

1004

Magento Commerce User Guide

CHAPTER 63: Shipping Settings

Shipping Policy

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

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.
If you use a word processor to compose the text, make sure to save the document as a .txt file
to remove any control characters from the text. Then, copy and paste the text into the Shipping
Policy text box.

Shipping Policy Parameters
4.

When complete, tap Save Config .

Magento Commerce User Guide

1005

1006

Magento Commerce User Guide

CHAPTER 64:

Basic Shipping Methods
Magento Commerce 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 Commerce User Guide

1007

Free Shipping

CHAPTER 64: 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

1008

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 Commerce User Guide

CHAPTER 64: 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 Commerce User Guide

1009

Flat Rate

CHAPTER 64: Basic Shipping Methods

Flat Rate
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. When enabled, Flat Rate appears as an option during checkout. Because no
specific carrier is specified, you can use a carrier of your choice.

Flat Rate

To set up flat rate shipping:

1010

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

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

Expand

the Flat Rate section. Then, do the following:

Magento Commerce User Guide

CHAPTER 64: Basic Shipping Methods

Flat Rate

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.

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 Commerce User Guide

1011

Table Rates

CHAPTER 64: 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

1012

Magento Commerce User Guide

CHAPTER 64: 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 Commerce User Guide

1013

Table Rates

CHAPTER 64: 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

1014

Magento Commerce User Guide

CHAPTER 64: 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 Commerce User Guide

1015

Table Rates

CHAPTER 64: 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.

1016

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 64: 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 Commerce User Guide

1017

Table Rates

CHAPTER 64: 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.

REGION /
STATE

COUNTRY

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.

1018

Set Store View to the main website. Then, tap Import to import the tablesrates.csv file.

Magento Commerce User Guide

CHAPTER 64: 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 determines 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 apply dimensional weight to some shipments. However, the manner in which
dimensional weight pricing is applied varies from one carrier to another.
We recommend that you use Magento Shipping to calculate dimensional weight for all
carriers.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 Commerce User Guide

1019

1020

Magento Commerce User Guide

CHAPTER 65:

Magento Shipping
Magento Shipping is a multi-carrier shipping and fulfillment solution that combines intelligent
automation capabilities, access to global carrier networks, and seamless integration with the
Magento Admin. Our technology partner, Temando, provides the engine that powers this
technology to deliver the following benefits:
l

Provides accelerated revenue growth, and boost business efficiency.

Manages multiple carriers from a single, integrated portal.

Automatically checks for conflicts with extensions during setup to help avoid issues during
development and testing.

Simplifies ongoing maintenance by automatically including new carriers and features
without having to update.

Integrates with Magento Order Management.
At this time, Magento Shipping is available in the United States, United Kingdom, and Australia.

Changes in the Latest Release
Release 2.2.5
New Feature
l

Click & Collect (Collection Point Locations)
Customers can choose to have a carrier deliver to a designated drop point.

Other Enhancements
l

Batch Processing MVP
Easier to batch-process large shipments.

Improved pagination in Admin

Multi-version API

Magento Commerce User Guide

1021

Quick Look

CHAPTER 65: Magento Shipping

Quick Look
Advanced Shipments
Create shipments with advanced features, including
route and package information with dimensional weight,
carrier quotes, international details with required export
information, harmonization codes, shipping documents
and labels, delivery instructions, and tracking
information.

Locations
Configure multiple warehouses, distribution centers,
retail stores, dropshippers, and third-party logistics.
Allocate shipments to any supported fulfillment location.

Click & Collect
Offer the convenience of ordering online, with convenient
customer pickup at a nearby location.

Dispatches
Book shipments with all carriers, and maintain a manifest
of scheduled pickup with selected carriers.

1022

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Quick Look

Shipping Partners
Receive real-time rates from global carriers, and
configure multiple accounts with the same carrier across
multiple locations. Access prenegotiated rates for
selected carriers, or create your own negotiated rates in
selected markets.

Packaging
Manage package names and dimensions, and access
carrier supplied packaging information.

Shipping Experience Rules
Automate the shipping and fulfillment processes based
on a variety of factors, including inventory levels,
proximity to destination, product type, shipping costs,
ETA, carrier, packaging, and more.

Magento Commerce User Guide

1023

Quick Look

CHAPTER 65: Magento Shipping

Customer Experience
From the storefront, Magento Shipping options appear during the first step of the checkout
process. Magento Shipping can be configured to show all options, or only the ones that apply
to the order.

Shipping Methods
During checkout, the shopper identifies the address type as a residence or business, and
specifies whether the carrier must obtain a signature, or can leave the package at the door.
Finally, the shopper chooses the preferred shipping rate and carrier to be used for the order.

Shipping Rate and Carrier

Click & Collect
If Collection Points are enabled in the configuration, specific locations can be specified as Click
& Collect fulfillment centers where the order can be sent for customer pick up. During checkout,
the customer chooses the most convenient collection point based on Country and Postal Code.
The customer is notified when the order is ready for pick up at the collection point.

Collection Point Selection

1024

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Setting Up Magento Shipping
Magento Shipping is initially available by request. To be considered for early access, click the
Request Shipping Account link in the Magento Shipping configuration.
When enabled, Magento Shipping adds a Dispatch option to the Magento Sales menu, a
Shipping section to the Stores menu, and new sections of detailed information in each
shipment. In the storefront, the selection of available Magento Shipping options appears during
checkout.

Step 1: Sign Up for Magento Shipping
1.

On the Admin sidebar under Settings, choose Configuration.

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

Expand the Magento Shipping section. Then, do one of the following:
l

If you have a Magento account, click Request Shipping Account.

If you don’t yet have a Magento account, complete the sign-up form. Then, tap Continue.

To access the Magento Shipping Portal, you must have both a Magento account and a Magento
Shipping account. Your access to Magento Shipping is based on your Magento account ID.
4.

Click Request Shipping Account. Then, do the following:
a.

Complete the Early Access to Magento Shipping form.

Click the link in the confirmation email to verify your account. Then, click the link to
continue where you left off.

After a new browser tab opens to your Magento account, return to your previous browser
tab to complete the remaining information. Then, complete the remaining information,
and Submit.
You will receive an email with additional instructions within the next 48 hours.

Magento Commerce User Guide

1025

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Early Access to Magento Shipping

Step 2: Generate Your API Tokens
1.

When you receive the confirmation email, open a tab to a separate browser window, and log in
to your Magento Shipping account.
You should now have an open tab to your Magento configuration, and another to your
Magento Shipping account. Information from your Magento Shipping account will later be
pasted into the Magento Shipping configuration in the Admin

Take a moment to read the Getting Started steps.

In the header, click the question mark (?) to hide the Welcome message and Getting Started
steps.

Magento Shipping Portal

1026

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

The Account Details section shows your API Endpoint and Account ID. This information will
later be copied and pasted into your Magento configuration.

Account Details
5.

A unique API token is used to identify the connection between your Magento website and your
Magento Shipping account.
In the API Tokens section, tap Generate Token for the type of token that you need.
Production
API Token

Generates the API token that is needed to use Magento Shipping in
production mode.

Test API Token

Generates an API token that is needed to use Magento Shipping in test
mode.

For a first-time setup, choose Test API Token. When you are ready to “go live” with Magento
Shipping, you can use the Production API Token. In the next step you will paste the token into
the Magento configuration.

API Tokens

Step 3: Activate Magento Shipping
Return to the browser tab with the Magento Shipping configuration, and do the following:
1.

Set Enabled to “Yes.”

Enter the Title that you want to use for Magento Shipping.

By default, only API errors are logged. If you prefer to log all API communication, set Enable
API Logging to “Yes.”

Paste the following credentials from your Magento Shipping account. You will need to return to
the browser tab that is open to Magento Shipping, and copy and paste each into the Magento
configuration.

Magento Commerce User Guide

1027

Setting Up Magento Shipping

API Endpoint

Account ID

API Token

CHAPTER 65: Magento Shipping

To run Magento Shipping in a testing environment, make sure to generate and copy the test token,
rather than the production token.

To give customers the option to have the shipment delivered to a designated drop point other
than the standard “ship to” address, set Enable Collection Points at Checkout to “Yes.” Then,
choose each country where such alternate collection points are to be available. (Hold down the
Ctrl key and click each country.)

Enable Collection Points at Checkout
6.

Complete the following settings as needed.
a.

1028

Set Ship to Applicable Countries to one of the following:
All Allowed
Countries

Customers from all countries specified in your store configuration
can use Magento Shipping.

Specific Countries

Select each country in the list where Magento Shipping can be used.

Set Show Method if Not Applicable to one of the following:
Yes

Always shows the Magento Shipping method, even when not
applicable.

Shows the Magento Shipping method only when applicable.

In the Displayed Error Message box, type the message to appear if Magento Shipping
becomes unavailable.

Enter a Sort Order number to determine the position of Magento Shipping in the list of
shipping methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Magento Shipping

Step 4: Complete the Remaining Settings
The following configuration settings can be completed now, or at a later time.

Checkout View Settings
The Checkout View Settings determine the options that appear as “add ons” during checkout.

Magento Shipping Options During Checkout

Magento Commerce User Guide

1029

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

To complete the Checkout View Settings, tap Configure.

Configure Checkout View Settings
2.

Mark the checkbox of each option that you want to appear during checkout. Then,
complete the information in each section as needed.

Checkout View Settings
3.

In the Address Type section, do the following:
a.

Enter the text that you want to use as the Dropdown Label for the Address Type
options during checkout.

In the Dropdown Options list, select each option that you want to include as an
address type.

Select the option that you want to be used as the Default Value.

Address Type
4.

In the Authority to Leave section, enter the Checkbox Label for the option.

Authority to Leave
5.

In the Signature Required section, enter the Checkbox Label for the option.

Signature Required

1030

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

When complete, tap Save.

Advanced Settings
1.

To configure the Advanced Settings, tap Configure. Then, do the following:

Configure Advanced Settings
2.

To synchronize Magento with other systems in your stack, set Enable sync to “Yes.”

To synchronize shipment entities, mark the Shipment checkbox.

Advanced Settings
4.

When complete, tap Save Config.

Locations
The Locations grid lists the available shipping locations, and can include stores, warehouses,
drop shippers, and company headquarters. Existing shipping locations can be edited or
removed, and new shipping locations added. The locations that you enter appear in a dropdown list for each Shipping Partner profile, to identify the locations where the carrier is
available.

Locations

To add a new shipping location:
1.

On the Admin sidebar, choose Stores. Then under Shipping, choose Locations.

Tap Create New Location. Then, do the following.

Magento Commerce User Guide

1031

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Enter the Location Name, as you want it to appear throughout Magento Shipping.

Set the location Type to one of the following:

Store

Warehouse

Drop Shipper

Headquarters

To enable collection points, set Enable Click & Collect to “Yes.”

Basic Settings
3.

Complete the fields in the Address section. If you need help, click the Help (

) button, or

refer to the Field Descriptions at the end of this topic.
4.

In the Locality field, enter an additional descriptive name to describe the location, such as the
name of the neighborhood, small town, or suburb.

See the Latitude/Longitude FInder to get the GPS coordinates of the location. Then, enter the
Latitude and Longitude coordinates.

Address
6.

Complete the fields in the Contact section. If you need help, click the Help (

) button, or refer

to the Field Descriptions at the end of this topic.

1032

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Contact
7.

When complete, tap Save Config.

Magento Commerce User Guide

1033

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Field Descriptions
FIELD

DESCRIPTION

Location Name

The name that is used to refer to the shipping location throughout the
Admin and storefront.

Type

Identifies the type of facility. Options:
Store
Warehouse
Drop Shipper
Headquarters

Enable Click & Collect

Determines if the location can be used as a collection point for Click
& Collect fulfillment. Options: Yes / No.

ADDRESS
Type

Identifies the type of address. Options: Business/Residential

Country

The country where the shipping facility is located.

Address Line 1

The street address of the shipping location.

Address Line 2

Additional street address information, if needed.

City

The city where the shipping facility is located.

State / Province

The state or province where the shipping facility is located.

Zip / Postal Code

The ZIP or postal code where the shipping facility is located.

Dependent Locality

An additional description of the location, such as the name of a small
town or suburb.

Longitude

The GPS longitude coordinate of the shipping facility. Use the
Latitude/Longitude Finder to get the GPS longitude coordinate of your
location.

Latitude

The GPS latitude coordinate of the shipping facility. Use the
Latitude/Longitude Finder to get the GPS latitude coordinate of your
location.

CONTACT

1034

Organisation Name

The name of the organization that is associated with the shipping
location.

Person First Name

The first name of the primary contact at the shipping location.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Field Descriptions (cont.)
FIELD

DESCRIPTION

Person Last Name

The last name of the primary contact at the shipping location.

National Identification
Number

The National Identification Number of the contact organization, if
applicable. For example, the INSEE code (France).

Tax Identification Number

The Tax Identification Number assigned to the contact organization,
if applicable. For example, TFN (Australia), TIN (France).

The email address of the primary contact at the shipping location.

Phone Number

The telephone number of the shipping location.

Fax Number

The fax number of the shipping location.

Magento Commerce User Guide

1035

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Shipping Partners
Carrier profiles for Magento Shipping are managed from the Stores menu. New connections to
carriers can be added, and existing connections can be edited or deleted from the Shipping
Partners grid.
Magento Shipping supports FedEx pre-negotiated rates, and ad-hoc returns for FedEx, USPS,
Australia Post, UK Mail, and DHL Express.
At this time, Magento Shipping is available to merchants in the U.S., UK, and Australia only.

Shipping Partners

To add a new carrier:
1.

On the Admin sidebar, choose Stores. Then under Shipping, choose Carriers.

Under Available Carriers, find the shipping partner that you want to add. For a description of
services, click Show more.

1036

To complete the setup, click Connect.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Shipping Partners
4.

Complete each step as follows. Your progress is tracked at the top of the page.
a.

Under Step 1, choose “Yes” if you have an account with the carrier. Then, tap Next.
If you do not have an account, you will be instructed to contact the carrier. When your
account is ready, return to this step and continue.

Step 1
b.

Some carriers require that you accept the terms of a license agreement. If applicable, read
the License Agreement. To continue, mark the I accept checkbox, and tap Next.

Magento Commerce User Guide

1037

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Step 2
c.

Under Step 3, enter your carrier Account Number. Then, complete the information in the
Shipping Address and User Contact and Address sections. This information must match
the information in your carrier account.
In the Locality field, enter the city.

Step 3

To edit an existing carrier:

1038

Find the carrier in the Shipping Partners grid. Then in the Action column, select Configure.

Make the necessary changes to the carrier profile.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

When complete, tap Save.

Field Descriptions
FIELD

DESCRIPTION

Carrier Connection
Nickname

The name that is used for the carrier during checkout.

Locations

Identifies each shipping location that can be used by the carrier.

Services

Identifies each shipping service that is provided by the carrier.

Magento Commerce User Guide

1039

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Packaging
The Packaging grid lists the available packaging options that are available through your store.
Existing packaging profiles can be edited or removed, and new packaging profiles added. The
packaging options appear in a dropdown for each Shipping Partner profile, and identify each
type of packaging that is supported by the carrier.

Packaging

To add a package:
1.

On the Admin sidebar, choose Stores. Then under Shipping, choose Packaging. Then, do the
following:
a.

Enter the Name of the package.

Choose the package Type.

In the Tare Weight field, enter the weight of the empty package. Then, set Tare Unit to the
unit of measurement that is used for the Tare Weight value.

Enter the Maximum Weight that can be placed in the package. Then, set Maximum
Weight Unit to the unit of measurement that is used for the Maximum Weight value.

Basic Settings

1040

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Complete the fields in the Outer Dimensions section. If you need help, click the Help (

)

button, or refer to the Field Descriptions at the end of this topic.

Outer Dimensions
3.

Complete the fields in the Inner Dimentions section. If you need help, click the Help (

)

button, or refer to the Field Descriptions at the end of this topic.

Inner Dimensions
4.

When complete, tap Save Config.

Field Descriptions
FIELD

DESCRIPTION

Name

The name of the packaging type.

Type

Describes the basic packaging type. Options:
Box
Carton
Crate
Cylinder
Document Envelope
Flat Pack
Letter
Pallet
Parcel
Satchel/Bag
Other

Magento Commerce User Guide

1041

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Field Descriptions (cont.)
FIELD

DESCRIPTION

Tare Weight

The weight of the empty container that is used to calculate the
shipment load when added to content weight.

Tare Weight Unit

The unit of measurement that is used to describe tare weight.
g

Gram

Ounce

Kilogram

Pound

Maximum Weight

The maximum weight allowed for this packaging type.

Maximum Weight Unit

The unit of measurement that is used to describe the maximum
weight.
g

Gram

Ounce

Kilogram

Pound

OUTER DIMENSIONS
Length

The package length when measured from the outside.

Width

The package width when measured from the outside.

Height

The package height when measured from the outside.

Unit

Determines the unit of measurement for the outer dimensions of the
package. Options:
cm

Centimeter

Inch

Meter

Millimeter

Foot

INNER DIMENSIONS

1042

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Field Descriptions (cont.)
FIELD

DESCRIPTION

Length

The package length when measured from the inside.

Width

The package width when measured from the inside.

Height

The package height when measured from the inside.

Unit

Determines the unit of measurement for the inner dimensions of the
package. Options:

Magento Commerce User Guide

Centimeter

Inch

Meter

Millimeter

Foot

1043

Shipping Experience Rules

CHAPTER 65: Magento Shipping

Shipping Experience Rules
The Shipping Experiences tab of the Magento Shipping Portal allows you to create rules to
automate the shipping process. You can create the following types of rules:
Qualification

Qualification rules control the availability of the rule. For example, you
can add conditions that determine when the shipping method becomes
available, and set the shipping charge.

Quoting

Quoting rules control the list of available carriers that appears when you
get quotes for a shipment.

To create a shipping experience rule:
1.

Choose the Shipping Experiences tab. Then, tap Create New Experience.

Shipping Experiences
3.

Enter a Name for the rule.

For now, accept the default Status of “Draft.”
When you are ready to “go live” with the rule in your store, you can change the Status to
“Production.”

1044

Click the tab for the type of experience that you want to create:
l

Qualification

Quoting

Tap Create Rule. Then, follow the instructions for the type of rule:

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Shipping Experience Rules

New Experience

Qualification Rule
1.

Enter a brief Description of the rule.

Click Add Condition. Then, do the following:
a.

Set Input to the shipping parameter that the condition is based upon.

Choose the Operator that is needed to describe the condition.

Enter the Value that is needed to complete the condition.

To add another condition, click Add Condition. Then, repeat these steps.

Conditions
3.

In the Outcomes section, do the following:
a.

Choose the Action that is applied when the conditions are met.

Enter the Shipping Method Label that appears during checkout.

Choose the Currency to be used to display the shipping charge.

To add an additional action, click Add Outcome.

Magento Commerce User Guide

1045

Shipping Experience Rules

CHAPTER 65: Magento Shipping

Outcomes
4.

When complete, tap Save.
The description of the new rule appears in the list of Qualification Rules on the
Qualification tab.

Qualification Rules
5.

Tap Finish to return to the Shipping Experiences tab.

Quoting Rule
1.

Enter a brief Description of the rule.

Click Add Condition. Then, do the following:
a.

1046

Set Input to one of the following parameters:
l

Destination Country

Destination Postal Code

Choose the Operator that is needed to describe the condition.

Select each Country or Postal Code that is needed to complete the condition.

To add another condition, click Add Condition. Then, repeat these steps.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Shipping Experience Rules

Conditions
3.

In the Outcomes section, do the following:
a.

Choose one of the following Action to apply when the conditions are met:
Quote with
All Carriers

The rule applies to all available carriers.

Quote with Carrier Allows you to choose specific carriers to be available for the
Services
rule.
b.

Enter the Shipping Method Label that appears during checkout.

Choose the Currency to be used to display the shipping charge.

To add an additional action, click Add Outcome.

Outcomes
4.

When complete, tap Save.

The description of the new rule appears in the list of Quoting Rules on the Quoting tab.

Quoting Rules
5.

Tap Finish to return to the Shipping Experiences tab.

Magento Commerce User Guide

1047

Troubleshooting

CHAPTER 65: Magento Shipping

Troubleshooting
The following issues have been identified in this release of Magento Shipping.
Currency Conversion
Issue

Currency conversion problem for shipping methods during checkout
when store supports multiple currencies.

Workaround

Follow these best practices to ensure that the experience currency,
base currency, and display currency are the same:
l

The Magento base currency is the same as the experience
currency.
The Magento currency rates are the same as the experience and
base currency.

Shipping Experience Rules

1048

Issue

When a user chooses a shipping method during checkout, Magento
might select two shipping methods.

Workaround

Make sure that only one rule with a “Show Shipping Method”
outcome can be applied to a single scenario. Consider these
example rules:
Rule 1:

Show 'Free Shipping' for Country is Canada
and Cost is not greater than $99.99

Rule 2:

Show 'Free Shipping' for Country is not
Canada and Cost is greater than $100

Magento Commerce User Guide

CHAPTER 66:

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 Commerce installation.

Magento Commerce User Guide

1049

CHAPTER 66: 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.

1050

Magento Commerce User Guide

CHAPTER 67:

Shipping Labels
Magento Commerce 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 Commerce User Guide

1051

Shipping Label Workflow

CHAPTER 67: 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.

1052

Magento Commerce User Guide

CHAPTER 67: 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 Commerce User Guide

1053

Configuring Shipping Labels

CHAPTER 67: 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.

In the panel on the left under Sales, choose Shipping Methods. Then, expand
USPS section, and verify that the following fields are complete:
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

1054

the

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Expand

Configuring Shipping Labels

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.

Store Information
3.

When complete, tap Save Config.

Magento Commerce User Guide

1055

Configuring Shipping Labels

CHAPTER 67: Shipping Labels

Carrier Requirements
CARRIER

1056

REQUIREMENTS

USPS

Requires a USPS account. As of February 23, 2018, USPS requires all
shipping labels to include postage.

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 Commerce User Guide

CHAPTER 67: 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 Commerce User Guide

1057

Creating Shipping Labels

CHAPTER 67: 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.

1058

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 Commerce User Guide

CHAPTER 67: 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 Commerce User Guide

1059

Creating Shipping Labels

CHAPTER 67: 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

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.

1060

Magento Commerce User Guide

CHAPTER 67: 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 Commerce User Guide

1061

Creating Shipping Labels

CHAPTER 67: 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.

1062

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 Commerce User Guide

CHAPTER 67: 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 Commerce 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.

1063

Creating Shipping Labels

CHAPTER 67: 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.

1064

Magento Commerce User Guide

CHAPTER 67: 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 Commerce User Guide

1065

Creating Shipping Labels

CHAPTER 67: 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.

1066

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 Commerce User Guide

CHAPTER 67: 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 Commerce User Guide

1067

Creating Shipping Labels

CHAPTER 67: 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

1068

(USPS shipments only) Detailed description of the package content.

Magento Commerce User Guide

REPORTS

1069

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

1070

CHAPTER 68:

Reports Menu
Magento Commerce 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 Commerce User Guide

1071

Menu Options

CHAPTER 68: Reports Menu

Menu Options
Marketing
A selection of marketing reports, including Products in Cart, Search Terms, Abandoned Carts, and
Newsletter Problem Reports.

Reviews
The selection of product review reports includes By Customer and By Product.

Sales
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and settlement
reports for PayPal and Braintree.

Customers
The selection of customer reports includes Order Total, Order Account, and New.

Products
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.

Business Intelligence
The Advanced Reporting dashboard gives you valuable insight with a dynamic set of product, order, and
customer reports, powered by Magento Business Intelligence. for more sophisticated reporting and
analysis, sign up for a free trial of BI-Essentials.

1072

Magento Commerce User Guide

CHAPTER 68: 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 Commerce User Guide

1073

1074

Magento Commerce User Guide

CHAPTER 69:

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 Commerce User Guide

1075

Reports

CHAPTER 69: 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.

1076

Magento Commerce User Guide

CHAPTER 70:

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 Commerce User Guide

1077

Reports

CHAPTER 70: 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.

1078

Magento Commerce User Guide

CHAPTER 71:

Sales Reports
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and
PayPal Settlement.

Shipping Report

Magento Commerce User Guide

1079

Reports

CHAPTER 71: 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.

1080

Magento Commerce User Guide

CHAPTER 71: Sales Reports

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 Commerce User Guide

1081

1082

Magento Commerce User Guide

CHAPTER 72:

Customer Reports
Customer reports provide insight into customer activity during a specified period of time or
date range.

Order Total Report

Magento Commerce User Guide

1083

Reports

CHAPTER 72: 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.

1084

Magento Commerce User Guide

CHAPTER 73:

Product Reports
The product reports give you insight regarding products viewed and ordered, bestsellers, stock
levels, and downloads.

Product Views Report

Magento Commerce User Guide

1085

Reports

CHAPTER 73: 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.

1086

Magento Commerce User Guide

CHAPTER 73: Product Reports

Reports

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.

Magento Commerce User Guide

1087

1088

Magento Commerce User Guide

Business Intelligence

1089

Contents
Magento advanced reporting and business
intelligence tools give you the insight you
need to make sound business decisions.
Analyze your top-performing customers,
products, and promotions to find new
opportunities for growth. Then, share the
insights across your organization with just a
few clicks.

1090

Advanced Reporting
BI Essentials
New Relic Reporting

CHAPTER 74:

Advanced Reporting
Advanced Reporting gives you access to a suite of dynamic reports that are based on your
product, order, and customer data, with a personalized dashboard that is tailored to your
business needs. Advanced Reporting is a free, cloud-based service that is powered by Magento
Business Intelligence.
For technical information, see Advanced Reporting in our developer documentation.

Advanced Reporting Dashboard

Requirements
The website must run on a public web server.

The domain must have a valid security (SSL) certificate.
Magento must have been installed or upgraded successfully without error.

In the Magento configuration, the Base URL (Secure) setting for the store view must point
to the secure URL. For example https://yourdomain.com

Magento Commerce User Guide

1091

CHAPTER 74: Advanced Reporting

In the Magento configuration, Use Secure URLs on Storefront, and Use Secure URLs in
Admin must be set to “Yes.”
Make sure that Magento crontab is created and cron jobs are running on the installed server.

The initial release of Advanced Reporting supports only one base currency.

Step 1: Enable Advanced Reporting
In the Magento configuration, Advanced Reporting is enabled by default, and starts
automatically if cron is configured and running. An attempt to establish the subscription is
initiated at the beginning of each hour over the next 24-hours until successful. The
subscription status is “pending” until the subscription is successfully established.
1.

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

In the panel on the left, choose General. Then under Advanced Reporting, do the following:
a.

Verify that Advanced Reporting Service is set to “Enable.” (This is the default setting.)

Set the Time of day to send data to the hour, minute, and second, according to a 24-hour
clock, that you want the service to receive updated data from your store. By default, data
is sent at 2:00 AM.

Under Industry Data, choose the Industry that best describes your business.

Advanced Reporting
3.

When complete, tap Save Config.

When prompted, click the Cache Management in the message at the top of the page. Then,
refresh any invalid caches.

1092

Magento Commerce User Guide

CHAPTER 74: Advanced Reporting

Wait overnight, or until after the time of your next scheduled update. Then, check the status of
your subscription. If the status is still “pending,” make sure that your installation meets all of
the requirements.

Step 2: Access Advanced Reporting
1.

Do one of the following:
l

In the Admin sidebar, choose Dashboard. Then, tap Advanced Reporting.

On the Admin sidebar, choose Reports. Then under Business Intelligence, choose
Advanced Reporting.

The Advanced Reporting dashboard provides a quick summary of your orders, customers, and
products. Make sure to scroll down to see the full dashboard.
2.

To get a better view of the data, set the Filters in the upper-right corner to the time period and
store view that you want to include in the report. Then, do the following:
l

Hover over any data point for more information.

Click each tab to see all dashboard reports.

Data Point

Magento Commerce User Guide

1093

CHAPTER 74: Advanced Reporting

To access your data resources:
1.

In the upper-right corner of the Advanced Reporting dashboard, click Additional Resources.

Troubleshooting
If you get a 404 “Page Not Found” message, verify that your store meets the requirements for
Advanced Reporting. Then, follow the instructions to verify that the integration is installed.

Advanced Reporting Not Available

1094

Magento Commerce User Guide

CHAPTER 74: Advanced Reporting

Verify that the Integration is Active
1.

On the Admin menu, choose System. Then under Extensions, choose Integration.

Verify that the Magento Analytics user integration appears in the list, and that the Status is
“Active.”

To reestablish the user, click Reauthorize. Then, do the following:

Reauthorize
a.

When prompted, tap Reauthorize to approve access to the API resources.

Reauthorize Access to API Resources
b.

Verify that the list of Integration Tokens for Extensions is complete. Then, tap Done.

Magento Commerce User Guide

1095

CHAPTER 74: Advanced Reporting

Integration Tokens
4.

Look for the message that indicates the integration “Magento Analytics user” has been
reauthorized.

Wait overnight, or until after the time of your next scheduled update.

Dashboard Reports
FIELD

DESCRIPTION

ORDERS

1096

Revenue

Shows all revenue received by the store view during the defined time
period.

Orders

Shows all orders placed through the store view during the defined
time period.

AOV

Shows the average order value placed through the store view during
the defined time period.

Refunds

Shows all refunds processed through the store view during the
defined time period.

Tax Collected

Shows all tax collected through the store view during the defined time
period.

Shipping Collected

Shows all shipping fees collected through the store view during the
defined time period.

Orders by Status

Shows the number of orders by status, for the store view during the
defined time period.

Orders by Status

Lists a summary of the number of orders by status.

Magento Commerce User Guide

CHAPTER 74: Advanced Reporting

Dashboard Reports (cont.)
FIELD

DESCRIPTION

Coupon Usage

Lists all coupon codes and the number of users for each, redeemed
through the store view during the defined time period.

Orders and Revenue by
Billing Region

Lists the number of orders and revenue by region for the store view
during the defined time period.

Tax Collected by Billing
Region

Lists the amount of tax collected by region for the store view during
the defined time period.

Shipping Fees Collected
by Shipping Region

Lists the shipping fees collected by region for the store view during
the defined time period.

CUSTOMERS
Unique Customers

Shows the number of unique customer accounts associated with the
store view during the defined time period.

New Registered Accounts

Shows the number of new customer accounts registered with the
store view during the defined time period.

Top Coupon Users

Lists the top coupon users by Customer ID, and the number of orders
placed with coupons for the store view during the defined time period.

Customer KPI Table

Lists the number of orders, revenue, and average order value by
Customer ID for the store view during the defined time period.

PRODUCTS
Quantity of Products Sold

Shows the number of products sold through the store view during the
defined time period.

Products Added to
Wishlists

Lists all products added to wishlists through the store view during the
defined time period.

Best Selling Products by
Quantity

Lists the best-selling products and quantity sold through the store
view during the defined time period.

Best Selling Products by
Revenue

Lists the best-selling products and revenue generated by the sale of
the product through the store view during the defined time period.

Magento Commerce User Guide

1097

1098

Magento Commerce User Guide

CHAPTER 75:

BI Essentials
Magento Business Intelligence is a cloud-based subscription service that gives you access to
sophisticated dynamic reports. You can sign up for a seven-day free trial from the Reports
section of the Admin. The price for continued access is based on your monthly gross
merchandise (GMV) volume, and starts at $100 per month.
The instructions in this section walk you through the setup, and introduce some basic features
of Magento BI Essentials. For more detailed information, see the Magento BI Help Center.

To sign up for Magento BI Essentials:
1.

On the Admin sidebar, choose Reports. Then under Business Intelligence, choose
BI Essentials.

Choose the range of Your Annual GMV. Then, tap Join Now.

Complete the sign-up form. Then, tap Create Account.

Magento Commerce User Guide

1099

CHAPTER 75: BI Essentials

Create Account
4.

When prompted, enter a password for your account.
Your password must be eight characters long, and include at least one special character.

Enter Your Password
5.

Check your email for a Welcome message from the Magento BI Team, with your login
credentials. To learn more, see the Essentials Quick Start Video Series.

To access Magento BI Essentials:
Method 1: From the Admin
1.

From the Dashboard of your store, tap Go to Advanced Reporting.

In the upper-right corner, click Additional Resources. Then under Magento Business
Intelligence, choose Magento BI Website.

1100

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Your Data Resources

Method 2: From your browser
1.

Go to the Magento BI website.

Enter your Email Address and Password. Then, tap Sign In.

Your Magento BI dashboard appears.

Magento Commerce User Guide

1101

CHAPTER 75: BI Essentials

Magento BI Essentials Dashboard

1102

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Dashboards

Dashboards
BI Dashboards give you a quick view of your store’s performance and sales activity at a glance.
Individual dashboards can be shared with other users, and organized into logical groups. You
can also set different levels of permission to others users.
It’s easy to create a new report, add it to a dashboard, and export the data to Excel. Charts and
reports can be resized and dragged into position on the dashboard.

Dashboard

To create a new dashboard:
1.

On the menu, choose Dashboards.

The name of the default dashboard appears in the upper-left corner of the dashboard header.
Click the down arrow (

) to show the available options.

Create Dashboard

Magento Commerce User Guide

1103

Dashboards

CHAPTER 75: BI Essentials

Tap Create Dashboard. Then, do the following:
a.

Enter a Name for your dashboard.

To create a new Group for the dashboard, enter the name of the group.
For example, if your Magento installation has multiple store views, you might create a
Group for each store view.

Tap Create.

Dashboard Name
d.

The name of your new dashboard appears in the upper-left corner. Click the down arrow to
show the options. If you created a group, the new dashboard appears below the group in
the list.

Add Report
4.

1104

To add a report, do one of the following:
l

Click the Add a report prompt on the page.

In the dashboard header, click Add Report.

Click Create Report. to show the Report Builder Options.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Dashboards

Report Builder Options

To arrange items on a dashboard:
l

To resize a chart or report, drag the lower-right corner to the new size.

To move a chart or report, hover over the title or header until the cursor changes to a cross.
Then, drag it into position.

To manage dashboard settings:
1.

On the menu, choose Manage Data. Then in the sidebar, choose Dashboards.

If applicable, enter a new Dashboard Name.

To assign the dashboard to a specific Dashboard Group, choose from the list of groups.

Permissions
To give all users the same level of access to the dashboard, do the following:
1.

Under Shared with, choose one of the following options:
l

View

Edit

None

When prompted for confirm, tap OK to update the permissions level for each user.

To change the permission level of an individual, find the user in the list change the
permission level. The change is automatically saved.

To make this dashboard the default for your BI Essentials account, tap Make Default.

To remove the dashboard, tap Delete Dashboard.

Magento Commerce User Guide

1105

Report Builder

CHAPTER 75: BI Essentials

Report Builder
Visual Report Builder
The Visual Report Builder is the easiest way to visualize
your data. Create charts, add metrics, and segment your
data all with a few clicks.

SQL Report Builder
The SQL Report Builder gives you the power to directly
query your data warehouse, view the results, and quickly
transform them into a chart.

1106

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Visual Report Builder
Visual Report Builder makes it easy to create quick reports based on predefined metrics. Each
metric includes a query that defines the set of data for the report.
The following example shows how to create a simple report, group the data by an additional
dimension, set the date and time interval, change the chart type, and save the report to a
dashboard.

To create a simple report:
1.

In the BI Essentials menu, choose Report Builder.

Under Visual Report Builder, tap Create Report. Then, do the following:
a.

Tap Add Metric.
The available metrics can be listed alphabetically or by table.

Visual Report Builder
b.

Choose the metric that describes the set of data that you want to use for the report.
The New Customers metric used in this example counts all customers, and sorts the list by
the date the customer signed up for an account. The initial report includes a simple line
graph, followed by the table of data.
The summary on the left shows the name of the current metric, followed by the result of
any calculations on column data that are specified in the metric. In this example, the
summary displays the total customer count.

Magento Commerce User Guide

1107

Report Builder

CHAPTER 75: BI Essentials

Visual Report Builder
3.

In the chart, hover over each data point on the line. Each data point shows the total number of
new customers who signed up during that month.

Follow these instructions to group the data, change the date range, and chart type.

Group By
The Group By control gives you the ability to add multiple dimensions by group or segment.
Dimensions are columns in the table that can be used to group the data.
1.

Choose one of the available dimensions from the list of Group By options.
For this example, the system found five coupon codes that were used by customers while
placing their first order.

Group by
2.

The Group By detail lists each coupon used by customers. The coupons that were used to
place the initial order are marked with a checkbox The chart now has multiple colored
lines that represent the each coupon that was used for a first order. The legend is colorcoded to correspond to each row of data.
Click Apply to close the Group By detail.

1108

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Multiple Dimensions
3.

Hover over a few data points on each line to see the number of customers during the
month who used that coupon while placing their first order.

The table of data now has an addition dimension, with a column for each month, and a
row for each coupon code.

Group by Table Data
5.

Click the Transpose (
orientation of the data.

) control in the upper-right corner of the table to change the

The axis of the data is flipped, and the table now has a column for each coupon code, and
a row for each month. You might find this orientation easier to read.

Transposed Data

Magento Commerce User Guide

1109

Report Builder

CHAPTER 75: BI Essentials

Date Range
The Date Range control shows the current date range and time interval settings, and is located
just above the chart to the right.
1.

Click the Date Range control, which in this example is set to “All-Time by Month.”

Date Range
2.

Make the following changes:
a.

To zoom in for a closer view, change the date range to Last Full Quarter.

Under Select Time Interval, choose “Week.”

When complete, tap Save.

The report now includes only the data for the last quarter, by week.

Report for Last Quarter by Week

Chart Type
Click the controls in the upper-right corner to find the best chart for the data.
Some chart types are not compatible with multidimensional data.

1110

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Line graph

Horizontal Bar

Horizontal Stacked Bar

Vertical Bar

Vertical Stacked Bar

Pie

Area

Funnel

To give the report a title, replace the “Untitled Report” text at the top of the page with a
descriptive title.

In the upper-right corner, tap Save. Then do the following:
a.

For Type, accept the default setting, “Chart.”

Choose the Dashboard where the report is to be available.

Tap Save to Dashboard.

Magento Commerce User Guide

1111

Report Builder

CHAPTER 75: BI Essentials

Save to Dashboard
7.

To view the chart in a dashboard, do one of the following:
l

Click Go to Dashboard in the message at the top of the page.

In the menu, choose Dashboards. Click the name of the current dashboard to display the
list. Then, click the name of the dashboard where the report was saved.

Report in Dashboard

Filters
One or more filter(s) can be added to limit the data that is used to product a report. Each filter
is an expression that includes a column from the associated table, an operator, and a value. For
example to include only repeat customers, you might create a filter that includes only
customers who have placed more than one order. Multiple filters can be used with logical
“AND/OR” operators to add logic to the report.
A report can have a maximum of 3,500 data points. To reduce the number of data points, use a filter
to reduce the amount of data that is used to generate the report.

1112

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Magento BI includes a selection of filters that you can use “out of the box,” or modify to suit
your needs. There is no limit to the number of filters you can create.

To add a filter
1.

In the chart, hover over each data point. In this report, each data point shows the total number
of customers for the month.

In the panel on the left, click the Filters (

) icon.

Add Filter
3.

Tap Add Filter.
Filters are numbered alphabetically, and the first is [A]. The first two parts of the filter are
drop-down lists of options, and the third part is a value.

Magento Commerce User Guide

1113

Report Builder

CHAPTER 75: BI Essentials

Click the first part of the filter, and choose the column that you want to use as the subject
of the expression.

Choose First Part of Filter
b.

Click the second part of the filter, and choose the operator.

Choose the Operator
c.

1114

In the third part of the filter, enter the value that is needed to complete the expression.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Enter the Value
d.

When the filter is complete, tap Apply.
The report now includes only repeat customers, and the number of customer records
retrieved for the report has been reduced from 33K to 12.6k.

Filtered Report
4.

In the sidebar, click the Perspective (

) icon.

Perspective
5.

In the list of settings, choose Cumulative. Then, tap Apply.

Magento Commerce User Guide

1115

Report Builder

CHAPTER 75: BI Essentials

Cumulative Perspective
The Cumulative perspective distributes the change over time, rather than showing the jagged
up and downs for each month.
6.

Enter a Title for the report. Then, Save it as a Chart to your dashboard.

Save to Dashboard

Formulas
A formula combines multiple metrics and mathematical logic to answer a question. For
example, how much of the revenue per product during the holiday season was generated by
new customers?

1116

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Holiday Sales in Dashboard

Step 1: Create the Basic Report
1.

In the menu, choose Report Builder.

Tap Add Metric, and choose the first metric for the report.
For this example, the “Revenue by products ordered” metric is used.

Tap Add Metric again, and choose the second metric for the report.
For this example, the “New Customers” metric is used.

In the sidebar, click Details to display information about each metric.

Revenue by Products Ordered

Magento Commerce User Guide

1117

Report Builder

CHAPTER 75: BI Essentials

In the sidebar, click the name of each metric to open the settings page in a new browser tab.
Scroll down to see each component of the metric, including the metric query, filter, and
dimensions.

Metric Settings
6.

To return to your report, click the previous browser tab.

In the chart, hover over a few data points on each line to see the amounts associated with each
metric.

Step 2: Add a Formula
1.

At the top of the sidebar, tap Add Formula.
The formula box shows the metrics as available inputs A and B, and includes an input box
where you can enter the formula.
Do the following:
a.

In the Enter your Formula input box, enter “A/B”.
This will divide the revenue by products ordered by the number of new customers.

1118

Set Select format to “123Number.”

In the sidebar, replace “Untitled” with a name for the formula.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Formula Settings
2.

When complete, tap Apply.
The report now has a new line for the formula, “New Customer Revenue,” and the sidebar
shows the total amount of revenue generated by new customers.

Report with Formula

Step 3: Add a Date Range
1.

Click the Date Range control in the upper-right corner.

On the Fixed Date Range tab, do the following:
a.

On the calendars, choose the date range.
For this example, the holiday season is from November 1 through December 31.

Under Select Time Interval, choose “Day.”

Magento Commerce User Guide

1119

Report Builder

CHAPTER 75: BI Essentials

Fixed Date Range
c.

When complete, click Apply.
The report is now limited to the holiday season, with a data point for each day.

Fixed Date Range

Step 4: Save the Report
In this step, you will save the report as a chart, and also as a table.
1.

Click the “Untitled Report” text at the top of the page, and enter a descriptive title. For this
example, the report title is “2017 Holiday Sales.”
Then, do the following:

1120

In the upper-right corner, tap Save.

For Type, accept the default setting, “Chart.”

Choose the Dashboard where the report is to be available.

Tap Save to Dashboard.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Click the report title, and change the name. For this example, the report title is changed to
“2017 Holiday Sales Data”
Then, do the following:

In the upper-right corner, tap Save a Copy.

Set Type to “Table.”

Choose the Dashboard where the report is to be available.

Tap Save a Copy to Dashboard.

To see the reports in your dashboard, do one of the following:
l

Click Go to Dashboard in the message at the top of the page.

In the menu, choose Dashboards. Click the name of the current dashboard to display the
list. Then, click the name of the dashboard where the report was saved.

Magento Commerce User Guide

1121

Manage Data

CHAPTER 75: BI Essentials

Manage Data
Manage Data provides access to a variety of tools for managing integrations, report and chart
data, dashboards, and exports.

To access Manage Data:
1.

In the menu, choose Manage Data.

In the sidebar, choose the topic that you want under the following headings:
l

Data Sources

Manage Data

Export Data

Manage Data

1122

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Metrics
Each report includes at least one query that defines the set of data, or “metrics” for the report.
The metrics statement describes the data that is to be retrieved, and consists of an operator,
column, table, and sorting order. Magento BI includes a set of default, “out of the box” metrics
that can be easily customized. You can create an unlimited number of custom metrics.

To access the available metrics:
1.

On the menu, choose Manage Data.

In the sidebar, choose Metrics.

Metrics
3.

Click the name of any metric to display detailed information. To show the Metric Options,
click the Settings (

) icon on the right.

Metric Detail

Magento Commerce User Guide

1123

Manage Data

CHAPTER 75: BI Essentials

Click Details to display more information about the metric.

Metrics

Default Metrics by Table
FIELD

DESCRIPTION

customer_entity
Avg first 30 day revenue

Avg lifetime coupons

Average on the Customer’s first 30 day revenue column in the
customer_entity table (Change) ordered by the created_at (use)
column

Filter A

Seconds since customer’s first order date
>=2592000

Filter B

Registered accounts we count (Saved Filter
Set)

Average on the Customer’s lifetime number of coupons column in
the customer_entity table (Change) ordered by the created_at
(use) column

Filter A

Avg lifetime orders

Average on the Customer’s lifetime number of orders column in
the customer_entity table (Change) ordered by the created_at
(use) column

Filter A

1124

Registered accounts we count (Saved Filter
Set)

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Default Metrics by Table (cont.)
FIELD
Avg Lifetime revenue

DESCRIPTION
Average on the Customer’s lifetime number of orders column in
the customer_entity table (Change) ordered by the created_at
(use) column

Filter A

New Customers

Count on the entity_id column in the customer_entity table
(Change) ordered by the created_at (use) column

Filter A

Registered accounts

Registered accounts we count (Saved Filter
Set)

Count on the entity_id column in the customer_entity table
(Change) ordered by the created_at (use) column

Filter A

Registered accounts we count (Saved Filter
Set)

customer_group
New Metric

Count on the customer_group_id column in the customer_group

table (Change) ordered by the [NONE] column

sales_flat_order
Avg order value

Average on the base_grand_total column in the sales_flat_order

table (Change) ordered by the created_at (use) column

Filter A
Avg time between orders

Orders we count (Saved Filter Set)

Average on the Seconds since previous order column in the sales_

flat_order table (Change) ordered by the created_at (use) column

Filter A

Magento Commerce User Guide

Orders we count (Saved Filter Set)

1125

Manage Data

CHAPTER 75: BI Essentials

Default Metrics by Table (cont.)
FIELD
Median time between
orders

DESCRIPTION
Median on the Seconds since previous order column in the sales_
flat_order table (Change) ordered by the created_at (use) column

Filter A
New Metric 2
(Number of orders)

Count on the entity_id column in the sales_flat_order table

(Change) ordered by the [input] created_at (use) column

Filter A
Orders

Orders we count (Saved Filter Set)

Count on the entity_id column in the sales_flat_order table

(Change) ordered by the [input] created_at (use) column

Filter A
Revenue

Orders we count (Saved Filter Set)

Sum on the base_grand_total column in the sales_flat_order table

(Change) ordered by the created_at (use) column

Filter A
Shipping

Sum on the base_shipping_amount column in the sales_flat_order
table (Change) ordered by the created_at (use) column

Filter A
Tax

Orders we count (Saved Filter Set)

Sum on the base_tax_amount column in the sales_flat_order table

(Change) ordered by the created_at (use) column

Filter A
Unique Customers

Orders we count (Saved Filter Set)

Count Distinct Values on the customer_email column in the sales_
flat_order table (Change) ordered by the created_at (use) column

Filter A

Orders we count (Saved Filter Set)

sales_flat_order_item

1126

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Default Metrics by Table (cont.)
FIELD
Products Ordered

DESCRIPTION
Sum on the qty_ordered column in the sales_flat_order_item table

(Change) ordered by the created_at (use) column

Filter A
Revenue by products
ordered

Ordered products we count (Saved Filter Set)

Sum on the Order item total value (quantity * price) column in the

sales_flat_order_item table (Change) ordered by the created_at
(use) column

Filter A

Ordered products we count (Saved Filter Set)

Metric Options
FIELD
Operator

DESCRIPTION
Average
Count
Sum
Average
Maximum Value
Minimum Value
Count Distinct Values
Median
First Quartile
Third Quartile
Tenth Percentile
Ninetieth Percentile

Table

addresses
categories
customer_entity
customer_group
sales_flat_order
sales_flat_order_address
sales_flat_order_item

Magento Commerce User Guide

1127

Manage Data

CHAPTER 75: BI Essentials

Metric Options (cont.)
FIELD
Target Column by Table

DESCRIPTION
customer_entity

Customer’s first 30 day revenue
Customer’s lifetime number of coupons
Customer’s lifetime number of orders
Customer’s lifetime revenue
entity_id
group_id
Seconds since customer’s first order date

customer_group

customer_group_id

sales_flat_order

base_grand_total
base_shipping amount
base_tax_amount
billing_address_id
Customer’s lifetime number of coupons
Customer’s lifetime number of orders
Customer’s lifetime revenue
customer_id
entity_id
Number of items in order
Seconds between customer’s first order date
and this order
Seconds since previous order
shipping_address_id
store_id

sales_flat_order_
item

base_price
Customer’s lifetime number of orders
Customer’s lifetime revenue
item_id
Order item total value (quantity * price)
order_id
product_id
qty_ordered

Order Column

[NONE]
created_at (use)
updated_at
[input] created at

1128

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Filter Sets
A filter set is based on a table, and can include multiple statements with logic to select the data
for a report or chart. Magento BI includes several default filter sets that you can use “as is” or
modify. There is no limit to the number of filter sets that you can create.
A filter set can be applied to any metric that uses the same table. To learn more, see Creating
filter sets for metrics in the Magento BI Help Center.

To see the available filter sets:
1.

On the menu, choose Manage Data. Then in the sidebar under Manage Data, choose Filter
Sets.

Click Expand All to display the detail of each filter set that is currently available.

Filter Sets

To create a new filter set:
1.

In the upper-right corner of the Filter Sets page, tap Create New Filter Set. Then, do the
following:

Create Filter Set

Magento Commerce User Guide

1129

Manage Data

CHAPTER 75: BI Essentials

Under Select a Table, choose the table upon which the filter set is based.

Select a Table
b.

Enter the Filter Set Name.

Tap Add Filter. Then, follow the instructions to build each part of the expression.

Add Filter

To add another filter, tap Add Filter. Then, build the expression.

To complete the Filter Logic, use the AND/OR operators to describe how multiple
statements in the filter are to be applied.

When complete, tap Save.
The new filter appears in the list of Available Filter Sets by Table.

Default Filters by Table
FIELD
customer_entity

DESCRIPTION
Registered accounts we count (Saved Filter Set)
created_at (use)
Customer’s first 30 day revenue
Customer’s first order’s billing region
Customer’s first order’s coupon code

1130

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Default Filters by Table (cont.)
FIELD

DESCRIPTION
Customer’s first order date
Customer’s group code
Customer’s lifetime number of coupons
Customer’s lifetime number of orders
Customer’s lifetime revenue
email
entity_id
group_id
Seconds since customer’s first order date
updated_at
[input] created at

sales_flat_order

Orders we count (Saved Filter Set)
base_grand_total
base_shipping_amount
base_tax_amount
Billing address city
Billing address country
Billing address region
billing_address_id
coupon_code
created_at (use)
Customer’s creation date
Customer’s first order date
Customer’s group code
Customer’s lifetime number of coupons
Customer’s lifetime revenue
Customer’s order number
Customer’s order number (previous-current)
customer_email
customer_id
entity_id
Is customer’s last order?
Number of items in order
order_currency_code
Seconds between customer’s first order date and this order

Magento Commerce User Guide

1131

Manage Data

CHAPTER 75: BI Essentials

Default Filters by Table (cont.)
FIELD

DESCRIPTION
Seconds since previous order

sales_flat_order_item

Ordered products we count(Saved Filter Set)
base_price
created_at (use)
Customer’s lifetime number of orders
Customer’s lifetime revenue
Customer’s order number
item_id
name
Order’s coupon_code
Order item total value (quantity * price)
order_id
product_id
product_type
qty_ordered
sku
updated_at
[input] created_at

1132

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Export Data

Export Data
Raw report data can be exported from the Magento BI data warehouse to a CSV or Excel file.
You can also create a list of raw, exported data from tables that refreshes every 15 seconds to
ensure that the data is always current.

To export report data:
1.

In the header of a report, click the Settings (

) control.

Report Settings
2.

Choose one of the following options:
l

Full CSV Export

Full Excel Export

Watch the bottom of the window for the export file. Then, open the file.

Exported Data in Excel

To create an export list:
1.

On the menu, choose Manage Data.

In the sidebar under Export Data, choose Raw Data Export.

Magento Commerce User Guide

1133

Export Data

CHAPTER 75: BI Essentials

Raw Data Export
3.

Tap Add Export. Then, do the following:
a.

Choose the Table.

Choose Table
b.

Enter the Export Name.

Under Available Columns, tap Add All.

Choose Columns
d.

1134

If you want to add a filter, tap Add Filter. Then, follow the instructions to create a filter
for the exported data.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Export Data

The filters in this example includes all customers who placed their first order during the
2018 holiday season.

Filters
4.

When ready, tap Export Data.
Look for a message that says the export is successfully queued. The export appears in the list
when the process is complete.

Export List
5.

To download the exported data, tap Download. Then, look for the exported zip file at the
bottom of the window.

Magento Commerce User Guide

1135

1136

Magento Commerce User Guide

CHAPTER 76:

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/

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.

Magento Commerce User Guide

1137

CHAPTER 76: New Relic Reporting

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

Set Enable New Relic Integration to “Yes.”

In the Insights API URL, replace the percent (% symbol with your New Relic Account ID.

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

1138

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

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

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

Magento Commerce User Guide

1139

New Relic Queries

CHAPTER 76: New Relic Reporting

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
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

1140

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

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

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.

Magento Commerce User Guide

1141

New Relic Queries

CHAPTER 76: New Relic Reporting

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)
Widget Name:

Current Product Count (all)

Description:

Returns the average number of application events for all products during the
specified time period.

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

1142

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

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
(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

Magento Commerce User Guide

1143

New Relic Queries

CHAPTER 76: New Relic Reporting

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

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

1144

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

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

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.

Magento Commerce User Guide

1145

New Relic Queries

CHAPTER 76: New Relic Reporting

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

1146

Magento Commerce User Guide

CHAPTER 77:

Marketing Automation
The Marketing Automation section of the Reports menu includes a wide selection of reports to
help you track campaign activity and performance.

Marketing Automation Reports

To access Marketing Automation reports:
1.

On the Admin sidebar, choose Reports.

In the menu under Marketing Automation, choose one of the following reports:
l

Importer Status

Automation Enrollment

Campaign Sends

Cron Tasks

Dashboard

Log Viewer

Abandoned Carts

Magento Commerce User Guide

1147

1148

Magento Commerce User Guide

OPERATIONS

1149

U.S. Tax Guidelines

Stores

Canadian Tax Guidelines

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,

EU Tax Guidelines

Stores Menu

Warning Messages
Currency
Currency Configuration
Currency Symbols

All Stores
Adding Store Views

Updating Currency Rates
Attributes

Editing a Store View
Adding a Language
Translating Products

Creating an Attribute

Translating Content

Attribute Sets

Adding Stores
Adding Websites
Store URLs
Using a Custom Admin URL
Configuration
Taxes
General Tax Settings
Cross-Border Price Consistency
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

1150

Product Attributes

CHAPTER 78:

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 Commerce User Guide

1151

Menu Options

CHAPTER 78: 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.

Shipping
Manage the Carrier, Location, and Packaging profiles for
Magento Shipping.

1152

Magento Commerce User Guide

CHAPTER 79:

All Stores
When Magento Commerce 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 Commerce User Guide

1153

Adding Store Views

CHAPTER 79: 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
2.

1154

Tap Create Store View . Then, do the following:

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Store Views

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 Commerce User Guide

1155

Adding Store Views

CHAPTER 79: 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

1156

Magento Commerce User Guide

CHAPTER 79: 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 Commerce User Guide

1157

Adding Store Views

CHAPTER 79: 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.”

1158

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 Commerce User Guide

CHAPTER 79: 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 Commerce User Guide

1159

Adding Store Views

CHAPTER 79: 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
1.

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.

Enter Translated Labels

1160

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Store Views

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 Commerce User Guide

1161

Adding Store Views

CHAPTER 79: 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.

1162

Magento Commerce User Guide

CHAPTER 79: 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 Commerce User Guide

1163

Adding Stores

CHAPTER 79: 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.

Enter a Code in lowercase characters to identify the store. For example: mainstore.

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

1164

Magento Commerce User Guide

CHAPTER 79: 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 Commerce User Guide

1165

Adding Stores

CHAPTER 79: 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.

1166

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 79: 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 Commerce User Guide

1167

Adding Websites

CHAPTER 79: 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.

Set Default Store to the store that is to be used as the default for this website.

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.

1168

Magento Commerce User Guide

CHAPTER 79: 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 Commerce User Guide

1169

Store URLs

CHAPTER 79: 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.

1170

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 79: 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 s