Magento Commerce User Guide, 2.2 Guide

User Manual:

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

Download
Open PDF In Browser	View PDF

Ma
g
ent
oCommer
c
e

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

Session Lifetime
CHAPTER 6: Store Details

82
83

Store Information

Locale Options

State Options

Country Options

Merchant Location

Currency

Store Email Addresses

CHAPTER 7: Storefront Branding
Uploading Your Logo

97
98

Adding a Favicon

101

Welcome Message

104

Magento Commerce User Guide

iii

Contents

105

Store Demo Notice

107

CHAPTER 8: Websites, Stores & Views
Scope

110

Changing Scope

111

Catalog Scope

114

Product Scope

115

Price Scope

117

Customer Account Scope

119

Scope Quick Reference

120

Single Store Mode
CHAPTER 9: Industry Compliance

122
125

PCI Compliance Guidelines

126

127

Cookie Law Compliance

129

Cookie Restriction Mode

130

Cookie Reference

132

CATALOG
CHAPTER 10: Catalog Menu

135
137

Menu Options

138

Catalog URLs

139

CHAPTER 11: Products Grid

143

CHAPTER 12: Creating Products

147

Product Workspace

109

148

Default Field Values

151

Scheduled Changes

153

Product Types

154

Simple Product

156

Magento Commerce User Guide

Contents

Configurable Product

161

Part 1: Creating a Configurable Product

162

Part 2: Adding Configurations

166

Grouped Product

174

Virtual Product

181

Bundle Product

186

Customizing the Bundle
Downloadable Product
Configuring Download Options
Gift Cards

187
197
206
208

Gift Card Workflow

209

Creating a Gift Card

211

Gift Card Accounts

217

Configuring Gift Card Accounts

221

CHAPTER 13: Product Settings

225

Advanced Product Settings

226

Other Product Settings

227

Content

229

Configurations

230

Product Reviews

230

Images and Videos

231

Search Engine Optimization

232

Related Products, Up-Sells, and Cross-Sells

234

Related Products

234

Up-sells

236

Cross-sells

238

Customizable Options

240

Product in Websites

244

Design

246

Autosettings
Gift Options

Magento Commerce User Guide

247
247

Contents

Downloadable Information

248

Grouped Products

248

Bundle Items

249

Gift Card Information

249

CHAPTER 14: Managing Price

251

Advanced Pricing

252

Group Price

255

Special Price

257

Tier Price

259

Minimum Advertised Price

261

MAP Logic

261

Configuring MAP

263

CHAPTER 15: Managing Inventory

267

Stock Management Methods

268

Stock Options

273

Product Stock Options

275

Stock Message Scenarios

277

Product Alerts

281

Product Alert Run Settings

283

CHAPTER 16: Images and Videos

285

Uploading Product Images

286

Adding Product Video

289

Media Gallery

292

Image Zoom

293

Light Boxes and Sliders

293

Placeholders

294

Watermarks

295

Swatches

298

Creating Swatches
CHAPTER 17: Categories

300
305

Magento Commerce User Guide

Contents

Best Practices for Product Categories

306

Creating Categories

307

Root Categories

313

Hidden Categories

316

Scheduled Changes

317

Content Settings

318

Display Settings

319

Search Engine Optimization

320

Products in Category

322

Sorting Category Products

323

Design Settings

327

Category Permissions

329

CHAPTER 18: Product Attributes

335

Best Practices for Product Attributes

336

Adding an Attribute

337

Attribute Input Types

342

Date & Time Options
CHAPTER 19: Using a Flat Catalog
Flat Catalog Setup

MARKETING
CHAPTER 20: Marketing Menu
Main Sections
CHAPTER 21: Shopping Tools

344
347
348

353
355
356
359

Opportunities to Engage

360

Email a Friend

361

Wish Lists

364

Configuring Wish Lists
Updating Wish Lists

Magento Commerce User Guide

365
366

vii

Contents

Sharing a Wish List

369

Wish List Search

371

Product Relationships

373

Compare Products

374

Other PayPal Solutions

1061

PayPal Payments Advanced

1063

Requirements

1063

Checkout Workflow

1064

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

1064
1064
1064
1065

PayPal Payments Pro

1066

Requirements

1066

Checkout Workflow

1066

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

1066
1067
1067
1068

PayPal Payments Standard

1069

Merchant Requirements

1069

Checkout Workflow

1069

Checkout Workflow
Setting Up PayPal Payments Standard

1069
1070

PayPal Payflow Pro

1071

Requirements

1071

Customer Workflow

1071

Magento Commerce User Guide

xix

Contents

Customer Workflow
Online Order Processing Workflow

1072

Online Order Processing Workflow

1072

Setting Up PayPal Payflow Pro

1072

PayPal Payflow Link

1073

Requirements

1073

Customer Workflow

1073

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

1073
1074
1074
1075
1076

PayPal Business Account

1077

PayPal Credit®

1077

PayPal Fraud Management Filter

1081

PayPal by Country

1082

CHAPTER 70: Other Payment Methods

1085

Authorize.Net Direct Post

1086

CyberSource

1086

eWAY

1090

Worldpay

1093

CHAPTER 71: Basic Payment Methods

1097

Check / Money Order

1098

Cash On Delivery

1100

Bank Transfer

1102

Purchase Order

1104

Zero Subtotal Checkout

1106

Fraud Protection

1107

Signifyd Fraud Protection

1071

1108

Magento Commerce User Guide

Contents

Shipping
CHAPTER 72: Shipping Settings

1111
1113

Point of Origin

1114

Multiple Addresses

1115

Shipping Policy

1116

CHAPTER 73: Basic Shipping Methods

1117

Free Shipping

1118

Flat Rate

1120

Table Rates

1122

Dimensional Weight

1129

CHAPTER 74: Carriers

1131

CHAPTER 75: Shipping Labels

1133

Shipping Label Workflow

1134

Configuring Shipping Labels

1135

Creating Shipping Labels

1139

Label Packages

REPORTS
CHAPTER 76: Reports Menu

1146

1151
1153

Menu Options

1154

Refresh Statistics

1155

CHAPTER 77: Marketing Reports
Reports
CHAPTER 78: Review Reports
Reports
CHAPTER 79: Sales Reports
Reports

Magento Commerce User Guide

1157
1158
1159
1160
1161
1162

xxi

Contents

CHAPTER 80: Customer Reports
Reports
CHAPTER 81: Product Reports
Reports
CHAPTER 82: Private Sales Reports
Reports
CHAPTER 83: New Relic Reporting
New Relic Queries

OPERATIONS
CHAPTER 84: Stores Menu
Menu Options

1166
1167
1168
1170
1171
1173
1175

1183
1185
1186

CHAPTER 85: All Stores

1187

Adding Store Views

1188

Editing a Store View

1190

Adding a Language

1192

Translating Products

1194

Translating Content

1196

Adding Stores

1197

Adding Websites

1201

Store URLs

1203

Use Secure Protocol

1203

Using a Custom Admin URL

1208

CHAPTER 86: Configuration

1211

Configuration Tabs

1211

CHAPTER 87: Taxes

1213

General Tax Settings
Cross-Border Price Consistency

xxii

1165

1213
1219

Magento Commerce User Guide

Contents

Tax Rules
Tax Classes

1221
1225

Configuring Tax Classes

1226

Default Tax Destination

1227

EU Place of Supply for Digital Goods

1228

Fixed Product Tax
Configuring FPT

1229
1230

Price Display Settings

1235

Tax Zones and Rates

1238

Import/Export Tax Rates

1240

Value Added Tax (VAT)

1243

Configuring VAT

1244

VAT ID Validation

1247

Configuring VAT ID Validation

1249

Tax Quick Reference

1254

International Tax Guidelines

1256

U.S. Tax Guidelines

1258

Canadian Tax Guidelines

1260

EU Tax Guidelines

1265

Warning Messages

1271

Calculation Settings

1271

Discount Settings

1272

CHAPTER 88: Currency

1273

Currency Configuration

1274

Currency Symbols

1278

Updating Currency Rates

1279

CHAPTER 89: Attributes

1281

Customer Attributes

1282

Customer Address Attributes

1287

Customer Address Templates

1288

Product Attributes

Magento Commerce User Guide

1290

xxiii

Contents

Creating Product Attributes

1295

Attribute Sets

1300

System
CHAPTER 90: System Menu
Menu Options

1305
1306

CHAPTER 91: Data Transfer

1309

Working with CSV Files

1310

Data Validation
Import

1313
1315

Import History

1320

Importing Product Images

1321

Importing Tier Price Data

1322

Import Guidelines

1324

Export

1326

Export Criteria

1328

Export Filters

1329

Exclude Attributes

1329

Exporting Tier Price Data

1330

Scheduled Import/Export

1332

Scheduling an Import

1333

Scheduling an Export

1339

Product Attribute Reference

1345

Complex Data

1356

Advanced Pricing Data

1358

Customer Attribute Reference

1360

CHAPTER 92: Integrations

1363

Onboarding Workflow

1364

Magento Marketplace

1368

CHAPTER 93: Permissions

xxiv

1303

1369

Magento Commerce User Guide

Contents

Adding Users

1370

Locked Users

1374

User Roles

1375

Role Resources

1378

Alternate Media Storage

1381

Using a Database

1382

Database Workflow

1382

Using a Content Delivery Network

1384

CDN Workflow

1384

CHAPTER 94: Security

1387

Security Scan

1388

Security Best Practices

1392

Start Right

1392

Protect the Environment

1393

Protect Magento

1395

Don’t be Taken for a Ride

1395

Be Prepared!

1396

Monitor for Signs of Attack

1396

Follow Your Disaster Recovery Plan

1397

Security Action Plan

1398

Configuring Admin Security

1399

CAPTCHA

1402

Admin CAPTCHA

1403

Customer CAPTCHA

1406

Encryption Key

1408

Session Validation

1410

Browser Capabilities Detection

1412

Action Log

1413

Action Log Report
Archive
Bulk Actions

Magento Commerce User Guide

1413
1415
1416

xxv

Contents

CHAPTER 95: Tools
Cache Management

1420

Full-Page Cache

1424

Index Management
Index Trigger Events

1426
1428

Backups

1431

Cron (Scheduled Tasks)

1433

Developer Tools

1435

Frontend Development Workflow

1436

Using Static File Signatures

1437

Optimizing Resource Files

1438

Developer Client Restrictions

1441

Template Path Hints

1442

Translate Inline

1444

Setup Wizard

1448

Setup Tools

1449

Extension Manager

1450

Module Manager

1452

System Upgrade

1457

System Config

1459

CHAPTER 96: Support

1461

Data Collector

1462

System Reports

1464

APPENDICES

xxvi

1419

1469

APPENDIX A: Release Notes

1471

APPENDIX C: Glossary

1473

APPENDIX D: Configuration Reference

1483

Magento Commerce User Guide

Contents

INDEX

Magento Commerce User Guide

1485

xxvii

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: 27 October. 2017

xxviii

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

7.0.4

Magento 2.1.2 and later only.

7.0.2 ,
7.0.6 to 7.1.0

Magento 2.1.x (all versions)

5.6.5 and later

Magento 2.1.2

5.6.x

Magento 2.1.0 and 2.1.1

Not Supported:
PHP 7.1, 5.4

Not Supported

PHP 7.0.5

Known issue that affects code
compiler.

Required PHP Extensions:
bc-math (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

Magento Commerce User Guide

CHAPTER 2: About This Release

System Requirements

SYSTEM REQUIREMENTS
Optional, but recommended
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 1.7 and 2.x (recommended)
2.x supported from Linux repository.
2.0 branch supported from PHP repository.

Apache Solr

Magento Commerce User Guide

(Enterprise Edition only)

System Requirements

CHAPTER 2: About This Release

Supported Applications (cont.)
NAME
Messaging

DESCRIPTION
RabbitMQ (Enterprise Edition only)

Supported Browsers
BROWSER

VERSION

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

Any
Any
Mac OS
Windows

Version 9 or later

Windows

iPad 2
iPad Mini
iPad with Retina Display

OS 7 or later

iPhone 4 or later
Latest, latest -1

IOS 7 or later
Android 4 or later

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

MOBILE STOREFRONT
Safari Mobile
Chrome for Mobile

The version before the most current.

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

Related Products

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Path to Purchase

Product Page

Magento Commerce User Guide

Path to Purchase

CHAPTER 4: Quick Tour

Shopping Cart
The cart is where order total can be determined, along with discount coupons and estimated
shipping and tax, and is a great place to display your trust badges and seals. It’s also an ideal
opportunity to offer one last item. As a cross-sell, you can select certain items to be offered as
an impulse purchase whenever a specific item appears in the cart.
Callouts

One Item in Cart

Change the Quantity

Estimate Shipping & Tax

Go to Checkout

Edit Line Item

Update the Cart

Checkout with Multiple Addresses

Use a Coupon

Cross-sells

Special Price

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Path to Purchase

Shopping Cart Page

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Customer Journey
Attract New Customers
Magento Commerce includes SEO functionality out of
the box. Improve your search ranking and attract the
most visitors to your site.

Engage Your Customers
Design your site with prepared templates, or create a
custom design with features that invite people to interact
with your store.

Increase AOV
Increase average order value with promotions and
content that encourage your customers to shop more.

Moment of Purchase
Give your customers a faster and easier way to check
out. Calculate shipping and taxes automatically, and
integrate multiple payment methods on a single page.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Customer Retention
Create and manage newsletters and promotions to keep
your customers coming back for more.

Loyalty & Advocacy
Encourage customers to write product reviews, create
wish lists, and send email about products to their friends.
Strengthen your relationship with your customers, who in
return, speak positively of your business to friends
and family.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Attract New Customers
Magento Commerce is packed with features that make it
easy to create a “search engine friendly” websites and
increase the likelihood of bringing the right customers to
your site.

Search Engine Optimization
Magento offers powerful, native capabilities to streamline Search Engine Optimization (SEO)
practices for content and site exposure that are integrated with the Admin, and tied directly into the
user experience.

Custom URLs
Custom URLs are short, clean, and easy to remember. You can also autogenerate search-friendly
URLs to streamline your purchase path.

Meta Data
Improve your search engine rankings by choosing specific criteria that helps search engines to find
and index your products more easily. Meta data can be entered for product, category, and content
pages.

Sitemap
Link to a sitemap from the footer of your store to give customers an overview of the catalog structure,
with links to all categories and products in the store. Easy integration with Google Sitemap.

Analytics
In addition to monitoring your site from the Admin dashboard, you can integrate third-party analytics
tools such as Google Analytics and New Relic Reporting for detailed statistics on traffic and sales.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Engage Your Customers
Magento Commerce makes it easy to create a
customized, engaging site experience. Encourage your
customers to spend more time exploring your site, and
give them the tools to make it easy to find what they want
faster.

Content Management
Magento’s CMS makes it easy to store pages, or parts of pages, that you can use in your store. Even
those without a technology background can create and manage site content.

Design & Theme
Control the visual elements of your store with a collection of templates and skin files. You can apply
these visual elements to all pages in your store, giving your store a cohesive look and feel.

Multiple Stores, Sites & Views
Control the look and feel of multiple sites, introduce new market and languages, and track analytics
from a single Admin.

Multiple Devices
Magento’s powerful features make it easy to create storefronts optimized for iPhone, Android, and
Mobile Opera browsers to help you engage consumers with mobile commerce now, and into the
future.

Shopping Tools
Your store includes a set of shopping tools that create opportunities for your customers to interact
with your store, connect on social media, and share with friends.

Sophisticated Search
Filter product by price, manufacturer, or any other criteria to reduce the time to purchase.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Increase Average Order Value
Magento Commerce provides a range of tools to help you
tailor the shopping experience, and encourage your
customers to put more items in their shopping carts and
spend more money.

Targeted Promotions
Use catalog and shopping cart price rules to create promotions that kick into gear when a set of
conditions is met. Segment customers dynamically and build segments based on specific
characteristics such as customer address, order history, shopping cart content, and much more.

Coupons
Create limited-time offers and coupons that customers can scan with their phone and apply to a
purchase.

Product Suggestions
Another way to increase AOV is to offer suggestions for related products and opportunities to up-sell
and cross-sell at strategic points along the path to conversion.

Email Reminders
Send automated reminder emails to customers who have added items to their carts or wish lists, but
haven’t made a purchase. A variety of triggers can launch automated emails, including total cart
value, quantity, items in the cart, and more.

User Permissions & Roles
Restrict access to data in the Admin on a “need to know” basis. Create multiple admin roles for readonly or and editing privileges. Track and review all activity at a granular level to specific stores and
websites.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Full-Page Caching
Enhance performance by caching primary pages. Caching pages improves server response times,
reduces load, and increases sustainable traffic.
You can use tags to define which components to cache, so only relevant pages are cached as
updates take place. It also has the ability to identify and differentiate visitors from shoppers.

Sales Order Archive
Archiving orders frees resources and improves performance when sales reps are assisting customers
with orders.

Index Management
Automatic reindexing takes place whenever prices change, shopping carts are updated, or new
categories created. Reindexing is a background process that does not interfere with store operations.

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Moment of Purchase
Now that you’ve given your customer an engaging
shopping experience, make it easy for them to complete
their purchases. Magento is designed to help you
streamline your checkout process experience while
boosting conversion rates.

Order Processing
Magento supports a complete order processing workflow. It's easy to customize order statuses and
track communications between sales reps and customers.

Shipping Labels
Merchants have complete control over package characteristics such as weight and size. Shipping
labels, rate, and bar code information originates directly from the carrier. Labels can be generated for
single or multiple orders.

Multiple Shipping Options
Magento supports a variety of shipping methods so you can give your customers a choice at
checkout. Customers can see a real-time estimate of shipping charges right from the shopping cart.

Multiple Payment Options
Magento Commerce supports the payment methods and currencies needed for global commerce.
You can choose the ones you want to offer, and at checkout, your customers can choose the ones
they prefer.

PayPal Merchant Solutions
It's easy to integrate a PayPal Payments account to provide your customers faster, more secure
checkout options.

Shopping Assistance
Assisted shopping makes it easy for customer service reps to create orders for customers. Customer
service reps have access to shopping cart contents, and can move items from a wish list to a
shopping cart, apply coupon codes, and more.

Security
Whether an order is fulfilled online or over the phone, Magento provides sophisticated security,
including CAPTCHA and SSL encryption, with best-in-breed encryption and hashing algorithms to
protect the security of the system.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Retain Customers
Magento makes it easy for you to get repeat business
and build brand loyalty. Magento gives you total control
and flexibility over creating and revising goodies like
rewards programs, custom coupons and automated
emails to keep your customers coming back again and
again.

RMA
Customers can submit requests for Return Merchandise Authorization from your store. You can
create shipment orders in a carrier system, and print shipping labels with RMA numbers.

Store Credit
Keep customers loyal and happy by issuing refunds as store credit or virtual gift cards to ensure that
the money they spend stays in your store.

Reward Points
Drive customer engagement with reward programs with award points based on a range of
transactions and customer behaviors. Base redemption on a variety of factors, such as balance,
customer history, and conversion rates.

Target Shopping History
Encourage customers to make return purchases with targeted promotions based on their shopping
history. With the Magento platform, you can easily build segments based on your customer base.

Custom Coupons
Create coupons codes for social media, email, or print campaigns. You can incorporate coupon codes
into any design you like.

Newsletters
Stay in touch with current customers who’ve opted to receive newsletters. You can create as many
newsletter templates as you want.

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

Magento Commerce User Guide

Customer Journey

CHAPTER 4: Quick Tour

Build Loyalty & Advocacy
Give customers a direct connection to your brand by
allowing them to create customer accounts where they
can see their purchase history, wish lists, and newsletter
subscriptions. Use product ratings and reviews to give
new customers objective product opinions and promote a
sense of community. These features turn customer
satisfaction into one of the most powerful and costefficient marketing tools at your disposal.

Dashboard Snapshots
Knowing what’s of interest on your site is crucial to maximize your marketing budget. Use this
information to determine what you should cross- and up-sell to loyal customers, or which products to
put on sale.

Customer Accounts
Opening an account provides customers with a personalized shopping experience that they can share
with their friends. Customers can save their shopping preferences, and manage their own store billing
and shipping information.

Advocacy Tools
Customers who share wish lists and send gift cards make a powerful endorsement of your brand.
Wish lists become powerful advocacy tools when shared by email or RSS feed, and gift cards bring
motivated new shoppers to your store.

Reviews & Ratings
Product reviews give your customers a way to engage with your brand while fostering a sense of
community. You can curate your reviews with tools to help you edit and approve comments for
inappropriate content before they go live.

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Customer Journey

Success!
Opening your Magento store for business requires the
following areas of consideration. While there are virtually
any number of customizations you can make to the
storefront and Admin, you can use each link in this is list
as a place to start.

Implementation
If you need help setting up your store, you can choose from our vast network of Magento Solutions
Partners.

Design
You can use a prepared theme and design your own home page, or work with an experienced
Magento designer or Magento Associate to customize your site.

Product Catalog
Configure products, create categories, import existing product catalogs, and leverage APIs or thirdparty data management solutions.

Payment Methods
Magento supports a wide variety of payment methods, services, and gateways that you can offer for
your customers’ convenience.

Shipping Methods
Magento shipping methods are easy to set up and give you the ability to connect with carriers who
can ship your products all over the world.

Taxes
Manage your taxes with our native tools, or add third-party extensions from Magento Marketplace.

Thanks for your order!
Magento can help you to build relationships with your customers, and bring them back to your store,
again and again.

Magento Commerce User Guide

Basic Configuration

Contents
This section of the guide introduces your store's
Admin, and walks you through the basic
configuration settings. You’ll learn the concepts
of store hierarchy and configuration scope, and
establish best practices for industry standards
and requirements.

Store Admin
Your Admin Account
Admin Sidebar
Admin Workspace
Dashboard
Message InBox
Global Search
Grid Controls
Actions Control
Store Details
Store Information
Locale Options
State Options
Country Options
Merchant Location
Currency
Store Email Addresses
Contact Us
Storefront Branding
Uploading Your Logo
Uploading a Favicon
Welcome Message
Store Demo Notice
Copyright Notice
Websites, Stores & Views
Configuration Scope
Single Store Mode
Industry Compliance
PCI Compliance
Privacy Policy
Cookie Law Compliance
Cookie Restriction Mode
Cookie Reference

CHAPTER 5:

Store Admin
Your store Admin is the password-protected back office where you, as the merchant, can set up
products, promotions, manage orders, and perform other administrative tasks. All basic
configuration tasks and store management operations are performed from the Admin.

Admin Sidebar and Dashboard
Your initial sign-in credentials were set up during the Magento installation. If you forget your
password, a temporary password can be sent to the email address that is associated with the
account. For increased security, you can configure your store to require a case-sensitive user
name and password. For additional security, the Admin login can be configured to require a
CAPTCHA. To learn more, see: Configuring Admin Security.
In addition to the default Admin account, you can create as many additional accounts that are
needed to manage the store and to support customer accounts. Each account can be associated
with a specific role and level of access, based on the person’s business need to know. The email
address that is associated with each Admin account must be unique.

Magento Commerce User Guide

Admin Sign In

CHAPTER 5: Store Admin

Admin Sign In
The first thing you will learn is how to sign in and out of the Admin, and to reset your
password. All of the instructions in the rest of this guide are written for a user with full
administrative privileges, and begin with the assumption that you are logged in to the Admin.
To learn more about Admin users and roles, see: Permissions
The Advanced Admin configuration determines how many times an admin user can try to log
in before the account is locked. By default, six attempts are allowed. To unlock a user account,
see: Locked Users.

Admin Sign In

To sign in to the Admin:
1.

In the address bar of your browser, enter the URL that was specified during the installation,
followed by the base URL of your store’s Admin. The default Admin URLs look something like
this:
http://www.yourdomain.com/admin

You can bookmark the page, or save a shortcut on your desktop for easy access.

Enter your Admin User Name and Password.

Tap Login .

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Sign In

To reset your password:
1.

If you forget your password, click the Forgot Your Password? link. Then, enter the Email
Address that is associated with the Admin account.

Forgot Password
2.

Tap Retrieve Password .
If an account is associated with the email address, an email will be sent to reset your
password.
Your Admin password must be seven or more characters long, and include both letters and
numbers.

To sign out of the Admin:
In the upper-right corner, tap the Account (

) icon. Then on the menu, choose Sign Out.

Sign Out
The Sign-In page returns, with a message that you are logged out. It’s always a good idea to
sign out of the Admin whenever you leave your computer unattended.

Admin Password Requirements
FIELD
Password

Magento Commerce User Guide

DESCRIPTION
An Admin password must be seven or more characters long, and
include both letters and numbers. For additional password options,
see: Configuring Admin Security.

Your Admin Account

CHAPTER 5: Store Admin

Your Admin Account
Your Admin account was initially set up during the installation, and might contain initial
placeholder information, or information from the sample data. You can personalize your user
name and password, and update your first and last name, and email address at any time. To
learn more about Admin accounts and roles, see: Permissions.

To edit your account information:
1.

In the upper-right corner, tap the Account (

) icon. Then, choose Account Setting.

Make any changes necessary changes to your account information. If you change your login
credentials, make sure to write them down.

When complete, tap Save Account .

Account Information

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Sidebar

Admin Sidebar
The sidebar on the left is the main menu for your store’s Admin, and is designed for both
desktop and mobile devices. The flyout menu provides access to all the tools you need to
manage your store on a daily basis.

Admin Startup Page
Displays the Admin startup page, which by default is the Dashboard.

Dashboard
The Dashboard provides a quick overview of the sales and customer activity in
your store, and is usually the first page that appears when you log in to the
Admin.

Sales
The Sales menu is where you can find everything related to the operations of
processing orders, invoices, shipments, credit memos, and transactions.

Catalog
The Catalog menu is used to create products and define categories.goo

Customers
The Customers menu is where you can manage customer accounts, and see
which customers are online at the moment.

Magento Commerce User Guide

Admin Sidebar

CHAPTER 5: Store Admin

Marketing
The Marketing menu is where you set up catalog and shopping cart price rules
and coupons. Price rules trigger actions when a set of specific conditions is met.

Content
The Content menu is where you manage the content elements and design of your
store. You will learn how to create pages, blocks, and frontend apps, and manage
the presentation of your store.

Reports
The Reports menu provides a broad selection of reports that give you insight into
every aspect of your store, including sales, shopping cart, products, customers,
tags, reviews, and search terms.

Stores
The Stores menu includes tools to configure and maintain every aspect of your
store, including multisite installation settings, taxes, currency, product attributes,
and customer groups.

System
The System menu includes tools to manage system operations, install
extensions, and manage Web Services for integration with other applications.

Find Partners & Extensions
This is where you can find a marketplace Magento Partners and solutions for
your store.

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Admin Workspace
The Admin workspace provides access to all the tools, data, and content that you need to run
your store. The default start up page can be set in the configuration. Many Admin pages have a
grid that lists the data for the section, with a set of tools to search, sort, filter, select, and apply
actions. By default, the Dashboard is the startup page for the Admin. However, you can choose
any other page to appear as the startup page when you log in. You can tap the Magento logo in
the Admin sidebar to return to the Admin startup page.

Admin Workspace

To change the Admin startup page:
1.

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

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

Expand

Set Startup Page to the page that you want to appear first after you log in to the Admin.

the Startup Page section.

Startup Page
5.

When complete, tap Save Config.

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

Workspace Controls
CONTROL

DESCRIPTION

The Global Search box can be used to find any value in the database,
including product, customer, and order records.

Sort

The header of each column can be used to sort the list in ascending or
descending order.

Filters

Defines a set of search parameters that determines the records that appear in
the grid.
In addition, the filters in the header of some columns can be used to limit the
list to specific values. Some filters have additional options that can be
selected from a list box, and for others, you can simply type the value you
want to find.

Default View

Determines the default column layout of the grid.

Columns

Determines the selection of columns and their order in the grid. The column
layout can be changed. and saved as a “view.” By default, only some of the
columns are included in the grid.

Paginate

The pagination controls are used to view the additional pages of results.

Actions

The Actions control applies an operation to all selected records. To select
individual records, mark the checkbox in the first column of each row, or use
the Select control.

Select

The Select control is used to select multiple records that are to be the target
of action. Options: Select All / Deselect All

Potential Startup Pages
SIDEBAR

PAGES

Dashboard
Sales

Operations

Orders
Invoices
Shipments
Credit Memos
Returns
Billing Agreements
Transactions

Archive

Orders
Invoices

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Potential Startup Pages (cont.)
SIDEBAR

PAGES
Shipments
Credit Memos

Catalog

Products
Categories

Customers

All Customers
Now Online
Segments

Marketing

Promotions

Catalog Price Rules
Related Products Rules
Cart Price Rules
Gift Card Accounts

Private Sales

Events
Invitations

Communications

Email Templates
Newsletter Template
Newsletter Queue
Newsletter Subscribers
Email Reminders

SEO & Search

URL Rewrites
Search Terms
Search Synonyms
Site Map

Content

User Content

Reviews

Elements

Pages
Hierarchy
Blocks
Banners
Widgets

Design

Magento Commerce User Guide

Configuration

Admin Workspace

CHAPTER 5: Store Admin

Potential Startup Pages (cont.)
SIDEBAR

PAGES
Themes
Schedule

Reports

Content Staging

Dashboard

Marketing

Products in Cart
Search Terms
Abandoned Carts
Newsletter Problem Reports

Reviews

By Customers
By Products

Sales

Orders
Tax
Invoiced
Shipping
Refunds
Coupons
PayPal Settlement
Braintree Settlement

Customers

Order Total
Order Count
New
Wish Lists
Segments

Products

Views
Bestsellers
Low Stock
Ordered
Downloads

Private Sales

Invitations
Invited Customers
Conversions

Statistics

Refresh Statistics

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Potential Startup Pages (cont.)
SIDEBAR
Stores

PAGES
Settings

All Stores
Configuration
Terms and Conditions
Order Status

Taxes

Tax Rules
Tax Zones and Rates

Currency

Currency Rates
Currency Symbols

Attributes

Customer
Customer Address
Product
Attribute Set
Returns
Rating

Other Settings

Reward Exchange Rates
Gift Wrapping
Gift Registry
Customer Groups

System

Data Transfer

Import
Export
Import/Export Tax Rates
Import History
Scheduled Import/Export

Extensions

Integrations

Tools

Cache Management
Index Management
Backups
Web Setup Wizard

Support

Data Collector
System Report

Permissions

Magento Commerce User Guide

All Users

Admin Workspace

CHAPTER 5: Store Admin

Potential Startup Pages (cont.)
SIDEBAR

PAGES
Locked Users
User Roles
Action Logs

Report
Archive
Bulk Actions

Other Settings

Notifications
Custom Variables
Manage Encryption Key

Find Partners & Extensions

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Dashboard
The dashboard is usually the first page that appears when you log in to the Admin, and gives
an overview of sales and customer activity. The blocks on the left provide a snapshot of lifetime
sales, average order amount, the last five orders, and search terms. The graph shows the orders
and amounts for the selected date range. You can use the tabs above the graph to toggle
between the two views. The tabs at the bottom provide quick reports about your best-selling
and most viewed products, new customers and those who have purchased the most.
The dashboard is the default startup page for the Admin, although you can change the
configuration to display a different page when you log in. You can also set the starting dates
used in dashboard reports, and disable the display of the charts section.
You can produce Dashboard snapshot reports for each store view. The tabs at the bottom of the
page summarize your best-selling and most viewed products, new customers, and those who
have purchased the most during the time period specified.

Dashboard

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

To configure the chart:
1.

On the Admin sidebar, tap Stores. Under Settings, choose Configuration. Then, do any of the
following:

Enable Charts
1.

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

In the Dashboard section, set Enable Charts to “Yes.”

Enable Charts

Set the Beginning Dates
1.

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

In the Dashboard section do the following:
a.

Set Year-To-Date Starts to the Month and Day.

Set Current Month Starts to the Day.

Beginning Date

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Choose the Data Source
If you have a lot of data to process, the performance of the Dashboard can be improved by
turning off the display of real time data.
1.

In the panel on the left, tap to expand Sales. Then, choose Sales.

Tap to expand the Dashboard section, and do the following:
l

For real-time data, set Use Aggregated Data (beta) to “Yes.”

For historical data, set Use Aggregated Data (beta) to “No.”

Data Source

Change the Startup Page
1.

In the panel on the left, tap to expand Advanced. Then, choose Admin.

Tap to expand the Startup Page section.

Choose the Startup Page that you want to appear when you log in to the Admin. The list
includes every page in the Admin menu structure.

Startup Page
2.

When complete, tap Save Config .

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

Dashboard Reports
REPORT

DESCRIPTION

Sales

The Dashboard reports on Lifetime Sales, Revenue, Tax, Shipping,
and Quantity for the time period specified.

Orders

The Orders tab at the top displays a chart of all orders during the
specified time period. Below the chart is the total revenue, tax,
shipping, and quantity ordered. The lifetime sales amount and the last
five orders are on the left.

Amounts

The Amounts tab at the top displays a chart of all order amounts
during the specified time period. The average order amount and the
last five orders are on the left.

Search Terms

The last five search terms, and top five search terms appear on the
left.

Products

The Bestsellers tab shows the price and quantity ordered of your
best-selling products. The products that have been viewed the most
during the specified time period are listed on the Most Viewed
Products tab.

Customers

The Customers tab at the bottom lists the customers who have
ordered the most during the specified range of time. The New
Customers tab lists all new customers who have registered for an
account during the time period. On the left, the Last Orders section
lists the most recent orders by customer.

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Message Inbox
Your store receives messages from Magento on a regular basis. The messages might refer to
system updates, patches, new releases, scheduled maintenance or upcoming events, and are
rated by importance. The bell icon in the header indicates the number of unread messages in
your inbox.

Incoming Messages
Any message of critical importance appears in a pop-up window when you log into your store.
The notice continues to appear after each login until the message is either marked as read, or
removed.

Message of Critical Importance
The Notifications grid lists all messages ranked by severity, with the most recent at the top.
The Action commands can be used to mark individual messages as read, view more detailed
information, or to remove the message from the inbox.
The configuration determines how often the inbox is updated, and how the messages are
delivered. If your store Admin has a secure URL, notifications must be delivered over HTTPS.

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

To view incoming messages:
1.

Tap the Notification icon in the header, and read the summary. Then, do one of the following:
l

If necessary, tap the message to display the full text.

To delete the message, tap the delete icon to the right of the message.

To display the Notifications grid, click See All.

For a message of critical importance, do one of the following:
l

Click Read Details.

To remove the popup, but keep the message active, tap Close.

To view all notifications:
1.

Do one of the following:
l

Tap the Notification icon in the header. Then in the footer of the summary, click See All.

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

In the Action column, do any of the following:
l

For more information, tap Read Details. The linked page opens in a new window.

To keep the message in your inbox, tap Mark As Read.

To delete the message, tap Remove.

All Notifications

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

To apply an action to multiple messages, do one of the following:
l

Mark the checkbox in the first column to select each message to be managed.

To select multiple messages, set the Mass Actions control as needed.

Set the Actions control to one of the following:
l

Mark as Read

Remove

Tap Submit to complete the process.

To configure notifications:
1.

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

Scroll down, and in the panel on the left under Advanced, choose System.

Expand

the Notifications section, and do the following:

If your store Admin runs over a secure URL, set Use HTTPS to Get Feed to “Yes.”

Set Update Frequency to determine how often your inbox is updated. The interval can be
from one to twenty-four hours.

Notifications
4.

When complete, tap Save Config .

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

Global Search
The magnifying glass in the header of the Admin can be used to find any record in the
database. The results can include customers, products, orders, or any related attribute. For
example, if you enter a customer name, the results might include the customer record as well
as any orders that are associated with the name.

To find a match:
1.

In the header, tap the magnifying glass (

) to open the search box. Then, do one of the

following:

To find a close match, enter the first few letters of what you want to find.

To find an exact match, enter the word, or multiple words that you want to find.

In the search results, click any item to open the record.

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Grid Controls
Admin pages that manage data display a collection of records in a grid. The controls at the top
of each column can be used to sort the data. The current sort order is indicated by an ascending
or descending arrow in the column header. You can specify which columns appear in the grid,
and drag them into different positions. You can also save different column arrangements as
views that can be used later. The Action column lists operations that can be applied to an
individual record. In addition, date from the current view of most grids can be exported to a
CSV or XML file.

Orders Grid

To sort the list:
1.

Tap any column header. The arrow indicates the current order as either ascending or
descending.

Use the pagination controls to view additional pages in the collection.

To paginate the list:
1.

Set the Pagination control to the number of records that you want to view per page.

Tap Next and Previous to page through the list, or enter a specific Page Number.

Next and Previous

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

To filter the list:
1.

Tap Filters.

Complete as many filters as necessary to describe the record you want to find.

Tap Apply Filters.

Filter Controls

To export data:
1.

Select the records that you want to export.
Product data cannot be exported from the grid. To learn more, see Export.

On the Export (
l

CSV

Excel XML

) menu in the upper-right corner, choose one of the following file formats:

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Export Control
3.

Tap Export.

Look for the downloaded file of exported data at the bottom of your browser window. Then,
open the file from the pop-up menu.

Grid Layout
The selection of columns and their order in the grid can be changed according to your
preference, and saved as a “view.” By default, only nine of twenty available columns are visible
in the grid.

Order Grid Columns

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

To change the selection of columns:
1.

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.

Make sure to scroll down to see all available columns.

To move a column:
1.

Tap the header of the column, and hold.

Drag the column to the new position, and release.

To save a grid view:
1.

Tap the View (

) control. Then, tap Save Current View.

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 grid view:
Tap the View (

) control. Then, do one of the following:

To use a different view, tap the name of the view.

To change the name of a view, tap the Edit (

) icon. Then, update the name.

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Actions Control
When working with a collection of records in the grid, you can use the Actions control to apply
an operation to one or more records. The Actions control lists each operation that is available
for the specific type of data. For example, for product records, you can use the Actions control
to update the attributes of selected products, change the status from “Disabled” to “Enabled,”
or to delete records from the database. .
You can make as many changes as necessary, and then update the records in a single step. It’s
much more efficient than changing the settings individually for each product.
The selection of available actions varies by list, and additional options might appear,
depending on the action selected. For example, when changing the status of a group of records,
a Status box appears next to the Actions control with additional options.

Applying an Action to Selected Records

Step 1: Select Records
The checkbox in the first column of the list identifies each record that is a target for the action.
The filter controls can be used to narrow the list to the records you want to target for the
action.
1.

Mark the checkbox of each record that is a target for the action. Or, use one of the following
Actions to select a group of records:

Select All / Unselect All

Select All on This Page/ Deselect All on This Page

If needed, set the filters at the top of each column to show only the records that you want to
include.

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

Step 2: Apply an Action to Selected Records
1.

Set the Actions control to the operation that you want to apply.

Example: Update Attributes
1.

In the list, mark the checkbox of each record to be updated.

Set the Actions control to “Update Attributes,” and tap Submit .
The Update Attributes page lists all the available attributes, organized by group in the
panel on the left.

Update Attributes

Mark the Change checkbox next to each attribute, and make the necessary changes.

Tap Save to update the attributes for the group of selected records.

When complete, tap Submit .

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Actions
ACTION

DESCRIPTION

Select All

Marks the checkbox of all records in the list.

Unselect All

Clears the checkbox of all records in the list.

Select All on This Page

Marks the checkbox of records on the current page.

Deselect All on This Page

Clears the checkbox of records on the current page.

Actions by Grid
MENU

LIST

ACTIONS

SALES
Orders

Cancel
Hold
Unhold
Print Invoices
Print Packing Slips
Print Credit Memos
Print All
Print Shipping Labels
Move to Archive

Invoices

PDF Invoices

Shipments

PDF Shipments
Print Shipping Labels

Credit Memos

PDF Credit Memos

Catalog

Delete

PRODUCTS

Change Status
Update Attributes
CUSTOMERS
All Customers

Delete
Subscribe to Newsletter
Unsubscribe from Newsletter
Assign a Customer Group

Magento Commerce User Guide

Admin Workspace

CHAPTER 5: Store Admin

Actions by Grid (cont.)
MENU

LIST

ACTIONS
Edit

MARKETING
Communications
Newsletter Subscribers

Unsubscribe
Delete

Search Synonyms

Delete

Search Terms

Delete

Reviews

Delete

SEO & Search

User Content

Update Status
CONTENT
Elements
Pages

Delete
Disable
Enable
Edit

Blocks

Delete
Edit

REPORTS
Refresh Statistics

Refresh Lifetime Statistics
Refresh Statistics for the Last Day

STORES
Settings
Order Status

Unassign

Magento Commerce User Guide

CHAPTER 5: Store Admin

Admin Workspace

Actions by Grid (cont.)
MENU

LIST

ACTIONS

SYSTEM
Tools
Cache Management

Enable
Disable
Refresh

Backups

Delete

Index Management

Update on Save
Update by Schedule

Other Settings
Notifications

Mark as Read
Remove

Magento Commerce User Guide

Session Lifetime

CHAPTER 5: Store Admin

Session Lifetime
As a security measure, the Admin is initially set to time out after 900 seconds, or fifteen
minutes of keyboard inactivity. However, you can adjust the lifetime of the session to fit your
work style.

To set the session lifetime:
1.

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

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

Expand

In the Admin Session Lifetime (seconds) field, enter the number of seconds that a session

the Security section.

remains active before it times out.

Security
5.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 6:

Store Details
The basic information for your store includes the store name and address, telephone number
and email address, that appear on email messages, invoices, and other communications sent to
your customers.

General Configuration

Magento Commerce User Guide

Store Information

CHAPTER 6: Store Details

Store Information
The Store Information section provides the basic information that appears on sales documents
and in other communications.

Store Information

Magento Commerce User Guide

CHAPTER 6: Store Details

Store Information

To enter your store information:
1.

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

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

Expand

the Store Information section, and do the following:

Enter the Store Name that you want to use in all communications.

Enter the Store Phone Number, formatted as you want it to appear.

In the Store Hours of Operation field, enter the hours your store is open for business. For
example: Mon - Fri, 9-5, Sat 9-noon PST.

Select the Country where your business is located.

Select the Region/State with the country.

Enter the Store Address. If the address is long, continue the address on Store Address
Line 2.

If applicable, enter the VAT Number of your store. To verify the number, click the Validate
VAT Number button. To learn more, see: VAT ID Validation.

When complete, tap Save Config .

Magento Commerce User Guide

Locale Options

CHAPTER 6: Store Details

Locale Options
The locale determines the language, country, tax rate, and other settings that are used
throughout the store. The Locale Options determine the time zone and language used for each
store, and identify the days of the work week in your area.

Locale Options

To set the store locale:
1.

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

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

Expand

Select your Timezone from the list. Then, do the following:

the Locale Options section.

Set Locale to the store language.

Set Weight Unit to the unit of measurement that is typically used for shipments from your
locale.

Set First Day of the Week to the day that is considered to be the first day of the week in
your area.

In the Weekend Days list, select the days which fall on a weekend in your area. (To select
multiple options, hold down the Ctrl (PC) or Command (Mac) key.)

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 6: Store Details

State Options

State Options
In many countries, the state, province, or region is a required part of a postal address. The
information is used for shipping and billing information, to calculate tax rates, and so on. For
countries where the state is not required, the field can be omitted entirely from the address, or
included as an optional field.
Because standard address formats vary from one country to another, you can also edit the
template that is used to format the address for invoices, packing slips, and shipping labels.

State Options

To set up the state options:
1.

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

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

Expand

the State Options section, and do the following:

In the State is required for list, select each country where Region/State is a required entry.

Set the Allow to Choose State if It is Optional for Country field to one of the following:
Yes

In countries where the state field is not required, includes the State field as an
optional entry.

In countries where the state field is not required, omits the State field.

When complete, tap Save Config .

Magento Commerce User Guide

Country Options

CHAPTER 6: Store Details

Country Options
The Country Options identify the country where your business is located, and the countries
from which you accept payment.

Country Options

Magento Commerce User Guide

CHAPTER 6: Store Details

Country Options

To set the country options for your store:
1.

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

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

Expand

the Country Options section, and do the following:

Choose the Default Country where your business is located.

In the Allow Countries list, select each country from which you accept orders. By default,
all countries in the list are selected. To select multiple countries, hold down the Ctrl (PC)
or Command (Mac) key.

In the Zip/Postal Code is Optional for list, select each country where you conduct
business that does not require a ZIP or postal code to be included as part of the street
address.

In the European Union Countries list, select each country in the EU where you conduct
business. By default, all EU countries are selected.

In the Top Destinations list, select the primary countries that you target for sales.

When complete, tap Save Config .

Magento Commerce User Guide

Merchant Location

CHAPTER 6: Store Details

Merchant Location
The Merchant Location setting is used to configure payment methods. If no value is entered,
the Default Country setting is used.

Merchant Location

To enter the merchant location:

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

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

Expand

When complete, tap Save Config.

the Merchant Location section. Then, choose your Merchant Country.

Magento Commerce User Guide

CHAPTER 6: Store Details

Currency

Currency
Currency Setup
Defines the base currency and any additional currencies
that are accepted as payment. Also establishes the
import connection and schedule that is used to update
currency rates automatically.

Currency Symbols
Defines the currency symbols that appear in product
prices and sales documents such as orders and invoices.
Magento support currencies from over two hundred
countries around the world.

Updating Currency Rates
Currency rates can be updated manually or imported into
your store as needed, or according to a predefined
schedule.

Currency Chooser
If multiple currencies are available, the currency chooser
appears in the header of the store.

Magento Commerce User Guide

Store Email Addresses

CHAPTER 6: Store Details

Store Email Addresses
You can have up to five different email addresses to represent distinct functions or departments
for each store or view. In addition to the following predefined email identities, there are two
custom identities that you can set up according to your needs.
l

General Contact

Sales Representative

Customer Support

Each identity and its associated email address can be associated with specific automated email
messages and appear as the sender of email messages that are sent from your store.
Process Overview:
Step 1: Set Up the Email Addresses for Your Domain
Step 2: Configure the Email Addresses for Your Store
Step 3: Update the Sales Email Configuration

Step 1: Set Up the Email Addresses for Your Domain
Before you can configure email addresses for the store, each must be set up as a valid email
address for your domain. Follow the instructions from your server administrator or email
hosting provider to create each email addresses that is needed.

Step 2: Configure the Email Addresses for Your Store
1.

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

In the panel on the left under General, choose Store Email Addresses.

Expand

the General Contact section, and do the following:

General Contact

In the Sender Name field, type the name of the person to appear as the sender of any
email messages that is associated with the General Contact identity.

In the Sender Email field, type the associated email address.

Repeat this process for each store email addresses that you plan to use.

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 6: Store Details

Store Email Addresses

Step 3: Update the Sales Email Configuration
If you use custom email addresses, make sure to update the configuration of any related email
messages, so the correct identity appears as the sender.
1.

In the panel on the left, under Sales, choose Sales Emails. The page has a separate section for
each of the following:

Order and Order Comments

Invoice and Invoice Comments

Shipment and Shipment Comments

Credit Memo and Credit Memo Comments

RMA, RMA Authorization, RMA Admin Comments, and RMA Customer Comments

Starting with Order, expand the section for each message, and make sure that the correct
sender is selected.

Sales Email Order Configuration
3.

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 6: Store Details

Contact Us
The Contact Us link in the footer of the store is an easy way for customers to keep in touch with
you. Customers can complete the form to send a message to your store.

Magento Commerce User Guide

CHAPTER 6: Store Details

To configure Contact Us:
1.

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

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

Expand

the Contact Us section. If necessary, set Enable Contact Us to “Yes.”

Expand

the Email Options section. Then, do the following:

Email Options
a.

In the Send Emails to field, enter the email address where messages from the Contact Us
form are sent.

Set Email Sender to the store identity that appears as the sender of the message from the
Contact Us form. For example: Custom Email 2.

Set Email Template to the template that is used for messages sent from the Contact Us
form.

When compete, tap Save Config.

To customize the content:
The Luma sample data includes a Contact Us Info block that can be customized for your store.
The contact-us-info block can be easily modified to add your own content to the Contact Us”
page.
1.

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

Find the Contact Us Info block in the list, and open in Edit mode.

Magento Commerce User Guide

CHAPTER 6: Store Details

Scroll down to the Content field, and make any changes necessary.
l

Use the editor toolbar to format the text, and add images and links.

Tap Show / Hide Editor to work directly with the HTML.

When complete, tap Save Block.

Magento Commerce User Guide

CHAPTER 7:

Storefront Branding
One of the first things you’ll want to do is to change the logo in the header, and upload a
favicon for the browser. You’ll also want to update the copyright notice in the footer,. These are
a few simple design tasks that you can take care of right away. While your store is in
development, you can turn on the store demo notice, and then remove it when you’re ready to
launch.

Storefront Branding

Magento Commerce User Guide

Uploading Your Logo

CHAPTER 7: Storefront Branding

Uploading Your Logo
The size and location of the logo in the header is determined by the store’s theme. Your logo
can be saved as either a GIF, PNG, or JPG (JPEG) file type, and uploaded from the Admin of
your store.

Logo in Header
The logo image resides in the following location on the server. Any image file with the name
“logo.gif” is used as the default theme logo.
Full path:

app/design/frontend/[vendor]/[theme]/web/images/logo.gif

Relative path:

images/logo.gif

If you don’t know the size of the logo, or any other image that is used in your theme, open the
page in a browser, right-click the image, and inspect the element.
In addition to the logo in the header, your logo also appears on email templates and on PDF
invoices and other sales documents. The logos used for email templates and invoices have
different size requirements, and must be uploaded separately. To learn more, see:
Communications.

Magento Commerce User Guide

CHAPTER 7: Storefront Branding

Uploading Your Logo

To upload your logo:
1.

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

Design Configuration
2.

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

Expand

the Header section. Then, do the following:

Header

To upload a new logo, tap Upload. Then, choose the file from your computer.

Enter the Logo Image Width and Logo Image Height.

In the Logo Image Alt field, enter the text that you want to appear when someone hovers
over the image.

When complete, tap Save Configuration.

Magento Commerce User Guide

Uploading Your Logo

CHAPTER 7: Storefront Branding

Logo File Formats
FILE FORMAT

100

DESCRIPTION

PNG

(Portable Network Graphics) This newer alternative to the GIF format
supports up to 16 million colors (24 bit). The lossless compression
format produces a high-quality bitmap image with crisp text, but a
larger file size than some formats. The PNG format supports
transparent layers, and is designed to be both viewed and streamed
online.

GIF

(Graphics Interchange Format) A widely supported, and older bitmap
format that is limited to 256 (8 bit) colors. The GIF format supports
simple animation and transparent layers.

JPG (JPEG)

(Joint Photographics Expert Group) A compressed bitmap format that
is used by most digital cameras. The lossy compression causes
some data loss, which is sometimes noticeable as blurry spots in
text.

Magento Commerce User Guide

CHAPTER 7: Storefront Branding

Adding a Favicon

Adding a Favicon
Favicon is short for “favorite icon,” and refers to the little icon on the tab of each browser page.
Depending on the browser, the favicon also appears in address bar, just before the URL.
Favicons are generally 16 x 16 pixels or 32 x 32 pixels in size. Magento accepts ICO, PNG,
APNG, GIF, and JPG (JPEG) file types, although not all browsers support these formats. The
most widely-supported file format to use for a favicon is ICO. Other image file types can be
used, although the format might not be supported by all browsers. There are many free tools
available online that you can use to generate an ICO image or convert an exiting image to the
format.

Favicon in Address Bar

Process Overview:
Step 1: Create a Favicon
Step 2: Upload the Favicon to Your Store
Step 3: Refresh the Cache

Step 1: Create a Favicon
1.

Create a 16 x 16 or 32 x 32 graphic image of your logo, using the image editor of your choice.

(Optional) Use one of the available online tools to convert the file to the .ico format. Then, save
the file to your computer.

Step 2: Upload the Favicon to Your Store
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.

Under Other Settings, expand

Magento Commerce User Guide

the HTML Head section. Then, do the following:

101

Adding a Favicon

CHAPTER 7: Storefront Branding

HTML Head
a.

Tap Upload. Then, navigate to the favicon file that you prepared, and tap Open.

Favicon
b.

If you want to delete the current favicon, tap Delete (
image. Then, upload another.

) in the lower-left corner of the

When complete, tap Save Configuration.

Step 3: Refresh the Cache
1.

When prompted to refresh the cache, click the Cache Management link in the message at the
top of the workspace.

102

In the list, mark the Page Cache checkbox that is marked “Invalidated.”

Set Actions to “Refresh.” Then, tap Submit.

To view the new favicon, return to your storefront and press F5 to refresh the browser.

Magento Commerce User Guide

CHAPTER 7: Storefront Branding

Adding a Favicon

Favicon File Formats
FILE FORMAT

DESCRIPTION

PNG

APNG

(Animated Portable Network Graphics) A file format similar to PNG
that supports simple animation.

GIF

(Graphics Interchange Format) A widely-supported, and older bitmap
format that is limited to 256 (8 bit) colors. The GIF format supports
simple animation and transparent layers.

JPG (JPEG)

(Joint Photographics Expert Group) A compressed bitmap format that
is used by most digital cameras. The lossy compression causes
some data loss, which is sometimes noticeable as blurry spots in
text.

Magento Commerce User Guide

103

Welcome Message

CHAPTER 7: Storefront Branding

Welcome Message
The Welcome message in the header expands to include the name of the customer who is
logged in. Before you launch your store, be sure to change the default Welcome text for each
store view.

Welcome Message

To change the welcome message:
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. Then, do the following:

Design Configuration

104

Under Other Settings, expand

the Header section.

Enter the Welcome Text that you want to appear in the header of your store.

Magento Commerce User Guide

CHAPTER 7: Storefront Branding

Header
3.

When complete, tap Save Configuration.

When prompted to update the Page Cache, click the Cache Management link at the top of the
workspace. Then, follow the instructions to refresh the cache.

Copyright Notice
Your store has a copyright notice in the footer of each page. As a best practice, the copyright
notice should include the current year, and identify your company as the legal owner of the
content on the site.

Copyright Notice
The &Copy; character code is used to insert the copyright symbol, as shown in the following
examples:
Long Format Example

To change the copyright notice:
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, and do the following:

Magento Commerce User Guide

105

CHAPTER 7: Storefront Branding

Design Configuration
a.

Under Other Settings, expand

the Footer section.

Footer
b.

106

In the Copyright box, enter the copyright notice that you want to appear in the footer of
each page. Use the &Copy; character code to insert a copyright symbol.

When complete, tap Save Configuration.

Magento Commerce User Guide

CHAPTER 7: Storefront Branding

Store Demo Notice

Store Demo Notice
If your store is online, but still under construction, you can display a store demo notice at the
top of the page to let people know that the store is not yet open for business. When you are
ready to “go live,” simply remove the message. It’s like flipping the sign hanging in the window
from “Closed” to “Open.” The format of the demo notice is determined by the theme of your
store.

Store Demo Notice

To set the store demo notice:
1.

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

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

Under Other Settings, expand

Scroll down to the bottom, and set the Display Demo Store Notice to your preference.

Magento Commerce User Guide

107

Store Demo Notice

CHAPTER 7: Storefront Branding

HTML Head
5.

108

When complete, tap Save Configuration.

Magento Commerce User Guide

CHAPTER 8:

Websites, Stores & Views
Every Magento installation has a hierarchy of website(s), store(s), and store view(s). The term
“scope” determines where in the hierarchy a database entity — such as a product, attribute, or
category — content element, or configuration setting applies. Websites, stores, and store views
have one-to-many parent/child relationships. A single installation can have multiple websites,
and each website can have multiple stores and store views.

Websites
Magento installations begin with a single website which
by default, is called “Main Website.” You can also set up
multiple websites for a single installation, each with its
own IP address and domain.

Stores
A single website can have multiple stores, each with its
own main menu. The stores share the same product
catalog, but can have a different selection of products
and design. All stores under the same website share the
same Admin and checkout.

Store Views
Each store that is available to customers is presented
according to a specific "view". Initially, a store has a
single default view. Additional store views can be added
to support different languages, or for other purposes.
Customers can use the language chooser in the header
to change the store view.

Magento Commerce User Guide

109

Scope

CHAPTER 8: Websites, Stores & Views

Scope
If your Magento installation has a hierarchy of websites, stores, or views, you can set the
context, or “scope” of a configuration setting to apply to a specific part of the installation. The
context of many database entities can also be assigned a specific scope to determine how it is
used in the store hierarchy. To learn more, see: Product Scope and Price Scope.
Some configuration settings such as postal code, have a [global] scope because the same value
is used throughout the system. The [website] scope applies to any stores below that level in the
hierarchy, including all stores and their views. Any item with the scope of [store view] can be
set differently for each store view, which is typically used to support multiple languages.
Unless the store is running in Single Store Mode, the scope of each configuration setting
appears in small text below the field label. If your installation includes multiple websites,
stores or views, you should always choose the Store View where the settings apply before
making any changes.

Hierarchy of Websites, Stores, and Store Views

Scope Settings
SCOPE

110

DESCRIPTION

Global

System-wide settings and resources that are available throughout the
Magento installation.

Website

Settings and resources that are limited to the current website. Each
website has a default store.

Store

Settings and resources that are limited to the current store. Each
store has a default root category (main menu) and default store view.

Store View

Setting and resources that are limited to the current store view.

Magento Commerce User Guide

CHAPTER 8: Websites, Stores & Views

Scope

Changing Scope
The Store View chooser in the upper-left corner of many Admin pages filters the view of the
page for a specific scope, and also sets the value of some entities that are used by Magento. It
lists each level in the hierarchy by name, and is used to change the scope to another level. Any
settings that represent the current scope are grayed out, so only those that represent the
current scope setting are available. The scope is initially set to “Default Config.” For Admin
users with restricted access, the list of available store views includes only those to which the
user has permission to access.
The checkbox to the right of many configuration settings can be used to either apply or override
the default setting, according to the current scope. The field value cannot be changed when the
checkbox is marked. To change the current value, first clear the checkbox, and then enter the
new value. You are prompted to confirm whenever you change scope. The checkbox label
changes according to the current scope, and always refers to the parent level which is one step
up in the hierarchy. Because the parent level is a container for all the items below that level,
the value from the parent level is inherited. unless it is overridden.

Default Config with "Use System Value" Checkboxes

To set the configuration scope:
Before making a configuration setting that applies only to a specific website, store, or store
view, do the following:
1.

On the Admin sidebar, do one of the following:
l

For most configuration settings, tap Stores. Then under Settings, choose Configuration.
For design-related settings, tap Content. Under Design, choose Configuration. Then in the
grid, choose the applicable store view.

Navigate to the configuration setting to be changed. Then, do the following:

Magento Commerce User Guide

111

Scope

CHAPTER 8: Websites, Stores & Views

In the upper-left corner, set Store View to the specific view where the configuration
applies. When prompted to confirm scope switching, tap OK .
A checkbox appears after each field, and additional fields might become available.

Clear the Use system value checkbox after any field that you want to edit. Then, update
the value for the view.

Repeat this process for every field that needs to be updated on the page.

When complete, tap Save Config .

Setting the Locale of the French Store View

Store Hierarchy
LEVEL

112

DESCRIPTION

Default Config

The default system configuration.

Main Website

The name of the website at the top of the hierarchy.

Main Website Store

The name of the default store that is associated with the parent
website.

Default Store View

The name of the default store view that is associated with the parent
store.

Stores Configuration

Jumps to the Stores grid, and is the same as choosing Stores > All
Stores from the Admin sidebar.

Magento Commerce User Guide

CHAPTER 8: Websites, Stores & Views

Scope

Default Value Options
CHECKBOX

DESCRIPTION

Use system value

The “Use system value” checkbox appears when the configuration
scope is set to “Default Config.”

Use Default

The “Use Default” checkbox appears when the configuration scope is
set to “Main Website,” and refers to the default store that is assigned
to the website.

Use Website

The “Use Website” checkbox appears when the configuration scope
set to a specific store view. When marked, it uses the setting from
the parent website that is associated with the store view. In this
case, the store level is skipped because it is understood to apply to
the default store that is associated with the website.

Magento Commerce User Guide

113

Scope

CHAPTER 8: Websites, Stores & Views

Catalog Scope
Magento uses the term “catalog” to refer to the product database as a whole. Access to catalog
data is determined by several factors, including the scope setting, the catalog configuration,
and the root category that is assigned to the store. The catalog includes products that are
enabled and available for sale, as well as those that are currently not offered for sale.
In sales, the term “catalog” usually refers to a curated selection of products that is available for
sale. For example, a store might have a “Spring Catalog” and a “Fall Catalog”.
Like the table of contents of a printed catalog, the main menu of your store — or “top
navigation” — organizes products by category to make it easy for customers to find what they
want. The main menu is based on a “root category,” which is a container for the menu that is
assigned to the store. Because the specific menu options are defined at the store view level,
each view can have a different main menu based on the same root category. Within each menu,
you can offer a curated selection of products that is suitable for the store.

Product Catalog in Store Hierarchy

114

Magento Commerce User Guide

CHAPTER 8: Websites, Stores & Views

Scope

Product Scope
For installations with multiple websites, stores, and views, the scope setting determines where
products are available for sale, and the product information that is available for each store
view. Initially, all products that you create are published to the default website, store, and store
view.

Multisite Installation
If you have only a single store with the default view, you can run your store in Single Store
Mode to hide the scope settings. However, if your store has multiple views, a scope indicator
appears below the name of each field.
l

To edit product information for a specific view, use the Store View control in the upper-left
corner to choose the view. Additional controls become available for any field that can be
edited at the store view level.
To define the scope of a product in a multisite installation, see the Product in Websites
section of product information.

The process of editing a product for a store view is like adding a layer of product information
that is specific to the view.
Although the Spanish store view is selected in the following example, the product information
still appears in the original language of the default store view. To translate the product
information, you must switch to the Spanish view, and translate the text fields — such as
product title, description, and the meta data. To learn more, see: Translating Products.

Magento Commerce User Guide

115

Scope

CHAPTER 8: Websites, Stores & Views

To edit a product for a different view:
1.

In the upper-left corner, set Store View to the specific view to be edited. When prompted to
confirm, tap OK to switch scope.

Store View
2.

A checkbox appears below any field that can be edited for the store view. To override the default
value, clear the Use Default Value checkbox. Then, update the field with the new value for the
store view.

Translating Product Name for Spanish Store View
3.

When complete, tap Save .

In the upper-left corner, set the Store View chooser back to the default.

To verify the change in your store, do the following:
a.

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

Customer View
b.

116

In the upper-right corner of the store, set the Language Chooser to the store view of the
product that you edited. Then, find the product that you edited for the view.

Magento Commerce User Guide

CHAPTER 8: Websites, Stores & Views

Scope

Price Scope
The scope of the base currency that is used for product prices can be configured to apply at
either the global or website level. If applied at the global level, the same price is used
throughout the store hierarchy. If the price configuration is set to the website level, the same
product can be available at different prices in different stores. By default, the scope of product
pricing is global.
Different factors can affect the price of the same product in one location and not another. For
example, there might be additional costs to bring the product to market, and other
considerations that impact the price of products sold in a specific store. The following
illustration shows a multisite installation with the base currency set to the website level. In
each store, the same product has a different price.

Price Scope

Magento Commerce User Guide

117

Scope

CHAPTER 8: Websites, Stores & Views

To configure price scope:
1.

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

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

Scroll down to the Price section. Then, set Catalog Price Scope to one of the following:
l

Global

Website

The scope setting that you choose appears below price fields in your catalog.

Catalog Price Scope
4.

118

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 8: Websites, Stores & Views

Scope

Customer Account Scope
The scope of customer accounts can be limited to the website where the account was created, or
shared with all websites and stores in the store hierarchy.

To set the scope of customer accounts:
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 Account Sharing Options section.

Account Sharing Options
4.

If necessary, clear the User system value checkbox. Then, set Share Customer Accounts to
one of the following:

Global

Shares customer account information with every website and store in the
Magento installation.

Per Website

Limits customer account information to the website where the account was
created.

When complete, tap Save Config.

Magento Commerce User Guide

119

Scope

CHAPTER 8: Websites, Stores & Views

Scope Quick Reference
SCOPE

DESCRIPTION

GLOBAL
Admin

All websites, stores, and store views in the installation are managed
from the same Admin.

Default Config

The global default configuration settings are used through the store
hierarchy, unless they are overridden at a lower level.

Catalog

The term “catalog” refers to the product database as a whole, and is
available throughout the installation.

Product Prices

Product prices can be configured to be applied at either a global or
website level.

Product Configurations

Attributes that are used as configurable product options must have a
global scope.

Customers

Customer accounts can be configured to be applied at a global or
website level. Each website can have a separate set of customer
accounts, or share the same customer accounts with other websites
in the installation.

WEBSITE

120

Domain

Additional websites can be set up as subdomains of the primary
domain, or have separate IP addresses and dedicated domains.

Customers

Currency

Each website can be assigned a different base currency. The base
currency is used to process all transactions, although a different
display currency might appear to the customer, according to the
locale of the store view.

Products

Individual products are assigned to the hierarchy at the website level.
The Products grid lists all products in the catalog, and the websites
where they are available.The Product in Websites setting identifies
each website where the product is available.

Magento Commerce User Guide

CHAPTER 8: Websites, Stores & Views

SCOPE

Scope

DESCRIPTION

Product Prices

Product prices can be configured to be applied at either a global or
website level.

Payment Methods

Payment methods are configured at the website level, although the
title and instructions can be configured for each store view.

Checkout

The checkout process takes place at the website level, although
some display options can be configured for each store view.All stores
associated with a website have the same checkout configuration.

STORE
Root Category

Each store can have a separate set of products and main menu that
is based on a “root” category and subcategories. Each catalog has a
root category that is assigned at the store level.

STORE VIEW
Subcategories

The subcategories that make up the main menu (under the root) are
assigned at the store view level.

Locale

Each store view can be assigned a different locale. The display
currency, units of measurement, and most of the Admin interface are
specific to the locale.

Languages

To support multiple languages, all content, including product
descriptions, must be translated for each store view.

Display Currency

A different display currency can be used for each store view,
although the transactions are processed at the website level using
the base currency.

Magento Commerce User Guide

121

Single Store Mode

CHAPTER 8: Websites, Stores & Views

Single Store Mode
If your Magento installation has only a single store and store view, you can simplify the
display by turning off all store view options and scope indicators. Most of the screenshots in
this guide were taken with Single Store Mode disabled to show the scope indicator for each
setting. Single Store Mode is overridden if you add more store views later.

Single Website, Store, and View

To set single store mode:
1.

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

Under General, scroll down to the bottom of the page, and expand the Single-Store Mode
section.

Set Enable Single-Store Mode to “Yes.”

Single Store Mode
4.

122

Tap Save Config .

Magento Commerce User Guide

CHAPTER 8: Websites, Stores & Views

Single Store Mode

When prompted to refresh the cache, do the following:
a.

Tap the Cache Management link in the system message at the top of the page.

System Message
b.

Mark the Page Cache checkbox.

With Actions set to “Refresh,” tap Submit .

Magento Commerce User Guide

123

124

Magento Commerce User Guide

CHAPTER 9:

Industry Compliance
Magento Commerce offers a range of security and privacy capabilities that meet legal
requirements and industry guidelines for online merchants. Some are mandated by the
payment card industry, and others are required by law, depending on your location.
l

Legal Requirements

Industry Guidelines

Best Practices

In this chapter, you will learn about PCI compliance, and the importance of establishing
procedures to protect payment information. You will also learn how to bring your store into
compliance with the Cookie Law, which is a requirement in some countries, and considered a
“best practice” in others. In addition, you will learn how to customize and maintain a privacy
policy for your store.

Magento Commerce User Guide

125

PCI Compliance Guidelines

CHAPTER 9: Industry Compliance

PCI Compliance Guidelines
The Payment Card Industry (PCI) has established a set of requirements for businesses that
accept payment by credit card over the Internet. In addition to maintaining a secure server
environment, merchants who handle customer credit card information must meet the following
guidelines:

PCI Requirements
Install and maintain a firewall configuration to protect cardholder data.
Do not use vendor-supplied defaults for system passwords and other security
parameters.
Protect stored cardholder data.
Encrypt transmission of cardholder data across open, public networks.
Use and regularly update antivirus software.
Develop and maintain secure systems and applications.
Restrict access to cardholder data by business need to know.
Assign a unique ID to each person with computer access.
Restrict physical access to cardholder data.
Track and monitor all access to network resources and cardholder data.
Regularly test security systems and processes.
Maintain a policy that addresses information security.

To learn more, see: Magento Approach to PCI Compliance.
As your business grows, you may be required to file a compliance report on an annual basis.
PCI reporting requirements increase in proportion to merchant level, but are waived for
businesses that process fewer than 20,000 credit card transactions per year. To learn more,
visit the PCI Security Standards Council website.

126

Magento Commerce User Guide

CHAPTER 9: Industry Compliance

Privacy Policy
Your store includes a sample privacy policy that must be updated with your own information.
Your privacy policy should describe the type of information that your company collects, and
how it is used. It should also list the filenames of cookies that are placed on the computers of
people who visit your store. Any additional cookies that are associated with third-party
extensions and add-ons should be included in the list.

To edit your privacy policy:
The Luma sample data includes a sample privacy policy that you can modify for your use..
1.

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

In the grid, find Privacy Policy. Then in the Action column, set Select to Edit.

Expand the Content section, and make the necessary changes to the content. To learn more,
see: Using the Editor.

Magento Commerce User Guide

127

CHAPTER 9: Industry Compliance

Content
If you change the URL key of the privacy policy page, you must also create a custom URL rewrite to
redirect traffic to the new URL key. Otherwise, the link in the footer will return “404 Page Not
Found.”

128

When complete, tap Save Page .

Magento Commerce User Guide

CHAPTER 9: Industry Compliance

Cookie Law Compliance

Cookie Law Compliance
Cookies are small files that are saved to the computer of each visitor to your site, and used as
temporary holding places for information. Information that is saved in cookies is used to
personalize the shopping experience, link visitors to their shopping carts, measure traffic
patterns, and improve the effectiveness of promotions. To keep pace with legislation in many
countries regarding the use of cookies, Magento offers merchants a choice of methods for
obtaining customer consent:

Method 1: Implied Consent
Implied consent means that visitors to your store have a clear understanding that cookies are a
necessary part of operations, and by using your site, have indirectly granted permission to use
them. The key to gaining implied consent is to provide enough information for a visitor to
make an informed decision. Many stores display a message at the top of all standard pages
that provides a brief overview of how cookies are used, with a link to the store’s privacy policy.
The privacy policy should describe the type of information that your store collects, and how it
is used.

Method 2: Expressed Consent
Operating your store in cookie restriction mode requires visitors to express their consent before
any cookies can be saved to their computers. Unless consent is granted, many features of your
store will be unavailable. For example, if Google Analytics is available for your store, it can be
invoked only after the visitor has granted permission to use cookies.

Magento Commerce User Guide

129

Cookie Law Compliance

CHAPTER 9: Industry Compliance

Cookie Restriction Mode
When Cookie Restriction Mode is enabled, visitors to your store are notified that cookies are
required for full-featured operations. Depending on your theme, the message might appear
above the header, below the footer, or somewhere else on the page. The message links to your
privacy policy for more information, and encourages visitors to click the Allow button to grant
consent. After consent is granted, the message disappears.
Your privacy policy should include the name of your store and contact information, and
explain the purpose of each cookie that is used by your store. To learn more, see: Cookie
Reference.
If you change the URL key of the privacy policy, you must also create a custom URL rewrite to
redirect traffic to the new URL key. Otherwise, the link in the Cookie Restriction Mode message will
return “404 Page Not Found.”

Cookie Restriction Notice In Footer

130

Magento Commerce User Guide

CHAPTER 9: Industry Compliance

Cookie Law Compliance

Step 1: Enable Cookie Restriction Mode
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 Cookie Settings
section, and do the following:

Default Cookie Settings
a.

Enter the Cookie Lifetime in seconds.

If you want to make cookies available to other folders, enter the Cookie Path. To make the
cookies available anywhere in the site, enter a forward slash.

To make the cookies available to a subdomain, enter the subdomain name in the Cookie
Domain field. (subdomain.yourdomain.com) To make cookies available to all subdomains,
enter the domain name preceded by a period. (.yourdomain.com)

To prevent scripting languages such as JavaScript from gaining access to cookies, make
sure that Use HTTP Only is set to “Yes.”

Set Cookie Restriction Mode to “Yes.”
If necessary, clear the checkbox, and tap OK to confirm scope switching.

When complete, tap Save Config .

When prompted to update the cache, click the Cache Management link in the system message.
Then, refresh each invalid cache.

Step 2: Update Your Privacy Policy
Update your privacy policy as needed to describe the information that your company collects,
and how it is used.

Magento Commerce User Guide

131

Cookie Law Compliance

CHAPTER 9: Industry Compliance

Cookie Reference
Magento Standard Cookies
COOKIE NAME

132

COOKIE DESCRIPTION

CART

The association with the customer's shopping cart.

CATEGORY_INFO

Stores the category info on the page to load pages faster.

COMPARE

The items in the customer's Compare Products list.

CUSTOMER

An encrypted version of the shopper's customer ID.

CUSTOMER_AUTH

Indicates if the customer are currently logged in to the store.

CUSTOMER_INFO

An encrypted version of the shopper's customer group.

EXTERNAL_NO_CACHE

Indicates if caching is disabled or enabled.

FRONTEND

The customer's session ID.

GUEST-VIEW

Determines if guests can edit their orders.

LAST_CATEGORY

The last category visited by the shopper.

LAST_PRODUCT

The most recent product viewed by the shopper.

NEWMESSAGE

Indicates whether a new message has been received.

NO_CACHE

Indicates if the cache can be used to store information.

PERSISTENT_SHOPPING_CART

A link to information about the shopper's cart and viewing
history.

RECENTLYCOMPARED

Items recently compared b the shopper.

STF

Information on products the shopper has emailed to friends.

STORE

The store view or language chosen by the shopper.

USER_ALLOWED_SAVE_COOKIE

Indicates if the shopper allows cookies to be saved.

Magento Commerce User Guide

CHAPTER 9: Industry Compliance

Cookie Law Compliance

Magento Standard Cookies (cont.)
COOKIE NAME

COOKIE DESCRIPTION

VIEWED_PRODUCT_IDS

The products recently viewed by the shopper.

WISHLIST

An encrypted list of products added to the shopper's wishlist.

WISHLIST_CNT

The number of items in the shopper's wishlist.

Google Analytics Cookies
COOKIE

DESCRIPTION

_utma

Identifies shoppers and sessions.

_utmb

Determines new sessions/visits.

_utmc

Determines if the shopper is in a new session/visit.

_utmz

Saves the traffic source or campaign that explains how the
shopper reached your site.

Magento Commerce User Guide

133

134

Magento Commerce User Guide

CATALOG

135

Contents
Catalog Menu
Catalog URLs

Bundle Items
Managing Pricing
Advanced Pricing
Group Pricing

Products Grid
Creating Products
Product Workspace
Default Field Values
Scheduled Changes
Product Types

Special Pricing
Tier Pricing
Minimum Advertised Price
Managing Inventory
Stock Options
Product Alerts

Simple Product
Configurable Product
Grouped Product
Virtual Product
Bundle Product
Downloadable Product
Download Options
Gift Cards
Gift Card Workflow

Images and Videos
Uploading Product Images
Adding Product Video
Media Gallery
Placeholders
Watermarks
Swatches
Categories

Creating a Gift Card

Best Practices

Gift Card Accounts

Creating Categories

Configuring Gift Card Accounts
Product Settings
Advanced Settings
Other Settings
Content
Configurations
Product Reviews
Images and Videos
Search Engine Optimization
Related Products, Up-sells, and Cross-sells
Customizable Options

Root Categories
Hidden Categories
Scheduled Changes
Content Settings
Display Settings
Search Engine Optimization
Products in Category
Sorting Category Products
Design Settings
Category Permissions
Using Product Attributes

Product in Websites

Best Practices

Design

Adding an Attribute

Autosettings

Attribute Input Types

Gift Options
Downloadable Information
Grouped Products

136

Using a Flat Catalog

CHAPTER 10:

Catalog Menu
The Catalog Menu provides easy access to product creation, category and inventory
management tools.

Catalog Menu

To display the Catalog menu:
On the Admin sidebar, tap Catalog .

Magento Commerce User Guide

137

Menu Options

CHAPTER 10: Catalog Menu

Menu Options
Products
Create new products of every type, and manage your
inventory.

Categories
Create the category structure that is the foundation of
your store’s navigation.

138

Magento Commerce User Guide

CHAPTER 10: Catalog Menu

Catalog URLs

Catalog URLs
The URLs you assign to products and categories play a major role in determining how well
your site is indexed by search engines. Before you start building your catalog is an ideal time to
consider the available options.

URL Formats
Dynamic URL
A dynamic URL is created “on the fly,” and might include a query string with variables for the
product ID, sort order, and the page where the request was made. When a customer searches
for a product in your store, the resulting URL might look something like this:
http://mystore.com/catalogsearch/result/?q=racer+back
http://mystore.com/women/tops-women.html?style_general=135

Static URL
A static URL is a fixed address for a specific page. A static URL can be displayed in a searchengine friendly format, or one that references products and categories by ID. Search-engine
friendly URLs include words that people might use to look for a product, and require Web
Server Rewrites to be enabled. Files with static URLs are commonly used for product and
category pages, content pages, and theme assets.
http://mystore.com/antonia-racer-tank.html

URL Components
URL Key
The URL key is the part of a static URL that describes the product or category. When you
create a product or category, an initial URL key is automatically generated, based on the
name. To change the URL key, see the Search Engine Optimization section of the product
information.
The URL key should consist of lowercase characters with hyphens to separate words. A welldesigned, “search engine friendly” URL key might include the product name and key words to
improve the way it is indexed by search engines. The URL key can be configured to create an
automatic redirect if the URL key changes.

Magento Commerce User Guide

139

Catalog URLs

CHAPTER 10: Catalog Menu

HTML Suffix
Your catalog can be configured to either include or exclude the suffix as part of category and
product URLs. There are various reasons why people might choose to use or to omit the suffix.
Some believe that the suffix no longer serves any useful purpose, and that pages without a
suffix are indexed more effectively by search engines. However, your company might have a
standardized format for URLs that requires a suffix.
Because the suffix is controlled by the system configuration, you should never type it directly
into the URL key of a category or product. (Doing so will result in a double suffix at the end of
the URL.) Whether you decide to use the suffix or not, be consistent and use the same setting
for all your product and category pages. Here are examples of URLs with—and withou—a
suffix.
http://mystore.com/helena-hooded-fleece.html
http://mystore.com/helena-hooded-fleece.htm
http://mystore.com/helena-hooded-fleece

Category Path
You can configure the URL to either include or exclude the category path. By default, the
category path is included in all category and product pages. The following examples show the
same product URL with, and without, the category path.
URL with Category Path

http://mystore.com/women/tops-women/hoodies-and-sweatshirts-women/helenahooded-fleece.html
URL without Category Path

http://mystore.com/helena-hooded-fleece.html

To prevent search engines from indexing multiple URLs that lead to the same content, you can
exclude the category path from the URL. Another method is to use a canonical meta tag to let
search engines know which URLs to index and which to ignore. By default, Magento does not
include the category path in product URLs.

140

Magento Commerce User Guide

CHAPTER 10: Catalog Menu

Catalog URLs

To configure catalog URLs:
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 Search Engine Optimizations section, and do the following:

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

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

Set Use Categories Path for Product URLs to your preference.

Search Engine Optimization
4.

When complete, tap Save Config .

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

Refresh Cache

Magento Commerce User Guide

141

142

Magento Commerce User Guide

CHAPTER 11:

Products Grid
All products in the catalog are accessible from the Products page, where you can create new
products and edit existing ones. For a multisite installation, each website can offer a different
selection of products for sale from the same catalog.
The Products grid lists all products in the catalog, indicates the website(s) where they are
available, and if they are currently enabled for sale.
You can browse through the list page by page, or search for specific products. Use the standard
controls to sort and filter the list, and apply actions to selected products.

Products Grid

Magento Commerce User Guide

143

CHAPTER 11: Products Grid

Workspace Controls
CONTROL
Add Product

DESCRIPTION
Initiates the process to create a new simple product. To choose a
specific product type, click the down arrow. Options:
Simple Product
Configurable Product
Grouped Product
Virtual Product
Bundle Product
Downloadable Product
Gift Card

Actions

Lists all actions that can be applied to selected products in the list. To
apply an action to a product or group of products, mark the checkbox
in the first column of each product. Options:
Delete
Change Status
Update Attributes

Filters

Initiates a catalog search based on the current filters.

[Default] View

Indicates the current grid column layout. If there are saved grid
column views, you can choose another.

Columns

Lists all actions that can be applied to selected products in the list. To
apply an action to a product or group of products, mark the checkbox
in the first column of each product. Product list actions include:
Delete
Change Status
Update Attributes
Use the Columns control to customize the selection of columns in
the grid.

144

Actions

Can be used to select multiple records as the target of action. The
checkbox is marked in the first column of each selected record.
Options: Select/Deselect All

Edit

Opens the product in edit mode. You can accomplish the same thing
by clicking anywhere on the row.

Magento Commerce User Guide

CHAPTER 11: Products Grid

Default Columns
COLUMN
(Checkbox)

DESCRIPTION
Selects multiple records to be subject to an action. The checkbox in
the first column of each selected record is marked . Options:
Select All

Selects all records found that match the current filter
settings.

Select All on Selects only the records found on the current page
This Page
that match the filter settings.
ID

A unique, sequential number that is assigned when a new product is
saved for the first time.

Thumbnail

Displays a thumbnail of the main product image.

Name

The product name.

Type

The product type.

Attribute Set

The name of the attribute set that is used as a template for the
product.

SKU

The unique Stock Keeping Unit that is assigned to the product.

Price

The unit price of the product.

Quantity

The quantity that is currently in stock.

Visibility

Indicates where the product is visible in the catalog. Options:
Not Visible Individually
Catalog
Search
Catalog, Search

Status

Indicates the current status of the product. Options:
Enabled
Disabled

Websites

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

Action

Opens the product in Edit mode.

Magento Commerce User Guide

145

146

Magento Commerce User Guide

CHAPTER 12:

Creating Products
Choosing a product type is one of the first things you must do to create a new product. In this
chapter, you will learn how to create a product of each type. In addition to the basic product
types, the term, complex product 1 is sometimes used to refer to products with multiple
options, such as a configurable product that is available in various colors and sizes. To learn
more about the available options, see Basic Settings and Advanced Settings.
If you are just starting out, you can create a few sample products to experiment with each
product type. For a deeper understanding, make sure to read about catalog navigation, how to
set up categories and attributes, and the catalog URL options that are available to you.
After you learn the basics, the most efficient way to add a large number of products to the
catalog is to import them from a CSV file.

Product Catalog

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

Magento Commerce User Guide

147

Product Workspace

CHAPTER 12: Creating Products

Product Workspace
The product workspace is basically the same for all product types, although the selection of
fields changes depending on the attribute set that is used. The product attributes are at the top
of the form, followed by expandable sections of product information. When a new product is
saved for the first time, the Store View chooser appears in the upper-left of the form.

Product Workspace

148

Magento Commerce User Guide

CHAPTER 12: Creating Products

Product Workspace

Enable Product
The online status of the product is indicated by the switch at the top of the form. To change
the online status, simply set the Enable Product switch to the “Yes” or “No” position.

CONTROL

DESCRIPTION
Indicates that the product is currently online.

Indicates that the product is currently offline.

Attribute Set
The name of the attribute set appears in the upper-left corner, and determines the fields that
appear in the product record. To choose a different attribute set, click the down arrow next to
the default attribute set name.

Attribute Sets

Expand/Collapse
To expand or collapse a section, tap either the expand

Magento Commerce User Guide

or collapse

button to the right.

149

Product Workspace

CHAPTER 12: Creating Products

Save Menu
The Save menu includes several options that let you save and continue, save and create a new
product, save and duplicate the product, or save and close.

Save Menu

COMMAND

150

DESCRIPTION

Save

Save the current product, and continue working.

Save & New

Save and close the current product, and begin a new product, based on the
same product type and template.

Save & Duplicate

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

Save & Close

Save the current product and return to the Inventory workspace.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Product Workspace

Default Field Values
To save time when creating products, the default value of several product fields references
values from another field. You can either accept the default value, or enter another. The
following fields have automatically generated default values:

FIELD

DESCRIPTION

SKU

Based on product Name.

Meta Title

Based on product Name.

Meta Keywords

Based on product Name.

Meta Description

Based on product Name and Description.

The placeholders that represent the value of another field are enclosed in double-curly braces.
Any attribute code that is included in the product attribute set can be used as a placeholder.

Product Fields Auto-Generation

Magento Commerce User Guide

151

Product Workspace

CHAPTER 12: Creating Products

To edit the placeholder value:
1.

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

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

Expand

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

placeholder values.
For example, if there’s a specific keyword that you want to include for every product, or a
phrase that you want to include in every meta description, you can type the value directly into
the appropriate field.
If you want to keep the existing placeholder values, be careful to preserve the double curly braces
that enclose each markup tag.

When complete, tap Save Config .

Common Placeholders
PLACEHOLDER
{{color}}
{{country_of_manufacture}}
{{description}}
{{gender}}
{{material}}
{{name}}
{{short_description}}
{{size}}
{{sku}}

152

Magento Commerce User Guide

CHAPTER 12: Creating Products

Product Workspace

Scheduled Changes
Product updates can be applied on schedule, and grouped with other content changes. You can
create a new campaign based on scheduled changes to the product, or apply the changes to an
existing campaign. To learn more, see: Content Staging.

Scheduled Changes

Magento Commerce User Guide

153

Product Types

CHAPTER 12: Creating Products

Product Types
Simple Product
A simple product is a physical item with a single SKU.
Simple products have a variety of pricing and of input
controls which makes it possible to sell variations of the
product. Simple products can be used in association with
grouped, bundle, and configurable products.

Configurable Product
A configurable product appears to be a single product
with lists of options for each variation. However, each
option represents a separate, simple product with a
distinct SKU, which makes it possible to track inventory
for each variation.

Grouped Product
A grouped product presents multiple, standalone
products as a group. You can offer variations of a single
product, or group them for a promotion. The products can
be purchased separately, or as a group.

Virtual Product
Virtual products are not tangible products, and are
typically used for products such as services,
memberships, warranties, and subscriptions. Virtual
products can be used in association with grouped and
bundle products.

154

Magento Commerce User Guide

CHAPTER 12: Creating Products

Product Types

Bundle Product
A bundle product let customers “build their own” from an
assortment of options. The bundle could be a gift basket,
computer, or anything else that can be customized. Each
item in the bundle is a separate, standalone product.

Downloadable Product
A digitally downloadable product that consists of one or
more files that are downloaded. The files can reside on
your server or be provided as URLs to any other server.

Gift Card
There are three kinds of gift cards: virtual gift cards which
are sent by email, physical gift cards which are shipped
to the recipient, and combined gift cards which are a
combination of the two. Each has a unique code, that is
redeemed during checkout. Gift cards can also be
included in a grouped product.

Magento Commerce User Guide

155

Simple Product

CHAPTER 12: Creating Products

Simple Product
One of the keys to harnessing the power of product types is learning when to use a simple,
standalone product. A simple products can be sold individually, or as part of a grouped,
configurable, or bundle product. A simple product with custom options is sometimes referred to
as a composite product.
The following steps take you through the process of creating a simple product using the default
product template with basic settings. When you finish the basics, you can complete the
advanced settings as needed.

Simple Product

Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Complete the Product Information
Step 6: Publish the Product

156

Magento Commerce User Guide

CHAPTER 12: Creating Products

Simple Product

Step 1: Choose the Product Type
1.

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

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

Add Simple Product

Step 2: Choose the Attribute Set
To choose the attribute set that is used as a template for the product, do one of the following:
l

In the Search box, enter the name of the attribute set.

In the list, choose the attribute set that you want to use.

The form is updated to reflect the change.

Choose Attribute Set

Magento Commerce User Guide

157

Simple Product

CHAPTER 12: Creating Products

Step 3: Complete the Required Settings
1.

Enter the product Product Name.

Accept the default SKU that is based on the product name, or enter another.

Enter the product Price.

Because the product is not yet ready to publish, set the Enable Product switch to the “No”
position.

Tap Save and continue.
When the product is saved, the Store View chooser appears in the upper-left corner.

Choose the Store View where the product is to be available.

Choose Store View

Step 4: Complete the Basic Settings
1.

Set Tax Class to one of the following:
l

None

Taxable Goods

Enter the Quantity of the product that is currently in stock.
Take note that by default, Stock Status is set to “In Stock.”

Enter the Weight of the product.

Accept the default Visibility setting, “Catalog, Search.”

To assign Categories to the product, tap the Select… box. Then, do either of the following:

Choose an existing category:

158

Start typing in the box to find a match.

Mark the checkbox of each category that is to be assigned.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Simple Product

Create a new category:
a.

Tap New Category .

Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.

Tap Create Category .

To feature the product in the list of new products, mark the Set Product as New checkbox.

Choose the Country of Manufacture.

Product Details
There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.

Step 5: Complete the Product Information
Scroll down and complete the information in the following sections as needed:
l

Content

Images and Videos

Related Products, Up-Sells, and Cross-Sells

Search Engine Optimization

Customizable Options

Products in Websites

Design

Gift Options

Magento Commerce User Guide

159

Simple Product

CHAPTER 12: Creating Products

Step 6: Publish the Product
1.

If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes”

position.

Do one of the following:

Method 1: Save and Preview
1.

In the upper-right corner, tap Save .

To view the product in your store, choose Customer View on the Admin (
store opens in a new browser tab.

) menu. The

Customer View

Method 2: Save and Close
On the Save ( ) menu, choose Save & Close.

Save & Close
THINGS TO REMEMBER
Simple products can be included in configurable, bundle, and grouped product types.
A simple product can have custom options with a variety of input controls, which makes it
possible to sell many product variations from a single SKU.

160

Magento Commerce User Guide

CHAPTER 12: Creating Products

Configurable Product

Configurable Product
A configurable product looks like a single product with drop-down lists of options for each
variation. Each option is actually a separate simple product with a unique SKU, which makes
it possible to track inventory for each product variation. You could achieve a similar effect by
using a simple product with custom options, but without the ability to track inventory for each
variation.

Configurable Product

Magento Commerce User Guide

161

Configurable Product

CHAPTER 12: Creating Products

Part 1: Creating a Configurable Product
Although a configurable product uses more SKUs, and may initially take a little longer to set
up, it can save you time in the long run. If you plan to grow your business, the configurable
product type is a good choice for products with multiple options.
Before you begin, prepare an attribute set that includes a dropdown or visual swatch for each
product variation. The attribute set that is used in this example has drop-down attributes for
color and size. Attribute sets that are tused for a configurable products must include at least
one dropdown or visual swatch attribute that meets the following requirements:

Product Variation Attribute Requirements
PROPERTY
Scope

SETTING
Global

Catalog Input Type for Store Owner Dropdown or Visual Swatch
Values Required

Yes

Process Overview:
Part I: Create Configurable Product
Step 1: Choose the Product Type
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Save and Continue

Step 1: Choose the Product Type

162

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

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

Magento Commerce User Guide

CHAPTER 12: Creating Products

Configurable Product

Add Configurable Product

Step 2: Choose the Attribute Set
The attribute set determines the selection of fields that are used in the product. The attribute
set is indicated at the top of the page, and is initially set to “Default”.
1.

To choose the attribute set for the product, click the field at the top of the page and do one of
the following:
l

In the Search box, enter the name of the attribute set.

In the list, choose the attribute set that you want to use.

The form is updated to reflect the change.
2.

If you need to add an additional attribute to the attribute set, tap Add Attribute. Then, follow
the instruction in Adding an Attribute.

Choose Template

Magento Commerce User Guide

163

Configurable Product

CHAPTER 12: Creating Products

Step 3: Complete the Required Settings
1.

Enter the product Product Name.

Accept the default SKU that is based on the product name, or enter another.

Enter the product Price.

Because the product is not yet ready to publish, set Enable Product to the “No” (

)

position.
5.

Tap Save and continue.
When the product is saved, the Store View chooser appears in the upper-left corner.

Choose the Store View where the product is to be available.

Choose Store View

Step 4: Complete the Basic Settings
1.

Set Tax Class to one of the following:
l

None

Taxable Goods

The Quantity is determined by the product variations, so you can leave it blank for now.
The Stock Status of a configurable product is determined by each associated configuration.
Because the product was saved without entering a quantity, the Stock Status is now set to “Out
of Stock.”

164

Enter the product Weight.

Accept the default Visibility setting, “Catalog, Search.”

To feature the product in the list of new products, mark the Set Product as New checkbox.

To assign Categories to the product, tap the Select… box. Then, do either of the following:

Magento Commerce User Guide

CHAPTER 12: Creating Products

Configurable Product

Choose an existing category:
a.

Start typing in the box to find a match.

Mark the checkbox of the category that is to be assigned.

Create a new category:
a.

Tap New Category .

Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.

Tap Create Category .

To feature the product in the list of new products, mark the Set Product as New checkbox.

Choose the Country of Manufacture.

Product Details
There might be additional attributes that are used to describe the product. The selection varies
attribute set, and you can complete them later.

Step 5: Save and Continue
This is a good time to save your work. In the upper-right corner, tap Save . In the next step,
you’ll set up the configurations for each variation of the product.

Magento Commerce User Guide

165

Configurable Product

CHAPTER 12: Creating Products

Part 2: Adding Configurations
The following example shows how to add configurations for three colors and three sizes. In all,
nine simple products will be created with unique SKUs to cover every possible combination of
variations. By default, the product name and SKU for each variation is based on the parent
product name or SKU, plus the attribute value.
The progress bar at the top of the page shows where you are in the process, and guides you
through each step.

Progress Bar

Process Overview: Part II: Add Configurations
Step 1: Choose the Attributes
Step 2: Enter the Attribute Values
Step 3: Configure the Images, Price, and Quantity
Step 4: Generate the Product Configurations
Step 5: Add a Product Image
Step 6: Complete the Product Information
Step 7: Publish the Product
Step 8: Configure the Cart Thumbnails (Optional)

Step 1: Choose the Attributes
1.

Continuing from Part I, scroll down to the Configurations section. Then, tap Create
Configurations .

Configurations
2.

Mark the checkbox of each attribute that you want to include as a configuration. For this
example, we choose color and size.

166

The list includes all attributes from the attribute set that can be used in a configurable product.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Configurable Product

Select Attributes
4.

If you need to add a new attribute, Create New Attribute . Complete the attribute properties,
and tap Save Attribute . Then, mark the checkbox to select the attribute.

In the upper-right corner, tap Next .

Step 2: Enter the Attribute Values
1.

For each attribute, mark the checkbox of the values that apply to the product.

To rearrange the attributes, grab the Change Order ( ) icon and move the section to a new
position. The order determines the position of the drop-down lists on the product page.

In the progress bar, Next.

Magento Commerce User Guide

167

Configurable Product

CHAPTER 12: Creating Products

Step 3: Configure the Images, Price, and Quantity
This step determines the images, pricing and quantity of each configuration. The available
options are the same for each, and you can choose only one. You can apply the same setting to
all SKUs, apply a unique setting to each SKU, or skip the settings for now.
1.

Choose the configuration options that apply.

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

Select Apply single set of images to all SKUs.

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

Use Same Images for All SKUs

Method 2: Apply Unique Images for Each SKU
Because we already uploaded an image for the parent product, we’ll use this option to upload
an image of each color. This is the image that will appear in the shopping cart when someone
buys the shirt in a specific color.
1.

Select Apply unique images by attribute to each SKU.

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

For each attribute value, either browse to the images that you want to use for that
configuration, or drag them to the box.

If you drag the an image to a value box, it appears in the sections for the other values, as well.
If you want to delete an image, tap the trashcan ( ) icon.

168

Magento Commerce User Guide

CHAPTER 12: Creating Products

Configurable Product

Unique Images per SKU

Configure the Prices
Method 1: Apply the Same Price to All SKUs
1.

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

Enter the Price.

Same Price per SKU

Method 2: Apply a Different Price for Each SKU
1.

If the price differs for each or for some variations of the product, select Apply unique
prices by attribute to each SKU.

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

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

Magento Commerce User Guide

169

Configurable Product

CHAPTER 12: Creating Products

Unique Price per SKU

Configure the Quantity
Method 1: Apply the Same Quantity to All SKUs
1.

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

Enter the Quantity.

Same Quantity for All SKUs

Method 2: Apply Different Quantity by Attribute
1.

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

Enter the Quantity for each.

Different Quantities per Attribute

170

Magento Commerce User Guide

CHAPTER 12: Creating Products

Configurable Product

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

Step 4: Generate the Product Configurations
1.

Wait a moment for the list of products to appear.

Do one of the following:
l

If you are satisfied with the configurations, tap Next.

To make corrections, tap Back.

Summary
The current product variations appear at the bottom of the Configuration section.

Current Configurations

Step 5: Add a Product Image
1.

Scroll down to the Images and Videos section. Then, expand

the section.

Click the Camera tile, and browse to the main image that you want to use for the configurable
product.

Magento Commerce User Guide

171

Configurable Product

CHAPTER 12: Creating Products

To learn more, see: Images and Videos.

Step 6: Complete the Product Information
Scroll down and complete the information in the following sections as needed:
l

Content

Related Products, Up-Sells, and Cross-Sells

Search Engine Optimization

Customizable Options

Products in Websites

Design

Gift Options

Step 7: Publish the Product
1.

If you are ready to publish the product in the catalog, set Enable Product to the “Yes” (

)

position.
2.

Do one of the following:

Method 1: Save and Preview
1.

In the upper-right corner, tap Save.

To view the product in your store, choose Customer View on the Admin (
store opens in a new browser tab.

) menu. The

Customer View

Method 2: Save and Close
On the Save ( ) menu, choose Save & Close.

Save & Close

172

Magento Commerce User Guide

CHAPTER 12: Creating Products

Configurable Product

Step 8: Configure the Cart Thumbnails (Optional)
If you have a different image for each variation you can set the configuration to use the correct
image for the shopping cart thumbnail.
1.

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

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

the Shopping Cart

section.
3.

Set Configurable Product Image to “Product Thumbnail Itself.”

When complete, tap Save Config .

Shopping Cart - Configurable Product Image
THINGS TO REMEMBER
A configurable product allows the shopper to choose options from drop-down list and visual
swatch input types. Each option is actually a separate, simple product.
The attributes that are used for product variations must have a global scope and the
customer must be required to choose a value. The product variation attributes must be
included in the attribute set that is used as a template for the configurable product.
The attribute set that is used as a template for a configurable product must include the
attribute(s) that contain the values that are needed for each product variation.
The thumbnail image in the shopping cart can be set to display the image from the
configurable product record, or from the product variation.

Magento Commerce User Guide

173

Grouped Product

CHAPTER 12: Creating Products

Grouped Product
A grouped product is made up of simple standalone products that are presented as a group.
You can offer variations of a single product, or group them by season or theme to create a set of
different products. Each product can be purchased separately, or as part of the group. In the
shopping cart, each item is listed separately.

Grouped Product

Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Add Products to the Group
Step 6: Publish the Product
Step 7: Configure the Cart Thumbnails (Optional)

174

Magento Commerce User Guide

CHAPTER 12: Creating Products

Grouped Product

Step 1: Choose the Product Type
1.

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

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

Add Simple Product

Step 2: Choose the Attribute Set
To choose the attribute set that is used as a template for the product, do one of the following:
l

In the Search box, enter the name of the attribute set.

In the list, choose the attribute set that you want to use.

The form is updated to reflect the change.

Choose Template

Magento Commerce User Guide

175

Grouped Product

CHAPTER 12: Creating Products

Step 3: Complete the Required Settings
1.

Enter the product Product Name.

Accept the default SKU that is based on the product name, or enter another.
Take note that the Quantity field is not available because the value is derived from the
individual products that make up the group.

Because the product is not yet ready to publish, set the Enable Product switch to the “No” (
) position.

Tap Save and continue.
When the product is saved, the Store View chooser appears in the upper-left corner.

Choose the Store View where the product is to be available.

Choose Store View

Step 4: Complete the Basic Settings
1.

Accept the Stock Status setting, “In Stock.”

To assign Categories to the product, tap the Select… box. Then, do either of the following:

Choose an existing category:
a.

Start typing in the box to find a match.

Mark the checkbox of the category that is to be assigned.

Create a new category:

176

Tap New Category .

Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.

Tap Create Category .

Accept the Visibility settings, “Catalog, Search.”

Magento Commerce User Guide

CHAPTER 12: Creating Products

Grouped Product

To feature the product in the list of new products, choose the Set Product as New From and
To dates on the calendar.

Choose the Country of Manufacture.
There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.

Grouped Product Details

Step 5: Add Products to the Group
1.

Scroll down to the Grouped Products section. Then, tap Add Products to Group .

Grouped Products
2.

If necessary, use the filters to find the products that you want to include in the group.

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

Magento Commerce User Guide

177

Grouped Product

CHAPTER 12: Creating Products

Add Selected Products
4.

Tap Add Selected Products to add them to the group.
The selected products appear in the Grouped Products section.

Products in Group
5.

Then, do any of the following:
l

178

Enter a Default Quantity for any of the items.
To change the order of the products, grab the Change Order icon ( ) in the first column,
and drag the product to the new position in the list.
To remove a product from the group, click Remove.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Grouped Product

Step 5: Complete the Product Information
Complete the information in the following sections as needed:
l

Content

Images and Videos

Search Engine Optimization

Related Products, Up-Sells, and Cross-Sells

Customizable Options

Products in Websites

Design

Gift Options

Step 6: Publish the Product
1.

If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” (

) position.

Do one of the following:

Method 1: Save and Preview
1.

In the upper-right corner, tap Save .

To view the product in your store, choose Customer View on the Admin (
store opens in a new browser tab.

) menu. The

Customer View

Method 2: Save and Close
On the Save ( ) menu, choose Save & Close.

Save & Close

Magento Commerce User Guide

179

Grouped Product

CHAPTER 12: Creating Products

Step 7: Configure the Cart Thumbnails (Optional)
If you have a different image for each product in the group, you can set the configuration to
use the correct image for the shopping cart thumbnail.
1.

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

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

Expand

the Shopping Cart section. Then, do the following:

If necessary, clear the Use system value checkbox.

Set Grouped Product Image to “Product Thumbnail Itself.”

Tap Save Config .

Shopping Cart
THINGS TO REMEMBER
A grouped product is essentially a collection of simple associated products.

Each item purchased appears individually in the shopping cart, rather than as part of the
group.
Each item purchased appears individually in the shopping cart, rather than as part of the
group.
The thumbnail image in the shopping cart can be set to display the image from the grouped
parent product, or associated product.

180

Magento Commerce User Guide

CHAPTER 12: Creating Products

Virtual Product

Virtual Product
Virtual products are used to represent non-tangible items such as memberships, services,
warranties, or subscriptions. Virtual products can be sold individually, or included as part of
the following product types:
l

Grouped Product

Bundle Product

Aside from the absence of the Weight field, the process of creating a virtual product and a
simple product is the same.

Virtual Product

Magento Commerce User Guide

181

Virtual Product

CHAPTER 12: Creating Products

Step 1: Choose the Product Type
1.

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

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

Add Virtual Product

Step 2: Choose the Attribute Set
To choose the attribute set that is used as a template for the product, do one of the following:
l

In the Search box, enter the name of the attribute set.

In the list, choose the attribute set that you want to use.

The form is updated to reflect the change.

Choose Attribute Set

182

Magento Commerce User Guide

CHAPTER 12: Creating Products

Virtual Product

Step 3: Complete the Required Settings
1.

Enter the product Product Name.

Accept the default SKU that is based on the product name, or enter another.

Enter the product Price.

Because the product is not yet ready to publish, set the Enable Product switch to the “No” (
) position.

Tap Save and continue.
When the product is saved, the Store View chooser appears in the upper-left corner.

Choose the Store View where the product is to be available.

Choose Store View

Step 4: Complete the Basic Settings
1.

Set Tax Class to one of the following:
l

None

Taxable Goods

Enter the Quantity of the product that is currently in stock. Then, do the following:
a.

Accept the default Stock Status setting, “In Stock.”
Note that the Weight field is not used, because a virtual product is not shipped.

b.
3.

Accept the default Visibility setting, “Catalog, Search.”

To assign Categories to the product, tap the Select… box. Then, do either of the following:

Choose an existing category:
a.

Start typing in the box to find a match.

Mark the checkbox of the category that is to be assigned.

Magento Commerce User Guide

183

Virtual Product

CHAPTER 12: Creating Products

Create a new category:
a.

Tap New Category .

Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.

Tap Create Category .

There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.

Step 5: Complete the Product Information
Complete the information in the following sections as needed:
l

Content

Images and Videos

Search Engine Optimization

Related Products, Up-Sells, and Cross-Sells

Customizable Options

Products in Websites

Design

Gift Options

Step 6: Publish the Product
1.

If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” (

) position.

Do one of the following:

Method 1: Save and Preview
1.

In the upper-right corner, tap Save.

To view the product in your store, choose Customer View on the Admin (
store opens in a new browser tab.

) menu. The

Customer View

184

Magento Commerce User Guide

CHAPTER 12: Creating Products

Virtual Product

Method 2: Save and Close
On the Save ( ) menu, choose Save & Close.

Save & Close
THINGS TO REMEMBER
Virtual products are used for non-tangible products such as services, subscriptions, and
warranties.
Virtual products are much like simple products, but without weight.
Shipping Options do not appear during checkout unless there is a tangible product in the
cart.

Magento Commerce User Guide

185

Bundle Product

CHAPTER 12: Creating Products

Bundle Product
A bundle is a “build your own,” customizable product. Each item in a bundle can be based on
one of the following product types:
l

Simple Product

Virtual Product

Bundle Product

186

Magento Commerce User Guide

CHAPTER 12: Creating Products

Bundle Product

Customizing the Bundle
The selection of options appears when the customer taps either the Customize and Add to Cart
button. Because the products that are included in the bundle vary, the SKU, Price, and Weight
can be set to either a dynamic or fixed value.
Minimum Advertised Price (MAP) is not available for Bundle products with dynamic pricing.

Customize Bundle
The following instructions walk you through the process of creating a bundle product with the
basic settings. Each required field is marked with a red asterisk (*). After you complete the
required settings and save the product, you can complete the remaining information as needed.
Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Add the Bundle Items
Step 6: Complete the Product Information
Step 7: Publish the Product

Magento Commerce User Guide

187

Bundle Product

CHAPTER 12: Creating Products

Step 1: Choose the Product Type
1.

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

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

Add Bundle Product

Step 2: Choose the Attribute Set
To choose the attribute set that is used as a template for the product, do one of the following:
l

In the Search box, enter the name of the attribute set,

In the list, choose the attribute set that you want to use.

The form is updated to reflect the change.

Choose Template

188

Magento Commerce User Guide

CHAPTER 12: Creating Products

Bundle Product

Step 3: Complete the Required Settings
1.

Enter the product Product Name.

You can either accept the default SKU that is based on the product name, or enter a different
value. To determine the type of SKU that is assigned to each bundle item, do the following:
l

A Dynamic SKU can be assigned automatically to each bundle item by adding a suffix to
the default SKU. By default, Dynamic SKU is set to “Yes.”
If you prefer to assign a unique SKU for each bundle item, set Dynamic SKU to the “No” (
) position.

Dynamic SKU and Price
3.

To determine the price of the bundle, do one of the following:
l

A Dynamic Price changes to reflect the options chosen by the customer. By default,
Dynamic Price is set to “Yes,” and the Price field is left blank.
To charge a fixed price for the bundle, set Dynamic Price to the “No.” (
enter the Price that you want to charge for the bundle.

) position. Then,

Because the product is not yet ready to publish, set the Enable Product switch to the “No” (
) position.

Tap Save and continue.
When the product is saved, the Store View chooser appears in the upper-left corner.

Choose the Store View where the product is to be available.

Choose Store View

Magento Commerce User Guide

189

Bundle Product

CHAPTER 12: Creating Products

Step 4: Complete the Basic Settings
1.

If the bundle has Fixed Pricing, set Tax Class to one of the following:
l

None

Taxable Goods

If the bundle has Dynamic Pricing, the tax is determined for each bundle item.
2.

Take note of the following:
l

The Quantity is not available because the value is determined for each bundle item.

The Stock Status is set by default to “In Stock.”

To determine the weight of the bundle, do one of the following:
l

A Dynamic Weight changes to reflect the options chosen by the customer. By default,
Dynamic Weight is set to “Yes,” and the Weight field is left blank.
To assign a fixed weight to the bundle, set Dynamic Weight to the “No.” (
Then, enter the Weight of the bundle.

) position.

Dynamic Weight
4.

To feature the product in the list of new products, mark the Set Product as New checkbox.

Accept the default Visibility setting, “Catalog, Search.”

To assign Categories to the product, tap the Select… box. Then, do either of the following:

Choose an existing category:
a.

Start typing in the box to find a match.

Mark the checkbox of each category that is to be assigned.

Create a new category:

190

Tap New Category .

Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.

Tap Create Category .

Choose the Country of Manufacture.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Bundle Product

Bundle Details
There might be additional attributes that describe the product. The selection varies attribute
set, and you can complete them later.

Step 5: Add the Bundle Items
1.

Scroll down to the Bundle Items section. Then, set Ship Bundle Items to one of the following:
l

Separately

Together

Bundle Items
2.

Tap Add Option , Then, do the following:

Magento Commerce User Guide

191

Bundle Product

CHAPTER 12: Creating Products

Add Bundle Options
a.

Enter an Option Title to be used field label.

Set Input Type to one of the following:
l

Drop-down

Radio buttons

Checkbox (See Note.)

Multiple Select (See Note.)

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

Tap Add Products to Option . Then, mark the checkbox of each product that you want to
include in this option. If there are many products, use the list filters and pagination
controls to find the products you need.

Tap Add Selected Products .

Add Selected Products

192

After the items appear in the Options section choose one to be the Default selection.

In the Default Quantity column, enter the quantity of each item that is to be added to the
bundle when a customer chooses the item.

To allow customers to change the quantity of a bundle item, select the User Defined
option.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Bundle Product

The quantity can be a preset or user-defined value. However, do not assign the User Defined
property to checkbox or multiple-select input types.

By default, the Default Quantity that is included in a bundle item cannot be changed by
the customer. However, the customer can enter the quantity of the item that is to be
included in the bundle.
For example, if the Default Quantity of the Sprite Status Ball is set to 2, and the customer
orders 4 of that bundle option, the total number of total balls purchased is 8.

Item Detail
3.

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

To remove any item from the bundle, tap the Delete (

When complete, tap Save .

) icon.

Step 6: Complete the Product Information
Scroll down and complete the information in the following sections as needed:
l

Content

Images and Videos

Search Engine Optimization

Related Products, Up-Sells, and Cross-Sells

Customizable Options

Products in Websites

Design

Gift Options

Magento Commerce User Guide

193

Bundle Product

CHAPTER 12: Creating Products

Step 7: Publish the Product
1.

If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” (

) position.

Do one of the following:

Method 1: Save and Preview
1.

In the upper-right corner, tap Save.

To view the product in your store, choose Customer View on the Admin (
store opens in a new browser tab.

) menu. The

Customer View

Method 2: Save and Close
On the Save ( ) menu, choose Save & Close.

Save & Close

194

Magento Commerce User Guide

CHAPTER 12: Creating Products

Bundle Product

Input Controls
CONTROL

DESCRIPTION

Drop-down

Displays a drop-down list of options with the product name and price.
Only one item can be selected.

Radio Buttons

Displays a radio button for each option, followed by the product name
and price. Only one item can be selected.

Checkbox

Displays a checkbox for each option, followed by the product name
and price. Multiple items can be selected.

Multiple Select

Displays a list of options with the product name and price. To select
multiple items, hold down the Ctrl (or Option) key, and click each
item.

Magento Commerce User Guide

195

Bundle Product

CHAPTER 12: Creating Products

Field Descriptions
FIELD

DESCRIPTION

SKU

Determines if each item is assigned a variable, dynamic SKU, or if a
fixed SKU is used for the bundle. Options include: Fixed / Dynamic.

Weight

Specifies the weight is calculated based on the items selected, or is
a fixed weight for the entire bundle. Options include:
Fixed / Dynamic.

Price View

Determines if the product price is shown as a range, from the least
expensive to the most expensive (Price Range), or with the least
expensive shown (As Low As). Options include: Price Range / As
Low As.

Ship Bundle Items

Specifies if individual items can be shipped separately.

THINGS TO REMEMBER
Customers can “build their own” bundle product.
Bundle items can be simple or virtual products without custom options.
The Price View can be set to a price range or to “As Low As.”
SKU and Weight can be either “Fixed” or “Dynamic.”
The quantity can be a preset or user-defined value. However, do not assign the User
Defined property to checkbox or multiple-select input types.
Bundle items can be shipped together or separately.

196

Magento Commerce User Guide

CHAPTER 12: Creating Products

Downloadable Product

Downloadable Product
A downloadable product can be anything that you can deliver as a file, such as an eBook,
music, video, software application, or update. You can offer an album for sale, and sell each
song individually. You can also use a downloadable product to deliver an electronic version of
your product catalog.
Because the actual download doesn’t become available until after the purchase, you can provide
samples, such as an excerpt from a book, a clip from an audio file, or a trailer from a video that
the customer can try before purchasing the product. The files that you make available for
download can be either uploaded to your server, or from a different server.

Downloadable Product
Downloadable products can be configured to require that the customer log in to an account to
receive the link, or can be sent by email and shared with others. The status of the order before
the download becomes available, default values, and other delivery options are set in the
configuration. To learn more, see: Configuring Download Options.
The following instructions take you through the process of creating a downloadable product
with the basic fields. Each required field is marked in the Admin with a red asterisk (*). After
you complete the required settings and save the product, you can add images and complete the
remaining product information as needed.
Downloadable file names can include letters and numbers. Either a dash or underscore character
can be used to represent a space between words. Any invalid characters in the file name are
replaced with an underscore.

Magento Commerce User Guide

197

Downloadable Product

CHAPTER 12: Creating Products

Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Complete the Downloadable Information
Step 6: Complete the Product Information
Step 7: Publish the Product

Step 1: Choose the Product Type
1.

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

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

Add Downloadable Product

Step 2: Choose the Attribute Set
The sample data includes an attribute set called “Downloadable” that has special fields for
downloadable products. You can use an existing template, or create another before the product
is saved.
To choose the attribute set that is used as a template for the product, do one of the following:
l

In the Search box, enter the name of the attribute set.

In the list, choose the “Downloadable” attribute set.

The form is updated to reflect the change.

198

Magento Commerce User Guide

CHAPTER 12: Creating Products

Downloadable Product

Choose Attribute Set

Step 3: Complete the Required Settings
1.

Enter the product Product Name.

Accept the default SKU that is based on the product name, or enter another.

Enter the product Price.

Because the product is not yet ready to publish, set the Enable Product switch to the “No” (
) position.

Tap Save and continue.
When the product is saved, the Store View chooser appears in the upper-left corner.

Choose the Store View where the product is to be available.

Choose Store View

Magento Commerce User Guide

199

Downloadable Product

CHAPTER 12: Creating Products

Step 4: Complete the Basic Settings
1.

Set Tax Class to one of the following:
l

None

Taxable Goods

Enter the Quantity of the product that is currently in stock.
Take note of the following:
l

By default, Stock Status is set to “Out of Stock.”

The Weight field is not used, because downloadble products are not shipped.

Accept the default Visibility setting, “Catalog, Search.”

To feature the product in the list of new products, mark the Set Product as New checkbox.

To assign Categories to the product, tap the Select… box. Then, do either of the following:

Choose an existing category:
a.

Start typing in the box to find a match.

Mark the checkbox of each category that is to be assigned.

Create a new category:

Tap New Category .

Enter the Category Name and choose the Parent Category to determine its position in the
menu structure.

Tap Create Category .

Set Format to one of the following:
l

Download

DVD

If necessary, you can edit the attribute to add more values.

200

Magento Commerce User Guide

CHAPTER 12: Creating Products

Downloadable Product

Product Details
There might be additional attributes that describe the product. The selection varies attribute
set, and you can complete them later.

Step 5: Complete the Downloadable Information
1.

Scroll down to Downloadable Information, and expand

the section. Then, mark the Is this

downloadable product? checkbox.
The Downloadable Information section has two parts. The first part describes each download
link, and the second part describes each sample file. The default value for many of these
options can be set in the configuration.

Downloadable Information

Magento Commerce User Guide

201

Downloadable Product

CHAPTER 12: Creating Products

Part 1: Complete the Links
1.

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

If applicable, mark the Links can be purchased separately checkbox.

Tap Add Link. Then, do the following:
a.

Enter the Title and Price of the download.

For both File and Sample files, choose one of the following methods of distribution
for the downloads:

Upload File

To upload the the distribution file to the server, choose
“Upload File.” Then, browse to the file, and select it for
upload.

URL

To access the distribution file from a URL, choose “URL”
Then, enter the full URL to the download file.

Set Shareable to one of the following:
No

Requires customers to log in to their accounts to access the
download link.

Yes

Sends the link by email, which customers can share with
others.

Use Config

Uses the method that is specified in the Dowloadable Product
Options configuration.

Do one of the following:
l

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

To allow unlimited downloads, mark the Unlimited checkbox.

Link Detail
4.

202

To add another link, tap Add Link. Then, repeat these steps.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Downloadable Product

Part 2: Complete the Samples
1.

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

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

Samples
3.

Complete the link detail as follows:
a.

Enter the Title of the individual sample.

Choose one of the following distribution methods:
Upload File

To upload the the sample distribution file to the server, choose
“Upload File.” Then, browse to the file, and select it for
upload.

URL

To access the sample distribution file from a URL, choose
“URL” Then, enter the full URL to the download file.

To add another sample, tap Add Link , and repeat these steps.

To change the order of the samples, grab the Change Order ( ) icon, and drag the
sample to a new position.

Magento Commerce User Guide

203

Downloadable Product

CHAPTER 12: Creating Products

Step 6: Complete the Product Information
Scroll down and complete the information in the following sections as needed:
l

Content

Images and Videos

Search Engine Optimization

Related Products, Up-Sells, and Cross-Sells

Customizable Options

Products in Websites

Design

Gift Options

Step 7: Publish the Product
1.

If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” (

) position.

Do one of the following:

Method 1: Save and Preview
1.

In the upper-right corner, tap Save.

To view the product in your store, choose Customer View on the Admin (
store opens in a new browser tab.

) menu. The

Customer View

Method 2: Save and Close
On the Save ( ) menu, choose Save & Close.

204

Magento Commerce User Guide

CHAPTER 12: Creating Products

Downloadable Product

Save & Close
THINGS TO REMEMBER
Downloadable products can be uploaded to the server, or linked to from another server on
the Internet.
You can determine the number of times a customer can download a product.
Customers who purchase a downloadable product can be required to log in before going
through checkout.
The delivery of a downloadable product can be made when the order is in either a “Pending”
or “Invoiced” state.

Magento Commerce User Guide

205

Downloadable Product

CHAPTER 12: Creating Products

Configuring Download Options
The downloadable configuration settings determine the default values and delivery options for
downloadable products, and specify if guests can purchase downloads.

To configure download options:
1.

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

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

Expand

the Downloadable Product Options section, and do the following:

Downloadable Product Options
a.

To determine the stage in the order workflow when the download becomes available, set
Order Item Status to Enable Downloads to one of the following:
Pending

Invoiced

To set a default limit on the number of downloads that a single customer can make, enter
the number in the Default Maximum Number of Downloads field.

Set Shareable to one of the following:

206

Yes

Allows customers to email the download link to others.

Prevents customers from sharing the download link with others by requiring
customers to log in to their accounts to access download links.

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

Magento Commerce User Guide

CHAPTER 12: Creating Products

Downloadable Product

Sample Title
e.

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

If you want the download link to open in a new browser window, set Opens Links in New
Window to “Yes.” This setting is used to keep the browser window to your store open.

To determine how downloadable content is delivered, set Use Content Disposition to one
of the following:

Attachment

Delivers the download link by email as an attachment.

Inline

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

If you want to require that purchasers register for a customer account and log in before
purchasing a download, set Disable Guest Checkout if Cart Contains Downloadable
Items to “Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

207

Gift Cards

CHAPTER 12: Creating Products

Gift Cards
There are three kinds of gift card products: virtual gift cards sent by email, physical gift cards,
which can be shipped to the recipient, and a combination of the two. Each gift card has a
unique code, which can be redeemed by only one customer during checkout. A code pool must
be established before gift cards can be sold.

Physical Gift Card

Virtual
A virtual gift card is sent to the recipient by email. The order requires an email address for the
recipient. A shipping address is not necessary.

Physical
A physical gift card is shipped to recipient’s address, which is required during the purchase of
the gift card.

Combined
The gift card is shipped and emailed to the recipient. The recipient’s email and shipping
address is required to purchase the gift card.

208

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

Gift Card Workflow
Gift cards are redeemed in the shopping cart similar to the way a coupon is applied to an
order. During checkout, the shopper enters the gift card code to apply an amount from the gift
card to the purchase. Gift card holders who have customer accounts can check the status and
remaining balance from their account dashboard. Single, as well as multiple gift cards can be
used to pay for all, or part of a purchase.
The gift card code(s) applied to an order can be viewed by opening the order in the Admin,
which makes it possible for you to retrieve the code to place it on a physical gift card, if
necessary. If a gift card order is canceled or refunded, you must manually cancel the associated
gift card account. You can either delete the account entirely, or deactivate it.

Gift Card Detail in Cart

Scenario
For example, a customer shopping in the demo Luma store can purchase either a virtual or
physical gift card.

Virtual Gift Card
A Luma virtual gift card is emailed with an optional message to your special someone. It can
be redeemed on any of the Luma family of websites and will never expire. Give the gift of
purchase power!

Physical Gift Card
A Luma gift card is packaged in a custom art mailer, and sent at no charge to your special
someone. It can be redeemed in store, by phone, or on any of the Luma family of websites. It
will never expire. Give the gift of purchase power!

Magento Commerce User Guide

209

Gift Cards

CHAPTER 12: Creating Products

Customer determines the gift card value. The customer determines the value of the
gift card from the product page. Depending on the configuration, there is either a fixed
price field, a list of price options, or both. All amounts appear in the currency that is used
in the store.
Customer completes the gift card information. For a physical gift card, the customer
enters the Sender Name and Recipient Name. For virtual or combined gift cards, the
customer also enters the Sender Email and Recipient Email. If the customer is logged in,
the Sender Name (and Sender Email, if applicable) is entered automatically from their
account. Depending on the configuration, the customer might also enter a message to
the recipient.
Customer completes checkout. The gift card appears as a line item in the cart with
detail that shows the name of the sender and recipient, and message, if applicable. The
amount associated with the gift card is converted to the base currency of the store when
it is added to the cart.
Customer receives confirmation of the order. The gift card purchaser can click the
link in the confirmation to track the order from their account dashboard.

Recipient receives the gift card. For virtual or combined gift cards, the recipient
receives an email with the gift card code, name of the sender, and message, if
applicable. If multiple gift cards are purchased in a single order, and the type is either
virtual or combined, all corresponding gift card codes are sent to the recipient in a single
email.
Physical gift cards can be shipped directly to the recipient, or to the customer, who can
then personally deliver the gift card to the recipient.
Recipient applies gift card to purchase. The gift card purchases an item in your store,
and applies the gift card code during checkout. Each time a gift card is applied during
checkout, the amount appears in the order totals block, and is subtracted from the grand
total. The full balance of each gift card is subtracted from the shopping cart total.
If multiple gift cards are used to pay for a purchaes, the amounts are applied in ascending
order, starting with the card with the smallest remaining balance, until the customer runs
out of cards, or until the grand total is zero. When the grand total reaches zero, the last
gift card account applied to the cart receives a partial deduction. Any cards that have not
been applied to the cart do not receive a deduction. The amounts are deducted from the
gift card accounts only after the order is placed.

210

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

Creating a Gift Card
The following instructions take you through the process of creating a gift card with the required
fields. Each required field is marked with a red asterisk (*). After you complete the required
settings and save the product, you can add images and complete the remaining product
information, as needed.

Gift Card Product Page

Process Overview:
Step 1: Choose the Product Type
Step 2: Choose the Attribute Set
Step 3: Complete the Required Settings
Step 4: Complete the Basic Settings
Step 5: Complete the Gift Card Information
Step 6: Complete the Product Information
Step 7: Publish the Product

Magento Commerce User Guide

211

Gift Cards

CHAPTER 12: Creating Products

Step 1: Choose the Product Type
1.

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

In the upper-right corner on the Add Product ( ) menu, choose Gift Card.

Add Gift Card

Step 2: Choose the Attribute Set
You can use the default “Gift Card” attribute set, or choose another. To choose the attribute set
that is used as a template for the product, do one of the following:
l

In the Search box, enter the name of the attribute set,

In the list, choose the attribute set that you want to use.

Choose Attribute Set

212

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

Step 3: Complete the Required Settings
1.

Enter a Product Name for the gift card. You might also indicate the type of gift card in the
name. For example, “Luma Virtual Gift Card.”

Enter a SKU for the product. By default, the Product Name is used as the default SKU.

Set Card Type to one of the following:
Virtual

Virtual gift cards are delivered by email to the recipient.

Physical

Physical gift cards can be mass produced in advance and embossed with
unique codes.

Combined

A combined gift card has the characteristics of both a virtual and
physical gift card.

Gift Card Type
1.

To offer the customer a choice of fixed amounts, tap Add Amount. Then, enter the first fixed
value of the card as a decimal. Repeat this step to enter the selection of fixed amounts.

Gift Card Amounts

Magento Commerce User Guide

213

Gift Cards

CHAPTER 12: Creating Products

To give customers the ability to set the value of the gift card, do the following:
) position.

Set Open Amount to the “Yes” (

To define the range of minimum and maximum acceptable values, enter the Open
Amount From and To values.
You can create gift cards with fixed pricing, open amount pricing, or both.

Step 4: Complete the Basic Settings
1.

For a physical or combined gift card, enter the Quantity in stock.

If the gift card that is to be shipped, enter the Weight of the package.

In the Categories field, choose “Gift Card.”

There might be additional individual attributes that describe the product. The selection varies
attribute set, and you can complete them later.

Step 5: Complete the Gift Card Information
1.

Scroll down to the Gift Card Information section.
The default settings in this section are determined by the system configuration.

Gift Card Information
2.

214

Clear the Use Config Settings checkbox of any of the following fields that you want to change:
Treat Balance as
Store Credit

Determines if the gift card holder can redeem the balance as store credit.

Lifetime (days)

Determines the number of days after purchase until the gift card expires.
If you do not want to set a limit for the lifetime of the card, leave this
field blank.

Allow Message

Determines if the purchaser of the gift card can enter a message for to
the recipient. A gift message can be included for both virtual (emailed)
and physical (shipped) gift cards.

Email Template

Determines the email template that is used for the notification sent to
the recipient of a gift card.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

Step 6: Complete the Product Information
Complete the information in the following sections as needed:
l

Content

Images and Videos

Related Products, Up-Sells, and Cross-Sells

Search Engine Optimization

Customizable Options

Products in Websites

Design

Gift Options

Step 7: Publish the Product
1.

If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes”

position.

Do one of the following:

Save and Preview
1.

In the upper-right corner, tap Save.

To view the product in your store, choose Customer View on the Admin (

) menu,

Customer View

Save and Close
On the Save ( ) menu, choose Save & Close.

Magento Commerce User Guide

215

Gift Cards

CHAPTER 12: Creating Products

Save & Close

Things to Remember
A “code pool” of unique numbers must be generated before a gift card can be offered for
sale.
The three types of gift cards are: Virtual, Physical, and Combined.
Gift cards can be set to “Redeemable” or “Non-Redeemable.”
The lifetime of a gift card can be unlimited, or set to a number of days.
The value of a gift card can be set to a fixed amount, or set to an open amount with a
minimum and maximum value.
A gift card account for the customer can be created when the order is placed, or at the time
of invoice.

216

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

Gift Card Accounts
A gift card account is automatically created for each Gift Card that is purchased. The value of
the gift card can then be applied toward the purchase of a product in your store. You can also
create gift card accounts from the Admin as a promotion or service for customers. The gift card
account number corresponds to the gift card code.

Gift Card Accounts

To examine an existing gift card account:
1.

If you need to find the number of the gift card account for a current order, do the following:
a.

On the Admin sidebar, tap Sales. Then under Operations, choose Orders.

Find the order in the list, and in the Action column, click View.

Scroll down to the Items Ordered section. The number is in the Product column, under Gift
Card Accounts.

On the Admin sidebar, tap Marketing.

Under Promotions, choose Gift Card Accounts.

Find the gift card account in the grid, and open in edit mode.
The Gift Card Code appears at the top of the Information section.

Magento Commerce User Guide

217

Gift Cards

CHAPTER 12: Creating Products

Gift Card Account Information

To create a gift card account:
1.

On the Admin sidebar, tap Marketing.

In the upper-right corner, click the Add Gift Card Account button. Then, do the following:

New Account

218

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

In the Information section, make sure that Active is set to “Yes.” Then, do the following:
a.

To make the card balance redeemable at checkout, or transferred to the customer’s store
credit, set Redeemable to “Yes.”

Choose the Website where the gift card account can be used.

Enter the initial Balance on the gift card.

To set an Expiration Date for the gift card, select the date from the calendar
blank, the gift card account will not expire.

. If left

Gift Card Information

Magento Commerce User Guide

219

Gift Cards

CHAPTER 12: Creating Products

In the panel on the left, choose Send Gift Card. Then, do the following:
a.

Enter the Recipient Email address.

Enter the Recipient Name.

Set Send Email from the Following Store View to the store view that appears as the
sender of the gift card notification.

Send Gift Card Settings
4.

220

Do one of the following:
l

If you are not ready to send the gift card, tap Save.

Tap Save & Send Email to save the changes and send the gift card by email to the recipient.

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

Configuring Gift Card Accounts
The Gift Card configuration establishes the default settings for all gift cards for the store view,
and manages the code pool. The code pool is a set of unique gift card codes in a specific format.
Codes from the pool are used each time a gift card account is created. It is the responsibility of
the store administrator to ensure that there are enough codes available for gift card sales. Make
sure to generate a code pool before offering gift cards for sale. By default, Magento generates
1,000 codes. A new pool is not generated until there are no more codes available in the current
pool.

Step 1: Configure Email Notifications
1.

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

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

Expand
a.

the Gift Card Email Settingssection. Then do the following:

Set Gift Card Notification Email Sender to the store identity that appears as the sender of
gift card notifications.

Set Gift Card Notification Email Template to the template that is used for the notification.

Gift Card Email Settings
4.

Expand

the Email Sent from Gift Card Account Management section. Then, do the

following:
a.

Set Gift Card Email Sender to the store identity to appear as the sender of the gift cards.

Set Gift Card Template to the template you want to use for the gift card.

Magento Commerce User Guide

221

Gift Cards

CHAPTER 12: Creating Products

Step 2: Complete the General Settings
1.

Expand

the Gift Card General Settings section.

To allow the customer to redeem the value on the card for cash, set Redeemable to “Yes.”

In the Lifetime (days) field, enter the number of days before the card expires. Leave the field
blank if there is no expiration date.
Depending on your location, it may be illegal for gift cards to expire. Check your local laws before
setting a lifetime for your gift cards.

If you want the customer to have the option to enter a message to accompany the gift card, set
Allow Gift Message to “Yes.” Then in the Gift Message Maximum Length field, enter the
number of characters available for the message.

Set Generate Gift Card Account when Orders Item is to one of the following:
Ordered

The gift card account is created when the order is placed.

Invoiced

The gift card account is created after payment is captured and the order
is invoiced.

Gift Card General Settings

Step 3: Establish the Gift Card Code Pool
6.

222

Expand

the Gift Card Account General Settings section. Then, do the following:

Magento Commerce User Guide

CHAPTER 12: Creating Products

Gift Cards

Gift Card Account General Settings
a.

To customize the code, complete the following according to your preference:
l

Code Length

Code Format

Code Prefix

Code Suffix

Dash Every X Characters

To determine the number of codes to generate, enter the New Pool Size.

To specify when you receive notification to restock the code pool, enter the Low Code Pool
Threshold.

Before you generate the code pool, tap Save Config. Then, tap Generate.

When complete, tap Save Config.

Magento Commerce User Guide

223

224

Magento Commerce User Guide

CHAPTER 13:

Product Settings
The most frequently used product settings and attributes are located at the top of the page,
followed by custom attributes. Any other product settings are in expandable sections at the
bottom of the page.

Product Settings

Magento Commerce User Guide

225

Advanced Product Settings

CHAPTER 13: Product Settings

Advanced Product Settings
To access the advanced pricing and inventory settings, click the link below the Price and
Quantity fields. To learn more, see:
l

Managing Pricing

Managing Inventory

Advanced Links

226

Magento Commerce User Guide

CHAPTER 13: Product Settings

Other Product Settings

Other Product Settings
The remaining product settings are located at the bottom of the page. Some settings are
available for all products, and others are available for specific product types. Additional
settings might appear when the product is saved for the first time.

To expand or collapse each section:
Tap the section. The button indicates if it is currently expanded

or collapsed

Other Settings

General Settings
SECTION

DESCRIPTION

Content

The Content section is used to enter the main product description
that appears on the product page. The short description can be used
in most RSS feeds, and might also appear in catalog listings,
depending on theme. The product description can be formatted using
the editor toolbar.

Product Reviews

The Product Reviews section lists all reviews that customers have
submitted about the product. The section appears only after a new
product has been saved.

Images and Videos

From the Images and Videos section, you can perform basic image
management tasks such as upload multiple images, rearrange the
order of images, and control how each image is used. For more
control over individual images, you can open each image in “detail
view.”

Magento Commerce User Guide

227

Other Product Settings

SECTION

CHAPTER 13: Product Settings

DESCRIPTION

Search Engine
Optimization

The Search Engine Optimization section specifies the URL Key and
meta data fields that are used by search engines to index the product.
Although some search engines ignore meta keywords, others
continue to use them. The current best practice is to incorporate highvalue keywords in both the meta title and meta description.

Related Products

234

Magento Commerce User Guide

CHAPTER 13: Product Settings

Other Product Settings

To set up related products:
1.

Open the product in edit mode.

Scroll down and expand

the Related Products, Up-Sells, and Cross-Sells section. Then,

tap Add Related Products.

Related Products

Up-sells

Cross-sells

Magento Commerce User Guide

CHAPTER 24: Related Product Rules

Creating a Related Product Rule

If the rule is to be active for a specific range of time, enter the From and To dates.

In the Result Limit field, enter the number of records to appear in the results list. The
maximum number is 20.

If the rule applies to a specific customer segment, set Customer Segments to “Specified.”
Then, choose the customer segment from the list.

In the panel on the left, choose Products to Match. Then, build the condition as you would for
a catalog price rule.

Products to Match
5.

In the panel on the left, choose Products to Display. Then, build the results condition as you
would for a catalog price rule.

Products to Display
6.

Complete the condition to describe the products that you want to include in the results.

When complete, tap Save.

Magento Commerce User Guide

427

Creating a Related Product Rule

CHAPTER 24: Related Product Rules

Field Descriptions
FIELD

DESCRIPTION

Rule Name

A name that identifies the rule for internal use.

Priority

Determines the sequence in which the results of the rule appear
when displayed with other sets of results that target the same place
on the page. The value can be set to any whole number, with the
highest priority of 1.
For example, if there are multiple up-sell rules that apply, the one with
the highest priority appears before the others. The sort order of the
products within each set of results is random.
Any up-sell, cross-sell, and related products that were manually
configured always appear on the page before any rule-based product
promotions.

Status

Controls the active status of the rule. Options: Active / Inactive

Apply To

Identifies the type of product relationship that is associated with the
rule. Options include:
Related Products
Up-sells
Cross-sells

428

From Date

If the rule is active for a range of time, determines the first date the
rule is active.

To Date

If the rule is active for a range of time, determines the last date the
rule is active.

Result Limit

Determines the number of products that appear in the results at one
time. The maximum number is 20. If more matching results are
found, the products rotate through the block each time the page is
refreshed.

Customer Segments

Identifies the customer segments to which the rule applies. Options:
All / Specified

Magento Commerce User Guide

CHAPTER 24: Related Product Rules

Category

Global

When creating a new event, this field links back to
the category tree. When editing an event, it links to
the category page related to the event.

Start Date

Global

The starting date and time of the event in
MMDDYYYY HH;MM format. Click the calendar
button to select the date.

End Date

Global

The ending date and time of the event in
MMDDYYYY HH;MM format. Click the calendar
button to select the date.

Image

Store View

Uploads an image for the event widget.

Sort Order

Global

Determines the sequence in which this event appears
when listed with other events.

Display Countdown Ticker
On

Global

Displays the countdown ticker in the header of each
page specified. Options include:
Category Page / Product Page

Status

Magento Commerce User Guide

Global

Indicates the status of the event based on the Start
Date and End Date range. Status is a read-only
value. Values include: Open / Closed / Upcoming

479

Creating Events

CHAPTER 28: Private Sales & Events

Updating Events
Events can be edited from either the Events page or from the category that is associated with
the event. When a category has an associated event, an Edit Event button appears in the
upper-right corner.

Edit Event

Method 1: Edit Event from the Events Page
1.

On the Admin sidebar, tap Marketing. Then under Private Sales, choose Events.

Find the event in the list, and open it in edit mode.

Make the necessary changes to the event.

When complete, tap Save.

Method 2: Edit Event from Category
1.

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

In the category tree on the left, select the category that is associated with the event. Then in
the upper-right corner, tap Edit Event.

480

Make the necessary changes to the event.

When complete, tap Save.

Magento Commerce User Guide

CHAPTER 28: Private Sales & Events

Invitations

Invitations
When invitations are enabled, customers can send and view invitations from the dashboard of
their customer accounts. The invitation email includes a link to your store’s Customer Login
page.

Invitation Workflow
Customer prepares invitations. From the account dashboard, the customer prepares
the list of recipients, and completes the invitation. A custom message can be included,
depending on the configuration.
Customer sends invitations. When ready, the customer taps the Send Invitations
button.

System manages transmission.The system sends invitations in batches, according to
the number set in the configuration.

Customer monitors response. The customer monitors the status of each invitation
from the account dashboard, as having been Sent, Accepted, or Canceled.

Magento Commerce User Guide

481

Invitations

CHAPTER 28: Private Sales & Events

Configuring Invitations
The invitation configuration enables invitations for the store, and determines how they are
sent.

To configure invitations:
1.

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

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

Expand

the General section. Then, do the following:

General

482

Magento Commerce User Guide

CHAPTER 28: Private Sales & Events

Set Enable Invitations Functionality to “Yes.”

To allow customers to manage invitations from the storefront, set Enable Invitations on
Storefront to “Yes.”

Set Referred Customer Group to one of the following:

Invitations

Same as Inviter

Default Customer Group from Configuration

Set New Accounts Registration to one of the following:
l

By Invitation Only

Available to All

To Allow Customers to Add Custom Message to Invitation Email, select “Yes.”

To limit the number of invitations that can be sent at one time, enter the number in the
Max Invitations Allowed to be Sent at One Time field.

Expand

the Email section, and do the following:

Select the store identity to be used as the Customer Invitation Email Sender.

Select the Customer Invitation Email Template used for invitations sent.

When complete, tap Save Config.

Magento Commerce User Guide

483

484

Magento Commerce User Guide

Communications

485

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
Email Reminder Rules
Configuring Email Reminders
Creating Email Reminders
Email Reminder Templates
Newsletters
Configuring Newsletters
Newsletter Templates
Sending Newsletters
Managing Subscribers
RSS Feeds
Using Variables
Adding Predefined Variables
Creating Custom Variables
Markup Tags
Variable Reference

486

CHAPTER 29:

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

487

Supported Email Clients

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

488

iPhone 5
iPhone 4s

Magento Commerce User Guide

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

489

Preparing Your Email Logo

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

490

Magento Commerce User Guide

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

491

Configuring Email Templates

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

492

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

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

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 29: Email

Configuring Email Templates

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

Sales Emails

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

Step 2: Choose the Type of Transmission
1.

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

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

Expand

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

following:
Disable

Sends sales email when triggered by an event.

Enable

Sends sales email at predetermined, regular intervals.

Magento Commerce User Guide

493

Configuring Email Templates

CHAPTER 29: Email

General Settings

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

Expand

the Order section. Then, do the following:

Order

494

Verify that Enabled is set to “Yes.”

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

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

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

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

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

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

Separate Email

Sends the copy as a separate email.

Magento Commerce User Guide

CHAPTER 29: Email

Configuring Email Templates

Expand

the Order Comments section, and repeat these steps.

Order Comments
6.

Complete the configuration for the remaining sales emails:
l

Invoice

Shipment

Credit Memo

When complete, tap Save Config.

Magento Commerce User Guide

495

Configuring Email Templates

CHAPTER 29: Email

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

Payment Failed Emails

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

Step 2: Configure the Payment Failed Emails
1.

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

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

Expand
a.

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

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

496

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

CHAPTER 29: Email

Configuring Email Templates

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

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

Separate Email

Sends the copy as a separate email.

When complete, tap Save Config.

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

Admin User Emails

To configure the Admin email templates:
1.

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

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

Expand

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

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

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

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

When complete, tap Save Config.

Magento Commerce User Guide

497

Customizing Email Templates

CHAPTER 29: Email

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

Preview of Welcome Template

498

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

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

Email Templates

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

Step 1: Load the Default Template
1.

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

Tap Add New Template. Then, do the following:

Magento Commerce User Guide

499

Customizing Email Templates

CHAPTER 29: Email

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

Default Header Template
b.

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

Step 2: Customize the Template
1.

Under Template Information, do the following:
a.

Enter the Template Name for your custom header.

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

Header Template Information
c.

500

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

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

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

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

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

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

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

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

Step 3: Update the Configuration
1.

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

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

Scroll down and expand

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

When complete, tap Save Config.

Magento Commerce User Guide

the Transactional Emails section.

501

Customizing Email Templates

CHAPTER 29: Email

Transactional Emails

Field Descriptions
FIELD

DESCRIPTION

LOAD DEFAULT TEMPLATE
Template

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

TEMPLATE INFORMATION
Template Name
Insert Variable

502

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

CHAPTER 29: Email

Customizing Email Templates

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

Email Templates

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

Step 1: Load the Default Template
1.

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

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

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

Tap Load Template.

Default Footer Template

Magento Commerce User Guide

503

Customizing Email Templates

CHAPTER 29: Email

Step 2: Customize and Preview the Template
1.

Enter the Template Name for your custom footer.

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

Footer Template Information
3.

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

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

504

Magento Commerce User Guide

CHAPTER 29: Email

Customizing Email Templates

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

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

Step 3: Update the Configuration
1.

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

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

Scroll down and expand

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

When complete, tap Save Config.

Transactional Emails

Magento Commerce User Guide

505

Customizing Email Templates

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

506

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

507

Customizing Email Templates

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

508

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

Magento Commerce User Guide

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

509

Customizing Email Templates

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

510

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

Template Subject

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

Template Content

The content of the template in HTML.

Template Styles

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

Magento Commerce User Guide

CHAPTER 30:

Email Reminders
The purpose of an email reminder is encourage people who have visited your store to take
advantage of a promotion and make a purchase. Email reminders can be automatically sent to
customers when a specific set of conditions is met. For example, you might send a reminder to
customers who have added something to their cart or wishlist, but have not yet made a
purchase. You can use email reminders to encourage customers to return to your store, and
include a coupon code as an incentive. Coupon codes can be automatically generated for each
batch of email reminders, to give you control over the offers that are associated with each
batch.
Email reminders can be triggered after a certain number of days have passed since a cart was
abandoned, or for any other condition you want to define, such as total cart value, quantity,
items in cart, and so on.

Email Reminders

Magento Commerce User Guide

511

Creating Email Reminders

CHAPTER 30: Email Reminders

Creating Email Reminders
Before setting up an email reminder rule, you must first set up a cart price rule to define the
promotion that is being offered. Rule conditions that trigger an email reminder can be based on
cart properties, wishlist properties, or both.
Email reminders might promote a cart price rule with, or without, a coupon. A cart price rule that
defines an auto-generated coupon generates a random coupon code for each customer.

To create an email reminder:
1.

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

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

Complete the Rule Information, as follows:

Rule Information

512

Enter a Rule Name to identify the rule internally.

Enter a brief Description of the rule.

To choose the Cart Price Rule promotion that this reminder is to advertise, tap Select
Rule…. Then, select the rule.

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Creating Email Reminders

Select Cart Rule
d.

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

To set up a date range for the rule to be active, enter the From and To dates. You can also
choose the date from the Calendar ( ).

To send the reminder more than once, enter the number of days before the next email blast
in the Repeat Schedule field.
To repeat the reminder multiple times, separate the number of days with a comma. For
example, enter “7” to trigger the rule again in seven days; enter “7,14” to trigger the rule in
seven days, and again fourteen days later.

In the panel on the left, choose Conditions. At least one condition must be defined for the rule.
The process is similar to building a catalog price rule.

Conditions
a.

Tap Add (

) to display the list of options. Then, choose one of the following conditions:

Wish List

Shopping Cart

Complete the condition to describe the scenario that triggers the email reminder.

Magento Commerce User Guide

513

Creating Email Reminders

CHAPTER 30: Email Reminders

Completed Condition
5.

In the panel on the left, choose Emails and Labels

Email and Labels
6.

In the Email Templates section, choose the email template to be used for each website and
store view in your store hierarchy.
If you don’t want to send the reminder email to customers of a store view, leave the value “Not
Selected.”

In the Default Titles and Description section, do the following:
a.

Enter the Rule Title for All Store Views.
This value can be incorporated into email templates by using the promotion_name variable.

514

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Creating Email Reminders

Enter the Rule Description for All Store Views.

Default Titles and Description
c.

In the Titles and Descriptions Per Store View section, enter the Rule Title and Description
for the Default Store View. For multiple store views, enter the appropriate title and
description for each.
The description can be incorporated into email templates by using the promotion_description
variable.

Titles and Description per Store View
8.

When complete, tap Save.

Magento Commerce User Guide

515

Creating Email Reminders

CHAPTER 30: Email Reminders

Trigger Conditions
SOURCE
Wish List

TRIGGER
Number of days abandoned
Sharing
Number of items
Specific items

Shopping Cart

Number of days abandoned
Specific coupon code applied
Line items quantity
Items quantity
Total
Virtual items
Specific Items

Field Descriptions
FIELD

DESCRIPTION

RULE INFORMATION
Rule Name

The name of the automated reminder rule identifies the rule internally.

Description

A description of the rule for internal reference.

Shopping Cart Price Rule

The shopping cart rule that is associated with this email reminder.
Reminder emails can promote a shopping cart price rule with or
without coupon. If a shopping cart price rule includes an autogenerated coupon, the reminder rule will generate a random, unique
coupon code for each customer.

Assigned to Website

The websites to receive automated reminder emails based on this
rule.

Status

Activates the rule. If status is inactive, then all other settings are
ignored, and the rule is not triggered.
Options: Active / Inactive

516

From Date

The starting date for this automated reminder rule. If no date is
specified, the rule becomes active immediately.

To Date

The ending date for this automated reminder rule. If no date is
specified, the rule becomes active indefinitely.

Repeat Schedule

The number of days before the rule is triggered, and the reminder
email sent again, provided the conditions are met.

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Creating Email Reminders

Field Descriptions (cont.)
FIELD

DESCRIPTION
To trigger the rule more than once, enter the number of days before
the next email blast, separated by a comma. For example, enter “7” to
have the rule triggered again seven days later; enter “7,14” to have
the rule triggered in seven days, and again fourteen days later.

EMAIL AND LABELS
Email Templates

Determines the email template to be used for each store view.

Rule Title for All Store
Views

Determines the title of the rule for each store view.

Rule Description for All
Store Views

Determines the description of the rule for each store view.

Magento Commerce User Guide

517

Configuring Email Reminders

CHAPTER 30: Email Reminders

Configuring Email Reminders
Email reminder rules can be sent at regular intervals by the minute, hour, or day. The
configuration determines how many emails are sent in a batch, and the store identity that
appears as the sender of the message.

To configure email reminders:
1.

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

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

Expand

the Automated Email Reminder Rules section. Then, do the following:

Automated Email Reminder Rules

518

Set Enable Reminder Emails to “Yes.”

To set how often Magento checks for new customers who qualify automated email
reminders, set Frequency to one of the following:
l

Minute Intervals

Hourly

Daily

Set the appropriate Interval, based on the Frequency setting. Then, set Start Time to the
hour, minute, and second the email is sent, based on a 24-hour clock.

To limit the number of emails that can be sent in a batch, enter the number in the
Maximum Emails per One Run field.

To avoid repeated attempts to send failed email, enter the maximum number of attempts
in the Email Send Failure Threshold field.

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Email Reminder Templates

Set Reminder Email Sender to the store contact that appears as the sender of the
reminder email.

When complete, tap Save Config.

Email Reminder Templates
The default email reminder template can be customized, and additional templates created for
different promotions. Email reminders have a selection of specific variables that can be
incorporated into the message. The information in these variables is determined by the email
reminder rule that you set up, and by the cart price rule that is associated with the coupon.
The Insert Variable button can be used to insert the markup tag with the variable into the
template. To learn more, see: Email Templates.

Preview of Promotion Reminder

To customize an email reminder template:
1.

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

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

In the Template list under Magento_Reminder, choose the Promotion
Notification/Reminder template.

b.
3.

Tap Load Template.

Follow the standard instructions to customize the template.

Magento Commerce User Guide

519

Email Reminder Templates

CHAPTER 30: Email Reminders

Email Reminder Variables
VARIABLE

MARKUP TAG

Coupon Code

Coupon Usage Limit

Coupon Usage Per
Customer

Customer Account URL

Customer Name

Email Footer Template

Email Header Template

520

Email Logo Image Alt

Email Logo Image URL

Promotion Description

Promotion Name

Store Name

Store URL

Magento Commerce User Guide

CHAPTER 30: Email Reminders

Configuring Email Communications

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

Magento Commerce User Guide

521

Configuring Email Communications

CHAPTER 30: Email Reminders

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:

522

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.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 31:

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

523

Preparing Your Invoice Logo

CHAPTER 31: Sales Documents

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

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

To configure invoices and packing slips:
1.

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

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

Expand

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

Invoice and Packing Slip Design
a.

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

524

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

525

Adding Reference IDs to Header

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

526

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

527

Customer Address Templates

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

528

Magento Commerce User Guide

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

529

530

Magento Commerce User Guide

CHAPTER 32:

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

531

Configuring Newsletters

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

532

Magento Commerce User Guide

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

533

Newsletter Templates

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

534

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

In the Template Name enter name for internal reference.

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

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

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

Magento Commerce User Guide

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

535

Sending Newsletters

CHAPTER 32: Newsletters

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

To send a newsletter:
1.

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

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

Add to Newsletter Queue
3.

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

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

Complete the email header information as follows:
a.

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

Enter the Sender Name.

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

536

Magento Commerce User Guide

CHAPTER 32: Newsletters

Sending Newsletters

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

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

Newsletter Queue

To check for problems:
1.

On the Admin menu, tap Reports.

Under Marketing, choose Newsletter Problem Reports.

Magento Commerce User Guide

537

Managing Subscribers

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

538

Magento Commerce User Guide

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

539

540

Magento Commerce User Guide

CHAPTER 33:

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

541

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

542

Expand

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

When complete, tap Save Config.

Magento Commerce User Guide

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

543

544

Magento Commerce User Guide

CHAPTER 34:

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

545

Adding Predefined Variables

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

546

When complete, tap Save Template.

Magento Commerce User Guide

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

547

Adding Custom Variables

CHAPTER 34: Using Variables

New Custom Variable
5.

548

When complete, tap Save.

Magento Commerce User Guide

CHAPTER 34: Using Variables

Markup Tags

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

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

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

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

Magento Commerce User Guide

549

Markup Tags

CHAPTER 34: Using Variables

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

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

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

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

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

550

Magento Commerce User Guide

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

551

Markup Tags

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

552

Magento Commerce User Guide

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

553

Markup Tags

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

554

Magento Commerce User Guide

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

555

Markup Tags

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

556

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

When complete,tap Save Config.

Magento Commerce User Guide

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

557

Variable Reference

CHAPTER 34: Using Variables

Store Contact Information Variables (cont.)
VARIABLE

558

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

559

560

Magento Commerce User Guide

CHAPTER 35:

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

561

Connect to Facebook

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

562

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

563

Connect to Facebook

CHAPTER 35: Social

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.

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.

564

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.

Magento Commerce User Guide

CHAPTER 35: Social

Connect to Facebook

Step 2: Launch Your Store
4.

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

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.

Magento Commerce User Guide

565

Connect to Facebook

CHAPTER 35: Social

Let Shopial Manage Pages
7.

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

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.

566

Enter a Name for your Magento Social page.

Tap Get Started.

Magento Commerce User Guide

CHAPTER 35: Social

Connect to Facebook

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.

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

567

Connect to Facebook

CHAPTER 35: Social

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

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

Choose the last option, Store.

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

568

Magento Commerce User Guide

CHAPTER 35: Social

Connect to Facebook

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

If you have a coupon, enter the Coupon Code.

Tap Recalculate.

Order Information
5.

Complete the Customer Information.

Magento Commerce User Guide

569

Connect to Facebook

CHAPTER 35: Social

Customer Information
6.

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

Credit Card Information

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

570

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

Connect to Facebook

Step 1: Activate Magento Social
3.

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

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.

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

Magento Commerce User Guide

571

Connect to Facebook

CHAPTER 35: Social

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.

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

Send Consumer Key
3.

572

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

Magento Commerce User Guide

SEO & Search

573

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
MySQL
Elasticsearch
Solr
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 Tag Manager
Google Adwords

574

CHAPTER 36:

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

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

575

Top Navigation

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

576

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 36: Catalog Navigation

Top Navigation

To set the depth of the top navigation:
1.

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

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

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

Default Config
4.

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

When complete, tap Save Config .

Category Top Navigation

Magento Commerce User Guide

577

Breadcrumb Trail

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

578

Magento Commerce User Guide

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

579

Product Listings

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

580

Magento Commerce User Guide

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

581

Product Listings

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

582

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 36: Catalog Navigation

Pagination Controls

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

Pagination Controls

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

Magento Commerce User Guide

583

Pagination Controls

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

584

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

585

Layered Navigation

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

586

Magento Commerce User Guide

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

587

Layered Navigation

CHAPTER 36: Catalog Navigation

Filterable Swatch Value with No Results
b.

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

Storefront Properties
3.

588

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

Magento Commerce User Guide

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

589

Layered Navigation

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

590

Magento Commerce User Guide

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

591

Layered Navigation

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

592

When complete, tap Save Config .

Magento Commerce User Guide

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

593

594

Magento Commerce User Guide

CHAPTER 37:

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

595

Quick Search

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

596

Magento Commerce User Guide

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

597

Advanced Search

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

598

Magento Commerce User Guide

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

599

Weighted Search

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

600

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 37: Catalog Search

Configuring Catalog Search

Configuring Catalog Search
By default, Magento uses a fulltext MySQL search engine. The available options depend on the
search engine that is configured for your Magento installation.

MySQL
MySQL is the default search engine used by Magento Commerce.

Elasticsearch
Elasticsearch is a powerful and highly scalable distributed search engine that is used by many
industry leaders with high-volume sites.

Solr
Solr is not included in a standard Magento installation, and must be installed separately. The Solr
configuration has a slightly different set of options and features.

Magento Commerce User Guide

601

Configuring Catalog Search

CHAPTER 37: Catalog Search

MySQL
MySQL is the default search engine used by Magento Commerce. By adjusting the Catalog
Search configuration, you can control the behavior of the search operations and determine the
size of valid query text and the display of search recommendations.

MySQL Configuration

To configure MySQL 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.

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

To display search suggestions, set Enable Search Suggestions to “Yes.” Then, do the
following:
a.

In the Search Suggestion Count field, enter the number of suggestions to offer for each
search term that returns no results. The default is 2.

602

To display the number of search results for each suggested term, set Show Results Count
for Each Suggestion to “Yes.”

Magento Commerce User Guide

CHAPTER 37: Catalog Search

Configuring Catalog Search

To offer search recommendations, set Enable Search Recommendations to “Yes.” Then, do the
following:
a.

In the Search Recommendations Count field, enter the number of recommendations that
you want to offer. The default is 5.

To display the number of results for each recommendation, set Show Results Count for
Each Recommendation to “ Yes.”

When complete, tap Save Config .

Magento Commerce User Guide

603

Configuring Catalog Search

CHAPTER 37: Catalog Search

Elasticsearch
Elasticsearch is a powerful and highly scalable distributed search engine that is used by such
high-volume sites as eBay, Wikipedia, and GitHub. The implementation of Elasticsearch for
Magento Enterprise Edition 2.1 includes both search suggestions and recommendations. For
installation instructions, see Elasticsearch in the Magento Developer Documentation.

Step 1: Set the Query Length
1.

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

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

Expand

the Catalog Search section. Then, do the following:

Elasticsearch Query Length
a.

In the Minimal Query Length field, enter the minimum number of characters that can be
submitted in a query.

In the Maximum Query Length field, enter the maximum number of characters that can
be submitted in a query.

Step 2: Configure the Elasticsearch Connection
1.

After the Search Engine field, clear the Use system value checkbox. Then, set Search Engine
to “Elasticsearch,” and do the following:

Elasticsearch Connection Settings

604

Enter the Elasticsearch Server Hostname. The default is: localhost.

Enter the Elasticsearch Server Port.

Magento Commerce User Guide

CHAPTER 37: Catalog Search

Configuring Catalog Search

In the Elasticsearch Index Prefix field, enter a prefix.to identify the Elasticsearch index.
For example: Magento2.

Set Enable Elasticsearch HTTP Auth to “Yes” to use HTTP authentication to prompt for a
username and password to access Elasticsearch Server.

In the Elasticsearch Server Timeout field, enter the number of seconds before the system
times out. The default is: 15.

To verify the configuration, tap Test Connection.

Step 3: Configure Suggestions and Recommendations
Search suggestions and recommendations can impact server performance.

Set Enable Search Suggestions to “Yes.” Then, do the following:

Elasticsearch Suggestion and Recommendation Settings

In the Search Suggestions Count field, enter the number of search suggestions to offer.

To show the number of results found for each suggestion, set Show Results for Each
Suggestion to “Yes.”

To offer recommendations, set Enable Search Recommendations to “Yes.” Then, do the
following:
a.

In the Search Recommendation Count field, enter the number of recommendations to
offer.

To show the number of results found for each recommendation, set Show Results Count
for Each Recommendation to “Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

605

Configuring Catalog Search

CHAPTER 37: Catalog Search

Solr
Solr is a standalone, enterprise-scale search server that communicates easily with applications.
Because Solr is highly scalable, it is used to power some of the world’s most high-traffic
Internet sites. This guide includes installation instructions for system administrators, as well
configuration instructions and “how to” help for store administrators.
Solr provides improved search performance and search results relevancy, support for spelling,
synonyms and stop words, and improved layered navigation performance. Solr is especially
recommended for sites with heavy traffic and search loads. Products are added to the search
engine index as each product is saved in the Admin, so the index is kept up to date without
any need for manual intervention.
All of the attributes that are available for layered navigation are added to Solr index. As a
result, Solr can also be used to generate the layered navigation. To add these attributes to Solr
search results, the store administrator must enable Solr for catalog navigation.
The following instructions show how to configure the Solr search engine after it has been
installed on your server. Solr can reside on the same server as Magento, or on a different server.
After the installation, you must complete the configuration from the Admin to establish the
connection.

Step 1: Establish the Connection
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 Catalog Search section. Then, do the following:

Beginning with the third field, clear the Use system value checkbox. Then, set Search
Engine to “Solr.”

Configuring Solr Connection

606

Enter the fully-qualified Solr Server Hostname or IP address. The default is localhost.

Enter the number of the port that is assigned as the Solr Server Port.

Magento Commerce User Guide

CHAPTER 37: Catalog Search

Enter the Solr Server Username and Solr Server Password.

In the Solr Server Timeout field, enter the number of seconds of inactivity that can pass
before the connection times out. The default is 15.

For a standard Solr installation, you can accept the default Solr Server Path. For a
custom deployment, enter the correct path to the installation. The default path is solr.

Set Indexation Mode to one of the following:

h.
4.

Configuring Catalog Search

Final commit

(Default) Offers better performance than a partial commit, and
users see the results immediately. Indexing begins after all
unneeded data is removed and new data is added.

Partial commit

As content is gradually reindexed, users see only the indexed
results. All content is removed after reindexing.

Engine
autocommit

Content is put into the index queue but is not committed. To use
autocommit, you must configure Solr to commit at regular intervals
(for example, every 5 minutes) or when a certain number of
uncommitted items is reached.

To verify the installation, tap Test Connection.

When the connection is established, tap Save Config. Then, continue to the next step to
complete the configuration.

Step 2: Configure Solr Search Features
1.

If you want to change the default query length settings, do the following:
a.

Beginning with the first field, clear the Use system value checkbox. Then, 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.

Query Length
2.

Continuing below the Test Connection button, set Enable Search Suggestions to “Yes.” Then,
do the following:

Magento Commerce User Guide

607

Configuring Catalog Search

CHAPTER 37: Catalog Search

Search Suggestions
a.

In the Search Suggestion Count field, enter the number of suggestions to offer for each
query that returns no results. The default is 2.

To display the number of search results for each suggested term, set Show Results Count
for Each Suggestion to “Yes.”

To offer search recommendations, set Enable Search Recommendations to “Yes.” Then, do the
following:

Search Recommendations
a.

In the Search Recommendations Count field, enter the number of recommendations that
you want to offer. The default is 5.

608

To display the number of results for each recommendation, set Show Results Count for
Each Recommendation to “ Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 38:

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

609

Popular Search Terms

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

610

Magento Commerce User Guide

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

611

Adding Search Terms

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

612

Magento Commerce User Guide

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

613

Search Terms Report

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

614

Magento Commerce User Guide

CHAPTER 38: Search Terms

Search Synonyms

Search 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,” while your product is listed as a “couch.” Or perhaps they spelled it wrong,
or just differently. Is it a sweatshirt, or a sweat shirt? Maybe it’s a fleece or a hoodie. You can
capture a broad range of search terms by entering all the possible words a customer might use
to find your products.

Search Results

To create a new synonym group:
1.

On the Admin sidebar, tap Marketing. Then under SEO & Search, choose Search Synonyms.
The Search Synonyms grid appears. If this is the first time you have used search synonyms, the
grid will be empty.

Search Synonyms Grid

Magento Commerce User Guide

615

Search Synonyms

CHAPTER 38: Search Terms

Tap New Synonym Group. Then, do the following:

New Synonym Group
a.

Set Scope to the store views whee the synonyms apply.

Enter each synonym in the group, separated by comma. Choose words that people might
use as search criteria. For example:

sweatshirt, sweat shirt, hoodie, fleece

cell phone, mobile phone, smart phone

couch, sofa, davenport

wrought iron, rot iron, rod iron

To merge these synonyms into a group with others that have the same scope, mark the
Merge existing synonyms checkbox.

When complete, tap Save Synonym Group.

Search Synonym Group Saved

616

Magento Commerce User Guide

CHAPTER 39:

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

617

Meta Data

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

618

Magento Commerce User Guide

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

619

Meta Data

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

620

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

621

Using a Sitemap

CHAPTER 39: SEO Best Practices

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

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

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

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

Google

Microsoft Bing

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

622

Magento Commerce User Guide

CHAPTER 39: SEO Best Practices

Sitemap Configuration

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

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

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

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

Expand
a.

the Categories Options section. Then, do the following:

Set Frequency to one of the following:
l

Always

Hourly

Daily

Weekly

Monthly

Yearly

Never

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

Categories Options
4.

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

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

None

Base Only

All

Magento Commerce User Guide

623

Sitemap Configuration

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

624

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 39: SEO Best Practices

Sitemap Configuration

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

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

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

Step 3: Set the Sitemap File Limits
1.

Expand
a.

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

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

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

Sitemap File Limits

Step 4: Set the Search Engine Submission Settings
1.

Expand

the Search Engine Submission Settings section.

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

Search Engine Submission Settings
3.

When complete, tap Save Config.

Magento Commerce User Guide

625

Search Engine Robots

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

626

Magento Commerce User Guide

CHAPTER 39: SEO Best Practices

Search Engine Robots

To configure robots.txt:
1.

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

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

Expand
a.

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

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

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

NOINDEX, FOLLOW

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

INDEX, NOFOLLOW

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

NOINDEX, NOFOLLOW

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

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

To restore the default instructions, tap Reset to Default.

When complete, tap Save Config.

Magento Commerce User Guide

627

628

Magento Commerce User Guide

CHAPTER 40:

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

629

Configuring URL Rewrites

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

630

Set Use Web Server Rewrites to your preference.

When complete, tap Save Config.

Magento Commerce User Guide

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

631

Automatic Product Redirects

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

632

Magento Commerce User Guide

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

633

Creating URL Rewrites

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

634

Redirect to:

gear/bags/impulse-duffle.html

Redirect from:

gear/bags/overnight-duffle.html

Magento Commerce User Guide

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

635

Creating URL Rewrites

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

636

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

637

Creating URL Rewrites

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

638

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

639

Creating URL Rewrites

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

640

Magento Commerce User Guide

CHAPTER 40: URL Rewrites

Creating URL Rewrites

Set Redirectto one of the following:
l

Temporary (302)

Permanent (301)

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

Category Rewrite Information
6.

Before saving the redirect, review the following:
l

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

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

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

New Category Rewrite

Magento Commerce User Guide

641

Creating URL Rewrites

CHAPTER 40: URL Rewrites

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

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

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

Field Descriptions
FIELD
Create URL Rewrite

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

Request Path

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

Target Path

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

Redirect

Determines the type of redirect. Options :
No

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

Temporary (302)

642

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

Magento Commerce User Guide

CHAPTER 40: URL Rewrites

Creating URL Rewrites

Field Descriptions (cont.)
FIELD

DESCRIPTION
Permanent (301)

Description

Magento Commerce User Guide

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.

643

Creating URL Rewrites

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

644

Redirect to:

new-page

Redirect from:

old-page

Magento Commerce User Guide

CHAPTER 40: URL Rewrites

Creating URL Rewrites

Step 2: Create the Rewrite
1.

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

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

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

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

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

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

Set Create URL Rewrite to “for CMS page.”

Find your new target page in the grid, and open in edit mode.

Custom URL Rewrite
6.

Under URL Rewrite Information, do the following:
a.

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

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

Set Redirectto one of the following:

Magento Commerce User Guide

645

Creating URL Rewrites

CHAPTER 40: URL Rewrites

Temporary (302)

Permanent (301)

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

Custom URL Rewrite
7.

Before saving the redirect, review the following:
l

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

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

When complete, tap Save.
The new rewrite appears in the grid at the top of the list.

Saved URL Rewrite

646

Magento Commerce User Guide

CHAPTER 40: URL Rewrites

Creating URL Rewrites

Step 3: Test the Result
1.

Go to the home page of your store.

Do one of the following:
l

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

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

Field Descriptions
FIELD
Create URL Rewrite

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

Request Path

The CMS page that is to be redirected.
The Request Path must be unique, and cannot be in use by another
redirect. If you receive an error message that the Request Path
already exists, delete the existing redirect, and try again.

Target Path

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

Redirect

Determines the type of redirect. Options :

Description

Magento Commerce User Guide

No redirect is specified.

Temporary (302)

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

Permanent (301)

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

Describes the purpose of the rewrite for internal reference.

647

Creating URL Rewrites

CHAPTER 40: URL Rewrites

Custom Rewrites
A custom rewrite can be used to manage miscellaneous redirects, such as redirecting a page
from your store to an external website. For example, you might have two Magento websites,
each with their own domain. You can use a custom redirect to reroute requests for a product,
category, or page to the other website. Unlike other redirect types, the target of a custom
redirect is not chosen from a list of existing pages in your store.
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although
people might still navigate to the former page from search engines or outdated links, the
redirect causes your store to switch to the new target.

Add URL Rewrite

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

Step 1: Plan the Rewrite
1.

To avoid mistakes, write down the URL of the "redirect to" page, and the URL key of the
"redirect from" page.
If you're not sure, open each page, and copy the URL from the address bar of your browser.
Custom Path

648

Redirect to:

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

Redirect from:

cms-page

Magento Commerce User Guide

CHAPTER 40: URL Rewrites

Creating URL Rewrites

category.html
category/subcategory.html
product.html
category/product.html

Step 2: Create the Rewrite
1.

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

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

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

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

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

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

Set Create URL Rewrite to “Custom.”

Under URL Rewrite Information, do the following:
a.

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

In the Request Path field, enter the URL key and path—if applicable—of the product,
category, or CMS page that is to be redirected.
The Request Path must be unique for the specified store. If there is already a redirect that uses
the same Request Path, you will receive an error when you try to save the redirect. The
previous redirect must be deleted before you can create a new one.

In the Target Path field, enter the URL of the destination. If the target is located on
another website, enter the fully qualified URL.

Set Redirectto one of the following:

Temporary (302)

Permanent (301)

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

Magento Commerce User Guide

649

Creating URL Rewrites

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

650

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

CHAPTER 40: URL Rewrites

Creating URL Rewrites

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

Field Descriptions
FIELD
Create URL Rewrite

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

Request Path

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

Target Path

The path or URL that is the destination of the redirect.

Redirect

Determines the type of redirect. Options :
No

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

Description

Magento Commerce User Guide

Temporary (302)

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

Permanent (301)

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

Describes the purpose of the rewrite for internal reference.

651

652

Magento Commerce User Guide

CHAPTER 41:

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

Google Adwords

Magento Commerce User Guide

653

Google Analytics

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

654

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 41: Google Tools

Google Tag Manager

Google Tag Manager
Google Tag Manager helps you manage the many tags, or snippets of code, that are related to
your marketing campaign events. Google Tag Manager gives you the ability to add tracking
tags to your site to measure the audience, or to personalize, retarget, or conduct search engine
marketing initiatives.
Google Tag Manager directly transfers data and events to Google Analytics, Enhanced
Ecommerce and other third-party analytics solutions, to produce a clear picture of how well
your site, products, and promotions are performing.
The following instructions walk you through the process of setting up a Google Tag Manager
account, configuring your Magento store, and creating a tag.
Process Overview:
Step 1: Configure Your Google Analytics Account
Step 2: Configure Your Google Tag Manager Account
Step 3:Configure Your Store

Step 1: Configure Your Google Analytics Account
1.

To enable Internal Site Search Tracking, do the following:

Navigate to Select View > View Settings.

Turn Site Search Tracking On.

Set Query parameter to “q”.

When complete, Save the settings.

To enable display features, do the following:
a.

Choose Property Settings.

Under Advertising Features, set Enable Demographics and Interest Reports to “On”.

Save the settings.

To enable Ecommerce Tracking, do the following:
a.

Navigate to Select View > Ecommerce Settings.

Set Enable Ecommerce to “On”.

Set Enable Enhanced Ecommerce Reporting to “On”.

Save the settings.

Reload the page to verify that all the settings remain “On”.

Magento Commerce User Guide

655

Google Tag Manager

CHAPTER 41: Google Tools

If not all settings are “On,” repeat the previous steps, save, and reload the page. Repeat this
process until all settings are set to “On”.

Step 2: Configure Your Google Tag Manager Account
The following instructions show how to configure a new container with the basic settings. A
sample Composer configuration (.json) file is used to simplify the process.
1.

Right-click this link: GMT_M2_Config_json.txt. Choose Save link as to download the sample
text file. Then, do the following:
a.

Open the file in an editor, and save as GMT_M2_Config.json.

Zip the file to produce an archive called GMT_M2_Config.zip.
The zipped file will be uploaded directly to Google Tag Manager, and does not need to be
copied to your server.

Create a new container. For this example, we recommend that you create a new container,
rather than modify an existing container.

Navigate to Admin > Container > Import Container. Then, verify the following settings:
l

The Overwrite option should be selected for the new container.

The Merge option should be selected is you are using an existing container.

To edit the Google Analytics ID that is referenced in variables, do the following:
a.

Navigate to Variables > User-Defined Variables.

Choose Google Analytics. Then, update the placeholder (UA-xxxxxx-x) with your own GA
ID.

Follow Google’s instructions to add tags, triggers, and variables to the new container.
If you have settings in another container that you want to use, they can be moved to the new
container.

Follow Google’s instructions to publish the new container.

Step 3: Configure Your Store

656

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

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

Expand

the Google Analytics section, and do the following:

Magento Commerce User Guide

CHAPTER 41: Google Tools

Google Tag Manager

Google API - Google Tag Manager
a.

Set Enable to “Yes.”

Set Account type to “Google Tag Manager.”

In the Container ID field, enter your GTM ID. (GTM-xxxxxx)

If you are also using Google Analytics to content experiments, set Enable Content
Experiments to “Yes.”

Leave the remaining fields as they are.

When complete, tap Save Config .

Test your Google Tag Manager settings to verify that everything works correctly.

Field Descriptions
FIELD

SCOPE

Enable

Store View

DESCRIPTION
Determines if Google Analytics Enhanced
Ecommerce can be used to analyze activity in your
store.
Options include: Yes / No

Account type

Store View

Determines the Google tracking code that is used to
monitor store activity and traffic. Options include:
Google Analytics
Google Tag Manager

Magento Commerce User Guide

657

Google Tag Manager

CHAPTER 41: Google Tools

Field Descriptions (cont.)
FIELD

658

SCOPE

DESCRIPTION

Container Id

Store View

If Google Tag manager is already installed and
configured for your store, the Container ID appears
automatically in this field.

List property for the
catalog page

Store View

Identifies the Tag Manager property associated with
the catalog page. Default value: Catalog Page

List property for the crosssell block

Store View

Identifies the Tag Manager property associated with
the cross-sell block. Default value:Cross-sell

List property for the up-sell
block

Store View

Identifies the Tag Manager property associated with
the up-sell block. Default value: Up-sell

List property for the related
products block

Store View

Identifies the Tag Manager property associated with
the related products block. Default value: Related
Products

List property for the search
results page

Store View

Identifies the Tag Manager property associated with
the search results page. Default value: Search
Results

“Internal Promotions” for
promotions field “Label”

Store View

Identifies the Tag Manager property associated with
the labels for internal promotions. Default value: Label

Magento Commerce User Guide

CHAPTER 41: Google Tools

Google Tag Manager

Creating a Tag to Track Conversions
If you have a Google AdWords account, you can create a tag that tracks conversions. The
following example shows how to use both Google Tag Manager and Google Analytics to create a
tag that fires on your store’s conversion “Success” page.
Process Overview:
Step 1: Create a Tag
Step 2: Create a Rule
Step 3: Preview and Publish

Step 1: Create a Tag
1.

In the New Tag box, tap Add a new tag.

Google Tag Manager
3.

You will need the following information from your AdWords account:
l

Conversion ID

Conversion Label

If you need help, visit Google’s support site.
4.

From the Google Tag Manager dashboard, tap Google AdWords. Then, do the following:
a.

Tap the title placeholder, and enter a name for the new tag.

Under Choose Product, select Google Adwords.

Magento Commerce User Guide

659

Google Tag Manager

CHAPTER 41: Google Tools

Choose Product
c.

Under Choose a Tag Type, select AdWords Conversion Tracking. Then, tap Continue.

Enter the Conversion ID and Conversion Label from your AdWords account. Then, tap
Continue.

Configure Tag

660

Magento Commerce User Guide

CHAPTER 41: Google Tools

Google Tag Manager

Step 2: Create a Rule
Continuing from the Google Tag Manager dashboard, the next step is to create a rule that fires
the tag on the conversion page.
1.

Under Fire On, tap Some Pages.

In the Choose Pages section, complete the following settings:
Name:

Enter a name for the page description.

Variable:

url

Operation:

matches RegEx

To learn more, see: What is “matches regex” for? in Tag Manager
Help
Value:

checkout/success.*

Conversion Page Location
3.

Mark the green checkbox, and tap Save. The trigger that you set up appears as a blue button
in the Fire On section.

When complete, tap Save Tag.

Magento Commerce User Guide

661

Google Tag Manager

CHAPTER 41: Google Tools

Step 3: Preview and Publish
The next step in the process is to preview the tag. Each time the tag is previewed, a snapshot of the
version is saved. When you are satisfied with the results, go to the version that you want to use, and
tap Publish.

662

Magento Commerce User Guide

CHAPTER 41: Google Tools

Google Tag Manager

Enhanced Ecommerce
Enhanced Ecommerce is a plugin for Google Universal Analytics that gives you insight into the
shopping and purchasing behavior of your customers. You can use Enhanced Ecommerce to
produce reports about key customer activities, such as when customers add items the cart,
begin the checkout process, or complete a purchase. You can also identify and analyze patterns
of shoppers who abandon their carts without making a purchase.
The following instructions show how to configure Google Tag Manager with Universal Analytics
to produce Enhanced Ecommerce data and reports.

Tags Fired in Shopping Cart Shown in Debug Mode

Step 1: Sign Up for Google Accounts
1.

Step 2: Configure Enhanced Ecommerce
1.

Create a new property for Enhanced Ecommerce analytics with the following settings:

Magento Commerce User Guide

663

Google Tag Manager

CHAPTER 41: Google Tools

Enhanced Ecommerce Property
SETTING

VALUE

ENABLE ECOMMERCE SETTINGS
Status

Related Products

ENHANCED ECOMMERCE SETTINGS
Enable Enhanced Ecommerce Reporting ON
Checkout Labeling
3.

664

(not required)

When complete, tap Submit.

Magento Commerce User Guide

CHAPTER 41: Google Tools

Google Tag Manager

Step 3: Create Tags and Triggers
1.

Google Tag Manager Triggers
NAME

EVENT TYPE

AddToCart

Custom Event

Checkout

Custom Event

Checkout only

Page View

CheckoutOption

Custom Event

gtm.dom

Custom Event

ProductClick

Custom Event

PromotionClick

Custom Event

RemoveFromCart

Custom Event

FILTER

Page URL matches RegEx /checkout/.*

Create the following Universal Analytics tags with the same basic configuration.

Universal Analytics Tags
NAME

TYPE

FIRING TRIGGERS

Add to cart tracking

Universal Analytics

AddToCart

Checkout option tracking

Universal Analytics

CheckoutOption

Checkout tracking

Universal Analytics

Checkout

Pageview tracking

Universal Analytics

gtm.dom

Product client tracking

Universal Analytics

ProductClick

Promo click tracking

Universal Analytics

PromotionClick

Remove from cart tracking

Universal Analytics

RemoveFromCart

Magento Commerce User Guide

665

Google Tag Manager

CHAPTER 41: Google Tools

Basic Tag Configuration
SETTING

VALUE

Product

Google Analytics

Tag Type

Universal Analytics

Tracking ID

UA-XXX (The tracking ID from your Universal Analytics account.)

Enable Enhanced
Ecommerce Features

True

Use data layer

True

Use Debug version

True

Complete the individual tracking configurations as follows:
a.

Enter the following Add to Cart tracking settings:

Add to Cart Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Add to Cart

Trigger

AddToCart

Enter the following Checkout option tracking settings:

Checkout Option Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Checkout Option

Trigger

CheckoutOption

Enter the following PageView tracking settings:

Page View Configuration

666

SETTING

VALUE

Track Type

PageView

Trigger

gtm.dom

Complete the following Product Click tracking configuration:

Magento Commerce User Guide

CHAPTER 41: Google Tools

Google Tag Manager

Product Click Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Product Click

Trigger

ProductClick

Complete the following Promotion Click tracking configuration:

Promotion Click Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Promotion Click

Trigger

PromotionClick

Complete the following Remove from Cart tracking configuration:

Remove from Cart Configuration
SETTING

VALUE

Track Type

Event

Category

Ecommerce

Action

Remove from Cart

Trigger

RemoveFromCart

When complete, tap Preview and verify that the tags work correctly.

When complete, tap Publish.

Magento Commerce User Guide

667

Google Tag Manager

CHAPTER 41: Google Tools

Troubleshooting Tools
Both Google Tag Manager and Universal Analytics have debug modes with a variety of tools
that you can use to troubleshoot your integration.

Preview and Debug
Tag Manager’s debug preview mode shows tags as they are fired and their associated data
layers.

Tags Fired During Checkout
Google Analytics Enhanced Ecommerce makes it possible to send sales data, and information
about product impressions and promotions to the data layer, along with any Google Analytics
pageview or event. You can use the values in the data layer to measure impressions and
analyze customer actions.

668

Magento Commerce User Guide

CHAPTER 41: Google Tools

Google Tag Manager

Values in Data Layer
You also can use the JavaScript console in Chrome to see the output of events as it is sent to
Google.

Chrome JavaScript Console

Magento Commerce User Guide

669

Google AdWords

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

670

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

Magento Commerce User Guide

671

Google AdWords

CHAPTER 41: Google Tools

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

Set Conversion Language to the language that is identified in your Google AdWords
script.

Enter the Conversion Format to be used for the Google Sites Stat notification on the
conversion page.
1

Displays a one-line notification with a link to more information about Google
tracking.

Displays a two-line notification with a link to more information about Google
tracking.

Displays no customer notification.

Enter the hexadecimal code for the Conversion Color that you want to use for the Google
Site Stats notification label.

Enter the encrypted text for the Conversion Label that appears on the Google Sites Stat
notification.
For example: MlEYCOKBnGoQz6CZoAM

Sample Google AdWords Tag Code

Set Conversion Value Type to one of the following:
Dynamic

Determines that a conversion has occurred based on the dynamic Order
Amount value.

Constant

Determines that a conversion has occurred based on a specific value
entered.

For a Constant conversion value type, enter a specific Value for the Order Amount to qualify as
a conversion.
6.

When complete, tap Save Config.

Step 4: Verify the Configuration
Within a few hours, the tracking status in your Google AdWords dashboard changes from
"Unverified" to "No recent conversions" or "Recording conversions." When someone clicks your
ad and makes a purchase, the conversion appears on the Conversion Actions page of your
dashboard and campaign report.

Magento Commerce User Guide

673

674

Magento Commerce User Guide

CONTENT

675

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

Content Elements
Design & Theme
Content Staging

676

CHAPTER 42:

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.

About Us

1The art of promoting products or services by providing valuable information at no charge.

Magento Commerce User Guide

677

CHAPTER 42: Content Menu

Content Menu

To display the Content menu:
On the Admin sidebar, tap Content .

678

Magento Commerce User Guide

CHAPTER 42: Content Menu

Menu Options

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. Then, organize your
pages into a hierarchy with navigation.

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.

Banners
Create banners that are triggered by promotions and that
appear only to customers in specific, targeted segments.

Widgets
Display dynamic data and add blocks, links, and
interactive elements most anywhere in your store.

Magento Commerce User Guide

679

Menu Options

CHAPTER 42: Content Menu

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

Staging
Content Staging gives your business team the ability
to easily create, preview, and schedule a wide range of
content updates directly from the Admin of your
store.

680

Magento Commerce User Guide

Content Elements

681

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
Page Hierarchy
Configuring Page Hierarchy
Adding a Node
Blocks
Adding a New Block
Adding Social Plugins
Positioning Blocks on a Page
Banners
Creating a Banner
Rotating Banners
Using Banners in Price Rules
Widgets
Widget Types
Creating a Widget
New Products List
Design & Theme

682

CHAPTER 43:

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

683

Core Content

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

684

Magento Commerce User Guide

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

685

Core Content

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

686

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

687

Workspace Controls

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

688

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

689

Workspace Controls

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

690

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

691

Workspace Controls

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

692

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

Magento Commerce User Guide

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

693

Workspace Controls

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

694

Tap the header of the column, and hold.

Drag the column to the new position, and release.

Magento Commerce User Guide

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

695

Workspace Controls

CHAPTER 43: Pages

Scheduled Changes
Page changes can be applied on schedule, and grouped with other content changes. You can
create a new campaign based on scheduled changes to a page, or apply the changes to an
existing campaign. To learn more, see: Content Staging.

Scheduled Changes

696

Magento Commerce User Guide

CHAPTER 43: Pages

Adding a New Page

Adding a New Page
The process of adding a new content page to your store is essentially the same for any type of
page you might want to create. You can include text, images, blocks of content, variables, and
widgets. Most content pages are designed to be read by search engines first, and by people
second. Keep the needs of each of these two very different audiences in mind when choosing the
page title, and URL, and when composing the meta data, and content.
The following instructions walk you through each step to create a basic page. Some advanced
features are skipped over, but are covered in other topics.

Pages

Process Overview:
Step 1: Add a New Page
Step 2: Complete the Content
Step 3: Complete the SEO Information
Step 4: Define the Scope
Step 5: Make Design Changes (Optional)
Step 6: Preview the Page
Step 7: Publish the Page

Step 1: Add a New Page
1.

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

Tap Add New Page.

Magento Commerce User Guide

697

Adding a New Page

CHAPTER 43: Pages

New Page
3.

On the new page, do the following:
a.

By default, a new page is published when the record is saved. If you do not want to
publish the page immediately, set Enable Page to "No."

Enter the Page Title. The Page Title is the name that appears in the breadcrumb trail
navigation.

To schedule design changes, expand

the Custom Design Update section. Then, do the

following:
a.

Use the calendar (

) to choose the From and To dates when the design change is to be in

effect.
b.

If applicable, set New Theme to a different theme that is to be used for the page.

If applicable, set New Layout to one of the following:
l

1 column

2 columns with left bar

2 columns with right bar

3 columns

Empty

Custom Design Update

698

Magento Commerce User Guide

CHAPTER 43: Pages

Adding a New Page

Step 2: Complete the Content
1.

Expand

the Content section.

Content
2.

In the Content Heading box, type the heading that you want to appear at the top of the page.

By default, the editor opens in WYSIWYG mode with the toolbar at the top.
l

If you prefer to work directly with the HTML code, tap Show / Hide Editor.

Complete the content and format the text as needed. You can add images, variables, and
widgets as needed. To learn more, see: Using the Editor.

Tap Save and Continue Edit.

Step 3: Complete the SEO Information
1.

Expand
a.

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

When the page was saved, a default URL key was created that is based on the Content
Heading. You can accept the default, or enter another URL Key that consists of all
lowercase characters, with hyphens instead of spaces.

Enter a Meta Title for the page. The Meta Title should be less than seventy characters in
length, and appears in the browser title bar and tab.

Enter your choice of high-value Meta Keywords that search engines can use to index the
page. Separate multiple words with a comma. Meta keywords are ignored by some search
engines, but used by others.

In the Meta Description field, enter a brief description of the page for search results
listings. Ideally, the description should be from 150-160 characters in length, with a
maximum limit of 255.

Magento Commerce User Guide

699

Adding a New Page

CHAPTER 43: Pages

Search Engine Optimization
2.

Tap Save and Continue Edit.

Step 4: Define the Scope of the Page
1.

Expand

the Page in Websites section.

In the Store View list, select each view where the page is to be available. If the installation has
multiple websites, select each website and store view where the page is to be available.

Pages in Websites

Step 5: Enter Any Design Changes (Optional)
1.

Expand the

Design section. Then, do the following:

Design
a.

700

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

CHAPTER 43: Pages

Adding a New Page

To include additional layout instructions, enter valid XML code in the Layout Update
XML box.

Step 6: Preview the Page
1.

To return to the Pages grid, tap Save Page.

Fnd the page in the grid. Then in the Action column, select View.

To return to the grid, tap Back in the upper-left corner of the browser window.

Step 7: Publish the Page
1.

In the Action column of the grid, select Edit.

Set Enable Page to "Yes."

Tap Save Page .
Now that your page is complete, it can be added to your store navigation, linked to other
pages, or added as a link in the footer of your store. You can also use it as your new home
page.

Magento Commerce User Guide

701

Adding a New Page

CHAPTER 43: Pages

Switching Home Pages
You can maintain a selection of different home pages, and activate the page that you want to
use as the default home page.

To Change the Home Page:
1.

Complete the steps to add a new page.

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

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

Expand

the Default Pages section. Then, do the following:

Default Pages

Set CMS Home Page to the new page.

Tap Save Config.

In the message at the top of the workspace, tap the Cache Management link, and refresh any
invalid caches.

702

Magento Commerce User Guide

CHAPTER 43: Pages

Media Storage

Media Storage
Media storage helps you organize and gain access to media files that are stored on the server.
The path to the location of the files is determined by the Base URL configuration. Files in
media storage can be accessed from the editor while working on pages and static blocks. Media
storage is usually located in the file system on the same server as the Magento program files.
Alternatively, media files can be managed in a database, or located on a separate server or
content delivery network. The editor can be configured to use either static or dynamic media
URLs for catalog content in category or product descriptions.

Media Storage

To insert an image from media storage:
Open the page or block to be edited. Then, use one of the following methods to insert an image
from media storage:

Method 1: From WYSIWYG Mode
1.

On the toolbar of the WYSIWYG editor, click Insert Image (

After the Image URL field, click Browse (

Insert Image (WYSIWYG Mode)

Magento Commerce User Guide

703

Media Storage

CHAPTER 43: Pages

In the directory tree on the left, navigate to the folder where the image is stored.

Select the tile of the image. Then, tap Insert File.

Insert File

Method 2: From HTML Mode
1.

Position the cursor in the code where the tag is to be inserted.

Tap Insert Image.

Insert Image (HTML Mode)

704

Magento Commerce User Guide

CHAPTER 43: Pages

Media Storage

To upload files to media storage:
The first two steps are the same as if you are inserting an image.
1.

On the toolbar of the WYSIWYG editor, click Insert Image (

After the Image URL field, click Browse (

In the directory tree on the left, do one of the following:
l

Navigate to the folder where you want to save the uploaded image.
Navigate to the place where you want to create a new folder, and tap Create Folder. Then,
enter the folder name, and tap OK.

To upload file(s) to media storage, tap Choose Files . Then, do the following:
a.

In the directory of your local computer, navigate to the location of the images.

Select each image that is to be uploaded.

Tap Open.
The images are uploaded to the current media storage folder on the server.

Media Storage

Magento Commerce User Guide

705

Using the Editor

CHAPTER 43: Pages

Using the Editor
The WYSIWYG editor gives you the ability to enter and format while working in a “What You
See Is What You Get” view of the content. If you prefer to work directly with the underlying
HTML code, you can easily change modes. The editor can be used to create content for pages,
blocks, and product descriptions. When working in the product catalog, the editor is accessed
by clicking the WYSIWYG Editor button. For a complete list of toolbar buttons, see: Using the
Editor in the online guide.

Editor Toolbar

Inserting a Link
An easy way to insert a link is to use the Link button in the editor toolbar. It doesn’t require
any knowledge of HTML, and the result is the same.

To insert a link:
1.

Highlight the text where you want to create the link. Then, in the editor toolbar, tap the Link
button.

Insert Link Button
2.

706

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 43: Pages

Using the Editor

Inserting an Image
From the editor, you can insert an image that has been uploaded to Media Storage, or link to
an image that resides on another server.

Media Storage

Method 1: Insert an Image from Media Storage
1.

If necessary, tap Show / Hide Editor to work directly with the code.

Position the cursor where you want the code for the image to be inserted. Then, tap Insert
Image.

Choose the image that you want to use, and tap Insert File .

To view the image in WYSIWYG mode, tap Show / Hide Editor again.

Method 2: Insert an Image from Another Server
Use this method to insert an image that is available online, but resides on another server. You
must have the full URL of the image to complete the process.
1.

If necessary, tap Show / Hide Editor to work in WYSIWYG mode.

Position your cursor where you want the image to appear.

On the Editor toolbar, tap the Insert Image button. Then, do the following:

Magento Commerce User Guide

707

Using the Editor

CHAPTER 43: Pages

Insert Image Button

In the Image URL field, paste the full URL to the image on the other server.

In the Image Description field, enter a brief description of the image.

In the Title field, enter a relevant title for the image.

Tap Insert to complete the process.

Inserting a Widget
The Widget tool can be used to add a variety of content elements to the page, including links to
any content page or node, product, or category. Links can be positioned on the page in a block
format, or incorporated directly into the content. You can use the Widget tool to create links to
the following types of content:
l

Content Pages

Catalog Categories

Catalog Products

By default, links inherit their style from the style sheet of the theme.

To insert a widget:
1.

Open the content page to be edited.

In the panel on the left, choose Content. Then, use either of the following methods:

Method 1: WYSIWYG Mode
1.

Tap Show / Hide Editor to work in WYSIWYG mode.

Position the cursor in the text where you want the widget to appear.

On the editor toolbar, tap Insert Widget.

Method 2: HTML Mode
From the HTML editor, tap Insert Widget.
3.

When prompted, choose the Widget Type. This example shows how to insert a link to a
product.

708

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

Magento Commerce User Guide

CHAPTER 43: Pages

Using the Editor

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

Set Template to one of the following:

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

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

Tap Select Product, and do the following:
a.

In the tree, navigate to the category you want.

In the list, choose the linked product.

Click Insert Widget to place the link on the page. In the HTML, a markup tag for the link
appears at the top of the page, enclosed in double curly braces.

If needed, use Cut (Ctrl + x) and Paste (Ctrl + v) to position the markup tag in the code
where you want the link to appear.

Tap Show / Hide Editor to see the link in WYSIWYG mode.
You can continue editing the page, and incorporate other links into the content.

Inserting a Variable
Your store includes many predefined variables that can be incorporated into content pages and
other communications. 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

709

Using the Editor

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

710

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 43: Pages

Page Hierarchy

Page Hierarchy
Your store’s page hierarchy system gives you the ability to organize your content pages and add
pagination, navigation, and menus. The Privacy Policy page in the sample data is an example
of a page with a menu on the left. If you publish a large amount of content on a regular basis,
you can use page hierarchy to organize your content to make it easy for people to find articles
of interest.
The page hierarchy system uses nodes to identify related pieces of content, and to organize
content pages into a parent/child relationships. A parent node is like a folder that might
contain child nodes and pages. The relative position of each node and page in the hierarchy is
shown as a tree. A node might contain other nodes and content pages, and a single content
page might be associated with multiple nodes and other content pages in a parent/child or
neighbor relationships.

Page with Left Navigation

Magento Commerce User Guide

711

Page Hierarchy

CHAPTER 43: Pages

Configuring Page Hierarchy
The configuration settings activate the page hierarchy system and metadata, and determine the
default menu layout.

CMS Page Hierarchy

To configure page hierarchy:

712

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

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

Expand

When complete, tap Save Config.

the CMS Page Hierarchy section, and make any changes that are necessary.

Magento Commerce User Guide

CHAPTER 43: Pages

Page Hierarchy

Adding a Node
The following example shows how to create a node with simple navigation to related content
pages. Although a node does not have a content page associated with it, it does have a URL
Key which can be referenced elsewhere in your site.
For example, you might create a node called “Press Releases” that has navigation to individual
press releases. Then, you can include the link on your “About Us” page to the node. Or you
might create a node for a collection of back issues of your newsletter.
To link to a node, use the Widget tool to create a CMS Hierarchy Node Link. Then, place the
widget in a content block or page.

Navigation Menu on About Us Page

Process Overview:
Step 1: Create a Node
Step 2: Add Pages to the Node
Step 3: Define the Structure
Step 4: Add Pagination Controls
Step 5: Choose the Menu Layout

Magento Commerce User Guide

713

Page Hierarchy

CHAPTER 43: Pages

Step 1: Create a Node
1.

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

Hierarchy - CMS Pages Grid
2.

Above the grid, tap Add Node. Then, do the following:
a.

Under Page Properties, type a Title for the node.

Enter a suitable URL Key in all lowercase characters, using hyphens to separate words,
instead of spaces.

Page Properties
c.

714

Tap Save . The node appears as a folder in the tree on the left of the page.

Magento Commerce User Guide

CHAPTER 43: Pages

Page Hierarchy

Node Added to Page Hierarchy Tree

Step 2: Add Pages to the Node
1.

In the hierarchy tree, click the node to open it in edit mode.

Scroll down to the CMS pages section, and mark the checkbox of each page you want to
include in the hierarchy.

Tap Add Selected Pages(s) to Tree. Each selected page appears in the tree below the node folder.

Pages Added to Tree

Magento Commerce User Guide

715

Page Hierarchy

CHAPTER 43: Pages

Step 3: Define the Structure
1.

If necessary, drag the pages into position to reflect the order that they are to appear in the
menu.

Drag Pages into Position
2.

Click the node at the top of the hierarchy. The Page Properties section now displays
information about the node.

Under Render Metadata in HTML Head, do the following:

Render Meta Data

716

To identify the node as the top of the hierarchy, set First to “Yes.”

To display a pagination control, set Next/Previous to “Yes.

To organize the pages in the hierarchy as a book, set Enable Chapter/Section to “Yes.”

To assign the node to a specific part of the book, set Chapter/Section to one of the
following:
l

Chapter

Section

Both

Magento Commerce User Guide

CHAPTER 43: Pages

Page Hierarchy

If you don’t want to include the node as part of the book, choose “None.”

Step 4: Add Pagination Controls
1.

UnderPagination Options for Nested Pages, set Enable Pagination to “Yes.”

Pagination Options
2.

In the Frame field, enter the number of page links that you want to include in the pagination
control

If there are more pages in the hierarchy that can be included in the pagination control, do the
following:
In the Frame Skip field, enter the number of pages that you want to skip ahead (or back) for
the next set of pagination links.

Magento Commerce User Guide

717

Page Hierarchy

CHAPTER 43: Pages

Step 5: Choose the Menu Layout
1.

If you want the mode to appear in the menu, do the following:
a.

Under Page Navigation Menu Options, set Show in Navigation Menu to “Yes”.

Page Navigation Menu Options
b.

718

To specify the location of the menu in relation to the content, set Menu Layout ot one of
the following:
l

Use Default

Content

Left Column

Right Column

To specify how much detail is included in the menu, set Menu Detalization to one of the
following:
Only Children

Includes only subpages in the menu.

Neighbours and
Children

Includes subpages and other pages that re at the same level in the
hierarchy.

To determine the depth of the menu, set Maximal Depth to the maximum number of levels
to include.

Magento Commerce User Guide

CHAPTER 43: Pages

Page Hierarchy

To format the menu, choose the List Type and corresponding List Style.
Unordered

The menu options are not numbered, and can be formatted with or
without bullets..

Ordered

The menu options are numbered, and can be formatted as numeric,
alphabetic, or roman numerals in either upper-or lowercase.

Under Main Navigation Menu Options, do the following:
If you want the node to be visible in the navigation menu, set Show in Navigation menu to
“Yes”.

Main Navigation Menu Options
3.

When complete, tap Save.

Field Descriptions
FIELD

DESCRIPTION

NODE PROPERTIES
Title

The name of the the node.

URL Key

A unique web address for the node.

RENDER METADATA IN HTML HEAD
This settings in this section apply only to top-level nodes and pages, and define the structure of the
hierarchy.
First

Identifies the first page in the hierarchy. Options: Yes / No

Next/Previous

Adds Next and Previous page links so readers can browse in
sequence. Options: Yes / No

Enable Chapter/Section

Determines if the content can be organized as a book, with chapters
and sections. Options: Yes / No

Chapter/Section

Options:

Magento Commerce User Guide

719

Page Hierarchy

CHAPTER 43: Pages

Field Descriptions (cont.)
FIELD

DESCRIPTION
No

Does not assign a book part to the current
node.

Chapter

Assigns the current node as a chapter.

Section

Assigns the current node as a section.

Both

Assigns the current node as both a chapter
and section.

PAGINATION OPTIONS FOR NESTED PAGES
Enable Pagination

Determines if a pagination control appears at the bottom of the each
page. Options: Yes / No

Frame

Determines the number of pagination links that appear in the
pagination control.

Frame Skip

Specifies the number of pages to skip ahead if there are additional
pages beyond what is visible in the pagination control.

PAGE NAVIGATION MENU OPTIONS
Show in Navigation Menu

Determines if a navigational menu is generated for the page
hierarchy. Options: Yes / No

Menu Layout

Determines the default layout of navigation menu. Options:

Menu Detalization

Maximal Depth

720

Use Default

Uses the menu style that is specified in the
configuration.

Left Column

The menu appears to the left of the content.

Right Column

The menu appears to the right of the content.

Determines the level of detail that is to be included in the menu.
Options:
Only Children

Includes only subpages i(children) in the
menu.

Neighbors and
Children

Includes both subpages and other pages at
the same level in the hierarchy (neighbors) in
the menu.

Determines the number of levels in the menu.

Magento Commerce User Guide

CHAPTER 43: Pages

Page Hierarchy

Field Descriptions (cont.)
FIELD
List Type

DESCRIPTION
Determines the style that is applied to the menu. Options:
Unordered

Creates a list of menu options that can be
styled with or without bullets. List Style
Options:
Default
Circle
Disc
Square

Ordered

Creates a list of numbered menu options that
can be numbered. List Style Options:
Default
Numbers (1, 2, 3,...)
Lower Alpha (a, b, c. ...)
Upper Alpha (A, B, C, ...)
Lower Roman (i, ii, iii, ...)
Upper Roman (I, II, III, ...)

MAIN NAVIGATION MENU OPTIONS
Show in navigation menu

Magento Commerce User Guide

Determines if the selected node is visible in the navigation menu.
Options: Yes / No

721

722

Magento Commerce User Guide

CHAPTER 44:

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

723

Adding New Blocks

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

724

Magento Commerce User Guide

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

725

Adding New Blocks

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

726

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

727

Adding New Blocks

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

728

Magento Commerce User Guide

CHAPTER 44: Content Blocks

Adding New Blocks

Adding a Lightbox or Slider
There is a wide assortment of jQuery-based image lightboxes, sliders, and carousels available
on Magento Marketplace, and some are free. A recent search on the term “slider” returned thirythree results.

Slider Extensions
To add a lightbox or slider to your store, download the extension from Magento Markeplace,
and follow the instructions from the developer.

Magento Commerce User Guide

729

Positioning Blocks

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

730

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

731

Positioning Blocks

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

732

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

733

Positioning Blocks

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

734

Magento Commerce User Guide

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

735

736

Magento Commerce User Guide

CHAPTER 45:

Banners
Banners can be used to display an image or block of content, and appear for a specific period of
time for a promotion. You can create banners that are visible only to certain customer
segments, or whenever price rule conditions and coupons apply.
When designing banners for your store, take into consideration both the page layout and the
theme you are using. Banners are often designed to appear on a specific page, and in a specific
part of the page layout. Although the header and footer are a fixed width, the width of the
content area and sidebars, can vary according to theme and page layout. When designing a
banner with graphic images, it is important to understand the page layout, so you can put the
available space to best use.

Banner on Home Page

Magento Commerce User Guide

737

Creating a Banner

CHAPTER 45: Banners

Creating a Banner
A banner can be as simple as a text message or image, or contain a combination of text,
images, and code that is triggered by a promotion according to schedule. After the banner is
created, use the Widget tool to place it in your store, or add it to a rotating sequence of
banners.

Free Shipping Banner in Header

Process Overview:
Step 1: Complete the Banner Properties
Step 2: Complete the Banner Content
Step 3: Choose a Related Promotion (optional)
Step 4: Place the Banner

Step 1: Complete the Banner Properties

738

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

In the upper-right corner, tap Add Banner. Then, do the following:
a.

Enter a Banner Name for internal reference.

Set Status to “Active.”

In the Applies To list, select one of the following:
l

Any Banner Type

Specified Banner Types

Magento Commerce User Guide

CHAPTER 45: Banners

Creating a Banner

This setting determines the location on the page where the banner is placed. (To select
more than one, hold the Ctrl key down and click each option.)

Banner Properties
d.

If the banner is to be used for a specific customer segment, set Customer Segments to
“Specified.” Then, choose each customer segment that is associated with the banner.

Step 2: Complete the Banner Content
1.

In the panel on the left, choose Content.

If the banner is to use the same content for each store view, clear the No Default Content
checkbox.

Default Content
3.

In the text box, enter the HTML code that is needed to format the banner. Then, do any of the
following:

Insert Widget
1.

Tap Insert Widget.

Choose the Widget Type.

Complete the Widget Options.

Tap Insert Widget.

Magento Commerce User Guide

739

Creating a Banner

CHAPTER 45: Banners

Insert Image
1.

Tap Insert Image.

In the text box, position the cursor where you want the image tag to be inserted.

Do either of the following:

Tap Browse to find the image on your local computer.

Locate the image in the media folders on the left.

Tap Insert File.

Insert Variable

To insert a variable, tap Insert Variable. Then, choose the variable that you want to insert.

Complete the HTML as needed. Depending on the content, the text box might contain a
combination of HTML and markup tags.

To create content for a specific store view, do the following:
a.

In the Store View Specific Content box after the name of the store view, clear the Use
Default checkbox.

Follow the instructions in the previous step to enter the banner content for the store view.

Step 3: Choose a Related Promotion (optional)
1.

In the panel on the left, choose Related Promotions.

Scroll down through the list of available promotions for the type of price rule, and mark the
checkbox of each promotion that can be used with the banner.

Related Promotions
3.

740

When complete, tap Save Banner.

Magento Commerce User Guide

CHAPTER 45: Banners

Creating a Banner

Banner Saved

Step 4: Place the Banner
Use the Widget tool to create a Banner Rotator that places the banner at a specific location in
the store.

Banner Type by Location
LOCATION

DESCRIPTION

Content Area

The width of the main content area varies, depending on the column
layout of the page.

Footer

The bottom section of the page contains the footer links and
copyright notice.

Header

The top section of the page contains your logo, account links, search
box, and top navigation.

Left Column

The left column of a two- or three-column layout.

Right Column

The right column of a two-or three-column layout.

Magento Commerce User Guide

741

Rotating Banners

CHAPTER 45: Banners

Rotating Banners
A banner rotator can be used to display a single banner, or multiple banners in a specific
sequence or random order. The next banner in the sequence appears whenever the page is
refreshed.
The banner rotator is a frontend app that can be assigned to a specific page, product, or
category, and placed most anywhere in your store. In addition, banner rotators can be
associated with a specific cart or catalog price rule.
Process Overview:
Step 1: Create the Individual Banners
Step 2: Add a Widget
Step 3: Configure the Banner Rotator

Step 1: Create the Individual Banners
Create the individual banners that you want to include in the rotator.

Step 2: Add a Widget
Follow the basic steps to add a widget.
l

Set Type to "Banner Rotator."

Under Layout Updates, choose the page and location where the banner rotator is to appear.

Step 3: Configure the Banner Rotator
1.

In the left panel, choose Widget Options. Then, do the following:
a.

Set Banners to Display to “Specified Banners.”

(Optional) To limit the banner to a certain area of the page, set Restrict by Banner Types
to the place on the page where you want the banner to appear.

Set Rotation Mode to one of the following:
l

Do not rotate, display all at once

One at a time, Random

One at a time, Series

One at a time, Shuffle

To choose the banners to be included in the rotator, do the following:
a.

In the Specify Banners section, use Search to find the banners you want to include. If
necessary, tap Reset Filter to list all the available banners.

742

Mark the checkbox of each banner you want to include in the rotator.

Magento Commerce User Guide

CHAPTER 45: Banners

Rotating Banners

To set the sequence of each banner in relation to the others, enter a number in the
Position column. To place a banner in the first position, enter the number 1.

When complete, tap Save.

Banner Layout Update Options
OPTION
Display On Categories

DESCRIPTION
Determines the categories where the banner rotator appears.
Anchor Categories

Appears only on anchored category pages
listed in the layered navigation.

Non-Anchor
Categories

Appears only on non-anchored category
pages, which are category pages that are not
shown in the layered navigation.

Products

Displays the banner rotator for a specific
product, or type of product. Options:
All Product Type
Simple Product
Grouped Product
Configurable Product
Bundle Product
Virtual Product
Gift Card

Archive

CHAPTER 60:

Orders
The Orders workspace lists all current orders. Each row in the grid represents an order, and
each column represents an attribute, or data field. Use the standard controls to sort and filter
the list, find orders, and apply actions to selected orders. You can view existing orders, and
create new orders. The tabs above the pagination controls can be used to filter the list, change
the default view, change and rearrange columns, and export data.

Orders

Magento Commerce User Guide

965

Order Workspace

CHAPTER 60: Orders

Order Workspace
The Order workspace lists all current orders. Each row in the grid represents a customer order,
and each column represents an attribute, or data field . Use the standard controls to sort and
filter the list, find orders, and apply actions to selected orders. From the grid, you can view
existing orders, and create new orders. The tabs above the pagination controls are used to filter
the list, change the default view, change and rearrange columns, and export data.

Orders

966

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workspace

Workspace Controls
CONTROL
Create New Order
Go to Archive

DESCRIPTION
Creates a new order.
Displays the list of archived orders.

Initiates a search for orders based on the current filters.

Filters

Defines a set of search parameters that determines the records that
appear in the grid.

Default View

Determines the default column layout of the grid.

Columns

Determines the selection of columns and their order in the grid. The
column layout can be changed. and saved as a “view.” By default,
only some of the columns are included in the grid.

Export

Exports the selected records as a CSV or Excel XML file.

Column Descriptions
COLUMN

DESCRIPTION

Select

Mark the checkbox to select the quote(s) to be subject to an action,
or use the selection control in the column header. Options: Select All
/ Deselect All

A unique, sequential number that is assigned when a new order is
saved for the first time.

Purchase Point

Identifies the store view where the order was placed.

Purchase Date

The date the order was placed.

Bill-to Name

The name of the person who is responsible to pay for the order.

Ship-to Name

The name of the person to whom the order is to be shipped.

Grand Total (Base)

The grand total of the order.

Grand Total (Purchased)

The grand total of products purchased in the order.

Status

The current order status.

Action

View

Signifyd Guarantee
Decision

If enabled, Signifyd automatically reviews your orders for fraud, and
indicates which orders to ship, and which to reject.

Magento Commerce User Guide

Opens the order in edit mode.

967

Order Workspace

CHAPTER 60: Orders

Column Descriptions (cont.)
COLUMN

DESCRIPTION

ADDITIONAL COLUMNS AVAILABLE

968

Billing Address

The billing address of the customer who placed the order.

Shipping Address

The address where the order is to be shipped.

Shipping Information

The method that is to be used to ship the order.

Customer Email

The email address of the person who placed the order.

Customer Group

The customer group to which the person who placed the order is
assigned.

Subtotal

The order subtotal, without shipping and handling, and tax.

Shipping and Handling

The amount charged for shipping and handling.

Customer Name

The first and last name of the customer who placed the order.

Payment Method

The method of payment to be used for the order.

Total Refunded

Any amount from the order that is to be refunded to the customer.

Refunded to Store Credit

Any amount from the order that is to be refunded to the customer’s
store credit.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workspace

Order Actions
To apply an action to specific orders, mark the checkbox in the first column of each order. To
select or deselect all orders, use the control at the top of the column.

Order Actions

Action Controls
CONTROL
Actions

DESCRIPTION
Lists all actions that can be applied to selected orders. To apply an
action to an order, or group of orders, mark the checkbox in the first
column of each order. Order actions:
Cancel

Print Packing Slips

Hold

Print Credit Memos

Unhold

Print All

Print Invoices

Print Shipping Labels
Move to Archive

Mass Actions

Can be used to select multiple records as the target of action. Mark
the checkbox in the first column of each record that is subject to the
action. Options:
Select All / Unselect All,
Select Visible / Unselect Visible

Submit

Edit

Magento Commerce User Guide

Applies the current action to the selected order records.
Opens the order in edit mode.

969

Order Workspace

CHAPTER 60: Orders

Order Search
The Search box in the upper-left of the Orders grid can be used to find specific orders by
keyword, or by filtering the order records in the grid.

Search Results

To search for a match:
1.

Enter a search term into the page search box.

Tap Search (

) to display the results.

To filter the search:

970

Tap the Filters (

) tab to display the selection of search filters.

Complete as many of the filters as needed to describe the order(s) that you want to find.

Tap Apply Filters to display the results.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workspace

Order Filters

Search Filters
FILTER

DESCRIPTION

Filters the search based on order ID.

Bill-to Name

Filters the search by the name of the person who is responsible to
pay for the order.

Ship-to Name

Filters the search by the name of the person to whom each order is
shipped .

Purchase Point

Filters the search by website, store, or store view where the order
was placed.

Status

Filters the search based on order status. Options:
Canceled

Payment Review

Closed

PayPal Canceled Reversal

Complete

Pending

Suspected Fraud

Pending Payment

On Hold

Processing

Purchase Date

Filters the search based on the date purchased. To find orders within
a range of dates, enter both the From and To dates.

Grand Total (Base)

Filters the search based on the Grand Total of each order.

Grand Total (Purchased)

Filters the search based on Grand Total of items purchased in each
order.

Magento Commerce User Guide

971

Order Workspace

CHAPTER 60: Orders

Search Filters (cont.)
FILTER
Apply Filters

972

DESCRIPTION
Applies all filters to the search.

Cancel

Cancels the current search.

Clear All

Clears all search filters.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workspace

Order Grid Layout
The selection of columns and their order in the grid can be changed according to your
preference. The new layout can be saved as a grid “view.” By default, only nine of twenty
available columns are included in the grid.

Order Grid Columns

To change the column selection:
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.

Make sure to scroll down to see all available columns.

To move a column:
1.

Tap the header of the column, and hold.

Drag the column to the new position, and release.

To save a grid view:
1.

Tap the View

control. Then, tap Save Current View.

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.

Magento Commerce User Guide

973

Order Workspace

CHAPTER 60: Orders

To change the view:
Tap the View

974

control. Then, do one of the following:

To use a different view, tap the name of the view.

To change the name of a view, tap the Edit (

) icon. Then, update the name.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workflow

Order Workflow
When a customer places an order, a sales order is created as a temporary record of the
transaction. In the Orders grid, sales orders initially have a status of "Pending," and can be
canceled at any time until the payment is processed. After payment is confirmed, the order can
be invoiced and shipped.
Place Order. The checkout process begins when the shopper clicks the Go to Checkout
button on the shopping cart page or reorders directly from their customer account.

Order Pending. In the Orders grid, the status of the sales order is initially “Pending.”
Payment has not been processed, and the order can still be canceled.

Receive Payment. The status of the order changes to “Processing.” when payment is
received or authorized. Depending on the payment method, you might receive notification
when the transaction is authorized or processed.
Invoice Order. An order is typically invoiced after payment is received. Some payment
methods generate an invoice automatically when payment is authorized and captured.
The payment method determines which invoicing options are needed for the order. After
the invoice is generated and submitted, a copy is sent to the customer.
Ship Order. The shipment is submitted, and the packing slip and shipping label are
printed. The customer receives notification, and the package is shipped. If tracking
numbers are used, the shipment can be tracked from the customer’s account.

Magento Commerce User Guide

975

Order Workflow

CHAPTER 60: Orders

Processing Orders
When a customer places an order, a sales order is created as a temporary record of the
transaction. The sales order has a status of “Pending” until payment is received. Sales orders
can be canceled until an invoice is generated. An easy way to think of it is this: Orders become
invoices, and invoices become shipments. The Orders grid lists all orders, regardless of where
they are in the workflow.
The panel on the left of an open order is used to display different information that is related to
the order.

Orders

976

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workflow

To view an order:
1.

On the Admin sidebar, tap Sales. Then under Operations, choose Orders.

Find the order in the grid, and in the Action column, click View.
l

A pending order can be modified, put on hold, canceled, or invoiced and shipped.

A completed order can be reordered.

View Order

To process an order:
1.

To open the order in view mode, and tap Edit.

Review the following sections in the sales order, using the field descriptions for reference.

Order and Account Information

Magento Commerce User Guide

977

Order Workflow

CHAPTER 60: Orders

Address Information

Payment & Shipping Method

Items Ordered

Items Ordered
3.

978

In the Order Total section, do the following:
a.

Enter a Comment to include with the order.

If you want to email the comment to the customer, mark the Notify Customer by Email
checkbox.

If you want the comment to be visible in the customer account, mark the Visible on
Storefront checkbox.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workflow

Order Total
4.

If you are ready to invoice the order, tap Invoice. Then follow the instructions in Creating an
Invoice

Order View Descriptions
TAB

DESCRIPTION

Information

Display detailed information about the order and account, including
the billing and shipping addresses, payment and shipping methods,
items orders, totals, and notes.

Invoices

Lists each invoice that is associated with the order.

Credit Memos

Lists each credit memo that is associated with the order.

Shipments

Lists each shipment record that is associated with the order.

Comments History

Lists all notes that are related to the order.

Button Bar
FIELD

DESCRIPTION

Back

Returns to the Orders page without saving changes.

Cancel

Cancels the sales order.

Send Email

Sends an email about the order to the customer.

Hold / Unhold

Changes the status of the sales order to “On Hold”. To release the
hold on the sales order, choose “Unhold”.

Invoice

Creates an invoice from the sales order by converting the order to an
invoice.

Ship

Creates a shipment record for the order.

Magento Commerce User Guide

979

Order Workflow

CHAPTER 60: Orders

Button Bar (cont.)
FIELD

DESCRIPTION

Reorder

Creates a new sales order based on the current order.
Edit

Opens the order in edit mode.

Field Descriptions
FIELD

DESCRIPTION

ORDER & ACCOUNT INFORMATION
Order Number

The order number appears at the top of the sales order, and also in
the Order & Account Information, followed by a note that indicates if
the confirmation email was sent.

Order Date

The date and time the order was placed.

Purchased From

Indicates the website, store, and store view where the order was
placed.

Placed from IP

Indicates the IP address of the computer from which the order was
placed.

Account Information
Customer Name

The name of the customerwho placed the order. The Customer Name
is linked to the customer profile.

The email address of the customer. The email address is linked to
open a new email message.

Customer Group

The name of the customer group to which the customer is assigned.

ADDRESS INFORMATION
Billing Address

The name of the customer who placed the order, followed by the
billing address, telephone number and VAT, if applicable. The
telephone number is linked to autodial on a mobile device.

Shipping Address

The name of the person to whose attention the order should be
shipped, followed by the shipping address and telephone number.
The telephone number is linked to autodial on a mobile device.

PAYMENT & SHIPPING METHOD

980

Magento Commerce User Guide

CHAPTER 60: Orders

Order Workflow

Field Descriptions (cont.)
FIELD

DESCRIPTION

Payment Information

The method of payment to be used for the order, and purchase order
number, if applicable, followed by the currency that was used to
place the order.

Shipping & Handling
Information

The shipping method to be used, and any handling fee that is
applicable.

ITEMS ORDERED
Product

The product name, SKU, and options if applicable.

Item Status

Indicates the status of the item. Values: Ordered

Original Price

The original catalog price of the item before discounts.

Price

The purchase price of the item.

Qty

The quantity ordered.

Subtotal

The subtotal is the purchase price multiplied by the quantity.

Tax Amount

The amount of tax that applies to the item as a decimal value.

Tax Percent

The percentage of tax applied to this item as a percentage.

Discount Amount

The discount that applies to this item.

Row Total

The line item total, including applicable taxes that are due at the
product level, less discounts.

ORDER TOTAL
Notes for this Order
Status

Indicate the current status of the sales order.

Comment

A text box that is used to enter a comment to the customer that
accompanies the order.

Magento Commerce User Guide

Notify Customer by
Email

Mark the checkbox if you want to send the
comment to the customer as a separate
email.

Visible on
Storefront

Mark the checkbox if you want the comment
to be visible from the customer’s account.

981

Order Workflow

CHAPTER 60: Orders

Field Descriptions (cont.)
FIELD

DESCRIPTION
Submit Comment

Submits the comment, and send by email, if
applicable.

Order Totals

982

Shipping & Handling

The amount charged for shipping and handling fees.

Tax

The amount of tax applied to the order, if applicable.

Store Credit

The amount of available store credit that is applied to the order, if
appliable.

Grand Total

The order total.

Total Paid

The total amount paid toward the order, if applicable.

Total Refunded

The total amount refunded from the order, if applicable.

Total Due

The total amount that is due.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Status

Order Status
All orders have an order status that is associated with a stage in the order processing workflow.
The status of each order is shown in the Status column of the Orders grid. Your store has a set
of predefined order status and order state settings. The order state describes the position of an
order in the workflow.

Order Status

Predefined Order Status
ORDER STATUS

STATUS CODE

Processing

processing

Suspected Fraud

fraud

Pending Payment

pending_payment

Payment Review

payment_review

Pending

pending

On Hold

holded

Complete

complete

Closed

closed

Canceled

canceled

PayPal Canceled Reversal paypay_canceled_reversal
Pending PayPal

pending_paypal

PayPal Reversed

paypal_reversed

Magento Commerce User Guide

983

Order Status

CHAPTER 60: Orders

Order Status Workflow

984

Magento Commerce User Guide

CHAPTER 60: Orders

Order Status

Custom Order Status
In addition to the preset order status settings, you can create custom order status settings of
your own, assign them to order states, and set a default order status for order states. For
example, you might need a custom order status for orders such as “packaging” or
“backordered,” or for a status that is specific to your needs. You can create a descriptive name
for the custom status, and assign it to the associated order state in the workflow.
Only default custom order status values are used in the order workflow. Custom status values that
are not set as default can be used only in the comments section of the order.

Order Status Settings

Magento Commerce User Guide

985

Order Status

CHAPTER 60: Orders

To create a custom order status:
1.

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

In the upper-right corner, tap Create New Status.

Create New Order Status
3.

Under Order Status Information section, do the following:
a.

Enter a Status Code for internal reference. The first character must be a letter (a-z), and
the rest can be any combination of letters and numbers (0-9). Use the underscore
character instead of a space.

b.
4.

Enter a Status Label to identify the status setting in both the Admin and storefront.

In the Store View Specific Labels section, enter any labels that are needed for different store
views.

986

When complete, tap Save Status.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Status

To assign an order status to a state:
1.

On the Order Status page, tap Assign Status to State.

Assign Status
2.

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

Choose the Order Status that you want to assign. They are listed by status label.

Set Order State to the place in the workflow where the order status belongs.

To make this status the default for the order state, mark the Use Order Status as Default
checkbox.

To make this status visible from the storefront, mark the Visible On Storefront checkbox.

Magento Commerce User Guide

987

Order Status

CHAPTER 60: Orders

Assign Status to State
3.

When complete, tap Save Status Assignment.

To edit an existing order status:
1.

In the Order Status grid, open the status record in edit mode.

Update the status settings as needed.

When complete, tap Save Status.

To remove an order status from an assigned state:
A status setting cannot be unassigned from a state if the status is currently in use.

In the Order Status grid, find the order status record to be unassigned.

In the Action column on the far right of the row, tap the Unassign link.
A message appears at the top of the workspace that the order status has been unassigned.
Although the order status label still appears in the list, it is no longer assigned to a state.
Order status settings cannot be deleted.

Order State
ORDER STATE
New
Pending Payment
Processing

988

When the state of new orders is set to “Processing,” the option to
“Automatically Invoice All Items” becomes available in the
configuration.

Magento Commerce User Guide

CHAPTER 60: Orders

Order Status

Order State (cont.)
ORDER STATE
Complete
Closed
Canceled
On Hold
Payment Review

Order Status Notification
Customers can track the status of their orders by RSS feed if the Order RSS feed is enabled in
the configuration. When enabled, a link to the RSS feed appears on each order.

Customer Order Status Notification

To enable Order Status Notification:
1.

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

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

Expand

Set Customer Order Status Notification to “Enable”.

When complete, tap Save Config.

the Order section.

Magento Commerce User Guide

989

Scheduled Order Operations

CHAPTER 60: Orders

Scheduled Order Operations
Magento cron jobs can be used to schedule the following order management tasks:
l

Pending Payment Order Lifetime

Scheduled Grid Updates

Orders Grid with Pending Orders

Pending Payment Order Lifetime
The lifetime of orders with pending payments is determined by the Orders Cron Settings
configuration. The default value is set to 480 minutes, which is eight hours.

To set the lifetime of orders with pending payments:
1.

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

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

Expand

the Orders Cron Settings section.

Orders Cron Settings
4.

In the Pending Payment Order Lifetime (minutes) field, enter the number of minutes before a
pending payment expires.

990

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 60: Orders

Scheduled Order Operations

Scheduled Grid Updates
The Grid Settings configuration schedules updates to the following order management grids,
and reindexes the data as scheduled by Cron:
l

Orders

Invoices

Shipments

Credit Memos

The benefits of scheduling these tasks is to avoid the locks that occur when data is saved, and
to reduce processing time. When enabled, any updates take place only during the scheduled
cron job. For best results, Cron should be configured to run once every minute.

To enable scheduled grid updates and reindexing:
1.

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

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

Expand

Set Asynchronous Indexing to “Enable.”

the Grid Settings section.

Grid Settings
5.

When complete, tap Save Config.

Magento Commerce User Guide

991

992

Magento Commerce User Guide

CHAPTER 61:

Invoices
An invoice is a record of the record of payment for an order. Multiple invoices can be created for
a single order, and each can include as many or as few of the purchased products that you
specify. You can upload a high-resolution logo for a print-ready PDF invoice, and include the
Order ID in the header. To customize the invoice template with your logo, see: Preparing Your
Invoice Logo.

PDF Invoice

Magento Commerce User Guide

993

Creating an Invoice

CHAPTER 61: Invoices

Creating an Invoice
Creating an invoice for an order converts the temporary sales order into a permanent record of
the order that cannot be canceled. A new invoice page looks similar to a completed order, with
some additional fields. Every activity that is related to an order is noted in the Comments
section of the invoice.
Normally, orders are invoiced and shipped after payment is received. However, if the method of
payment is a purchase order, the order can be invoiced and shipped before payment is received.
You can generate an invoice with a packing slip, and also print shipping labels from your
carrier account. A single order can be divided into partial shipments which are invoiced
separately, if necessary.
When the state of new orders is set to “Processing,” the option to “Automatically Invoice All
Items” becomes available in the configuration. Some credit card payment methods complete the
invoicing step as part of the process when Payment Action is set to “Authorize and Capture.” In
such a case, the Invoice button does not appear, and the order is ready to ship.
Before an invoice can be printed, it must first be generated for the order. To view or print the
PDF, first download and install a PDF reader such as Adobe Acrobat Reader.

Invoices

994

Magento Commerce User Guide

CHAPTER 61: Invoices

Creating an Invoice

To invoice an order:
1.

On the Admin sidebar, tap Sales. Then under Operations, choose Orders.

Find the order in the grid, and do the following:
a.

In the Action column, click the View link.

In the upper-right corner, tap Invoice. The new invoice page looks similar to a completed
order page, with additional fields that can be edited.
The Invoice button does not appear for orders placed with the “Authorize and Capture” payment
action.

If the items are ready to ship, you can generate a packing slip for the shipment at the same
time you create the invoice. To create a packing slip, do the following:
a.

In the Shipping Information section, mark the Create Shipment checkbox. A shipment
record will be created at the same time the invoice is generated.

Create Shipment
b.

To include a tracking number, tap Add Tracking Number . Then, enter the following:
l

Carrier

Title

Number

If you need to generate a partial invoice, do the following:
In the Items to Invoice section, update the Qty to Invoice column to include only specific
items on the invoice. Then, tap Update Qty’s.

Magento Commerce User Guide

995

Creating an Invoice

CHAPTER 61: Invoices

Items to Invoice
4.

If an online payment method was used for the order, set Amount to the appropriate option.

To notify customers by email when the invoice is generated, do the following:

Mark the Email Copy of Invoice checkbox.

Enter any Invoice Comments. To include the comments in the notification email, mark
the Append Comments checkbox.

When complete, tap Submit Invoice at the bottom of the page. The status of the order changes
from "Pending" to "Complete."

Submit Invoice

996

Magento Commerce User Guide

CHAPTER 61: Invoices

Creating an Invoice

Completed Invoice

Magento Commerce User Guide

997

Creating an Invoice

CHAPTER 61: Invoices

To print the invoice:
1.

At the top of the workspace, tap Print to generate a PDF of the invoice

Do one of the following:
l

Send the PDF invoice to a printer.

Save the PDF file.

To customize the default invoice, see: Preparing Your Invoice Logo.

Default PDF Invoice

998

Magento Commerce User Guide

CHAPTER 61: Invoices

Creating an Invoice

Payment Actions
PAYMENT ACTION

DESCRIPTION

Capture Online

Upon invoice submission, the system captures the payment from the
third-party payment gateway. You have the ability to create a credit
memo and void the invoice.

Capture Offline

Upon invoice submission, the system does not capture the payment.
It is assumed that the payment is captured directly through the
gateway, and you no longer have the option to capture this payment
through Magento. You have the ability to create a credit memo, but
you do not have the option to void the invoice. (Even though the order
used an online payment, the invoice is essentially an offline invoice.)

Not Capture

When the invoice is submitted, the system does not capture the
payment. It is assumed that you will capture the payment through
Magento at a later date. There is a Capture button in the completed
invoice. Before capturing, you are able to cancel the invoice. After
capturing you are able to create a credit memo and void the invoice.
Do not select Not Capture unless you are certain that you are going
to capture the payment through Magento at a later date. You will not
be able to create a credit memo until the payment has been captured
using the Capture button.

Magento Commerce User Guide

999

Printing Multiple Invoices

CHAPTER 61: Invoices

Printing Multiple Invoices
Invoices can be printed individually or as a batch. However, before an invoice can be printed, it
must first be generated for the order. To add your logo and address to the invoice, see:
Preparing Your Invoice Logo.
To view or print the PDF, you must have a PDF reader. You can download Adobe Reader at no
charge.

To print multiple invoices:
1.

On the Admin sidebar, tap Sales. Then under Operations, choose Invoices.

In the Invoices grid, mark the checkbox of each invoice to be printed.

Set the Actions control to “PDF Invoices.”

Print Invoices
The invoices are saved in a single PDF file that can be sent to a printer, or saved.

1000

Magento Commerce User Guide

CHAPTER 62:

Shipments
The Shipments grid lists the shipment record of all invoices that have been prepared for
shipping. A shipment record can be generated when an order is invoiced.

Shipments

Magento Commerce User Guide

1001

1002

Magento Commerce User Guide

CHAPTER 63:

Credit Memos
A credit memo is a document that shows the amount that is due the customer for a full or
partial refund. The amount can be applied toward a purchase, or refunded to the customer. You
can print a credit memo for a single order, or for multiple orders as a batch. Before a credit
memo can be printed, it must first be generated for the order. The credit memo grid lists the
credit memos that have been issued. to customers.
The methods that are available to issue refunds depends on the payment method that was used
for the order. Orders that were placed using can be refunded to the respective account. Orders
that were paid by credit card through a payment gateway can be refunded online, by the
payment processor. Orders that were paid COD or by check or money order are refunded offline.

Credit Memos

Magento Commerce User Guide

1003

Product Return Workflow

CHAPTER 63: Credit Memos

Product Return Workflow

1004

Magento Commerce User Guide

CHAPTER 63: Credit Memos

Issuing a Credit Memo

Issuing a Credit Memo
Before a credit memo can be printed, it must first be generated for the order. If you create a
credit memo for an order that includes gift options, the refund for the gift wrapping and/or
printed card appears in the Refund Totals section of the credit memo. To exclude these costs
from the amount to be refunded, enter the amount as an Adjustment Fee. If multiple credit
memos are issued for the same order, the refund for gift options appears in only the first credit
memo.

Create Credit Memo

To issue a credit memo:
1.

On the Admin sidebar tap Sales. Then, choose Orders.

Find the completed order in the grid. Then in the Action column, click the View link to open
the order.

In the button bar at the top of the page, tap Credit Memo. (The button appears only after an
order is invoiced.)

Create Credit Memo
The New Credit Memo page looks similar to the completed order page, with an Items to Refund
section that lists each item from the invoice.

Items to Refund

If an online payment method was used, you will not be able to edit these fields.

Magento Commerce User Guide

1005

Issuing a Credit Memo

CHAPTER 63: Credit Memos

Do one of the following:
l

If the product is to be returned to inventory, mark the Return to Stock checkbox.

If the product will not be returned to inventory, leave the checkbox blank.

The Return to Stock checkbox appears only if inventory Stock Options are set to “Decrease Stock
When Order Is Placed.”
5.

Complete the following:
a.

In the Qty to Refund box, enter the number of items to be returned. Then, press the Enter
key to record the change. The Update Qty’s button becomes active.

Enter 0 for the Qty to Refund of any items that are not to be refunded.

Tap Update Qty’s to recalculate the total. (The amount to be credited cannot exceed the
maximum amount that is available for refund.)

In the Refund Totals section, do the following, as applicable:
a.

In the Refund Shipping field, enter any amount that is to be refunded from the shipping
fee. This field initially displays the total shipping amount from the order that is available
for refund. It is equal to the full shipping amount from the order, less any shipping
amount that has already been refunded. Like the quantity, the amount can be reduced, but
not increased.

In the Adjustment Refund field, enter a value to be added to the total amount refunded as
an additional refund that does not apply to any particular part of the order (shipping,
items, or tax). The amount entered cannot raise the total refund higher than the paid
amount.

In the Adjustment Fee field, enter a value to be subtracted from the total amount
refunded. This amount is not subtracted from a specific section of the order such as
shipping, items, or tax.

If the purchase was paid with store credit, mark the Refund to Store Credit checkbox. The
amount will be credited to the customer’s account balance.

To add a comment, enter the text in the Credit Memo Comments box.

To send an email notification to the customer, mark the Email Copy of Credit Memo
checkbox.

To include the comments you have entered in the email, mark the Append Comments
checkbox.
The status of a credit memo notification appears in the completed credit memo next to the
credit memo number.

1006

Magento Commerce User Guide

CHAPTER 63: Credit Memos

Issuing a Credit Memo

Refund Totals
7.

To complete the process and generate the credit memo, choose one of the following refund
option buttons, according to the payment type:

Refund Offline

Refund Online

To add a comment to the completed credit memo, scroll down to the Comments History
section, and enter the comment in the box. A history of all activity related to the order is listed
below.
l

To send the comment to the customer by email, mark the Notify Customer by Email
checkbox.
To post the comment in the customer’s account, mark the Visible on Frontend checkbox.

Then, tap Submit Comment .
9.

In the panel on the left, choose Credit Memos. Any credit memos that are associated with this
order appear in the list.

Field Descriptions
FIELD

DESCRIPTION

ORDER & ACCOUNT INFORMATION
Order Number

The order number appears in the Order & Account Information,
followed by a note that indicates if the confirmation email was sent.

Order Date

The date and time the order was placed.

Order Status

Indicates the order status as “Complete.”

Magento Commerce User Guide

1007

Issuing a Credit Memo

CHAPTER 63: Credit Memos

Field Descriptions (cont.)
FIELD

DESCRIPTION

Purchased From

Indicates the website, store, and store view where the order was
placed.

Placed from IP

Indicates the IP address of the computer from which the order was
placed.

Account Information
Customer Name

The name of the customerwho placed the order. The Customer Name
is linked to the customer profile.

The email address of the customer. The email address is linked to
open a new email message.

Customer Group

The name of the customer group to which the customer is assigned.

ADDRESS INFORMATION
Billing Address

The name of the customer who placed the order, followed by the
billing address, telephone number and VAT, if applicable. The
telephone number is linked to autodial on a mobile device.

Shipping Address

The name of the person to whose attention the order should be
shipped, followed by the shipping address and telephone number.
The telephone number is linked to autodial on a mobile device.

PAYMENT & SHIPPING METHOD
Payment Information

The method of payment to be used for the order, and purchase order
number, if applicable, followed by the currency that was used to
place the order.

Shipping & Handling
Information

The shipping method to be used, and any handling fee that is
applicable.

ITEMS TO REFUND

1008

Product

The product name, SKU, and options if applicable.

Price

The purchase price of the item.

Qty

The quantity ordered.

Magento Commerce User Guide

CHAPTER 63: Credit Memos

Issuing a Credit Memo

Field Descriptions (cont.)
FIELD

DESCRIPTION

Return to Stock

Checkbox that indicates if the returned item is to be returned to
stock.

Qty to Refund

Indicates the number of units returned of the product.

Subtotal

The subtotal is the purchase price multiplied by the quantity of
product units returned.

Tax Amount

The amount of tax that applies to the returned item as a decimal
value.

Tax Percent

The percentage of tax applied to the returned item as a percentage.

Discount Amount

Any discount that applies to the returned item.

Row Total

The line item total, including applicable taxes that are due for the
returned product level, less discounts.

ORDER TOTAL
Credit Memo Comments
Comment Text

A text box that is used to enter a comment to the customer about the
credit memo.

Refund Totals
Refund Shipping

The shipping amount to be refunded.

Adjustment Refund

An amount that is added to the total amount refunded as an additional
refund that does not apply to any particular part of the order, such as
shipping, items, or tax. The amount entered cannot raise the total
refund higher than the amount paid.

Adjustment Fee

An amount that is subtracted from the total amount refunded, such as
a restocking fee, or an amount that is related to gift wrapping or gift
options.

Grand Total

The total amount to be refunded

Append Comments

Checkbox that determines if comments are included in the credit
memo.

Email Copy of Credit
Memo

Checkbox that determines if a copy of the credit memo is emailed.

Magento Commerce User Guide

1009

Issuing a Credit Memo

CHAPTER 63: Credit Memos

Field Descriptions (cont.)
FIELD
Refund to Store Credit

DESCRIPTION
Checkbox that determines if the total is to be refunded to store credit.

REFUND BUTTONS
The payment method used for the order determines that refund buttons that are available for a
credit memo.

1010

Refund Online

If the original purchase was paid by credit card through a payment
gateway, the refund amount is managed by the payment processor.
To manage refunds, see the documentation provided by your
payment provider.

Refund Offline

If the original purchase was paid by check or money order, the refund
is paid directly to the customer, by issuing a check, gift card, or cash
if you have a brick and mortar storefront. The credit memo serves as
a record of the offline transaction.

Magento Commerce User Guide

CHAPTER 63: Credit Memos

Printing Credit Memos

Printing Credit Memos
To print or view the completed credit memo, you must have a PDF reader installed on your
computer. You can download Adobe Reader at no charge.

Credit Memos

To print a credit memo:
1.

On the Admin sidebar, tap Sales. Then under Operations, choose Credit Memos.

Use one of the following methods to print the credit memo:

Magento Commerce User Guide

1011

Printing Credit Memos

CHAPTER 63: Credit Memos

Method 1: Print current credit memo
1.

In the grid, open the credit memo.

Tap Print.

Print Credit Memo

Method 2: Print multiple credit memos
1.

In the list, mark the checkbox of each credit memo that you want to print.

Set the Actions control to “PDF Credit Memos. Then, tap Submit.

When prompted, do one of the following:
l

1012

To save the document, tap Save. Then, follow the prompts to save the file to your
computer. When the download is complete, open the PDF in Adobe Reader, and print
the document.
To view the document, tap Open. The printed-ready PDF credit memo opens in Adobe
Reader. From here, you can either print the credit memo or save it to your computer.

Magento Commerce User Guide

CHAPTER 64:

Store Credit
Store credit is an amount that is restored to a customer account. Customers can use their store
credit to pay for purchases, and administrators can use store credit for cash refunds. Gift card
balances can be credited to the customer’s account, instead of using the gift card code for future
purchases.
After an order is paid and invoiced, all of the order, or a portion of it, can be refunded by
issuing a credit memo. A credit memo differs from a refund because the amount of the credit is
restored to the customer’s account where it can be used for future purchases. In some cases, a
refund can be given at the same time that a credit memo is issued, and applied to the
customer’s balance of store credit. The amount of store credit that is available in the customer’s
account is specified in the configuration.

Store Credit Workflow
Customer Login. Customer logs into account before beginning the checkout process.

Use Store Credit. During the Review & Payments step of the checkout process, the
customer elects to “Use Store Credit” as a payment option. The available balance is
shown in parentheses If the available balance is greater than the order grand total, the
other payment methods disappear.
Credit Applied to Order. The amount of store credit that is applied to the order appears
with the order totals, and is subtracted from the grand total.

Magento Commerce User Guide

1013

Store Credit Workflow

CHAPTER 64: Store Credit

Customer Balance Adjusted. The customer’s available balance is adjusted when the
order is placed.
Orders paid with store credit cannot be refunded, and credit memos cannot be issued. To
refund such an order, the order must be canceled and the balance manually added to the
customer’s account. If an order is partially paid with store credit, the amount paid with
store credit cannot be refunded. Again, the amount must be manually be added to the
customer’s account.
Managing Refunds. Orders paid with store credit cannot be refunded, nor can credit
memos be issued. To refund such an order, the order must be canceled and the balance
manually added to the customer’s account. If an order is partially paid with store credit,
the amount paid with store credit cannot be refunded. Again, the amount must be
manually be added to the customer’s account.

1014

Magento Commerce User Guide

CHAPTER 64: Store Credit

Applying Store Credit

Applying Store Credit
Administrators can view the credit balance and history from the account of a customer, and
also apply store credit to a purchase.

Customer Credit Balance and History

To view the credit balance:
1.

On the Admin sidebar, tap Customers. Then under Operations, choose All Customers.

Find the customer In the grid. Then in the Action column, click Edit.

In the panel on the left, choose Store Credit.

Store Credit Balance

Configuring Store Credit
The store credit configuration control automatic refunds, the display of available credit in
customers’ accounts, and the email template that is used for notifications sent to customers.

Magento Commerce User Guide

1015

Configuring Store Credit

CHAPTER 64: Store Credit

Store Credit Options

To configure store credit:
1.

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

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

Expand

1016

the Store Credit Options section. Then, do the following:

Set Enable Store Credit Functionality to “Yes.”

Set the following to your preference:
l

Show Store Credit History to Customers

Refund Store Credit Automatically

Set Store Credit Update Email Sender to the store identity that appears as the sender of
email notifications sent to customers.

Set Store Credit Update Email Template to the template that is used for email
notifications sent to customers.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 64: Store Credit

Refunds in Customer Account

Refunds in Customer Account
Customers can track the status of their refunds and verify the balance of their store credit from
the dashboard of their accounts.

Refund Detail

Magento Commerce User Guide

1017

Refunds in Customer Account

CHAPTER 64: Store Credit

To view a refund from your customer account:
1.

From the storefront, log into your customer account. Then, do one of the following:
l

Find the order in the list of Recent Orders, and click View.

In the panel on the left, choose My Orders. Then, find the order in the list and click View.

Tap the Refunds tab to view the details of the refund.

If the refund was applied to store credit, choose Store Credit in the panel on the left.
The amount refunded to your store credit appears in the list with the date and time of the
action.

Amount Refunded to Store Credit

1018

Magento Commerce User Guide

CHAPTER 65:

Returns
A returned merchandise authorization (RMA) can be granted to customers who request to
return an item for replacement or refund. Typically the customer contacts the merchant to
request a refund. If approved, a unique RMA number is assigned to identify the returned
product. In the configuration, you can either enable RMA for all products, or allow RMA for
only certain products. The Returns grid lists the current returned merchandise requests (RMAs)
, and is used to enter new return requests.
RMAs can be issued for Simple, Grouped, Configurable, and Bundle product types. However,
RMAs are not available for virtual products, downloadable products, and gift cards.

Returns

Magento Commerce User Guide

1019

RMA Workflow

CHAPTER 65: Returns

RMA Workflow
Receive Request. Both registered customers and guests can request an RMA. You can
also submit an RMA request from the Admin.

RMA Issued. After considering the request, you can authorize it partially, completely, or
cancel the request. If you authorize the return and agree to pay for the return shipment,
you can create a shipment order from the Admin with a supported carrier.
Merchandise Returned. The customer follows your shipping instructions and returns
the merchandise to you,

Receive Merchandise. You receive and approve the return partially or completely, or
cancel the RMA.

1020

Magento Commerce User Guide

CHAPTER 65: Returns

Configuring Returns

Configuring Returns
By default, RMA requests can be submitted by customers from the storefront. Requests to
return individual items are managed by the Enable RMA attribute, which is managed in the
Advanced Settings section of each product record, under Autosettings. By default, the
configuration settings are applied to the product. If Enable RMA is set to “No,” the product
does not appear in the list of items that are available for return. An RMA can be generated only
if there is an item in the order that is available for return. Changes to the value of the Enable
RMA attribute apply to both new and existing orders.

Enable RMA for Product

To enable RMAs:
1.

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

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

Expand the RMA Settings section. Then, do the following:

Magento Commerce User Guide

1021

Configuring Returns

CHAPTER 65: Returns

RMA Settings
a.

Set Enable RMA on Storefront to “Yes.”

Set Enable RMA on Product Level to “Yes.”

Set Use Store Address to one of the following:
Yes

Choose “Yes” to have returned products sent to the store address.

Choose “No,” and enter an alternate address where returned products are to be
sent.

RMA Settings with Alternate Address
4.
1022

When complete, tap Save Config.
Magento Commerce User Guide

CHAPTER 65: Returns

Configuring Returns

Returns Attribute
The Returns Attributes are used to store information that is needed during the product return
process. The default attributes include the condition of the returned product, the reason for the
return, and a field that indicates how the return was resolved. The process to create a returns
attribute is similar to creating a customer attribute.

Returns Attributes

To create a returns attribute:
1.

On the Admin sidebar, choose Stores. Then under Attributes, choose Returns.

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

Follow the same process as you would to create a customer attribute.

New Returns Attribute

Magento Commerce User Guide

1023

1024

Magento Commerce User Guide

CHAPTER 66:

Billing Agreements
The Billing Agreements grid lists all billing agreements between your store and its customers.
The store administrator can filter the records by the customer or billing agreement information
including billing agreement reference ID, status, and creation date. Each record includes
general information about the billing agreement, and all sales orders that have used it as a
payment method. The store administrator can view, cancel, or delete customer’s billing
agreements. A canceled billing agreement can be deleted only by the store administrator.

Billing Agreements

Magento Commerce User Guide

1025

1026

Magento Commerce User Guide

CHAPTER 67:

Transactions
The Transactions grid lists all payment activity that has taken place between your store and a
payment system, and provides access to more detailed information.

To view transactions:
On the Admin sidebar, tap Sales. Then under Operations, choose Transactions.

Transactions

Magento Commerce User Guide

1027

1028

Magento Commerce User Guide

CHAPTER 68:

Archive
Archiving orders on a regular basis improves performance and keeps your workspace free of
unnecessary information, so you can focus on current business. Invoices, shipments, and credit
memos are archived separately from orders, and can be accessed any time.
The Archive options appear in the Sales menu only when archiving is enabled.

Move Order to Archive

Magento Commerce User Guide

1029

1030

Magento Commerce User Guide

Payments

1031

Contents
In this section of the guide, you will learn about
the payment methods, services, and gateways
that you can make available to your customers,
and how to configure them.

Recommended Solutions
PayPal Express Checkout
PayPal In-Context Checkout
PayPal Billing Agreements
PayPal Settlement Reports
Braintree
Other PayPal Solutions
PayPal Payments Advanced
PayPal Payments Pro
PayPal Payments Standard
PayPal Payflow Pro
PayPal Payflow Link
PayPal Reference
PayPal Business Account
PayPal Credit
PayPal Fraud Management Filter
PayPal by Country

Other Payment Solutions
Authorize.Net Direct Post
CyberSource
eWAY
Worldpay
Basic Payment Methods
Check / Money Order
Cash On Delivery
Bank Transfer
Purchase Order
Zero Subtotal Checkout
Fraud Protection
Signifyd

1032

CHAPTER 69:

Recommended Solutions
The following payment solutions provide an easy way for merchants who are just starting out
to accept online payments. As your business grows, you can combine these with additional
PayPal payment solutions.

PayPal Express Checkout
Use PayPal Express Checkout as a standalone option,
or combine it with another PayPal payment solution.

Braintree
Braintree allows you to accept credit/debit cards and
PayPal without any setup or monthly fees. Your
customers never leave your store to complete the
purchase.

Magento Commerce User Guide

1033

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

PayPal Express Checkout
PayPal Express Checkout helps boost sales by giving your customers the ability to pay by credit
card or from the security of their personal PayPal accounts. During checkout, the customer is
redirected to the secure PayPal site to complete the payment information. The customer is then
returned to your store to complete the remainder of the checkout process. Choosing Express
Checkout adds the familiar PayPal button to your store, which has been reported to increase
sales.*

Customers with current PayPal accounts can make a purchase in a single step by clicking the
“Check out with PayPal” button. Express Checkout can be used as a standalone, or in
combination with one of PayPal’s All-In-One solutions. If you already accept credit cards
online, you can offer Express Checkout as an additional option to attract new customers who
prefer to pay with PayPal.

Requirements
Merchant: Personal PayPal Account
Customer: Personal PayPal Account

1034

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

Checkout Workflow
Unlike other payment methods, PayPal Express Checkout allows the customer to check out at
the beginning of the usual checkout workflow from the product page, the mini shopping cart,
and shopping cart.
Customer Places Order. The customer taps the “Check out with PayPal” button. .

Customer Is Redirected to PayPal Site. The customer is redirected to the PayPal site
to complete the transaction. / The customer taps the “Check out with PayPal” button.
and is redirected to the PayPal site to complete the transaction.
Customer Logs into their PayPal Account. The customer must log in to their PayPal
account to complete the transaction. The payment system uses the customer’s billing
and shipping information from their PayPal account.
Customer Returns to the Checkout Page. The customer is redirected back to the
checkout page in your store to review the order.

Customer Places Order. The customer places the order, and the order information is
submitted to PayPal.

PayPal Settles the Transaction. PayPal receives the order and settles the transaction.

PayPal Express Checkout does not support orders with multiple-addresses.

Magento Commerce User Guide

1035

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

Setting Up PayPal Express Checkout
You can have two PayPal solutions active at the same time: Express Checkout, plus an All-InOne solution. If you enable a different solution, the one used previously is automatically
deactivated.
Process Overview:
Step 1: Configure Your PayPal Account
Step 2: Complete the Required Settings
Step 3: Advertise PayPal Credit
Step 4: Complete the Basic Settings
Step 5: Complete the Advanced Settings

Step 1: Configure Your PayPal Account
1.

Before you begin, you must configure your PayPal merchant account on the PayPal website.
a.

Go to Service Settings > Hosted Checkout Pages > Set Up, and make the following
settings:
AVS

CSC

Enable Secure Token Yes
c.
2.

Save the settings.

PayPal recommends that you set up an additional user on your account. To set up an
additional user, do the following:

Go to manager.paypal.com and log in to your account.

Follow the instructions to set up an additional user.

Save the changes.

Expand
a.

the Required PayPal Settings section, and do the following:

Enter the Email Address that is associated with your PayPal merchant account.
Important! Email addresses are case sensitive. To receive payment, the email address you
enter must match the email address specified in your PayPal merchant account.

1036

Set API Authentication Methods to one of the following:

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

API Signature

API Certificate

PayPal Express Checkout

If necessary, click the Get Credentials from PayPal button. Then, complete the following:
l

API Username

API Password

API Signature

If you are using credentials from your sandbox account, set Sandbox Mode to “Yes.”
If necessary, click the Sandbox Credentials button and follow the instructions to set up
your testing environment.
When testing the configuration in a sandbox, use only credit card numbers that are
recommended by PayPal. When you are ready to “go live,” return to the configuration and
set Sandbox Mode to “No.”

If your system uses a proxy server to establish the connection between Magento and the
PayPal payment system, set API Uses Proxy to “Yes.” Then,, complete the following:
l

Proxy Host

Proxy Port

When these sections are complete, set Enable this Solution to “Yes.”

To enable PayPal In-Context Checkout, do the following:
a.

Set Enable In-Context Checkout Experience to “Yes.”

Enter your PayPal Merchant Account ID.
Your Merchant Account ID is in your PayPal business account profile.

To offer financing through PayPal to your customers, see PayPal Credit to learn more.
You have now completed the Required PayPal Settings. At this point, you can either continue
with the Basic and Advanced Settings, or click the Save Config button. You can return later
fine-tune the configuration.

Step 2: Complete the Required Settings
1.

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

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

If your Magento installation has multiple websites, stores or views, in the upper-left corner,
choose the Store View where the configuration applies.

In the Merchant Location section, select the Merchant Country where your business is located.

Magento Commerce User Guide

1037

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

Under Recommended Solutions in the PayPal Express Checkout section, tap Configure. Then,
do the following:
a.

Set API Authentication Methods to one of the following:
l

API Signature

API Certificate

If necessary, tap Get Credentials from PayPal. Then, complete the following:
l

API Username

API Password

API Signature

If your system uses a proxy server to establish the connection between Magento and the
PayPal payment system, set API Uses Proxy to “Yes.” Then,, complete the following:
l

Proxy Host

Proxy Port

Set Enable This Solution to “Yes.”

If you want to offer PayPal Credit to your customers, set Enable PayPal Credit to “Yes.”
You have now completed the required settings. You can either continue with the remaining
settings, or save and return later fine-tune the configuration.

Step 4: Complete the Basic Settings
the Basic Settings - PayPal Express Checkout section.

Expand

Enter a Title to identify this payment method during checkout. It is recommended to set the
title to “PayPal” for each store view.

If you offer multiple payment methods, enter a number in the Sort Order field to determine the
sequence in which PayPal Payments Standard is listed with the other methods. Payment
methods appear in ascending order based on the Sort Order value.

1038

Set Payment Action to one of the following:

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

Authorization

Approves the purchase, but puts a hold on the funds. The amount is not
withdrawn until it is “captured” by the merchant.

Sale

The amount of the purchase is authorized and immediately withdrawn
from the customer’s account.

Order

The amount of the order is neither captured nor authorized in the
customer’s balance, bank account, or credit card at PayPal. The Order
payment action represents an agreement between the PayPal payment
system and the merchant, which enables the merchant to capture one or
more amounts up to the “ordered” total from the customer’s buyer
account, over a period of up to 29 days. After the funds are “ordered,”
the merchant can capture them at any time during the following 29 day
period. Capturing of the order amount can be done only from the
Magento Admin by creating one or more invoices.

To display the “Check out with PayPal” button on the product page, set Display on Product
Details Page to “Yes.”

If Payment Action is set to “Order,” complete the following fields:
Authorization
Honor Period
(days)

Determines how long the primary authorization remains valid. The
value should be equal to the corresponding value in your PayPal
merchant account. The default value in your PayPal merchant account is
3. To increase this number you need to contact PayPal. The
authorization becomes invalid at 11:49 p.m., U.S. Pacific Time, of the
last day.

Order Valid Period
(days)

Determines how long the order remains valid. When the order becomes
invalid, you can no longer create invoices for it. Specify the value equal
to the Order Valid Period value in your PayPal merchant account. The
default value in your PayPal merchant account is 29. To change this
number, you must contact PayPal.

Number of Child
Authorizations

Specifies the maximum number of authorizations for a single order,
which determines the maximum number of online partial invoices that
you can create for an order. The number in this field should be equal to
the corresponding setting in your PayPal merchant account. The default
number of child authorizations in your PayPal account is 1. To increase
this number, you must contact PayPal.

Magento Commerce User Guide

1039

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

Basic Settings

Step 5: Complete the Advanced Settings
1.

Expand

the Advanced Settings section. Then, complete the following:

Set Display on Shopping Cart to “Yes.”

Set Payment Applicable From to one of the following:

All Allowed
Countries

Accepts payment from the countries already specified in your
configuration.

Specific Countries

Accepts payments from only the countries you specify. Hold the
Ctrl key down and in the Payment Applicable From list, click each
country where you accept payment.

Set Debug Mode to “Yes” to write communications with the payment system into the log
file. The log file for PayPal Payments Advanced is payments_payflow_advanced.log.
In accordance with PCI Data Security Standards, credit card information is not recorded in the
log file.

To enable host authenticity verification, set Enable SSL Verification to “Yes.”

To display a full summary of the customer’s order by line item from the PayPal site, set
Transfer Cart Line Items to “Yes.”
To include up to ten shipping options in the summary, set Transfer Shipping Options to
“Yes.” (This option appears only if line items are set to transfer.)

1040

To determine the type of image used for the PayPal acceptance button, set Shortcut
Buttons Flavor to one of the following:
Dynamic

(Recommended) Displays an image that can be dynamically
changed from the PayPal server.

Static

Displays a specific image that cannot be dynamically changed.

To allow customers without PayPal accounts to make a purchases with this method, set
Enable PayPal Guest Checkout to “Yes.”

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

Set Require Customer’s Billing Address to one of the following:
Yes

Requires the customer’s billing address for all purchases.

Does not require the customer’s billing address for any purchases.

For Virtual Quotes Requires the customer’s billing address for virtual quotes only.
Only
i.

To specify whether the customer can sign a billing agreement with your store in the PayPal
payment system when there are no active billing agreements available in the customer
account, set Billing Agreement Signup to one of the following:
Auto

The customer can either sign a billing agreement during the
Express Checkout flow or use another method of payment.

Ask Customer

The customer can decide whether to sign a billing agreement during
the Express Checkout flow.

Never

The customer cannot sign a billing agreement during the Express
Checkout flow.

Merchants must ask PayPal Merchant Technical Support to enable billing agreements in their
accounts. The Billing Agreement Signup parameter is enabled only after PayPal confirms that
billing agreements are enabled for your merchant account.

To allow the customer to complete the transaction from the PayPal site without returning
to your Magento store for Order Review, set Skip Order Review Step to “Yes.”

Magento Commerce User Guide

1041

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

Advanced Settings
2.

Complete the following sections as needed for your store:

PayPal Billing Agreement Settings
A billing agreement is a sales agreement between the merchant and customer that has been
authorized by PayPal for use with multiple orders. During the checkout process, the Billing
Agreement payment option appears only for customers who have already entered into a billing
agreement with your company. After PayPal authorizes the agreement, the payment system
issues a unique reference ID to identify each order that is associated with the agreement.
Similar to a purchase order, there is no limit to the number of billing agreements a customer
can set up with your company.

1042

Expand

the PayPal Billing Agreement Settings section.

Set Enabled to “Yes.” Then, do the following:
a.

Enter a Title to identify the PayPal Billing Agreement method during checkout.

If you offer multiple payment methods, enter a number in the Sort Order field to
determine the sequence in which Billing Agreement appears when listed with other
payment methods during checkout.

Set Payment Action to one of the following:

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

Authorization

Approves the purchase, but puts a hold on the funds. The
amount is not withdrawn until it is “captured” by the
merchant.

Sale

The amount of the purchase is authorized and immediately
withdrawn from the customer’s account.

Set Payment Applicable From to one of the following:
All Allowed
Countries

Accepts payment from the countries already specified in your
configuration.

Specific Countries

Accepts payments from only the countries you specify. Hold
the Ctrl key down and in the Payment Applicable From list,
click each country where you accept payment.

To record communications with the payment system in the log file, set Debug Mode
to “Yes.”
The log file is stored on the server and is accessible only to developers. In accordance
with PCI Data Security Standards, credit card information is not recorded in the log file.

To enable SSL verification, set Enable SSL verification to “Yes.”

To display a summary of each line item in the customer’s order on your PayPal
payments page, set Transfer Cart Line Items to “Yes.”

To allow customers to initiate a billing agreement from the dashboard of their
customer account, set Allow in Billing Agreement Wizard to “Yes.”

Billing Agreement Settings

Magento Commerce User Guide

1043

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

Settlement Report Settings
1.

Click to expand the Settlement Report Settings section.

If you have signed up for PayPal’s Secure FTP Server, enter the following SFTP login
credentials:
l

Password

To run test reports before “going live” with Express Checkout on your site, set Sandbox
Mode to “Yes.”

Enter the Custom Endpoint Hostname or IP Address. By default, the value is:
reports.paypal.com

Enter the Custom Path where reports are saved. By default, the value is:
/ppreports/outgoing

To generate reports according to a schedule, under Scheduled Fetching, make the
following settings:
a.

Set Enable Automatic Fetching to “Yes.”

Set Schedule to one of the following:
l

Daily

Every 3 Days

Every 7 Days

Every 10 Days

Every 14 Days

Every 30 Days

Every 40 Days

PayPal retains each report for forty-five days.
c.

1044

Set Time of Day to the hour, minute, and second when you want the reports to be
generated.

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

Settlement Report Settings

Frontend Experience Settings
The frontend experience settings give you the opportunity to choose which PayPal logos appear
on your site, and to customize the appearance of your PayPal merchant pages.
1.

Click to expand the Frontend Experience Settings section.

Select the PayPal Product Logo that you want to appear in the PayPal block in your
store. The PayPal logos are available in four styles and two sizes. Options include:

No Logo

We Prefer PayPal (150 x 60 or 150 x 40)

Now Accepting PayPal (150 x 60 or 150 x 40)

Payments by PayPal (150 x 60 or 150 x 40)

Shop Now Using PayPal (150 x 60 or 150 x 40)

To customize the appearance of your PayPal merchant pages, do the following:
a.

Enter the name of the Page Style that you want to apply to your PayPal merchant
pages. Options include:

Magento Commerce User Guide

1045

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

paypal

Uses the PayPal page style.

primary

Uses the page style that you identified as the “primary” style
in your account profile.

your_custom_
value

Uses a custom payment page style, which is specified in your
account profile.

In the Header Image URL field, enter the URL of the image that you want to appear
in the upper-left corner of the payment page. The maximum file size is 750 pixels
wide by 90 pixels high.
PayPal recommends that the image be located on a secure (https) server. Otherwise, the
customer’s browser may warn that “the page contains both secure and nonsecure items.”

Enter the six-character hexadecimal code, without the “#” symbol, for each of the
following:
Header
Background Color

Background color for the checkout page header.

Header Border
Color

2-pixel border around the header.

Page Background
Color

Background color for the checkout page and around the
header and payment form.

Frontend Experience Settings
3.

1046

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

PayPal In-Context Checkout
PayPal’s In-Context Checkout makes it easier than ever to pay online. Customers never lose
sight of your store during this simplified one- or two-click seamless checkout. In-Context
Checkout works equally well on Macs and PCs, and offers a consistent experience on desktop
computers, tablets, and mobile devices. To learn more, see: In-Context Checkout in Express
Checkout.

PayPal In-Context Checkout Demo

Magento Commerce User Guide

1047

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

To configure In-Context Checkout:
1.

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

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

In the PayPal Express Checkout section, tap Configure. Then, do the following:
a.

In the Required PayPal Settings section, set Enable In-Context Checkout Experience to
“Yes.”

Enter your PayPal Merchant Account ID.
Your Merchant Account ID is in your PayPal business account profile.

Enable PayPal In-Context Checkout
4.

1048

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

PayPal Billing Agreements
To simplify the checkout process, customers can enter into a billing agreement with PayPal, as
the payment service provider. During checkout, the customer chooses the billing agreement as
the payment method. The payment system verifies the billing agreement by its unique number,
and charges the customer's account. With a billing agreement in place, it is no longer necessary
for the customer to enter payment information for each purchase. Customers can manage their
billing agreements from the dashboard of their customer account, where the status of each is
shown as “Active” or “Canceled.” When a billing agreement is canceled, it cannot be reactivated.
The Billing Agreements grid lists all billing agreements between your store and its customers.
The store administrator can filter the records by the customer or billing agreement information
including billing agreement reference ID, status, and creation date. Each record includes
general information about the billing agreement, and all sales orders that have used it as a
payment method. The store administrator can view, cancel, or delete customer’s billing
agreements. A canceled billing agreement can be deleted only by the store administrator.

Billing Agreements

Magento Commerce User Guide

1049

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

Billing Agreement Workflow
Customer signs up for a billing agreement. After a billing agreement is in place,
additional billing agreements can be added only from the customer account. There is no
limit to the number of billing agreements a customer can create. Customers can use any
of the following methods to sign up for billing agreements:
l

Sign up in customer account. Customers can sign up for a billing agreement from
their customer accounts.
Sign up at checkout. Customers who pay for a purchase with PayPal Express
Checkout can mark a checkbox to create a billing agreement. Although the billing
agreement is not used for the current order, it becomes available as a payment
method option the next time the customer places an order.
Sign up by store administrator. On a customer’s request, the store administrator
can create a sales order using the customer’s billing agreement.

PayPal Verifies and Records Agreement. When the customer places the order with
payment by billing agreement, the billing agreement reference ID and sales order
payment details are transferred to PayPal, and recorded in the customer account, along
with reference information. If the payment is authorized, an order is created in
Magento.The billing agreement reference ID is sent to the customer and to the store.

1050

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Express Checkout

PayPal Settlement Reports
The PayPal Settlement report provides the store administrator with the information about each
transaction that affects the settlement of funds.
Before generating settlement reports, the store administrator must request PayPal Merchant
Technical Services to create an SFTP user account, enable settlement reports generation, and
enable SFTP in their PayPal business account.

After configuring and enabling settlement reports in the PayPal merchant account, Magento
will start generating reports during the following twenty-four hours. The list of available
settlement reports can be viewed from the Admin.

To view settlement reports:
1.

On the Admin sidebar, tap Reports. Then under Sales, choose select PayPal Settlement.

For the most recent updates, tap Fetch Updates in the upper-right corner.
The system connects to the PayPal SFTP server to fetch the reports. When the process is
complete, a message appears with the number of reports fetched. The report includes the
following information for each transaction:

Magento Commerce User Guide

1051

PayPal Express Checkout

CHAPTER 69: Recommended Solutions

Field Descriptions
FIELD

DESCRIPTION

PayPal Reference ID Type One of the following reference codes:
Order ID
Transaction ID
Subscription ID
Preapproved Payment ID

Options include:
Custom

The text entered by the merchant on
the transaction in PayPal.

Transaction Debit or Credit The direction of money movement of
gross amount.
Fee Debit or Credit

1052

The direction of money movement for
fee.

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Braintree

Braintree
Braintree offers a fully customizable checkout experience with fraud detection and PayPal
integration. Braintree reduces the PCI compliance burden for merchants because the
transaction takes place on the Braintree system.

Configure Braintree

Setting Up Braintree
Process Overview:
Step 1: Get Your Braintree Credentials
Step 2: Complete the Basic Settings
Step 3: Complete the Advanced Settings
Step 4: Complete the Country-Specific Settings
Step 5: Complete the PayPal through Braintree Settings
Step 6: Complete the 3D Verification Settings

Step 1: Get Your Braintree Credentials
Visit Braintree Payments and sign up for an account.

Step 2: Complete the Basic Settings
1.

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

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

If your Magento installation has multiple websites, stores or views, in the upper-left corner,
choose the Store View where the configuration applies.
In the Merchant Location section, verify that Merchant Country is set to the location of
your business.

Under Recommended Solutions, in the Braintree section, tap Configure. Then, do the following:

Magento Commerce User Guide

1053

Braintree

CHAPTER 69: Recommended Solutions

Enter a Title to identify Braintree as a payment option during checkout.

Set the current operating Environment for Braintree transactions to one of the following:
l

Sandbox

Production

When testing the configuration in a sandbox, use only credit card numbers that are
recommended by Braintree. When you are ready to go live with Braintree, set Environment
to “Production.”
c.

Set Payment Action to one of the following:
Authorize Only

Approves the purchase and puts a hold on the funds. The amount
is not withdrawn from the customer’s bank account until the sale is
“captured” by the merchant.

Authorize and
Capture

The amount of the purchase is authorized and immediately
withdrawn from the customer’s account.

In the Merchant ID field, enter the email address that is associated with your Braintree
account.

Enter the following credentials from your Braintree account:
l

Public Key

Private Key

Basic Settings
4.

Set Enable this Solution to “Yes.”

To include PayPal as a payment option with Braintree, set Enable PayPal through Braintree
to “Yes.”

1054

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Braintree

If you want the ability to store customer information securely, so customers don't have to
reenter it each time they make a purchase, set Vault Enabled to “Yes.”

Basic Settings

Step 3: Complete the Advanced Settings
1.

Expand

the Advanced Braintree Settings section.

In the Vault Title field, enter a descriptive title for your reference that identifies the vault where
your customer card information is stored.

Enter the Merchant ID that is to be associated with Braintree transactions. If left blank, the
default merchant account from your Braintree account is used.

To use Braintree fraud protection for all transactions, set Advanced Fraud Protection to “Yes.”
Make sure that Advanced Fraud Protection is enabled in the Settings/Protection section of your
account.

If you want the system to save a log file of interactions between your store and Braintree, set
Debug to “Yes.”

To require customers to provide the three-digit security code from the back of a credit card, set
CVV Verification to “Yes.”
If using CVV verification, make sure to enable AVS and/or CVV in the Settings/Processing
section of your Braintree account.

In the Credit Card Types box, hold down the Ctrl key and select each credit card that is
accepted by your store as payment through Braintree.

In the Sort Order field, enter a number to determine the sequence in which Braintree appears
when listed with other payment methods during checkout.

Magento Commerce User Guide

1055

Braintree

CHAPTER 69: Recommended Solutions

Advanced Settings

Step 4: Complete the Country Specific Settings
1.

Set Payment from Applicable Countries to one of the following:
l

All Allowed Countries

Specific Countries

For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.

1056

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Braintree

Country-Specific Settings
2.

To set up Country Specific Credit Card Types, do the following:
a.

Tap Add.

Set the Country, and choose each Allowed Credit Card Type.

Repeat to identify the credit cards that are accepted from each country.

Step 5: Complete the PayPal through Braintree Settings
1.

Do the following to identify your PayPal through Braintree configuration:
a.

Enter a Title to identify Braintree’s payment by PayPal option during checkout.

In the Vault Title field, enter a descriptive title to identify the vault where your customer
card information is to be stored.

In the Sort Order field, enter a number to determine the sequence in which Braintree’s
PayPal payment option appears when listed with other payment options during checkout.

To display your merchant name differently than what is defined in your store
configuration, enter the name as you want it to appear in the Override Merchant Name
field.

Set Payment Action to one of the following:

Magento Commerce User Guide

1057

Braintree

CHAPTER 69: Recommended Solutions

Authorize

Approves the purchase and puts a hold on the funds. The amount is not
withdrawn from the customer’s bank account until the sale is “captured”
by the merchant.

Authorize and
Capture

The amount of the purchase is authorized and immediately withdrawn
from the customer’s account.

Set Payment from Applicable Countries to one of the following for Braintree transactions
processed by PayPal:
l

All Allowed Countries

Specific Countries

For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.
4.

To require that customers provide a billing address, set Require Customer’s Billing Address
to “Yes.”
This feature must first be enabled for your account by PayPal Technical Support.

If you want customers to be able to edit the shipping address while completing a PayPal
transaction, set Allow to Edit Shipping Address Entered During Checkout on PayPal Side to
“Yes.”

To save a log file of interactions between your store and PayPal through Braintree, set Debug
to “Yes.”

If you want to bypass the Order Review step before the order is submitted, set Skip Order
Review to “Yes.”
By default, Order Review is the last stage of the checkout process.

To display the PayPal button on both the mini shopping cart and shopping cart page, set
Display on Shopping Cart to “Yes.”

1058

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Braintree

PayPal through Braintree Settings

Step 6: Complete the 3D Verification Settings
1.

If you want to add a verification step for customers using credit cards that are enrolled in a
verification program such as “Verified by VISA,” set 3d Secure Verification to “Yes.”
During the process, the transaction amount that is submitted for verification is checked
against the amount that is sent for authorization,

In the Threshold Amount field, enter the minimum order amount that is required to trigger 3D
verification.

Set Verify for Applicable Countries to one of the following:
l

All Allowed Countries

Specific Countries

To Verify for Specific Countries, hold down the Ctrl key and select each country from which
payments are to be verified.

Magento Commerce User Guide

1059

Braintree

CHAPTER 69: Recommended Solutions

3D Verification Settings

Step 7: Dynamic Descriptors
The following descriptors are used to identify purchases on customer credit card statements.
You can reduce the number of chargebacks by clearly identifying the company that is
associated with each purchase. If Dynamic Descriptors are not enabled for your account,
contact Braintree support.
1.

Enter the Dynamic Descriptor for the Name, Phone, and URL according to these guidelines:
Name

There are two parts to the Name descriptor, which are separated by an
asterisk (*). For example:
company*myproduct

The first part of the descriptor identifies the company or DBA, and the
second part identifies the product. The length of the Company and
Product parts of the descriptor can be allocated in the following ways,
for a combined length of up to twenty-two characters.
Characters in Name Descriptor

Phone

Company

Product

Option 1

Must be 3 characters

Up to 18 characters

Option 2

Must be 7 characters

Up to 14 characters

Option 3

Must be 12 characters

Up to 9 characters

The Phone descriptor must be ten to fourteen characters in length, and
can include only numbers, dashes, parentheses, and periods. For
example:
9999999999
(999) 999-9999

1060

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Other PayPal Solutions

999.999.9999

URL

The URL descriptor represents your domain name, and can be up to
thirteen characters long. For example: company.com

When your Braintree configuration is complete, tap Save Config.

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

CHAPTER 69: Recommended Solutions

PayPal All-In-One Payment Solutions
In the United States, PayPal offers the following PCI-compliant solutions to meet the needs of
your growing business.
l

PayPal Payments Advanced

PayPal Payments Pro

PayPal Payments Standard

PayPal All-In-Payment Solutions

PayPal Payment Gateways
PayPal offers a choice of two payment gateway solutions for your business. You can let PayPal
host your checkout on its secure payment site, or you can take control of the entire payment
experience with a completely customizable solution.
l

PayPal Payflow Pro

PayPal Payflow Link

PayPal Payment Gateways

1062

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Other PayPal Solutions

PayPal Payments Advanced
PayPal Payments Advanced is a PCI-compliant solution that lets your customers pay by debit
or credit card without leaving your site. It includes an embedded checkout page that can be
customized to create a seamless and secure checkout experience.

PayPal Payments Advanced
Even customers without a PayPal account can make purchases through PayPal’s secure
payment gateway. Accepted cards include Visa, MasterCard, Switch/Maestro, and Solo credit
cards in the United States and United Kingdom. For additional convenience, PayPal Express
Checkout is included with PayPal Payments Advanced.
You can have two PayPal solutions active at the same time: Express Checkout, plus any All-InOne or Payment Gateway solution. If you change payment solutions, the one that was used
previously is disabled.
PayPal Payments Advanced cannot be used for orders created from the Admin of your store.

Requirements
PayPal Business Account
If you manage multiple Magento websites, you must have a separate PayPal merchant
account for each website.

Magento Commerce User Guide

1063

Other PayPal Solutions

CHAPTER 69: Recommended Solutions

Checkout Workflow
Customer Chooses Payment Method. During checkout, the customer chooses to pay
with PayPal Payments Advanced. The Pay Now button appears instead of the Place
Order button.
Pay Now. The customer taps Pay Now, and a PayPal-hosted form appears. The
customer enters the card information, and the card is verified. If successful, the order
confirmation page appears.
Pay with PayPal. The form also includes the Pay with PayPal button, which redirects
the customer to the PayPal site, where payment can be made with PayPal Express
Checkout.
Troubleshooting. If the transaction fails for any reason, an error message appears on
the checkout page and the customer is instructed to try again. Any issues are managed
by PayPal.

Order Processing Workflow
Processing orders with PayPal Payments Advanced is the same as for any regular PayPal order.
Orders are invoiced and shipped, and credit memos generated for both online and offline
refunds. However, multiple online refunds are not available for orders paid with PayPal
Payments Advanced.
Customer Places Order. In the final stage of checkout, the customer taps the Place
Order button.

PayPal Responds. PayPal evaluates the request. If found to be valid, PayPal
processes the transaction.

1064

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Other PayPal Solutions

Magento Sets Order Status. Magento receives response from PayPal, and sets the
order status to one of the following:
Processing

The transaction was successful.

Pending Payment

The system did not receive any response from PayPal.

Canceled

The transaction was not successful for some reason.

Suspected Fraud

The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.

Merchant Fulfills Order. The merchant invoices and ships the order.

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

Setting Up PayPal Payments Advanced

Magento Commerce User Guide

1065

Other PayPal Solutions

CHAPTER 69: Recommended Solutions

PayPal Payments Pro
PayPal Payments Pro brings you all the benefits of a merchant account and payment gateway
in one, plus the ability to create your own, fully customized checkout experience. PayPal
Express Checkout is automatically enabled with PayPal Payments Pro, so you can tap into
more than 110 million active PayPal users.

PayPal Payments Pro
For merchants outside the US, this method is called “PayPal Website Payments Pro.”

You can have two PayPal solutions active at the same time: PayPal Express Checkout, plus any
one of the All-In-One solutions. If you change payment solutions, the one used previously is
automatically disabled.

Requirements
PayPal Merchant Account (with Direct Payments Activated)

Checkout Workflow
Customer Goes to Checkout. Customer adds products to cart, and taps Proceed to
Checkout.

Customer Chooses Payment Method. During checkout, customer chooses the
PayPal Direct Payment option, and enters the credit card information.
l

If paying with PayPal Payments Pro, the customer stays on your site during the
checkout process.
If paying with PayPal Express Checkout, the customer is redirected to the PayPal
site to complete the transaction.

At the customer’s request, the store administrator can also create an order from the
Admin, and process the transaction with PayPal Payments Pro.

1066

Magento Commerce User Guide

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

1067

Other PayPal Solutions

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

1068

Magento Commerce User Guide

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

1069

Other PayPal Solutions

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

1070

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Other PayPal Solutions

PayPal Payflow Pro
PayPal Payflow Pro gateway, formerly known as Verisign, is available for customers of the
United States, Canada, Australia, and New Zealand. Unlike other PayPal payment methods,
merchants are charged a fixed monthly fee, plus a fixed fee for each transaction, regardless of
their number.

Configure

Requirements
PayPal Business Account
The PayPal Payflow Pro gateway links the merchant account at PayPal with the
merchant’s website, and acts both as a gateway and a merchant account.
If you manage multiple Magento websites, you must have a separate PayPal merchant
account for each website.

Customer Workflow
Customer Goes to Checkout. During checkout, the customer chooses to pay with
PayPal PayFlow Pro, and enters the credit card information.
Customers are not required to have personal PayPal accounts. However, depending on
the merchant country, customers can also use their personal PayPal account to pay for
the order.
Customer Submits Order. The customer submits the order, and the order information
is sent to PayPal for processing. The customer does not leave the checkout page of your
site.
PayPal Completes the Transaction. Payments are accepted at the time the order is
placed. Depending on the payment action specified n the configuration, either a sales
order or a sales order and an invoice is created.

Magento Commerce User Guide

1071

Other PayPal Solutions

CHAPTER 69: Recommended Solutions

Online Order Processing Workflow
Administrator Submits Online Invoice. The store administrator submits an online
invoice. and as a result a corresponding transaction and an invoice is created.

PayPal Receives the Transaction. The order information is sent to PayPal. A record of
the transaction and an invoice is generated. You can view all Payflow Pro Gateway
transactions in your PayPal merchant account.

Partial invoices and partial refunds are not supported by PayPal Payflow Pro.

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

PayPal Payflow Pro

1072

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

Other PayPal Solutions

PayPal Payflow Link
PayPal PayFlow Link is available for merchants in the United States and Canada only.
Customers are not required to have a personal PayPal account, and enter their credit card
information in a form that is hosted by PayPal. The information is never stored on your
Magento server. PayFlow Link cannot be used for orders that are created from the Admin.

Configure
Credit memos are supported for both online and offline refunds. However, multiple online
refunds are not supported.

Customer Workflow
Customer Goes to Checkout. During checkout, the customer chooses to pay with
PayPal PayFlow link, and enters the credit card information.
The customer is not required to have a personal PayPal account.
Customer Chooses Pay Now. The customer taps the Pay Now button to submit the
order.

Customer Enters Credit Card Info. The customer enters the credit card information on
a form that is hosted by PayPal/
If the customer clicks the Cancel Payment link, the customer returns to the Payment
Information stage of checkout, and the order status changes to “Canceled.”
Customer Submits the Order. The credit card information is submitted directly to
PayPal, and is not retained anywhere on the Magento site.

Magento Commerce User Guide

1073

Other PayPal Solutions

CHAPTER 69: Recommended Solutions

Order Workflow
PayPal Receives Request. PayPal receives the request from the customer to Pay
Now.

PayPal Verifies the Payment Information. PayPal verifies the credit card information,
and assigns the appropriate status.
Payment Verified: If verified, the “Pending Payment” the applicable status is initially
assigned to the order until the transaction is settled.
Processing

The transaction was successful.

Pending Payment

The system did not receive any response from PayPal.

Canceled

The transaction was not successful for some reason.

Suspected Fraud

The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.

Cancel Payment. If the customer clicks the Cancel Payment link, the customer returns
to the Payment Information stage of checkout, and the order status changes to
“Canceled.”
Customer Is Redirected to Confirmation Page. If the transaction completes
successfully, the customer is redirected to the order confirmation page in your store.
If the transaction fails on any reason, an error message appears on the checkout page
and the customer is directed to repeat the checkout process. These situations are
managed by PayPal.
Merchant Fulfills Order. The merchant invoices, and ships the order as usual.

1074

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

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

Magento Commerce User Guide

1075

PayPal Reference

CHAPTER 69: Recommended Solutions

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)

1076

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Reference

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.

PayPal Credit®
PayPal Credit offers your customers quick access to financing, so they can buy now and pay
later, at no additional cost to you. You are not charged when customers choose PayPal Credit,
and pay only your normal PayPal transaction fee.
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.
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.

Magento Commerce User Guide

1077

PayPal Reference

CHAPTER 69: Recommended Solutions

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

1078

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.

Magento Commerce User Guide

CHAPTER 69: Recommended Solutions

PayPal Reference

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.

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:

Magento Commerce User Guide

1079

PayPal Reference

CHAPTER 69: Recommended Solutions

Catalog Category Page

Catalog Product Page

Checkout Cart Page

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.

1080

Magento Commerce User Guide

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

1081

PayPal Reference

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

1082

Magento Commerce User Guide

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

1083

1084

Magento Commerce User Guide

CHAPTER 70:

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

Authorize.Net Direct Post

Cybersource

eWAY

Worldpay

Magento Commerce User Guide

1085

Authorize.Net Direct Post

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

CyberSource

1086

Magento Commerce User Guide

CHAPTER 70: Other Payment Methods

CyberSource

CyberSource was one of the pioneers in the early online payment industry, and later acquired
Authorize.Net. Today, Cybersoure is a wholly-owned subsidiary of Visa Inc. Over 400,000
businesses worldwide use CyberSource to process online payments, streamline fraud management,
and to simplify payment security. The company is based in Foster City, California, and has offices
throughout Asia, Europe, Latin America, the MIddle East, Africa, and the United States.

Step 1: Get Your CyberSource Credentials
Sign up for a CyberSource merchant account, and get your credentials.

Step 2: Enable CyberSource
1.

Set Enabled to “Yes.”

Accept the Default Payment action of “Authorized Only,” which approves the purchase and
puts a hold on the funds. The amount is not withdrawn from the customer’s bank account
until the sale is “captured” by the merchant.

Enter a Title to identify CyberSource during checkout.

Enable CyberSource

Step 3: Enter Your CyberSource Credentials
Enter the following credentials from your CyberSource account:
l

Profile ID

Merchant ID

Transaction Key

Access Key

Secret Key

Magento Commerce User Guide

1087

CyberSource

CHAPTER 70: Other Payment Methods

Your CyberSource Credentials

Step 4: Complete the Payment Information
1.

Set New Order Status to one of the following order status settings:
l

Processing

Suspected Fraud

To run CyberSource in a test environment before going live, set Test Mode to “Yes.”
When you are ready to go live with CyberSource, set Test Mode to “No.”

If you want the system to save a log file of interactions between your store and CyberSource, set
Debug to “Yes.”

Set Credit Card Types to each card that you accept as payment. To choose multiple credit
cards, hold down the Ctrl key and click each option.

Credit Card Types

1088

Magento Commerce User Guide

CHAPTER 70: Other Payment Methods

CyberSource

Step 5: Complete the Remaining Information
1.

Set Payment from Applicable Countries to one of the following:
l

All Allowed Countries

Specific Countries

For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.
2.

To set limits on the total amount that is allowed for any order, enter the Minimum Order Total
and Maximum Order Total.

In the Sort Order field, enter a number to determine the sequence in which CyberSource
appears when listed with other payment methods during checkout.

When complete, tap Save Config.

Remaining Information

Magento Commerce User Guide

1089

eWAY

CHAPTER 70: Other Payment Methods

eWAY
eWAY is based in Australia, and provides secure payment processing services to merchants
throughout Australia, New Zealand, the United Kingdom, Singapore, Malaysia, and Hong
Kong. Their latest Rapid 3.1 API enables real-time fraud protection.

Step 1: Get Your eWAY Credentials
Sign up for an eWAY merchant account, and get your credentials.

Step 2: Enable eWAY
1.

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

Expand

the eWAY section. Then, do the following:

Enable eWAY
a.

Set Enabled to “Yes.”

Set Connection Type to one of the following:

Direct connection

Completes the transaction without leaving your website.

Responsive shared
page

Redirects to a page for your store that is hosted on the eWAY server
to complete the transaction.

Enter a Title to identify eWAY as a payment option during checkout.

Step 3: Enter Your eWAY Credentials
1.

To run test transactions in a test environment, set Sandbox Mode to “Yes.” To learn more, see:
Sandbox/Testing on the eWAY website.
When you are ready to go live with eWAY, set Sandbox Mode to “No.”

1090

Magento Commerce User Guide

CHAPTER 70: Other Payment Methods

eWAY

Follow the instructions on the eWAY website to set up your Live API key and password. Then,
enter the following:

Live API Key

Live API Password

Live Client-side Encryption Key

Follow the instructions on the eWAY website to set up your sandbox credentials. Then, enter
the following:
l

Sandbox API Key

Sandbox API Password

Sandbox Client-side Encryption Key

eWAY Credentials

Step 4: Configure Payments
1.

Set Payment Action to one of the following
Authorize Only

Approves the purchase and puts a hold on the funds. The amount is not
withdrawn from the customer’s bank account until the sale is “captured”
by the merchant.

Authorize and
Capture

The amount of the purchase is authorized and immediately withdrawn
from the customer’s account.

To save a record of communications between your store and the eWAY system in a log file, set
Debug to “Yes.”
In accordance with PCI Data Security Standards, credit card information is not recorded in the log
file.

Magento Commerce User Guide

1091

eWAY

CHAPTER 70: Other Payment Methods

In the Credit Card Types box, hold down the Ctrl key and select each credit card that is
accepted as payment in your store.

Configure Payments
4.

Set Payment from Applicable Countries to one of the following:
l

All Allowed Countries

Specific Countries

For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.

Configure Countries
5.

In the Sort Order field, enter a number to determine the order in which eWAY appears when
listed with other payment methods during checkout.

1092

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 70: Other Payment Methods

Worldpay

Worldpay
London-based Worldpay has twenty-five offices in eleven countries around the world. The
company is a global leader in card payments, multi-currency processing, and provides local instore and mobile payment acceptance solutions for companies large and small.

Step 1: Get Your Worldpay Credentials
Sign up for a Worldpay online merchant account.

Step 2: Enable Worldpay
1.

Set Enabled to “Yes.”

Enter a Title to identify Worldpay as a payment option during checkout.

Enable Worldpay

Step 3: Enter Your Worldpay Credentials
Enter the following credentials from your Worldpay account:
l

Installation ID

Payment Response Password

Remote Admin Installation ID

Remote Admin Authorization Password

MDS Secret for Transactions

Worldpay Credentials

Magento Commerce User Guide

1093

Worldpay

CHAPTER 70: Other Payment Methods

Step 4: Configure Contact Information
1.

If you want customers to be able to edit their contact information, set Allow to Edit Contact
Information to “Yes.”

If you don’t want to show customers their contact information, set Hide Contact Information
to “Yes.”

Accept the default Signature Fields value.

Contact Information

Step 5: Configure Test Mode
1.

If you want the system to save a log file of interactions between your store and Worldpay, set
Debug to “Yes.”

To run Worldpay in a test environment before going live, set Test Mode to “Yes.”
When you are ready to go live with Worldpay, set Test Mode to “No.”

Test Mode

Step 6: Configure Payments
1.

To determine the payment action used for test transactions, set Payment Action for Test to
one of the following:

Authorised

Error

Captured

To determine the payment action used for live transactions, set Payment Action to one of the
following:

1094

Magento Commerce User Guide

CHAPTER 70: Other Payment Methods

Worldpay

Authorize Only

Approves the purchase and puts a hold on the funds. The amount is not
withdrawn from the customer’s bank account until the sale is “captured”
by the merchant.

Authorize and
Capture

The amount of the purchase is authorized and immediately withdrawn
from the customer’s account.

Set Payment from Applicable Countries to one of the following:
l

All Allowed Countries

Specific Countries

For Payment from Specific Countries, hold down the Ctrl key and select each country from
which you accept payment.

Configure Payments

Step 7: Configure Fraud Prevention Settings
Set both Order Status to Suspected Fraud for CVV and Order Status to Suspected Fraud tor
Postcode AVS to one of the following:
l

None

Not Supported

Not Checked

Not Matched

Partially Matched

Magento Commerce User Guide

1095

Worldpay

CHAPTER 70: Other Payment Methods

Fraud Settings

Step 8: Sort Order and Save
1.

In the Sort Order field, enter a number to determine the sequence in which Worldpay appears
when listed with other payment methods during checkout.

Sort Order
2.

1096

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 71:

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

1097

Check / Money Order

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

1098

Magento Commerce User Guide

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

1099

Cash On Delivery

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

1100

Magento Commerce User Guide

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

1101

Bank Transfer

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

1102

Magento Commerce User Guide

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

1103

Purchase Order

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

1104

Magento Commerce User Guide

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

1105

Zero Subtotal Checkout

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

1106

Magento Commerce User Guide

CHAPTER 71: Basic Payment Methods

Fraud Protection

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 .

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 Filter

Signifyd Guaranteed Fraud Protection

Archive

Archive
The Admin Actions archive lists the CSV log files that are stored on the server. In the
configuration, you can specify how long the log entries are stored, and how often they are
archived. By default, the file name includes the current date in ISO format: yyyyMMddHH.
Log archiving requires a cron job to be set up.

To configure the log archive:
1.

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

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

Expand
a.

the Admin Actions Log Archiving section, and do the following:

In the Log Entry Lifetime, Days field, enter the number of days that you want to keep the
log entries in the database before they are removed.

Set Log Archiving Frequency to one of the following:
l

Daily

Weekly

Monthly

Admin Actions Log Archiving
4.

When complete, tap Save Config.

To view the archive:
1.

On the Admin sidebar, tap System.

Under Actions Logs, choose Archive.

Magento Commerce User Guide

1415

Archive

CHAPTER 94: Security

Admin Actions Archive

Bulk Actions
The Bulk Actions Log records the details of asynchronous mass operations that run in the
background, such as import/export.

Bulk Actions Log

To configure bulk actions:

1416

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

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

Expand

In the Days Saved in Log field, enter the number of days that bulk actions are saved in a log.

the Bulk Actions section.

Magento Commerce User Guide

CHAPTER 94: Security

Archive

Bulk Actions
5.

When complete, tap Save Config.

To view bulk actions:
1.

Find the action in the log.

In the Action column, click Details.

Magento Commerce User Guide

1417

1418

Magento Commerce User Guide

CHAPTER 95:

Tools
In this section of the guide, you will learn how to perform routine index and cache
management operations, back up the system, and use tools that help our Support team
troubleshoot and resolve issues.
l

Cache Management

Index Management

Backups

Cron (Scheduled Backups)

Developer Tools

Alternate Media Storage

Web Setup Wizard

Support

Magento Commerce User Guide

1419

Cache Management

CHAPTER 95: Tools

Cache Management
Magento’s cache management system is an easy way to improve the performance of your site.
Whenever a cache needs to be refreshed, a notice appears at the top of the workspace to guide
you through the process. Follow the link to Cache Management, and refresh the invalid caches.

Update Cache Message
The Cache Management page shows the status of each primary cache and its associated tag.
The large buttons in the upper-right corner can be used to flush the Magento Cache, or the allinclusive Cache Storage. At the bottom of the page there are additional buttons to flush the
catalog product images cache and JavaScript/CSS cache. After clearing a cache, always refresh
your browser to make sure that you can see the most recent files.

Cache Management

1420

Magento Commerce User Guide

CHAPTER 95: Tools

Cache Management

To refresh specific caches:
1.

Do one of the following:
l

Click the Cache Management link in the message above the workspace.

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

For each cache to be refreshed, mark the checkbox at the beginning of the row.

Set Actions to “Refresh,” and tap Submit .

To perform mass actions:
1.

To select a group of caches, set Mass Actions to one of the following:
l

Select All

Select Visible

Mark the checkbox of each cache to be targeted by the action.

Set Actions to “Refresh,” and tap Submit.

To flush the product image cache:
1.

From the Cache Storage Management page, under Additional Cache Management, click Flush
Catalog Images Cache to clear pre-generated product image files.
The message, “Image cache was cleaned” appears at the top of the workspace.

Make sure to also clear the cache of your browser.

To flush the JavaScript/CSS cache:
1.

From the Cache Storage Management page, under Additional Cache Management, click Flush
JavaScript/CSS Cache to clear any JavaScript and CSS files that have been merged into a
single file.
The message, “The JavaScript/CSS cache has been cleaned” appears at the top of the
workspace.

Make sure to also clear the cache of your browser.

Magento Commerce User Guide

1421

Cache Management

CHAPTER 95: Tools

Control Descriptions
CONTROL
Mass Actions

Actions

DESCRIPTION
Marks the checkbox of multiple caches. Options include:
Select All

Marks the checkbox of all caches.

Unselect All

Clears the checkbox of all caches.

Select Visible

Marks the checkbox of all visible caches.

Unselect Visible

Clears the checkbox of all visible caches.

Determines the action to be applied to all selected caches. Options
include:

Submit

Enable

Enables all selected caches.

Disable

Disables all selected caches.

Refresh

Refreshes all selected caches.

Applies the action to all selected caches.

Button Descriptions
BUTTON

DESCRIPTION

Flush Magento Cache

Removes all items in the default Magento cache (var/cache),
according to their associated Magento tags.

Flush Cache Storage

Removes all items from the cache, regardless of Magento tag. If your
system uses an alternate cache location, any cached files used by
other applications are removed in the process.

Flush Catalog Images
Cache

Removes all automatically resized and watermarked catalog images
that are stored at: media/catalog/product/cache.
If recently uploaded images aren't reflected in the catalog, try flushing
the catalog and refreshing your browser.

Flush JavaScript/CSS
Cache

Flush Static Files Cache

1422

Removes the merged copy of JavaScript and CSS files from the
cache. If recent changes to the style sheet or JavaScript aren't
reflected in the store, try flushing the JavaScript/CSS cache and
refreshing your browser.
Removes preprocessed view files and static files.

Magento Commerce User Guide

CHAPTER 95: Tools

Cache Management

Cache Descriptions
CACHE
Configuration

DESCRIPTION
Various XML configurations that were collected across modules and
merged. Associated Tag: CONFIG
System:

config.xml
local.xml

Module:
Layouts

config.xml

Layout building instructions.
Associated Tag: LAYOUT_GENERAL_CACHE_TAG

Blocks HTML output

Page blocks HTML. Associated Tag: BLOCK_HTML

Collections Data

Collection data files. Associated Tag: COLLECTION_DATA

Database DDL operations

Results of DDL queries, such as describing tables or indexes.
Associated Tag: DB_DDL

EAV types and attributes

Entity types declaration cache. Associated Tag: EAV

Page Cache

Full page caching. Associated Tag: FPC

Integrations Configuration

Integration configuration file. Associated Tag: INTEGRATION

Integrations API
Configuration

Integrations API configuration file.

Target Rule

The target rule index.

Associated Tag: INTEGRATION_API_CONFIG

Associated Tag: IARGET_RULE
Translations

Translation files. Associated Tag: TRANSLATE

Web Services
Configuration

REST and SOAP configurations, generated WSDL file.

Magento Commerce User Guide

Associated Tag: WEBSERVICE

1423

Cache Management

CHAPTER 95: Tools

Full-Page Cache
Magento Commerce uses full-page caching on the server to quickly display category, product,
and CMS pages. Full-page caching improves response time and reduces the load on the server.
Without caching, each page might need to run blocks of code and retrieve information from the
database. However, with full-page caching enabled, a fully-generated page can be read directly
from the cache. For more technical information, see: Configure and Use Varnish
We recommend Varnish to be used only in a production environment.

Cached content can be used to process the requests from similar types of visits. As a result,
pages shown to a casual visitor might differ from those shown to a customer. For the purposes
of caching, each visit is one of three types:
Non-sessioned

During a non-sessioned visit, a shopper views pages, but does not
interact with the store. The system caches the content of each page
viewed, and serves them to other non-sessioned shoppers.

Sessioned

During a sessioned visit, shoppers who interact with the store—through
activities such as comparing products or adding products to the
shopping cart—are assigned a session ID. Cached pages that are
generated during the session are used only by that shopper during the
session.

Customer

Customer sessions are created for those who have registered for an
account with your store and shop while logged in to their accounts.
During the session, customers can be presented with special offers,
promotions, and prices that are based on the customer group to which
they are assigned.

To configure the full-page cache:
1.

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

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

Expand

the Full Page Cache section.

Full Page Cache

1424

Magento Commerce User Guide

CHAPTER 95: Tools

Cache Management

Set Caching Application to one of the following:
l

Built-in Application

Varnish Caching

To set the time-out for the page cache, enter the TTL for public content. (The default value is
86400)

If using Varnish, complete the Varnish Configuration section as follows:
a.

In the Access list field, enter the IP addresses that can purge the Varnish configuration to
generate a config file. Separate multiple entries with a comma. The default value is
“localhost.”

In the Backend host field, enter the IP address of the backend host that generates config
files. The default value is “localhost.”

In the Backend port field, identify the backend port that is used to generate config files.
The default value is: “8080.”

To export the configuration as a varnish.vcl file, tap the button for the version of Varnish
that you use.
l

Export VCL for Varnish 3

Export VCL for Varnish 4

Varnish Configuration
7.

When complete, tap Save Config .

Magento Commerce User Guide

1425

Index Management

CHAPTER 95: Tools

Index Management
Magento reindexes automatically whenever one or more items change. Actions that trigger
reindexing include price changes, creating catalog or shopping cart price rules, adding new
categories, and so on. To optimize performance, Magento accumulates data into special tables
using indexers. As the data changes, the indexed tables must be updated—or reindexed.
Reindexing is performed as a background process, and your store remains accessible during the
processes.
Reindexing data speeds up processing, and reduces the time the customer has to wait. For
example, if you change the price of an item from $4.99 to $3.99, Magento reindexes the data to
show the price change in the store. Without indexing, Magento would have to calculate the
price of every product on the fly—taking into account shopping cart price rules, bundle pricing,
discounts, tier pricing, and so on. Loading the price for a product might take longer than the
customer is willing to wait.
The indexers can be set to either update on save, or on schedule. Reindexing is performed as a
background process that is scheduled as a cron job, and your store remains accessible during
the processes. A system message appears if a cron job is not available to update any indexers
that become invalid.

Index Management
Index Management has a slightly different presentation for flat product catalogs.
To avoid problems when multiple Admin users update objects that trigger automatic
reindexing, we recommend that you set all indexers to run on schedule as cron jobs.
Otherwise, every time an object is saved, any objects with interdependencies might
cause a deadlock. Symptoms of a deadlock include high CPU usage and MySQL errors.
As a best practice, we recommend that you use scheduled indexing .

1426

Magento Commerce User Guide

CHAPTER 95: Tools

Index Management

To change the index mode:
1.

On the Admin sidebar, tap System. Then under Tools, choose Index Management.

Mark the checkbox of each indexer that you want to change.

Set Actions to one of the following:

Update on Save

Update by Schedule

Tap Submit to apply the change to each selected indexer.

Column Descriptions
COLUMN

DESCRIPTION

Indexer

The name of the indexer.

Description

A description of the indexer.

Mode

Indicates the current update mode for each indexer. Options:

Status

Updated

Magento Commerce User Guide

Update on Save

The index is set to update whenever a
change is saved.

Update on
Schedule

The index is set to update on schedule
according to a cron job.

Displays one of the following:
Ready

The index is up-to-date.

Scheduled

Reindexing is scheduled to take place.

Running

Reindexing is currently running.

Reindex Required

A change has been made that requires
reindexing, but the indexers cannot be
updated automatically. Check to see if cron
is available and configured correctly.

Indicates the date and time an index was last updated.

1427

Index Management

CHAPTER 95: Tools

Index Trigger Events
Reindexing Triggers
INDEX TYPE
Product Prices

REINDEXING EVENT
Add customer group
Change configuration settings

Flat catalog1 product data

Add store
Add store group
Add, edit, or delete attribute (for searching and filtering)

Flat catalog category data

Add store
Add store group
Add, edit, or delete attribute (for searching and filtering)

Catalog category/product
index

Add, edit, or delete products (single, mass, and import)
Change product-to-category relations
Add, edit, or delete categories
Add or delete stores
Delete store groups
Delete websites

Catalog search index

Add, edit, or delete products (single, mass, and import)
Add or delete stores
Delete store groups
Delete websites

Stock status index

Change inventory configuration settings.

Category permissions
index

Add store, add store group, add or delete or update attribute (for
searching and filtering)

1 The flat product and category indexers also influence how catalog and shopping cart price rules are indexed. If

you have a large number of SKUs (about 500,000 or more), you will notice a dramatic improvement in indexing time
for price rules. To take advantage of this improvement, you must enable Use Flat Catalog Product.

1428

Magento Commerce User Guide

CHAPTER 95: Tools

Index Management

Index Actions and Controls
Index Actions
ACTION
Creating a new store, new
customer group, or any
action listed in “Actions
that Cause a Full
Reindex.”

RESULT
Full reindex

Bulk loading of items in the Partial reindex (only
following ways:
changed items are
reindexed)
l
Magento import/export
l

TO CONTROL
Full reindexing is performed on the
schedule determined by your Magento
cron job.

At the frequency determined by your
Magento cron job.

Direct SQL query
Any other method that
directly adds, changes,
or deletes data.

Changing scope (for
example, from global to
website)

Partial reindex (only
changed items are
reindexed)

At the frequency determined by your
Magento cron job.

Events that Trigger Full Reindexing
Full Reindex Triggers
INDEXER
Catalog Category Flat
Indexer

EVENT
Create a new web store
Create a new web store view
Create, or delete an attribute that is any of the following:
l

Searchable or visible in advanced search

Filterable

Filterable in search

Used for sorting

Change an existing attribute to be any of the preceding.
Enable flat category storefront options
Catalog Product Flat
Indexer

Create a new web store
Create a new web store view
Create, or delete an attribute that is any of the following:

Magento Commerce User Guide

1429

Index Management

CHAPTER 95: Tools

Full Reindex Triggers (cont.)
INDEXER

EVENT
l

Searchable or visible in advanced search

Filterable

Filterable in search

Used for sorting

Change an existing attribute to be any of the preceding.
Enable flat category storefront options
Stock status indexer

Price Indexer

When the following Catalog Inventory options change in the system
configuration:
Stock Options

Display Out of Stock Products

Product Stock
Options

Manage Stock

Adding a new customer group.
When any of the following Catalog Inventory options change in the
system configuration:

Category or Product
Indexer

Stock Options

Display Out of Stock Products

Product Stock
Options

Manage Stock

Price

Catalog Price Scope

Create or delete a store view
Delete a store
Delete a website

1430

Magento Commerce User Guide

CHAPTER 95: Tools

Backups

Backups
Magento Commerce gives you the ability to back up different parts of the system—such as the
file system, database, and media files—and to rollback automatically. A record for each backup
appears in the grid on the Backups page. Deleting a record from the list deletes the archived file
as well. Database backup files are compressed using the .GZ format. For the system backups
and database and media backups, the .TGZ format is used. As a best practice, you should
restrict access to backup tools, and back up before installing extensions and updates.
Restrict access to backup tools. Access to the Backups and Rollback management tool
can be restricted by configuring user permissions for backup and rollback resources. To
restrict access, leave the corresponding checkbox unselected. If you need to grant access
to rollback resources, you must grant access to backup resources as well.
Back up before installing extensions and updates. Always perform a backup before
you install an extension or update. Component Manager includes a backup option that you
can use before installing an extension or upgrading to a new release.

Backups

Magento Commerce User Guide

1431

Backups

CHAPTER 95: Tools

To create a backup:
1.

On the Admin sidebar, tap System. Then under Tools, choose Backups.

In the upper-right corner, tap the button for the type of backup you want to create:

System Backup

Creates a complete backup of the database and the file system. During
the process, you can choose to include the media folder in the backup.

Database and
Media Backup

Creates a backup of the database and the media folder.

Database Backup

Creates a backup of the database.

To put the store into maintenance mode during the backup, mark the checkbox. When the
backup is complete, maintenance mode is turned off automatically.

For a system backup, mark the Include Media folder to System Backup checkbox if you want
to include the media folder. Then when prompted, confirm the action.

To schedule backups

1432

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

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

Expand

When complete, tap Save Config.

the Scheduled Backup Settings section, and do the following:

Magento Commerce User Guide

CHAPTER 95: Tools

Cron (Scheduled Tasks)

Cron (Scheduled Tasks)
Magento performs some operations on schedule by periodically running a script. You can
control the execution and scheduling of Magento cron jobs from the Admin. Store operations
that run according to a cron schedule include:
l

Catalog Price Rules

Newsletters

XML Sitemap Generation

Currency Rate Updates

In addition, you can configure the following to run according to a cron schedule:
l

Order System Grid Updates and Reindexing

Pending Payment Lifetime

Make sure that the base URLs for the store are set correctly, so the URLs that are generated
during cron operations are correct. To learn more, see: Setting Up Cron Jobs.

To configure cron:
1.

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

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

Expand

the Cron section.

Cron (Scheduled Tasks)

Magento Commerce User Guide

1433

Cron (Scheduled Tasks)

CHAPTER 95: Tools

Then, complete the following settings for the Index and Default groups. The settings are the
same in each section.
l

Generate Schedules Every

Schedule Ahead for

Missed if not Run Within

History Cleanup Every

Success History Lifetime

Failure History Lifetime

Use Separate Process

Cron Configuration for Group: Index
5.

1434

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 95: Tools

Developer Tools

Developer Tools
Use the Advanced Developer tools to determine the compilation mode during frontend
development, create a whitelist of IP addresses, display template path hints, and make spot
changes to text in the interface of the storefront and Admin.
l

Frontend Development Workflow

Using Static File Signatures

File Optimization

Developer Client Restrictions

Template Path Hints

Translate Inline

Magento Commerce User Guide

1435

Developer Tools

CHAPTER 95: Tools

Frontend Development Workflow
The Frontend Development Workflow type determines if Less compilation takes place on the clientor server side during development. Less is an extension of CSS that has additional features and
conventions, and that produces streamlined code. Client-side Less compilation is recommended for
theme development. Server-side compilation is the default mode. The development workflow options
are not available for stores in production mode. To learn more, see Client-side LESS compilation vs.
server-side in the developer documentation.
The Frontend Development Workflow configuration is available in Developer Mode only.

Front-end Development Workflow
1.

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

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

Expand the Front-end Development Workflow section.

Set Workflow Type to one of the following:

1436

Client side less
compilation

Compilation takes place in the browser using the native less.js library.

Server side less
compilation

Compilation takes place on the server using the Less PHP library. This is
the default mode for production.

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 95: Tools

Developer Tools

Using Static File Signatures
Adding a digital signature to the URL of static files makes it possible for browsers to detect
when a newer version of the file is available. Static files that can be tracked with digital
signatures include JavaScript, CSS, images, and fonts. The signature is appended to the path
directly after the base URL. If a file’s signature differs from what is currently stored in the
browser’s cache, then the newer version of the file is used. To learn more, see Static File
Processing in the developer documentation.
The Static File Settings configuration is available only when working in developer mode.

Static File Settings

To enable signed static files:
1.

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

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

Expand the Static Files Settings section.

Set Sign Static Files to “Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

1437

Developer Tools

CHAPTER 95: Tools

Optimizing Resource Files
The time it takes to load resource files can be reduced by merging and bundling files, and by
minimizing code.
l

Merging combines separate files of the same type into a single file.
Bundling is a technique that groups separate files in order to reduce the number of HTTP
requests that are required to load a page.
Minification removes spaces, line breaks, and comments, but does not affect the
functionality of the code. Because minimized files cannot be edited, the process should be
applied only when you are ready to go into production.

By default, Magento does not merge, bundle, or minimize files, and the project developer
should determine which file optimization methods should be used. The following operations are
supported for each file type:
CSS and JavaScript files can be optimized in Developer Mode only.

FILE TYPE
CSS Files

JavaScript Files

Template Files

1438

SUPPORTED OPERATIONS
l

Merge

Minify

Merge

Bundle

Minify

Magento Commerce User Guide

CHAPTER 95: Tools

Developer Tools

To optimize resource files:
1.

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

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

To optimize CSS files, do the following:
the CSS Settings section. Then, do the following:

Expand

Set Merge CSS Files to “Yes.”

Set Minify CSS Files to “Yes.”

CSS Settings
4.

To optimizeJavaScript files, do the following:
a.

Expand

the JavaScript Settings section. Then, do the following:

Set Merge JavaScript Files to “Yes.”

Set Minify JavaScript Files to “Yes.”

JavaScript Settings

Magento Commerce User Guide

1439

Developer Tools

CHAPTER 95: Tools

To minify PHTML template files, do the following:
the Template Settings section.

Expand

Set Minify Html to “Yes.”

Template Settings
6.

1440

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 95: Tools

Developer Tools

Developer Client Restrictions
Before using a tool such as Template Path Hints, make sure to add your IP address to the
Developer Client Restrictions whitelist to avoid disrupting the shopping experience of
customers in the store, .If you don’t know your IP address, you can search for it online.
Developer Client Restrictions can be set in Developer Mode only.

Add Your IP Address to the Whitelist
1.

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

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

Expand

the Developer Client Restrictions section.

Developer Client Restrictions
4.

In the Allow IPs field, enter your IP address. If access is needed from multiple IP addresses,
separate each with a comma.

When complete, tap Save Config.

When prompted, refresh any invalid caches.

Magento Commerce User Guide

1441

Developer Tools

CHAPTER 95: Tools

Template Path Hints
Template Path Hints are a diagnostic tool that adds notation with the path to each template
that is used on the page. Template path hints can be enabled for either the storefront or the
Admin.
Template Path Hints can be edited in Developer Mode only.

Template Path Hints in Storefront

Step 1: Whitelist Your IP Address
Before using template path hints, add your IP address to the whitelist, so you won’t interfere
with customers who are shopping in the store. When you are finished, make sure to clear the
Magento cache to remove all hints from the store.

Developer Client Restrictions

1442

Magento Commerce User Guide

CHAPTER 95: Tools

Developer Tools

Step 2: Enable Template Path Hints
1.

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

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

Expand

the Debug section. Then, do the following:

Debug
a.

To activate template path hints for the store, set Enabled Template Path Hints for
Storefront to “Yes.”

To activate template path hints for the Admin, set Enabled Template Path Hints for
Admin to “Yes.”

To include the names of blocks, set Add Block Names to Hints to “Yes.”

When complete, tap Save Config.

When you are finished, return to the Admin to disable the hints and clear the cache.

Step 3: Clear the Cache
1.

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

In the upper-right corner, tap Flush Magento Cache.

Magento Commerce User Guide

1443

Developer Tools

CHAPTER 95: Tools

Translate Inline
You can use the Translate Inline tool in developer mode to touch up text in the interface to
reflect your voice and brand. When the Translate Inline mode is activated, any text on the page
that can be edited is outlined in red. It’s easy to edit field labels, messages, and other text that
appears throughout the storefront and Admin. For example, many themes use terminology
such as “My Account,” “My Wishlist,” and “My Dashboard,” to help customers find their way
around. However, you might prefer to simply use the words “Account,” “Wishlist,” and
“Dashboard.”
The Translate Inline tool is available only when working in developer mode.

Translatable Text
If your store is available in multiple languages, you can make fine adjustments to the
translated text for the locale. On the server, interface text is maintained in a separate CSV file
for each output block, and is organized by locale. As an alternate approach, rather than use the
Translate Inline tool, you can also edit the CSV files directly on the server.
To use the Translate Inline tool, your browser must allow pop-ups.

Step 1: Disable Output Caches

1444

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.

Mark the following checkboxes:

Magento Commerce User Guide

CHAPTER 95: Tools

Developer Tools

Blocks HTML output

Page Cache

Translations

Set the Actions control to “Disable.” Then, tap Submit.

Disable Output Caches

Step 2: Enable the Translate Inline Tool
1.

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

To work with a specific store view, set the Store View that is to be updated.

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

Expand

the Translate Inline section. Then if necessary, clear the Use Website checkbox.

The Enabled for Admin option is not available when editing a specific store view.

Translate Inline
5.

Set Enabled for Storefront to “Yes.”

When complete, tap Save Config.

When prompted, refresh the invalid caches, but leave the disabled caches as they are for now.

Magento Commerce User Guide

1445

Developer Tools

CHAPTER 95: Tools

Step 3: Update the Text
1.

Open your storefront in a browser, and go to the page that you want to edit. If necessary, use
the language chooser to change the store view.
Each string of text that can be translated is outlined in red. When you hover over any text box,
a book icon ( ) appears.

Tap the book icon (

) to open the Translate window. Then, do the following:

If the change is for the specific store view, mark the Store View Specific checkbox.

Enter the new Custom text.

When complete, tap Submit.

Enter Custom Text
3.

To see your changes in the store, press the F5 key to refresh the browser.

Repeat this process for any elements in the store to be changed.

Step 4: Restore Original Settings
1.

Return to the Admin of your store. On the Admin sidebar, tap Store. Then under Settings,
choose Configuration.

1446

Set Store View to the specific view that was edited.

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

Expand the Translate Inline section.

Magento Commerce User Guide

CHAPTER 95: Tools

Developer Tools

Translate Inline

Set Enabled for Frontend to “No.”

When complete, tap Save Config.

On the Admin sidebar, tap System. Then under Tools, choose Cache Management.
a.

Mark the checkbox of the following output caches that were previously disabled:
l

Blocks HTML output

Page Cache

Translations

Set the Actions control to “Enable.” Then, tap Submit.

When prompted, refresh any invalid caches.

Step 5: Verify the Changes in Your Store
Go to your storefront and examine each page that was updated to make sure the changes are
correct. In this example, “Customer Login” was changed to “Customer Sign In.” If changes were
made to a specific view, use the Language Chooser to switch to the correct view.

Customer Sign In

Magento Commerce User Guide

1447

Setup Wizard

CHAPTER 95: Tools

Setup Wizard
The Setup Wizard can be used to easily install and uninstall components, modules, and
extensions, manage modules, upgrade your installation, and make changes to the Web setup of
your installation.

Setup Wizard

1448

Magento Commerce User Guide

CHAPTER 95: Tools

Setup Tools

Setup Tools
Extension Manager
Extension Manager lists each component that is
currently installed, and can be used to synchronize any
extensions you have purchased from Magento
Marketplace with your system.

Module Manager
Module Manager lists the components and modules that
are currently installed in your Magento system.

System Upgrade
The System Upgrade tool can be used to upgrade your
installation of Magento. During the process, it checks
your system for readiness, creates a backup, and then
upgrades your system.

System Config
The System Config tool uses the public and private keys
from your Marketplace account to synchronize web setup
operations.

Magento Commerce User Guide

1449

Setup Tools

CHAPTER 95: Tools

Extension Manager
Installing an extension is a three-step process that should take place during off-peak hours.
Before the extension is installed, your store is put into maintenance mode, checked for
readiness, and backed up. After the extension is installed, it must be configured for your store
according to the developer’s instructions.

Installed Extensions

To install an extension:
1.

On the Admin sidebar, tap System. Then under Tools, choose Web Setup Wizard.

Web Setup Wizard
3.

Tap Extension Manager.
It will take a few minutes to generate the list of all available updates, recently purchased
extensions, and currently installed extensions and sample data.

1450

Magento Commerce User Guide

CHAPTER 95: Tools

Setup Tools

Summary of Your Marketplace Account
4.

Tap Review and Install. Then, do the following:
a.

In the list of extensions that are ready to install, mark the checkbox of the extension that
you want to install.

In the Latest version column, choose the version that you want to install.

In the Action column, click Install.

Extensions Ready to Install
5.

Follow the onscreen instructions to complete the following:
l

Step 1: Readiness Check

Step 2: Create Backup

Step 3: Component Install

Magento Commerce User Guide

1451

Setup Tools

CHAPTER 95: Tools

Module Manager
Module Manager lists the components and modules that are currently installed in your
Magento system. Before a module is disabled, the system completes a readiness check and
creates a backup.
l

The colored dot in the first column indicates if the module is currently “on” or “off”.
Click the down arrow before the component name to list any dependent packages that are
associated with the module.

Module Manager

To disable a module:
1.

Find the module in the list.

In the Action column, click Select. Then, click Disable, and do the following:
a.

Under Step 1: Readiness Check, tap Start Readiness Check to verify that your installation
has the correct version of PHP and required extensions and file permissions.
A module with dependent components will fail Readiness Check.

Readiness Check

1452

Magento Commerce User Guide

CHAPTER 95: Tools

Setup Tools

When the readiness check is complete, do one of the following:

Tap Next.

Correct any issues, and Try Again.

Under Step 2, mark the checkbox of each Backup Option that you want to include. Then,
tap Create Backup.

Create Backup
Before the backup is created, the available disk space is checked, and the store is placed in
maintenance mode. It might take several minutes — or more — to create the backup,
depending on the size of your database.
When the backup is complete, tap Next.
c.

Under Step 3, tap Disable.
Your store is taken offline while the module is disabled.

Disable Module
d.

As the process is running, the details appear in the box below. To toggle the display of the
log, tap Console Log.

When the Success page appears, the module is disabled and your store returns to
production mode. Tap Back to Setup Tool to return to Module Manager.

Magento Commerce User Guide

1453

Setup Tools

CHAPTER 95: Tools

Success
In the Module Manager list, the red dot in the first column means the module is now
disabled.

Module Disabled

To enable a module:
1.

Find the module in the list.

In the Action column, click Select. Then, click Enable and do the following:
a.

Under Step 1, tap Start Readiness Check.

Enable Module
When the readiness check is complete, do one of the following:

1454

Magento Commerce User Guide

CHAPTER 95: Tools

Setup Tools

Tap Next.

Correct any issues, and Try Again.

Under Step 2, mark the checkbox of each Backup Option that you want to include. Then,
tap Create Backup.

Create Backup
c.

When the backup is complete, tap Next.

Under Step 3, tap Enable.

Enable Module
e.

As the process is running, the details appear in the box below. To toggle the display of the
log, tap Console Log.

Magento Commerce User Guide

1455

Setup Tools

CHAPTER 95: Tools

When the Success page appears, the module is enabled and your store returns to
production mode. Tap Back to Setup Tool to return to Module Manager.

Sucess

1456

Magento Commerce User Guide

CHAPTER 95: Tools

Setup Tools

System Upgrade
The System Upgrade tool can be used to upgrade your Magento installation from the Admin.
The upgrade is a three-step process that should take place during off-peak hours. Before
upgrade takes place, your store is put into maintenance mode, checked for readiness, and
backed up.

System Upgrade

To upgrade your Magento installation:
1.

On the Admin sidebar, tap System. Then under Tools, choose Web Setup Wizard.

Web Setup Wizard
3.

Tap Extension Manager.

Magento Commerce User Guide

1457

Setup Tools

CHAPTER 95: Tools

System Upgrade
4.

When prompted, follow the instructions to copy and paste the Public Access Key and Private
Access Key from your Marketplace account. Then, tap Submit.
To learn more, see Magento 2 Access Keys in the Marketplace User Guide.

1458

Follow the onscreens instructions to complete the following steps:
l

Step 1: Select Version

Step 2: Create Backup

Step 3: System Upgrade.

Magento Commerce User Guide

CHAPTER 95: Tools

Setup Tools

System Config
The System Config page saves a copy of your public and private access keys that are used to
synchronize your store with Magento Marketplace.

Magento Marketplace System Config

To synchronize your purchases:
1.

When the process is complete, your credentials are saved.

Credentials Saved

Magento Commerce User Guide

1459

1460

Magento Commerce User Guide

CHAPTER 96:

Support
The Support Tools are designed to identify known issues in your system. They can be used as a
resource during the development and optimization processes, and as a diagnostic tool to help
our support team identify and resolve issues.
l

Data Collector

System Reports

Magento Commerce User Guide

1461

Data Collector

CHAPTER 96: Support

Data Collector
Data Collector gathers the information about your system that is needed by our Support team
to troubleshoot issues with your Magento installation. The backup that is created takes several
minutes to complete, and includes both a code and database dump. The data can be exported
to a CSV or Excel XML file.

Data Collector

To run Data Collector:
1.

On the Admin sidebar, tap System. Then under Support choose Data Collector.

In the upper-right corner, tap New Backup.
It will take a few minutes to generate the backup. When complete, the backup appears in the
Data Collector grid.

1462

To view a log with the backup details, do the following:
a.

In the Action column, select Show Log.

Click Back to return to the grid.

Magento Commerce User Guide

CHAPTER 96: Support

Data Collector

Log

To export backup data:
1.

In the first column mark the checkbox of the backup to be exported.

On the Export menu, choose the format of the export data.

Export Format
3.

Look for the download message at the bottom of the screen, and Save the file.

Magento Commerce User Guide

1463

System Reports

CHAPTER 96: Support

System Reports
The system reporting tool gives you the ability take periodic full, or partial, snapshots of the
system, and save them for future reference. You can compare performance settings before and
after code development cycles, or changes to server settings. The system reporting tool can
dramatically reduce the time spent preparing and submitting the information required by
Support to begin an investigation.
From the System Reports grid, you can view and download existing reports, delete reports, and
create new reports.

Manage System Reports

To access system reports:
1.

On the Admin sidebar, tap System. Then under Support, choose System Report.

To generate a new system report, tap New Report. Then, do the following:
a.

In the Groups list, select each set of information that you want to include in the report.
By default, all groups are selected.

In the upper-right corner, tap Create.
It might take a few minutes for the report to generate.

1464

To view the report, click the View link at the end of the row.

To download a report, click the Download link at the end of the row.

To create a new report, click the New Report button. Then, do the following:

Magento Commerce User Guide

CHAPTER 96: Support

System Reports

In the list, select the Groups of system information that you want to include in the report.

Select Groups
b.

Tap Create to generate the report.
It might take a few minutes for the report to generate, depending on the number of report
types selected. When the report is ready, it appears at the top of the grid with the date and
time generated..

View System Report
6.

In the Action column of the grid, select one of the following:
l

View

Delete

Download

In the panel on the left, expand

Magento Commerce User Guide

each section of the report to view the detail.

1465

System Reports

CHAPTER 96: Support

General System Report Information
8.

To save the report as an HTML file, tap Download. Then save the file to your computer.

To view the report, open the download file in a browser. In the header, tap the control to jump
to a specific section of the report.

1466

Magento Commerce User Guide

CHAPTER 96: Support

System Reports

System Reports
REPORT GROUP
General

INFORMATION INCLUDED
Magento Version
Data Count
Cache Status
Index Status

Environment

Environment Information
MySQL Status

Modules

Custom Modules List
Disabled Modules List
All Modules List

Configuration

Configuration
Data from app/etc/env.php
Shipping Methods
Payment Methods
Payments Functionality Matrix

Logs

Log Files
Top System Messages
Today's Top System Messages
Top Debug Messages
Today’s Top Debug Messages
Top Exception Messages
Today's Top Exception Messages

Attributes

User Defined Eav Attributes
New Eav Attributes
Entity Types
All Eav Attributes
Category Eav Attributes
Product Eav Attributes
Customer Eav Attributes
Customer Address Eav Attribute
RMA Item Eav Attributes

Events

Custom Global Events
Custom Admin Events
Custom Frontend Events

Magento Commerce User Guide

1467

System Reports

CHAPTER 96: Support

System Reports (cont.)
REPORT GROUP

INFORMATION INCLUDED
Customer Doc Events
Custom Crontab Events
Custom REST Events
Custom SOAP Events
Core Global Events
Core Admin Events
Core Frontend Events
Core Doc Events
Core Crontab Events
Corre REST Events
Core SOAP Events
All Global Events
All Admin Events
All Frontend Events
All Doc Events
All REST Events
All SOAP Events

Cron

Cron Schedules by status code
Cron Schedules by job code
Errors in Cron Schedules Queue
Cron Schedules List
Custom Global Cron Jobs
Custom Configurable Cron Jobs
Core Global Cron Jobs
Core Configurable Cron Jobs
All Global Cron Jobs
All Configurable Cron Jobs

Design

Adminhtml Themes List
Frontend Themes List

Stores

Website Tree
Websites List
Stores List
Store Views List

1468

Magento Commerce User Guide

Appendices

1469

Contents

Release Notes
Change Log
Glossary
Configuration Reference

1470

APPENDIX A:

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

Magento Commerce User Guide

1471

1472

Magento Commerce User Guide

APPENDIX C:

Glossary
A
above the fold
The web page content that is immediately visible in the browser window; section of a page that is
displayed without the need to scroll.
Admin
The password-protected back office of your store where orders, catalog, content, and
configurations are managed.
alt text
The text that is displayed in place of an image when the user is unable to view the image.
anchor text
The visible text that is anchored to another page or page section; the literal text of a hyperlink.
API
Application Program Interface: A software interface that lets third-party applications read and
write to a system using programming language constructs or statements.
aspect ratio
The proportional relationship between the width and height of an image.
attribute
A characteristic or property of a product; anything that describes a product. Examples of product
attributes include color, size, weight, and price.
authorization
To give a service permission to perform certain actions or to access resources.
average inventory cost
Product price, less coupons or discounts, plus freight and applicable taxes. The average is
determined by adding the beginning cost of inventory each month, plus the ending cost of
inventory for the last month of the period.

Magento Commerce User Guide

1473

APPENDIX C: Glossary

B
B2B
Business to Business: A type of business transaction between two business entities that are not
the final consumers of the goods or services.
B2C
Business to Consumer: Business transactions between a business entity and a consumer.
banner
Promotional graphics displayed either horizontally on the top of a web page or vertically on the
left or right margins. Website advertisements are often displayed as banners.
base currency
The primary form of currency used in store transactions.
base currency rate
The base currency rate is the default for your store.
batch processing
To perform a task or make a change to multiple items all at once, without manual repetition.
bounce rate
The percentage of visitors to your site that leave without viewing any other pages.
brand
A unique identity that defines a particular product or group of products.
breadcrumb
A navigation aid that helps the user to keep track of their location within your store.
brick and mortar
A retail business with a permanent physical location, as opposed to being entirely virtual.
broken link
A hyperlink that fails to send the user to its intended web page.
C
callout
A term that is sometimes used to describe a block that is defined as a layout update using XML
code.
canonical URL
The canonical meta tag redirects search engines to the correct URL, when seemingly duplicate
content is encountered on the server.

1474

Magento Commerce User Guide

APPENDIX C: Glossary

capture
The process of converting the authorized amount into a billable transaction. Transactions cannot
be captured until authorized, and authorizations cannot be captured until the goods or services
have been shipped.
cardholder
A person who opens a credit card account and is authorized to make purchases.
cascading style sheet
The markup standard used to apply styles to HTML elements on the page.
category
A set of products that share particular characteristics or attributes.
CCV
Credit Card Verification code. (See CVV)
checkout process
The process of gathering the payment and shipping information that is necessary to complete the
purchase of items in the shopping cart. In the final step, the customer reviews and places the
order.
CMS
Content Management System: A software system that is used to create, edit, and maintain
content on a website.
complex data
Data that is associated with multiple product options.
complex product
A product that requires the customer to choose from a selection of options.
composite product
Any product type that offers customers a choice of options.
Content Delivery Network
A large distributed network of servers that specializes in the high performance delivery of multimedia content.
content marketing
The art of promoting products or services by providing valuable information at no charge.
conversion
A marketing term that indicates a goal has been reached. If the goal is to sell a product,
conversion is reached when a visitor to your site becomes a buyer.
conversion rate
The percentage of visitors who are converted into buyers.

Magento Commerce User Guide

1475

APPENDIX C: Glossary

credit memo
A document issued by the merchant to a customer to write off an outstanding balance because of
overcharge, rebate, or return of goods.
CSS
Cascading Style Sheets: A style sheet language that controls the appearance of HTML
documents; a way to control the appearance of text, graphics, lists, links, and all other elements
on a web page.
CSV
Comma Separated Values: A type of file used to store data values which are separated from
each other by commas.
CVM
Card Verification Method: A way to verify the identity of the customer by confirming a 3-digit or 4digit credit card security code with the payment processor.
CVV
The Card Verification Value, also known as the Card Security Code, provides an additional level
of security for online transactions.
D
domain
The address of a website on the web; what the customer types in their browser address bar to
access the store.
double opt-in
The process for subscribing email recipients by requiring them to take a secondary step to
confirm that they want to receive emails.
dynamic content
A web page that displays different content depending on the user request.
Dynamic Media URL
A link to an image that contains a relative reference to the file location in media storage.
E
EAV
Entity Attribute Value
evergreen content
Content that has a long shelf life.

1476

Magento Commerce User Guide

APPENDIX C: Glossary

F
FAQ
Frequently Asked Questions.
favicon
Short for favorites icon; a 16x16 or 32x32 pixel icon associated with a website; is displayed in the
browser address bar and next to the site name in a bookmark list.
feed reader
Software that is used to read syndicated content from RSS feeds.
FOB
Freight On Board: A shipping term indicating who is responsible for paying transportation
charges.
frontend properties
Properties that determine the presentation and behavior of an attribute from the standpoint of the
customer in your store.
fulfillment
The process of managing customer shipments.
G
gateway
A transaction bridge between a customer and a payment processing service that is used to
transfer money between the customer and the merchant.
gross margin
The difference between the cost and price of a product.
H
handle
In programming, a name used to reference an object.
home page
The first home page a visitor sees when they access your website URL. Considered the most
important page on your website according to search engine indexing.
HTML
HyperText Markup Language: A standard for tagging and structuring text, images, videos, and
other media on a web page.

Magento Commerce User Guide

1477

APPENDIX C: Glossary

I
invoice
A document that provides a detailed description of a purchase, including products purchased,
quantity, price, shipping cost, sales tax, and total.
J
JavaScript
A scripting language used with HTML to produce dynamic effects and interactions on web pages.
jQuery
A popular JavaScript library that is often used to create dynamic and responsive effects.
K
keyword
A term or phrase used in a search to filter for content that is of significant importance to that term
or phrase.
L
landing page
A page on your site where a visitor arrives after clicking a link or advertisement.
layout
The visual and structural composition of a page.
layout update
A specific set of XML instructions that determines how the page is constructed.
link juice
The value and authority transferred from one web page to another via hyperlinks (or links). Link
juice affects a website’s page rank, a factor used to rank a search engine results page.
liquid layout
A flexible approach to web design that specifies the size and position of elements as
percentages rather than as exact measurements in pixels.
load sequence
The order in which scripts are loaded into memory. To work correctly, some scripts must be
loaded before others.
locale
A set of configurations that defines the user’s language, country, tax rate, and other settings.
login
The process of signing into an online account.

1478

Magento Commerce User Guide

APPENDIX C: Glossary

M
markdown
The amount subtracted from the original price of a product.
markup tag
A snippet of code that can be used to add functionality or content to a page.
media storage
A dedicated space on the content delivery network for your store's assets.
merchant account
An account with a bank or financial institution that makes it possible to accept credit card
transactions.
meta tags
Information in a web page that is not displayed on the page itself, but is used by search engines
to determine the page title, description, and page keywords.
N
navigation
The 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.
O
opt-in
The process by which a user consents to receiving emails from an online store.
P
packing slip
A document that is usually included in a shipped package that describes the contents. Packing
slips do not include financial or account information.
path to purchase
The path a prospect follows that leads to a sale.
payment bridge
An application that helps merchants meet PCI- DSS requirements.
payment gateway
A service that charges your customers’ credit cards and sends the funds to your merchant
account, for deposit into your business bank account.
Payment Gateway
A third-party service that processes transactions for external payment methods.

Magento Commerce User Guide

1479

APPENDIX C: Glossary

Payment Method
A way for the customer to pay for the merchandise in your store. Payment methods can be
internal or external. The Payment Methods section of the System Configuration includes all basic
payment methods and gateways.
PCI
Payment Card Industry: Refers to debit and credit cards and their associated businesses.
price markup
A percentage added to the cost of an item to determine the retail price.
privacy policy
A document that explains the merchant’s policies for handling customer information.
purchase order (PO)
A written sales contract between a buyer and seller that describes the merchandise or service to
be purchased from a vendor.
R
redirect
A method used to alert browsers and search engines that a page has been moved. 301 Redirect:
Permanent change 302 Redirect: Temporary change
relative link
A hyperlink that includes only the address of the linked page that is relative to the linking page,
rather than the full URL.
return policy
A document that explains the merchant’s rules regarding the return of products by customers.
robots.txt
A file placed on a website that tells search engine crawlers which pages not to index.
RSS feed
Really Simple Syndication: A technology that creates web content syndication and allows web
users to subscribe to product feeds, websites, and blogs.
S
SaaS
Software as a Service: A software delivery model where the vendor provides the software and
hosting environment, and customers pay for the service by subscription or per use.
Sass/Compass
A CSS pre-compiler that provides organizable, reusable CSS.
security certificate
Information that is used by the SSL protocol to establish a secure connection.

1480

Magento Commerce User Guide

APPENDIX C: Glossary

SEO
Search Engine Optimization: The process of improving a website’s search engine rankings in
order to increase valued visitors.
SERP
Search Engine Results Page
settlement
Settlement occurs when the acquiring bank and the issuer exchange funds and the proceeds are
deposited into the merchant account.
shipping carrier
A company that transports packages. Common carriers include UPS, FedEx, DHL, and USPS.
shopping cart
A grouping of products that the customer wishes to purchase at the end of their shopping
session.
sidebar
The right or left column of a two-column page layout.
sitemap
A page that provides search engines with an efficient, alternate route through your site.
SKU
Stock Keeping Unit: A number or code assigned to a product to identify the product, options,
price, and manufacturer.
splash page
A promotional page with a product or advertisement; normally displayed before the home page.
SSL certificate
A validation and security mechanism that identifies the merchant and encrypts credit card and
other sensitive information.
static block
A fixed content block that can be displayed on various content pages in a store.
static content
Content that does not change frequently. See also dynamic content.
static files
The collection of assets, such as CSS, fonts, images, and JavaScript that is used by a theme.
T
theme
A package that contains graphics and appearance information, and customizes the look and feel
of the store.

Magento Commerce User Guide

1481

APPENDIX C: Glossary

transactional email
A notification email sent to the customer when a transaction is processed.
transactional emails
An automated email message that is sent in response to a specific event or transaction.
U
URL
Uniform Resource Locator: The unique address of a page on the internet.
usability
Refers to the degree to which a product or service is easy to use by its customers.
W
widget
A prepared snippet of code that adds functionality and/or dynamic effects to your store.
WYSIWYG
What You See Is What You Get: An editor that displays formatted text as it will appear in its final
published form.
X
XML
Extensible Markup Language: A markup format derived from SGML that it used to format
information for publication and distribution.

1482

Magento Commerce User Guide

APPENDIX D:

Configuration Reference
This reference has field descriptions for every configuration setting in Magento Commerce. To
learn how to apply configuration settings to specific store views, see: Scope.
From the HTML version of the guide, you can drill down through any section of the reference,
and follow the links to corresponding topics in the user guide. From step-by-step instructions,
click any linked caption below a screenshot to jump to the field descriptions.
Follow these links for the corresponding section in the online reference:
l

General

Catalog

Customers

Sales

Services

Advanced

Configuration

Magento Commerce User Guide

1483

1484

Magento Commerce User Guide

Index
1

Account

1 Column Layout 327, 776, 778

customer information 858
Magento 19

share 23

2 Columns
with Left Bar 328, 776, 779
with Right Bar 328, 776

Account, Magento 20
Action Log 1413
Archive 1415
Report 1413

3
3 Column Layout 777, 780

Actions
control 60, 77
Actions, Mass 79

4
404 Page Not Found 685-686

Add
Banner 738
Address

5
503 Service Unavailable 685

Book, customer 858
format 1287
template 1287

Address format 528, 1288
Address templates 528, 1288

Abandoned carts 929
Address, customer 835
Adjustment Fee 1005

1485

Index

Admin 53, 77
access 1369

Allow

account 56

cookies 929

account, unlock 1374

Countries 88

Actions Log 1413

HTML Tags on Frontend 1294

CAPTCHA 1402

Allow Reorder 916

logged out 82

Allowed Currencies 1275

Alternate Media Storage 1381

Notifications 69

Analytics 42, 48

permissions 1369

Anchor

role 1370

category 743

role, create 1373

Anchor category 313

role, custom 1375

Android, email 488

security 1387

Antivirus software 126

session lifetime 82

AOV 44

sidebar 57

API 49, 1363

Startup Page 67

APNG file format 103

Startup Page, change 59

Append Complex Data 1334, 1337

URL, custom 1208

Apple Mail 488

user 1370

Approve product review 377-378

user, create 1370

Archive

Admin Actions
Archive 1415

Admin actions 1415
Assisted Shopping 935

Admin Startup Page 57

Asynchronous indexing 991

Advanced Admin, configuration 54

Attribute

Advanced Pricing 252
Attributes 1358

1486

All Stores 1187

code 1292
Customer 1360

Advanced Product Settings 226

entities 1324

Advanced Search 597

filterable 586

Advocacy Tools 48

group 1302

All Customers 825

input types 342

Magento Commerce User Guide

Index

predefined 545

banner 737

Prodct, reference 1345

Banner

Product, create 1295

create 738

Returns 1023

Customer Segment 895

system 1301

Customer Segments 893

Attribute set 162

locations 741

Attribute Set 1300

price rule 745

Attributes 1281

rotator 742

Customer 1282

Base

Date and Time 344

currency 1279

Product 335

image 288

product, add 337

JavaScript URL 1385-1386

Australia, PayPal solutions 1082
Authorize.Net
Direct Post Method 1086
Auto-generated fields 151
Automatic
redirect 631
refund 1015
Automatic Sort 325

media URL 1385-1386
Base URL 1203
Base URL Home page 686
Best practice
industry 125
Best practices
Security 1392
Best Practices

Automatic Sort, Visual Merchandiser 324

Product Attributes 336

Autosettings, product 247

Product Categories 306

Average Order Value 44

Bestsellers 68
Billing

agreement 859

B2B Sites 475

agreement, PayPal Express Checkout 1049

Backend See also
Admin 53
Backup
delete 1431
Bank Transfer Payment 1102

Magento Commerce User Guide

Billing Agreements 1025
Block 545
category 319, 327
create 724
ID, markup tag 550

1487

Index

reference 743
Block reference 735, 782, 792

Cancel
order 947

category 730

Canceled, order status 983

CMS pages 730

Canonical meta tag 140, 620

product page 731

CAPTCHA 1402, 1406

Blog, as Home page 686

configuration, Admin 1403

Blog, Magento 4-5, 7

configuration, store 1406

Braintree 1033, 1053
Brand loyalty 471

Capture
Offline 999

Branding 97

Cardholder data 126

Breadcrumb trail 578, 686

Cart

Browser Capabilities Detection 1412

Configuration 908

Bulk Actions Log 1416

Link 909

Bundle Items 249

Sidebar 909-910

Bundle Product 155, 186

Cart contents, retrieve 929

Bundle, JavaScirpt files 1438

Cart, manage 936

Business location 88

Cash On Delivery 1100

Business Rules, best practices 306

Catagories 305

Buy X, Get Y Free 418

Catalog 49, 135
Category Link 748

Event Widget 474

Cache 1420

Events 474

JavaScript 1421

flat 347

Storage Management 1420

images 285

Callout 735

indexing 347

Campaign, edit 814

New Products List 748

Campaign, preview 817

Price Rules 383

Canada

Product Link 748

Example Tax Configuration 1260

1488

Catalog page 32

Canada, PayPal solutions 1082

Catalog Prices, display 1235

Canadian tax 1255

Catalog Prices, tax 1255

Magento Commerce User Guide

Index

Catalog, menu 137
Categories
Custom Design 328

CDN 1384
JavaScript use 1384
media retrieval 1384

Display Settings 319

Certification 6

Events 472

Check / Money Order 1098

Scheduled Changes 317

Checkbox 60

Category

Checkout 949

Automatic Sorting 323

Configuration 953

Content Settings 318

Payments 951

create 307

Shipping 950

Display Settings 319

Checkout Options 954

grayed out 307

Checkout process 46

ID 307

Terms and Conditions 956

landing page 327

Checkout Totals, sort order 960

page 319

Checkout with PayPal 1034

path, in URL 140, 620

Chrome, email 489

Products 322, 435

Clear cache 1420

root 313

Client Restrictions, Developer 1441

Search Engine Optimization 320

Closed, order status 983

tree 307

Club, membership 471

URL key 307

CMS 43, 677

Category hidden 316

Page Link 748

Category options, Visual Merchandiser 323

Page Versioning 711

Category Permissions 329

Pages 683, 697

Events 472
Category Products 144-145, 322, 437, 688,
967
Category Rule 325
Category rules 440
Category Rules 438
Category structure, best practices 306

Magento Commerce User Guide

Static Block 748
Widget 750
COD 1100
Code
Pool, Gift Card 208, 221
Column 775
layout 327, 735

1489

Index

sort 73
Combined Gift Card 208

management system 43

Comma-separated values 1310

menu 57

Community 48

page 697

Compare Products 360, 374, 1293

Content Staging 805

Comparison operator 386

Content, Product 229

Complete, order status 983, 996

Conversion page 661

Complex data 1356

Conversion tracking 655

Compliance, industry 125

Conditions, price rule 399

domain 131

Configurable Product 154, 161

law 129

create 162

lifetime 131

image 173

persistent 929

Configurable Product, configurations 166

Restriction Mode 127, 129

Configuration 1211, 1483

session 929

Cart 908

use, Magento 132

search, default 602

Cookie, Limit Sending By 362

security 1387

Configuration, Design 767

Configurations, add 166

Countdown ticker 472-473

Configurations, Product 230

Country Options 88

Configure

Coupon 44, 47, 408, 541

Admin Security 1399

code 511

Connect to Facebook 562

Coupon Usage, report 411

Consent, cookies 129

Create

Consistent prices 1219

Packages, shipping labels 1146

Consulting 6

Store View 1188, 1192, 1199

Website 1187, 1197

form 550
Content 675, 677, 683
Area 741

1490

Delivery Network 1384

Credit 1013
card 1085
history, show 1015

Magento Commerce User Guide

Index

memo 1003
Credit Memo
Print 1011

layout 328
Layout Update
product 246

Cron 1433

Layout Update, category 328

Cron job 347, 511

Theme 328

Cron Settings, orders 990

URL 42

Cross-border trade 1219

variable 545

Cross-sells 234, 238, 373
rules 425
CSS

Custom Options 240
Custom Order Status 985
Customer

email 498

account 48, 829, 839

CSS, merge 801

dashboard 829

CSV file 1126, 1310, 1324

VAT Validation 1250

category path 1310

Account scope 119

customer structure 1312

Address 835

structure 1310

address template 528, 1288

csv separator 1310

address, promotion 886

CSV, upload to cart 941

balance, reward points 461

Currency 91

CSV structure 1312

Configure 1274

engagement 43

rates 1279

group 885

Rates 1273

create 881

Setup 1279

reward points 468

symbols 1279

VAT 1250

Symbols 1278

journey 40-41

to reward points 467

Order Status, RSS feed 543

Currency Chooser 1273

promotion 886

Current Configuration Scope 110

Reports 1165

Custom

retention 47

Design
Category 327

Magento Commerce User Guide

segment 44
Service page 684

1491

Index

Support 92

backup 1432

VAT 1250

compression, backup 1431

Customer Account

media storage 1382

Gift Registry 445

Date and Time Options 344

Update 852

Date, input type 342

Customer Attributes 1282, 1360

Day of Week 86

Customer Group

Default

Events 472
Customer Segment 885

Config 110
Country 88

Attributes 886

Display Currency 1279

Banner 895

Title, page 771

Create 887

Default pages 686

Price Rule 893

Default Tax Destination 1227

Customers 68, 821
menu 57
Customers online 826

Default theme 796
Demo
login 54

Customers, menu 823

Demo Notice 771

CyberSource 1087

Design 43, 49, 764-765
custom, category 327

product 246

Dashboard 48, 65

Schedule 803

charts 66

Design Configuration 767

configuration 65

Developer Client Restrictions 1441, 1444

customer 829

Developer Tools 1435

menu 57

Development environment 348

Data Collector 1462

DHL 1132

Data location 1332

shipping labels 1138

Data Transfer 1309

Digital Goods, tax 1228

Data Validation, import 1313

Dimensional weight 1129

Database

Direct Post Method, Authorize.Net 1086

and Media Backup 1432

1492

Magento Commerce User Guide

Index

Discount 383, 1106
quantity 259
Display

Eco tax 1229
Ecosystem, Magento 7
Editor, WYSIWYG 706

Gift Card Prices 927

Elasticsearch 604

Gift Wrapping Prices 927

in Suggested Terms 612

a Friend 360-361

Mode, category 319

a Friend, configure 361

not required State 87

addresses, domain 92

Settings

addresses, store 92

Category 319
Store Demo Notice 107

campaign 47
CSS file 491, 502, 505

Distributing newsletters 536

footer 492

Documentation 4

header template 499

Double opt-in 532

Logo 491

Downloadable Information, product 248

message templates 507

Downloadable Product 155, 197

Reminder Rules 511

configure 206

Reminder Rules, template 519

Drill-down, price 590

template 498

Dropdown

template, configure 487

input type 343
Duplicate
content 620
Dynamic
media URL 555

Email clients 488
Email template
variables 545
Email Template
Configure 491

URL 139

email, browsers 489

values, bundle product 186

Empty, page layout 328, 777
Enable

Cookies 685

EAV 347

Encryption 126

eBook download 197

Encyrption Key 1408

ECG 6

Enhanced Ecommerce, Google 663

Magento Commerce User Guide

1493

Index

Entity Attributes 1327

Export, criteria 1328

Equalize

Export, Exclude 1329

Price Ranges, layered navigation 591

Export, filters 1329

Product Counts, layered navigation 591

Expressed consent, cookies 129

EU Member Countries 1253

Extension Manager 1450

EU Place of Supply 1228

Extensions 58, 1368

European Union

Extensions, install 1450

Example Tax Configuration 1265
Event

Components 472

Facebook 7, 726

Configure 474

Facebook, connect 562

Create 477

Favicon 101, 770

date, gift registry 450

FedEx 1132

Edit 477, 480

shipping labels 1138

Invitations 472, 481

Feed reader 541

Selling restrictions 476

Fields, default values 151

Ticker 473

Filter

Widget 472
Events 471
log 1415
Website Restrictions 472

controls 74
Filterable
attribute 586, 1294
Find Partners & Extensions 58

Evergreen content 677

Firefox, email 489

eWAY 1090

Firewall 126

Export 1326

Fixed Product Tax 1229

failed email 1332
product data 1326
product types 1326

input type 343
Flat
catalog 347

reindex 1332
Scheduled 1339
Settings 1326
Tier Price 1330

1494

setup 348
Rate Shipping 1120
Flush
JavaScript cache 1421

Magento Commerce User Guide

Index

product image cache 1421

configure 221

Footer 105, 741, 773

create 211

Forum, Magento 4, 7

deactivate 209

FPT 1229

email template 221

attribute 1231

expiration date 222

configuration 1230

partial deduction 209

in attribute set 1233

prices 213

in product 1234

redeem 209

France, PayPal solutions 1082

refund 209, 1005

Fraud Management

status 209

PayPal 1081

Gift Card Information 249

Fraud Protection 1107

Gift Card, printed 922

Free

Gift Message 922

shipping 1118
shipping, price rule 414

Gift Options 247, 921
Tax configuration 927

Frontend Development Workflow 1436

Gift Receipt 922

FTP calculations 1229

Gift Registry 443

Full

Configure 451

page cache, settings 1424

create 446

reindex 1429

Customer Account 445
event date 450

Search 443, 455-456

Gateway, payment 1085

storefront 443

General
Contact 92-93
Germany, PayPal 1082
GIF file type 100, 103
Gift Card 155, 208

Gift Wrap 922-923
Gift Wrapping
refund 1005
Global
search 60, 72

account 217

[GLOBAL] 110

account, multiple 209

Gmail 488

balance 209

Goods & Services Tax 1260

Magento Commerce User Guide

1495

Index

Google 653

Help 4

Analytics 653

Hidden category 307, 316

Analytics, cookies 133

Hierarchy 711

Enhanced Ecommerce 663

menu 711

Merchant Center 653

Hold, order 947

Reader 541

Home page 30, 684

Sitemap 622, 653

New Products list 755

Tag Manager 655

Home page, create 702

Universal Analytics 654, 663

Home page, default 686

Grid
filter 74

Hong Kong, PayPal solutions 1082
HTML

layout 75

editor 706

Products 143

email 498

sort 73

Head 770

Grid Settings 991

in product description 1294

Grid, columns 694

product descriptions 342

Grid, export data 74

HTML Head 770

Grid, Product 580

HTML, Page Setup 769

Group price 255

http 1203

Grouped Product 154, 174

https 1203

Grouped Products 248
GST 1260

Guest

ICO file type 101

retrieve cart contents 929
Guest Checkout 954-955

Image
cache, flush 1421
import 1321

size 285

Handle 793

upload, product 286

Header 741, 772

URL 707

welcome message 104
Header template, email 499

1496

zoom 293
Image, placeholders 294

Magento Commerce User Guide

Index

Image, watermarks 295

modes 1426

Images and Videos, product 231

Trigger events 1428

Implementation 49

Indexing speed 347

Implied consent, cookies 129

Input type

Import 1315

Date 342

Behavior 1325

Dropdown 343

Data Validation 1313

Fixed Product Tax 343

failed email 1332

Media Image 343

Failed Emails, scheduled 1338

Multiple Select 343

File Information, scheduled 1338

Price 343

guidelines 1324

Text Area 342

History 1320

Text Field 342

images 1321

Yes/No 342

reindex 1332

Insert image 707

Scheduled 1333

Install

Settings, scheduled 1337

Magento 53

table rates, shipping 1126

installation 13

Tax Rates 1240

Integrations 1363

Tier Prices 1322

Interface text, change 1444

Import/Export 1309
In-Context Checkout, PayPal 1047
In Anchor, category 319

Internet Explorer
email 489
Inventory

In Stock 273

Configuration 275

Inbox, Admin 69

Manage Stock 273

Include / Exclude Tax 1271

Inventory, manage 267

Include in

Invitation

Advanced Search 597

Configure 482

Navigation Menu 316

Invitations 472, 481

Index 1426

Invoice 79

actions 1429

Comments 996

Management 1426

Create 994

Magento Commerce User Guide

1497

Index

Print 1000

Layered Navigation 319, 585, 1293

Invoice order 975

filterable 586

Invoiced

Interval Division Limit 591

order, download product 205

product count 585

Invoices 993

Layered Price Navigation Step 319

IP Address, Limit Sending By 362

layout

IP ddress 1203
iPhone, email 488
Italy, PayPal solutions 1082
Iterative splitting, price navigation 590

update 781
Layout
custom 328
Layout Update 793
banner 743

syntax 785, 788

Japan, PayPal solutions 1082

widget 734, 758

JavaScript
cache 1421
JavaScript, merge 802
JPG, JPEG file type 100, 103

Left Column 741
Like button, Facebook 726
Link
image 707
LinkedIn 7

Linux 10

Knowledge base 4

List, Product 580
Listing Sort By, category 319

Load sequence 793

Label

local.xml 1382

shipping 1139
Landing page 609

Locale, language 1192

Landing page, login 832

Language 110

Admin 53

Language Pack, Add 1192

demo store 54

Layered navigation

Landing page 832

configuration 593

1498

Locale 86

Magento account 19

Magento Commerce User Guide

Index

Logo 772

markup tag 709

email 490

Markup tag 545, 549, 552

file types 98

Match products by rule 325

header 98

Measurements, units of 86

path 98

Media

Loyalty 461

image, input type 343

Loyalty program 48

retrieval, CDN 1384
Storage 707, 1383

Storage, database 1382

M;ultiple Address, ship to 1115

URL 555, 707

Magento

URL, markup tag 549

account 19

Media Gallery 292

Connect 49

Media Storage 703

cookies 132

Media Storage, alternate 1381

Solutions Partners 49

Members Only 471, 475

Magento account 20

Membership 471

Magento Connect, Install Extension 1192

Magento Marketplace 798, 1368, 1450

Catalog 137

Magnify image 293

Customers 823

Main menu 576

Merchandising tools 44

Manage

Merchant level, PCI 126

Customers 79

Merchant Location 90

Products 79

Merchant solutions, PayPal 46

Stock 273

Merge, resource files 1438

Stores 1187, 1197

Message

MAP 261
MAP (Minimum Advertised Price) 261
Marketing
menu 57
Reports 1157
Marketplace 1368

Magento Commerce User Guide

InBox 69
Messages
Admin 69
Meta
Information 42, 618
Description 618

1499

Index

Keywords 618

Name, customer 835

page 697

Navigation 316, 575

Title 618

Breadcrumb trail 578

tag, canonical 620

menu 711

Millennium Generation
customer segment 891

Top 576
New

Mini cart 910

Customers 68

Mini Cart 909

order state 983

Minify, resource files 1438

Products list 541, 748, 756

Minimum Advertised Price 261, 263

New Relic Reporting 1173

Minimum Order Amount 913
Miscellaneous
HTML 773

Queries 1175
New Zealand, PayPal solutions 1082
Newsletter 47, 531

Misspelled words

configuration 532

redirect 609

Queue 536

Moderate, product reviews 377-378

subscribers 80

Module Manager 1452

templates 534

Money Order 1098

Next page link 583

Multi-Address Minimum Order 913

Nginx 10

Multiple

Select, input type 343

layout updates 328

Music download 197

Node 711, 713

Non-sessioned visit 1424
Account 19

Not Capture 999

Orders 858

Notifications, Admin 69

Product Reviews, customer 859

Notifications, system 69

MySQL 11
Fulltext Search 602

O
OAuth 1363

N
Name and Address Options 835

1500

Offline, refund 1007
On Hold, order status 946, 983

Magento Commerce User Guide

Index

One Page Checkout 959

Grid Layout 973

Onepage Checkout 954, 956, 959

Orders and Returns 748, 759

Online

About Us page 684

status, product 149
Online customers 826

Out of Stock 273
Outlook 488-489

Online refund 1007
Operators, Category rules 440

Opt-in 532

Packing slip 994

Oracle 11

Page 683

Order 983, 994

create 697

Actions 969

session, customer 1424

cancel 947

Translate 1196

fulfillment 49

Page Footer 773

review 956

Page Hierarchy 711

Scheduled Operations 990
Search 970

configuration 712
Page Layout 246, 328, 737, 775, 778

status 983, 985

examples 778

Status workflow 984

product 246

update 946

Page Not Found 685

Workflow 975

Page Search 690

Order by SKU 919

Page Setup 769

Order confirmation 952

Pages

Order Grid Updates, scheduled 991
Order Lifetime, pending payment 990
Order Pending 975
Order processing 46, 976

Default 686
Pagination 583
controls 60, 73, 599
Parent

Order Status, notification 989

category 328

Order Workspace 966

Page Hierarchy 711

Order, create 943
Orders 965
Grid 966

Magento Commerce User Guide

Partial
order, refund 1005
reindex 1429

1501

Index

Partners, find 57-58

Express Checkout 1061

partners, Magento 6

Billing Agreements 1049

Password 126, 854

Fraud Management Filter 1081

Password Options 837

merchant solutions 46

Password Reset, Admin 55

Payflow Link 1073

Path to Purchase 28

Payflow Pro 1071

Pay Now button, PayPal 1069

Payments Advanced 1063

payment

Payments Pro 1067

gateways 1062
Payment

Payments Standard 1069
Settlement Report 1051

actions 999

solutions 1083

gateways 49, 1085

Webiste Payments Standard 1069

methods 49

PayPal Credit 1077

options 46

PayPal Express Checkout 1033-1034

Review, order status 983

PayPal In-Context Checkout 1047

services 49

PayPal Payments Pro 1066

Payment Card Industry (PCI) 126

PayPal Reference 1076

Payment Methods

PCI Compliance 126

Authorize.Net 1086
Cash on Delivery 1100

PDF
credit memo 1003

Check / Money Order 1098

PDF Invoices 1000

Purchase Order 1104

PDF Printouts 526

Zero Subtotal Checkout 1106

Pending

Payments
Recommended Solutions 1033

order status 983, 996
order, download product 205

Payments, offline 1097

Payment, order status 983

Payments, online 1097

PayPal, order status 983

PayPa Express Checkout

Reviews 377-378

Requirements 1034
PayPal 1061

Pending Payment, order lifetime 990
Percona 11

business account 1077

1502

Magento Commerce User Guide

Index

Permanent

navigation 585, 590

(301) 638, 642, 647, 651

Range, bundle product 186

Redirect 631

Special 257

Permissions
admin 1369

Tier 259
View, bundle product 186

Category 329

Price consistency 1219

custom 1375

Price Display Settings 1235

Events 472

Price group 255

Persistent

Price Rule

cookie 929

Banner 745

shopping cart 929

Catalog 383, 393

PHP script
database media storage 1382

condition, attributes 1290
coupon 408

Physical Gift Card 208

Customer Segment 893

Place order 975

promotions 418, 420

Placeholders, image 294

Reward Points 469

Plugins 1368

Shopping Cart 395

PNG file type 100, 103

Price Type

PO 1104

Fixed 241

Point of Origin 1114

Percentage 241

Poll 360

Price, manage 251

pop-ups, allow 1444

Popular Search Terms 610

credit memo 1003

Postal code, optional 89

shipping labels 1134

Previous page link 583

Printed Card 922

Price

Privacy

Advanced 252

policy 127, 131, 684

Advanced Pricing, attributes 1358

Private Access Keys, Marketplace 1459

display 1279

Private Sales 471, 475

drill-down 590

Private Sales, reports 1170

input type 343

Processing, order status 983

Magento Commerce User Guide

1503

Index

Product
attributes, add 337
Bundle 186

reviews 48, 377
moderate 377-378

catalog 49

Reviews 230

Configurable 161-162

Scheduled Changes 153

Configurations, add 166

Search Engine Optimization 232

Content 229

suggestions 44

create 147

type

data, export 1326
Description
HTML 1294
Downloadable 155, 197
file structure 1310

export 1326
Video 289
Virtual 181
workspace 148
Product Alerts

Gift Card 208

configuration 281

Group price 255

run settings 283

Grouped 174
image cache 1421
Image, upload 286

Product Attribute
Best Practices 336
Product Attributes 335, 1345

image, watermarks 295

Advanced Pricing 1358

image, zoom 293

Complex data 1356

images 285

Product Configurations 230

Images and Videos 231

Product Field Auto-Generation 151

Information 885

Product Grig 143

Design 246
list 1294

1504

return workflow 1004

product images 292
Product in Websites 244

by category 550

Product List 580

markup tag 550

Product page 36

new 550

Product Reports 1167

promotion 886

Product Reviews 230

ratings 48

Product Reviews Reports 1159

relationships 234, 236, 238

Product Scope 115

Magento Commerce User Guide

Index

Product Settings 225

Advanced 226

Rating, product 379

Other 227

Receive payment 975

Product Stock Options 275

Recently Compared Products 748

Product Types 154