Magento Open Source User Guide, Version 2.2 Guide

User Manual:

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

Download
Open PDF In Browser	View PDF

Contents
GETTING STARTED

CHAPTER 1: Welcome

Resources

Join the Conversation!

CHAPTER 2: About This Release
System Requirements

Installation

Prelaunch Checklist

Your Login Credentials

For Your Records

CHAPTER 3: Your Magento Account

Creating an Account

Sharing Your Account

CHAPTER 4: Quick Tour

Path to Purchase

Home Page

Catalog Page

Search Results

Product Page

Shopping Cart

Customer Journey

Attract New Customers

Engage Your Customers

Increase Average Order Value

Contents

Moment of Purchase

Retain Customers

Build Loyalty & Advocacy

Success!

Basic Configuration

CHAPTER 5: Store Admin

Admin Sign In

Your Admin Account

Admin Sidebar

Admin Workspace

Dashboard

Message Inbox

Global Search

Grid Controls

Grid Layout

Actions Control

Admin Session Lifetime

CHAPTER 6: Store Details

Store Information

Locale Options

State Options

Country Options

Merchant Location

Currency

Store Email Addresses

CHAPTER 7: Storefront Branding

Uploading Your Logo

100

Adding a Favicon

103

Welcome Message

106

Magento Commerce User Guide

iii

Contents

107

Store Demo Notice

109

CHAPTER 8: Websites, Stores & Views
Scope

112

Changing Scope

113

Catalog Scope

116

Product Scope

117

Price Scope

119

Customer Account Scope

121

Scope Quick Reference

122

Single Store Mode
CHAPTER 9: Industry Compliance

124
127

PCI Compliance Guidelines

128

GDPR Compliance

129

Google Analytics Settings for GDPR

130

134

Cookie Law Compliance

136

Cookie Restriction Mode

137

Cookie Reference

139

Magento 2.x Default Cookies

139

Google Analytics Cookies

143

CATALOG
CHAPTER 10: Catalog Menu

145
147

Menu Options

148

Catalog URLs

149

CHAPTER 11: Products Grid

153

CHAPTER 12: Creating Products

157

Product Workspace

111

158

Magento Commerce User Guide

Contents

Default Field Values

161

Product Types

163

Simple Product

165

Configurable Product

170

Part 1: Creating a Configurable Product

171

Part 2: Adding Configurations

175

Grouped Product

183

Virtual Product

190

Bundle Product

195

Customizing the Bundle
Downloadable Product
Configuring Download Options

196
206
215

CHAPTER 13: Product Settings

217

Advanced Product Settings

218

Other Product Settings

219

Content

221

Configurations

222

Product Reviews

223

Images and Videos

224

Search Engine Optimization

225

Related Products, Up-Sells, and Cross-Sells

227

Other PayPal Solutions

930

PayPal Payments Advanced

932

Requirements

932

Checkout Workflow

933

Checkout Workflow

xvi

873

933

Magento Commerce User Guide

Contents

Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Advanced

933
933
934

PayPal Payments Pro

935

Requirements

935

Checkout Workflow

936

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

936
937
937
938

PayPal Payments Standard

939

Merchant Requirements

939

Checkout Workflow

939

Checkout Workflow
Setting Up PayPal Payments Standard

939
940

PayPal Payflow Pro

941

Requirements

941

Customer Workflow

942

Customer Workflow
Online Order Processing Workflow

942
942

Online Order Processing Workflow

942

Setting Up PayPal Payflow Pro

943

PayPal Payflow Link

944

Requirements

944

Customer Workflow

944

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

944
945
945
946
947

PayPal Business Account

948

PayPal Credit®

949

Magento Commerce User Guide

xvii

Contents

PayPal Fraud Management Filter

953

PayPal by Country

954

CHAPTER 60: Other Payment Methods
Klarna

958

Klarna Customer Experience

959

Setting Up Klarna

960

Managing Your Account

965

Amazon Pay

968

Amazon Pay Customer Experience

969

Setting Up Amazon Pay

972

Using Amazon Seller Central

978

Managing Amazon Pay Transactions

980

Amazon Pay Resources

982

Authorize.Net Direct Post
CHAPTER 61: Basic Payment Methods

984
985

Check / Money Order

986

Cash On Delivery

988

Bank Transfer

990

Purchase Order

992

Zero Subtotal Checkout

994

CHAPTER 62: Fraud Protection
Signifyd Guaranteed Fraud Protection

997
997

Shipping

999

CHAPTER 63: Shipping Settings

1001

Point of Origin

1002

Multiple Addresses

1003

Shipping Policy

1004

CHAPTER 64: Basic Shipping Methods
Free Shipping
xviii

957

1007
1008
Magento Commerce User Guide

Contents

Flat Rate

1010

Table Rates

1012

Dimensional Weight

1019

CHAPTER 65: Magento Shipping
Quick Look

1021
1022

Customer Experience

1024

Shipping Methods

1024

Click & Collect

1024

Setting Up Magento Shipping

1025

Locations

1031

Shipping Partners

1036

Packaging

1040

Shipping Experience Rules

1044

Troubleshooting

1048

CHAPTER 66: Carriers

1049

CHAPTER 67: Shipping Labels

1051

Shipping Label Workflow

1052

Configuring Shipping Labels

1053

Creating Shipping Labels

1057

Label Packages

REPORTS
CHAPTER 68: Reports Menu

1064

1069
1071

Menu Options

1072

Refresh Statistics

1073

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

1075
1076
1077
1078
xix

Contents

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

BUSINESS INTELLIGENCE

1080
1083
1084
1085
1086

1089

CHAPTER 74: Advanced Reporting

1091

CHAPTER 75: BI Essentials

1099

Dashboards

1103

Report Builder

1106

Visual Report Builder

1107

Filters

1112

Formulas

1116

Manage Data

1122

Metrics

1123

Filter Sets

1129

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

1133
1137
1139
1147

OPERATIONS

1149

Stores

1150

CHAPTER 78: Stores Menu

1079

1151

Magento Commerce User Guide

Contents

Menu Options

1152

CHAPTER 79: All Stores

1153

Adding Store Views

1154

Editing a Store View

1156

Adding a Language

1158

Translating Products

1160

Translating Content

1162

Adding Stores

1163

Adding Websites

1167

Store URLs

1169

Use Secure Protocol

1169

Using a Custom Admin URL

1174

CHAPTER 80: Configuration

1177

Configuration Tabs

1177

CHAPTER 81: Taxes

1179

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

1181
1182
1185
1190
1192
1196

Configuring Tax Classes

1197

Adding New Tax Classes

1198

Default Tax Destination

1200

EU Place of Supply for Digital Goods

1201

Fixed Product Tax
Configuring FPT

1202
1203

Price Display Settings

1208

Tax Zones and Rates

1211

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

1213
1216
xxi

Contents

Configuring VAT

1217

VAT ID Validation

1220

Configuring VAT ID Validation
Tax Quick Reference

1227

International Tax Guidelines

1229

U.S. Tax Guidelines

1231

Canadian Tax Guidelines

1233

EU Tax Guidelines

1238

Warning Messages

1244

Calculation Settings

1244

Discount Settings

1245

CHAPTER 82: Currency

1247

Currency Configuration

1248

Currency Symbols

1252

Updating Currency Rates

1253

CHAPTER 83: Attributes
Product Attributes

System
CHAPTER 84: System Menu
Menu Options

1255
1256

1261
1263
1264

CHAPTER 85: Data Transfer

1267

Working with CSV Files

1268

Data Validation
Import

1271
1273

Import History

1278

Importing Product Images

1279

Import Guidelines

1281

Export
Export Criteria

xxii

1222

1283
1285

Magento Commerce User Guide

Contents

Export Filters

1286

Exclude Attributes

1286

Data Transfer Examples

1287

Importing Configurable Products

1287

Importing Tier Prices

1293

Product Attribute Reference

1296

Complex Data

1307

Advanced Pricing Data

1309

Customer Attribute Reference

1311

CHAPTER 86: Integrations

1315

Onboarding Workflow

1316

Magento Marketplace

1320

CHAPTER 87: Permissions

1321

Adding Users

1322

Locked Users

1326

User Roles

1327

Role Resources

1330

Alternate Media Storage

1332

Using a Database

1333

Database Workflow

1333

Using a Content Delivery Network

1335

CDN Workflow

1335

CHAPTER 88: Security

1339

Security Scan

1340

Security Best Practices

1344

Start Right

1344

Protect the Environment

1345

Protect Magento

1347

Don’t be Taken for a Ride

1347

Be Prepared!

1348

Monitor for Signs of Attack

1348

Magento Commerce User Guide

xxiii

Contents

Follow Your Disaster Recovery Plan

1349

Security Action Plan

1350

Configuring Admin Security

1351

CAPTCHA

1354

Admin CAPTCHA

1355

Customer CAPTCHA

1358

Encryption Key

1360

Session Validation

1362

Browser Capabilities Detection

1364

CHAPTER 89: Tools
Cache Management

1366

Full-Page Cache

1372

Index Management
Index Trigger Events

xxiv

1365

1374
1376

Backups

1379

Cron (Scheduled Tasks)

1381

Developer Tools

1383

Amazon Logs

1383

Frontend Development Workflow

1384

Using Static File Signatures

1385

Optimizing Resource Files

1386

Developer Client Restrictions

1389

Template Path Hints

1390

Translate Inline

1392

Setup Wizard

1396

Setup Tools

1397

Extension Manager

1398

Module Manager

1402

System Upgrade

1407

Web Setup

1408

Magento Commerce User Guide

Contents

APPENDICES

1415

APPENDIX A: Release Notes

1417

APPENDIX B: Change Log

1419

APPENDIX C: Glossary

1421

APPENDIX D: Configuration Reference

1431

INDEX

Magento Commerce User Guide

1433

xxv

Contents

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

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

PDF User Guide (You are here!)
You’ll find the same great information in the PDF user
guide, based on the date last updated. Simply click the
link to open the PDF in your browser. You can also rightclick the download link to save the file to your computer.
To page through the PDF as a book, set your reader’s
View > Page Display to “Two Page View”. See the
Documentation Archive for previous versions of the user
guide. Updated: 2 November, 2017

xxvi

Magento Commerce User Guide

GETTING STARTED

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

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

CHAPTER 1:

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

Magento Advantage

Magento Commerce User Guide

Resources

CHAPTER 1: Welcome

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

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

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

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

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

Magento Commerce User Guide

CHAPTER 1: Welcome

Resources

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

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

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

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

Magento Commerce User Guide

Resources

CHAPTER 1: Welcome

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

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

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

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

Magento Commerce User Guide

CHAPTER 1: Welcome

Join the Conversation!

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

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

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

Twitter
Follow us on Twitter!

LinkedIn
Join a Magento group on LinkedIn.

Google+
Add us to your circle on Google+.

Magento Commerce User Guide

Join the Conversation!

CHAPTER 1: Welcome

YouTube
Learn while you watch videos
on our YouTube channel!

Meetup
Find a Magento Meetup near you!

Magento Commerce User Guide

CHAPTER 2:

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

Magento Commerce

Magento Commerce User Guide

System Requirements

CHAPTER 2: About This Release

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

SYSTEM REQUIREMENTS
ENVIRONMENT
Operating System

Linux x86-64

Composer

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

Web Server

Apache 2.2 or 2.4

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

Nginx 1.8.x

(or latest mainline version)

PHP

Supported

Not Supported

7.0.2

7.0.0

7.0.4

7.0.1

7.0.6 - 7.0.x

7.0.3

7.1.x

7.0.5

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

intl
mbstring
mcrypt
mhash
openssl

SimpleXML
soap
xml
xsl
zip

PDO_MySQL
Optional, but recommended

Magento Commerce User Guide

CHAPTER 2: About This Release

System Requirements

SYSTEM REQUIREMENTS
opcache

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

php_xdebug2.2.0

Recommended for development
environments only.

or later

Additional configuration:
safe_mode off
memory_limit minimum 512 MB

Database

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

SSL

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

Mail Server

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

Mail Transfer Agent (MTA) or SMTP server

Supported Applications
NAME

DESCRIPTION

Reverse Proxy / Web
Accelerator

Varnish 3.5

Cache Storage

Redis 3.x

Varnish 4.x (or latest stable version.)

Memcache 1.4.x
Session Storage

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

Elasticsearch

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

Apache Solr
Messaging

Magento Commerce User Guide

(Enterprise Edition only)

RabbitMQ (Enterprise Edition only)

System Requirements

CHAPTER 2: About This Release

Supported Browsers
BROWSER

VERSION

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

Any
Any
Mac OS
Windows

Version 9 or later

Windows

iPad 2
iPad Mini
iPad with Retina Display

OS 7 or later

iPhone 4 or later
Latest, latest -1

IOS 7 or later
Android 4 or later

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

MOBILE STOREFRONT
Safari Mobile
Chrome for Mobile

The version before the most current.

Magento Commerce User Guide

CHAPTER 2: About This Release

Installation

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

Set Up Your Environment

Get the Magento Software

Complete the Web Setup

Verify

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

Installation and Configuration

Magento Commerce User Guide

Installation

CHAPTER 2: About This Release

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

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

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

Magento Commerce User Guide

CHAPTER 2: About This Release

Installation

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

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

Magento Commerce User Guide

Installation

CHAPTER 2: About This Release

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

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

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

Magento Commerce User Guide

CHAPTER 2: About This Release

Installation

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

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

Magento Account
User Name:
Password:
Email Address:

Test Customer Account
User Name:
Password:
Email Address:

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

Magento Commerce User Guide

CHAPTER 3:

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

Your Magento Account

Magento Commerce User Guide

Creating an Account

CHAPTER 3: Your Magento Account

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

To create a Magento account:
1.

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

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

Under Personal Information, do the following:
a.

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

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

Under Login Information, do the following:
a.

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

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

When complete, tap Submit . Your account dashboard appears.

Magento Commerce User Guide

CHAPTER 3: Your Magento Account

Creating an Account

Create an Account

To log in to your Magento account:
1.

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

In the upper-right corner, click My Account.

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

When complete, tap Login .

To receive a new password:
1.

If you forget your password, click Forgot Your Password?

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

Magento Commerce User Guide

Creating an Account

CHAPTER 3: Your Magento Account

To reset your password:
1.

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

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

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

When complete, tap Save .

Change Password

Magento Account Password Requirements
FIELD
Password

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

Magento Commerce User Guide

CHAPTER 3: Your Magento Account

Sharing Your Account

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

Shared Access

To set up a shared account:
1.

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

Account ID

Email address

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

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

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

In the Shared Information section, do the following:

Magento Commerce User Guide

Sharing Your Account

CHAPTER 3: Your Magento Account

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

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

Your Email

Your Phone

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

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

Manage Permissions

Magento Commerce User Guide

CHAPTER 3: Your Magento Account

Sharing Your Account

To access a shared account:
1.

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

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

Switch Accounts
3.

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

Magento Commerce User Guide

CHAPTER 4:

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

Customer Journey

Magento Commerce User Guide

Path to Purchase

CHAPTER 4: Quick Tour

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

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

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

Magento Commerce User Guide

CHAPTER 4: Quick Tour

Path to Purchase

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

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

Magento Commerce User Guide

Path to Purchase

CHAPTER 4: Quick Tour

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

Main Menu

Your Account

Feature a Brand

Offer a Promotion

Offer a Discount

Hear from an Expert

Appeal to a Lifestyle

Shop by Fabric

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

Other PayPal Solutions
PayPal is a global leader in online payments and a fast and secure way for your customers to
pay online. With PayPal and Magento Commerce, you can accept payments from all major
debit and credit cards. PayPal offers additional convenience without extra effort, because even
your customers who don’t have a PayPal account can pay for their purchases with PayPal. In
this guide, PayPal payments solutions are organized as follows:
l

Other PayPal Solutions

PayPal All-In-One Payment Solutions
In the United States, PayPal offers the following PCI-compliant solutions to meet the needs of
your growing business.
l

PayPal Payments Advanced

PayPal Payments Pro

PayPal Payments Standard

PayPal All-In-Payment Solutions

PayPal Payment Gateways
PayPal offers a choice of two payment gateway solutions for your business. You can let PayPal
host your checkout on its secure payment site, or you can take control of the entire payment
experience with a completely customizable solution.
l

PayPal Payflow Pro

PayPal Payflow Link

PayPal Payment Gateways

Magento Commerce User Guide

931

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

PayPal Payments Advanced
PayPal Payments Advanced is a PCI-compliant solution that lets your customers pay by debit
or credit card without leaving your site. It includes an embedded checkout page that can be
customized to create a seamless and secure checkout experience.

PayPal Payments Advanced
Even customers without a PayPal account can make purchases through PayPal’s secure
payment gateway. Accepted cards include Visa, MasterCard, Switch/Maestro, and Solo credit
cards in the United States and United Kingdom. For additional convenience, PayPal Express
Checkout is included with PayPal Payments Advanced.
You can have two PayPal solutions active at the same time: Express Checkout, plus any All-InOne or Payment Gateway solution. If you change payment solutions, the one that was used
previously is disabled.
PayPal Payments Advanced cannot be used for orders created from the Admin of your store.

Requirements
PayPal Business Account

If you manage multiple Magento websites, you must have a separate PayPal merchant
account for each website.

932

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

Checkout Workflow
Customer Chooses Payment Method. During checkout, the customer chooses to pay
with PayPal Payments Advanced. The Pay Now button appears instead of the Place
Order button.
Pay Now. The customer taps Pay Now, and a PayPal-hosted form appears. The
customer enters the card information, and the card is verified. If successful, the order
confirmation page appears.
Pay with PayPal. The form also includes the Pay with PayPal button, which redirects
the customer to the PayPal site, where payment can be made with PayPal Express
Checkout.
Troubleshooting. If the transaction fails for any reason, an error message appears on
the checkout page and the customer is instructed to try again. Any issues are managed
by PayPal.

Order Processing Workflow
Processing orders with PayPal Payments Advanced is the same as for any regular PayPal order.
Orders are invoiced and shipped, and credit memos generated for both online and offline
refunds. However, multiple online refunds are not available for orders paid with PayPal
Payments Advanced.
Customer Places Order. In the final stage of checkout, the customer taps the Place
Order button.

PayPal Responds. PayPal evaluates the request. If found to be valid, PayPal
processes the transaction.

Magento Commerce User Guide

933

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

Magento Sets Order Status. Magento receives response from PayPal, and sets the
order status to one of the following:
Processing

The transaction was successful.

Pending Payment

The system did not receive any response from PayPal.

Canceled

The transaction was not successful for some reason.

Suspected Fraud

The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.

Merchant Fulfills Order. The merchant invoices and ships the order.

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

Setting Up PayPal Payments Advanced

934

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

PayPal Payments Pro
PayPal Payments Pro brings you all the benefits of a merchant account and payment gateway
in one, plus the ability to create your own, fully customized checkout experience. PayPal
Express Checkout is automatically enabled with PayPal Payments Pro, so you can tap into
more than 110 million active PayPal users.

PayPal Payments Pro
For merchants outside the US, this method is called “PayPal Website Payments Pro.”

You can have two PayPal solutions active at the same time: PayPal Express Checkout, plus any
one of the All-In-One solutions. If you change payment solutions, the one used previously is
automatically disabled.

Requirements
PayPal Merchant Account (with Direct Payments Activated)

Magento Commerce User Guide

935

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

Checkout Workflow
Customer Goes to Checkout. Customer adds products to cart, and taps Proceed to
Checkout.

Customer Chooses Payment Method. During checkout, customer chooses the
PayPal Direct Payment option, and enters the credit card information.
l

If paying with PayPal Payments Pro, the customer stays on your site during the
checkout process.
If paying with PayPal Express Checkout, the customer is redirected to the PayPal
site to complete the transaction.

At the customer’s request, the store administrator can also create an order from the
Admin, and process the transaction with PayPal Payments Pro.

936

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

Order Processing Workflow
Order Placed. The order can be processed either the Admin of your store, or from your
PayPal merchant account.

Payment Action. The payment action specified in the configuration is applied to the
order. Options include:
Authorize

Magento creates a sales order with the “Processing” status. In
this case, the amount of money to be authorized is pending
approval.

Sale

Magento creates both a sales order and invoice.

Capture

PayPal transfers the order amount from the buyer’s balance,
bank account or credit card to the merchant’s account.

Invoicing. An invoice is created in Magento after PayPal sends an instant payment
notification message to Magento.
Make sure that instant payment notifications are enabled in your PayPal merchant
account.

If required, an order can be partially invoiced for a specified quantity of products. For
each partial invoice submitted, a separate Capture transaction with a unique ID becomes
available, and a separate invoice is generated.
Authorization-only payment transactions are closed only after the full order amount is
captured.
An order can be voided online at any time until the order amount is fully invoiced.
Returns. If for any reason the customer returns the purchased products and claims a
refund, as with order amount capturing and invoice creation, you can create an online
refund either from the Admin or from your PayPal merchant account.

Magento Commerce User Guide

937

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

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

Setting Up PayPal Payment Pro

938

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

PayPal Payments Standard
PayPal Payments Standard is the easiest way to accept payments online. You can offer your
customers the convenience of payment both by credit card and PayPal by simply adding a
checkout button to your store.

PayPal Payments Standard
For merchants outside the US, this method is called “PayPal Website Payments Standard.”

With PayPal Payments Standard, you can swipe credit cards on mobile devices. There is no
monthly fee, and you can get paid on eBay. Supported credit cards include Visa, MasterCard,
Discover, and American Express. In addition, customers can pay directly from their personal
PayPal accounts. PayPal Payments Standard is available in all countries on the PayPal
worldwide reference list.

Merchant Requirements
PayPal Business Account

Checkout Workflow
For customers, PayPal Payments Standard is a one-step process if the credit card information
the their personal PayPal accounts is up to date.
Customer Places Order. The customer taps the “Pay Now” button to complete the
purchase.

PayPal Processes the Transaction. The customer is redirected to the PayPal site to
complete the transaction.

Magento Commerce User Guide

939

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

Setting Up PayPal Payments Standard
PayPal Payments Standard cannot be used simultaneously with any other PayPal method, including
Express Checkout. If you change payment solutions, the one used previously is disabled.

For step-by-step configuration instructions, see PayPal Payments Standard in the online user
guide.

Setting Up PayPal Payments Standard

940

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

PayPal Payflow Pro
PayPal Payflow Pro gateway, formerly known as Verisign, is available for customers of the
United States, Canada, Australia, and New Zealand. Unlike other PayPal payment methods,
merchants are charged a fixed monthly fee, plus a fixed fee for each transaction, regardless of
their number.

Checkout with PayPal

Requirements
PayPal Business Account
The PayPal Payflow Pro gateway links the merchant account at PayPal with the
merchant’s website, and acts both as a gateway and a merchant account.
If you manage multiple Magento websites, you must have a separate PayPal merchant
account for each website.

Magento Commerce User Guide

941

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

Customer Workflow
Customer Goes to Checkout. During checkout, the customer chooses to pay with
PayPal PayFlow Pro, and enters the credit card information.
Customers are not required to have personal PayPal accounts. However, depending on
the merchant country, customers can also use their personal PayPal account to pay for
the order.
Customer Submits Order. The customer submits the order, and the order information
is sent to PayPal for processing. The customer does not leave the checkout page of your
site.
PayPal Completes the Transaction. Payments are accepted at the time the order is
placed. Depending on the payment action specified n the configuration, either a sales
order or a sales order and an invoice is created.

Online Order Processing Workflow
Administrator Submits Online Invoice. The store administrator submits an online
invoice. and as a result a corresponding transaction and an invoice is created.

PayPal Receives the Transaction. The order information is sent to PayPal. A record of
the transaction and an invoice is generated. You can view all Payflow Pro Gateway
transactions in your PayPal merchant account.

Partial invoices and partial refunds are not supported by PayPal Payflow Pro.

942

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

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

PayPal Payflow Pro

Magento Commerce User Guide

943

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

PayPal Payflow Link
PayPal PayFlow Link is available for merchants in the United States and Canada only.
Customers are not required to have a personal PayPal account, and enter their credit card
information in a form that is hosted by PayPal. The information is never stored on your
Magento server. PayFlow Link cannot be used for orders that are created from the Admin.

Configure
Credit memos are supported for both online and offline refunds. However, multiple online
refunds are not supported.

Customer Workflow
Customer Goes to Checkout. During checkout, the customer chooses to pay with
PayPal PayFlow link, and enters the credit card information.
The customer is not required to have a personal PayPal account.
Customer Chooses Pay Now. The customer taps the Pay Now button to submit the
order.

Customer Enters Credit Card Info. The customer enters the credit card information on
a form that is hosted by PayPal/
If the customer clicks the Cancel Payment link, the customer returns to the Payment
Information stage of checkout, and the order status changes to “Canceled.”
Customer Submits the Order. The credit card information is submitted directly to
PayPal, and is not retained anywhere on the Magento site.

944

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

Other PayPal Solutions

Order Workflow
PayPal Receives Request. PayPal receives the request from the customer to Pay
Now.

PayPal Verifies the Payment Information. PayPal verifies the credit card information,
and assigns the appropriate status.
Payment Verified: If verified, the “Pending Payment” the applicable status is initially
assigned to the order until the transaction is settled.
Processing

The transaction was successful.

Pending Payment

The system did not receive any response from PayPal.

Canceled

The transaction was not successful for some reason.

Suspected Fraud

The transaction did not pass some of the PayPal fraud filters.
The system receives the response from PayPal that the
transaction is under review by Fraud Service.

Cancel Payment. If the customer clicks the Cancel Payment link, the customer returns
to the Payment Information stage of checkout, and the order status changes to
“Canceled.”
Customer Is Redirected to Confirmation Page. If the transaction completes
successfully, the customer is redirected to the order confirmation page in your store.
If the transaction fails on any reason, an error message appears on the checkout page
and the customer is directed to repeat the checkout process. These situations are
managed by PayPal.
Merchant Fulfills Order. The merchant invoices, and ships the order as usual.

Magento Commerce User Guide

945

Other PayPal Solutions

CHAPTER 59: Recommended Solutions

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

PayPal Payflow Link Setup

946

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

PayPal Reference
PAYPAL SOLUTION

DESCRIPTION

EXPRESS CHECKOUT
PayPal Express Checkout

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

ALL-IN-ONE SOLUTIONS
PayPal Payments Advanced (Includes Express
Checkout)

Allows you to accept payments with a
PCI-compliant checkout that keeps
customers on your site.

PayPal Payments Pro (Includes Express Checkout)
PayPal Website Payments Pro (Outside US)

Allows you to accept payments with a
completely customizable checkout.

PayPal Payments Standard (Includes Express
Checkout)

Adds PayPal as an additional payment
method to your checkout page.

PayPal Website Payments Standard (Outside US)
PAYMENT GATEWAYS
PayPal Payflow Pro (Includes Express Checkout)

Connects your merchant account with a
fully customizable gateway that lets
customers pay without leaving your site.

PayPal Payflow Link (Includes Express Checkout)

Connects your merchant account with a
PCI-compliant gateway that lets
customers pay without leaving your site.

OTHER PAYPAL SOLUTIONS
PayPal Integral Evolution
PayPal Pasarela Integral
PayPal Pro
PayPal Website Payments Plus
PayPal Website Payments Pro Hosted Solution
PayPal Payments Pro Hosted Solution (includes Express Checkout)

Magento Commerce User Guide

947

PayPal Reference

CHAPTER 59: Recommended Solutions

PayPal Business Account
To offer PayPal as a payment method in your store, you must have a PayPal business account
and/or a PayPal Payflow account. The account requirements are specified in the description of
each PayPal solution. Your PayPal merchant account is also used to manage any fraud filters
that are applied to purchases made from your store.
Customers who use PayPal Express Checkout or Express Checkout for Payflow Pro must have a
PayPal buyer account. PayPal Payments Standard (which is some countries is called Website
Payments Standard) can be used directly or through a buyer account, provided that the
merchant enables PayPal Account Optional. By default, this parameter is enabled. Customers
can choose to enter their credit card information, or create a buyer account with PayPal. When
disabled, customers must first create a PayPal buyer account before making a purchase.
Website Payments Pro, Website Payments Pro Payflow Edition, Payflow Pro Gateway, and
Payflow Link require customers to enter credit card information during checkout.

948

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

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

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

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

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

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

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

Magento Commerce User Guide

949

PayPal Reference

CHAPTER 59: Recommended Solutions

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

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

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

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

PayPal Express Checkout

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

PayPal Express Checkout
4.

Complete the Required PayPal Settings. Then, expand

Set Enable PayPal Credit to “Yes”.

Tap Save Config.

Advertise PayPal Credit.

Enable PayPal Credit

To enable PayPal Credit banners:
1.

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

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

For any of the following Recommended Solutions, tap Configure.

PayPal Express Checkout

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

Expand

the Required PayPal Settings section. Then, expand

the Advertise PayPal

Credit section.

950

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

Advertise PayPal Credit
5.

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

Expand
a.

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

Set Position to one of the following:

the Home Page section. Then, do the following:

Header (center)

Sidebar (right)

Set Size to one of the following:
l

190 x 100

234 x 60

300 x 50

468 x 60

728 x 90

800 x 66

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

Catalog Category Page

Catalog Product Page

Checkout Cart Page

Magento Commerce User Guide

951

PayPal Reference

CHAPTER 59: Recommended Solutions

When complete, tap Save Config.

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

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

952

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

PayPal Fraud Management Filter
PayPal fraud management filters make it easier to detect and respond to fraudulent
transactions, and can be configured to flag, hold for review, or deny riskier payments. Magento
order status values changed according to the fraud filter settings.

Filter Actions
ACTION
Review

DESCRIPTION
If you set the filter action to “Review,” the suspected order receives the
status ”Payment Review” when the order is placed. You can review the order
and approve, or cancel the payment in the Admin, or on the PayPal side.
When you click the Accept Payment or the Deny Payment buttons, no new
transactions for the order are created.
If you change the status of the transaction on the PayPal site, you must click
the Get Payment Update button in the upper-right corner of the Order page in
the Admin to apply the changes. If you click Accept Payment or Deny
Payment, the changes made at the PayPal site are applied.

Deny

If you set the filter action to “Deny,” the suspected order cannot be placed by
the customer, because the corresponding transaction is rejected by PayPal.
To deny the payment from the Admin, click the Deny Payment button in the
upper-right corner of the page. The order status changes to “Canceled,” the
transaction is reverted, and funds are released on the customer’s account.
The corresponding information is added in the Comments History section of
the order view.

Flag

Magento Commerce User Guide

If you set the filter action to “Flag”, the suspected order gets the status
”Processing” when it is placed. The corresponding transaction is marked with
a “flag” in the list of the merchant account transactions.

953

PayPal Reference

CHAPTER 59: Recommended Solutions

PayPal by Country
PayPal Payment Solutions
COUNTRY
Australia

PAYPAL PAYMENT SOLUTION
PayPal Website Payments Standard
PayPal Payflow Pro
PayPal Website Payments Pro Hosted Solution
PayPal Express Checkout

Canada

PayPal Website Payments Standard
PayPal Website Payments Pro
PayPal Payflow Pro
PayPal Payflow Link (includes Express Checkout)
PayPal Express Checkout

France

PayPal Integral Evolution
PayPal Website Payments Standard
PayPal Express Checkout

Germany

PayPal Express Checkout

Hong Kong SAR China

PayPal Website Payments Pro Hosted Solution
PayPal Website Payments Standard
PayPal Express Checkout

Italy

PayPal Pro
PayPal Payments Standard
PayPal Express Checkout

Japan

PayPal Website Payments Plus
PayPal Website Payments Standard
PayPal Express Checkout

New Zealand

PayPal Payflow Pro
PayPal Website Payments Standard
PayPal Express Checkout

Spain

PayPal Pasarela Integral
PayPal Website Payments Standard
PayPal Express Checkout

954

Magento Commerce User Guide

CHAPTER 59: Recommended Solutions

PayPal Reference

PayPal Payment Solutions (cont.)
COUNTRY
United Kingdom

PAYPAL PAYMENT SOLUTION
PayPal Payments Pro Hosted Solution (includes Express
Checkout)
PayPal Payments Standard
PayPal Express Checkout

United States

PayPal Payments Advanced (Includes Express Checkout)
PayPal Payments Pro (Includes Express Checkout)
PayPal Payments Standard+
PayPal Payflow Pro (Includes Express Checkout)
PayPal Payflow Link (Includes Express Checkout)
PayPal Express Checkout

OTHER COUNTRIES
PayPal Express Checkout and PayPal Website Payments Standard are available in the following
countries:
Argentina, Austria, Belgium, Brazil, Bulgaria, Chile, Costa Rica, Cyprus, Czech Republic,
Denmark. Dominican Republlic, Ecuador. Estonia, Finland. French Guiana. Gibraltar. Greece.
Guadeloupe, Hungary, Iceland. India. Indonesia. Ireland. Israel, Jamaica, Latvia. Leichtenstein.
Lithuania. Luxembourg, Malaysia. Malta. Martinique. Mexico, Netherlands. Norway, Philippines.
Poland. Portugal, Réunion, Romania, San Marino, Singapore, Slovakia, Slovenia, South Africa,
South Korea,, Sweden, Switzerland, Taiwan, Thailand, Turkey, United Arab Emirates, Uruguay,
Venezuela, Vietnam

Magento Commerce User Guide

955

956

Magento Commerce User Guide

CHAPTER 60:

Other Payment Methods
Magento Commerce supports the following payment solutions that offer merchant services in
all parts of the world. Unlike some payment solutions that transfer control to another site to
complete the transaction, a payment gateway makes it possible for you to accept credit card
payments directly from your store without the customer leaving your site.
l

Klarna

Amazon Pay

Authorize.Net Direct Post

Magento Commerce User Guide

957

Klarna

CHAPTER 60: Other Payment Methods

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

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

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

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

958

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

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

To pay with Klarna:
1.

Select Slice it. Pay over time with Klarna.

Pay Over Time with Klarna
2.

Do one of the following:
l

Add the purchase to your Klarna account.

Apply for Klarna credit, and receive an instant decision.

Klarna During Checkout
3.

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

Magento Commerce User Guide

959

Klarna

CHAPTER 60: Other Payment Methods

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

Klarna Merchant Portal

Step 1: Set Up Your Klarna Account
1.

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

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

Tap the Settings icon.

In the main menu, choose Settings.

Then, do the following:

960

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

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

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

Generate API Credentials
3.

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

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

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

Complete the following store information:
l

Store name

Homepage URL

Customer Support Email

Customer Support Phone

Store Settings

Magento Commerce User Guide

961

Klarna

CHAPTER 60: Other Payment Methods

Step 2: Configure Magento
1.

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

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

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

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

the Klarna section. Then, tap Configure.

Klarna
5.

Expand
a.

the Klarna API section. then, do the following:

Set API Version to one of the following:
l

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

Klarna Payments (North America)

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

Enter the Password/Shared secret from your Klarna account.

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

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

Klarna API

962

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Expand

Klarna

the Klarna Payments section. then, do the following:

Set Enable this Solution to “Yes.”

Set Payment from applicable countries to one of the following:
All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

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

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

Klarna Payments
7.

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

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

Details color

Button color

Button text color

Checkbox color

Magento Commerce User Guide

963

Klarna

CHAPTER 60: Other Payment Methods

Checkbox check mark color

Header color

Link color

Border color

Selected border color

Text color

Secondary text color

Border radius

Klarna Payments Design
8.

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

964

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

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

EVENT

ACTION

Canceled Order

Sends cancel to Klarna.

Full/Partial Capture

Sends capture to Klarna.

Full/Partial Refund

Sends refund to Klarna.

Klarna Merchant Portal

To manage orders:
Do one of the following:
l

In the main menu, choose Orders.

On the Klarna dashboard, choose Orders.

Then, do any of the following:

Find an Order
1.

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

Magento Commerce User Guide

965

Klarna

CHAPTER 60: Other Payment Methods

Unacknowledged

Uncaptured

Captured

Cancelled

Show
2.

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

Customer name and email

Merchant reference

Klarna reference

Order ID

Export Orders

966

Tap Export all (CSV).

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

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Klarna

Exported Orders

Magento Commerce User Guide

967

Amazon Pay

CHAPTER 60: Other Payment Methods

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

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

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

968

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

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

Amazon Pay on Product Page

To place an order with Amazon Pay:
1.

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

Shipping Addresses
2.

Choose the shipping address from your Amazon Address Book.

Magento Commerce User Guide

969

Amazon Pay

CHAPTER 60: Other Payment Methods

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

Click the arrow (

) to view all available options.

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

If you prefer, click Return to standard checkout.

Amazon Pay Address Book
3.

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

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

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

970

Click the arrow (

) to view all available options.

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

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

Amazon Pay Payment Method
5.

Enter a Discount Code, if applicable.

Review the order. Then, tap Place Order.

Magento Commerce User Guide

971

Amazon Pay

CHAPTER 60: Other Payment Methods

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

To set up Amazon Pay:
1.

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

configuration applies.
b.

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

Amazon Pay
2.

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

972

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

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

Create Amazon Pay Account
b.

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

Credentials
1.

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

Get your Test Credentials for the Amazon Pay Sandbox.

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

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

Merchant Id

Access Key Id

Secret Access Key

Client ID

Client Secret

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

Magento Commerce User Guide

973

Amazon Pay

CHAPTER 60: Other Payment Methods

Verify the Payment Region for the store.

Credentials
3.

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

974

If your credentials are valid, continue with the configuration.

Otherwise, correct your credentials, and try again.

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

Options
1.

Expand

Set Enable Amazon Pay to “Yes.”

Set Enable Login with Amazon to “Yes.”

Set Payment Action to one of the following:

the Options section.

Charge on
Shipment

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

Charge on Order

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

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

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

Asynchronous

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

Synchronous if
Possible

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

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

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

Instant Payment
Notifications

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

Options

Magento Commerce User Guide

975

Amazon Pay

CHAPTER 60: Other Payment Methods

Advanced Settings
1.

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

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

English (Great Britain)

de-DE

German (Germany)

fr-FR

French (France)

it-IT

Italian (Italy)

sp-SP

Spanish (Spain)

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

Set Button Color to one of the following:
l

Gold

Light Gray

Dark Gray

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

976

Set Button Size to one of the following:
l

Small

Medium

Large

Extra Large

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

Amazon Pay button on Product Page

Amazon Pay button in minicart

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Amazon Pay

Frontend
2.

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

Sales Options
3.

When complete, tap Save Config.

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

Mark the checkbox of each invalid cache.

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

Magento Commerce User Guide

977

Using Amazon Seller Central

CHAPTER 60: Other Payment Methods

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

Amazon Seller Central (Production View)

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

Amazon Pay (Sandbox View)

Amazon Pay (Production View)

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

Set the chooser to one of the following:

978

Amazon Pay (Production View)

Amazon Pay (Sandbox View)

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

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Using Amazon Seller Central

Amazon Seller Central (Sandbox View)
a.

In the page header, tap Copy your keys.

Copy Your Keys
b.

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

Your Credentials

Magento Commerce User Guide

979

Using Amazon Seller Central

CHAPTER 60: Other Payment Methods

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

Invoice with Credit Memo Button

To issue a refund:
1.

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

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

In the button bar, tap Credit Memo.

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

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

To view Amazon Pay activity:
1.

Go to pay.amazon.com.

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

Merchant Sign In
3.

980

When prompted, do the following:
a.

Enter your email address or mobile number.

Enter your password.

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

c.
4.

Using Amazon Seller Central

Tap Sign in.

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

Orders from Region
5.

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

Can’t find an order?

Magento Commerce User Guide

981

Using Amazon Seller Central

CHAPTER 60: Other Payment Methods

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

Amazon Pay Website

To find help:
1.

In the upper-right corner, click Help.

Amazon Seller Central

982

Magento Commerce User Guide

CHAPTER 60: Other Payment Methods

Using Amazon Seller Central

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

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

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

Getting Started Guide

Magento Commerce User Guide

983

Authorize.Net Direct Post

CHAPTER 60: Other Payment Methods

Authorize.Net Direct Post
Authorize.Net handles all steps in the transaction process — such as payment data collection,
data submission, and response to the customer — while the customer remains in your store.
Authorize.Net Direct Post can be used with orders created from the Admin as well as from the
store.

Customer Workflow
Customer chooses payment method. During checkout, the customer chooses
Authorize.Net Direct Post as the payment method.

Customer submits the order. The customer enters the credit card information, reviews
the order, and taps the Place Order button.

Authorize.Net completes the transaction. Authorize.Net validates the card
information, and processes the transaction.
l

If successful, the customer is redirected to the order confirmation page.
If the transaction fails, an error message appears, and the customer can try a different
card, or choose a different payment method.

Setting Up Authorize.Net Direct Post
For step-by-step configuration instructions, see Authorize.Net Direct Post in the Magento
Commerceonline user guide.

Authorize.Net Direct Post

984

Magento Commerce User Guide

CHAPTER 61:

Basic Payment Methods
The payment methods covered in this section are built in to Magento, and do not require the
services of a third-party payment processing company.

Offline Payments
Magento supports a number of offline payment methods,
including payment by check or money order, and cash on
delivery (COD),

Online Payments
Bank transfer is a basic payment method that is included
with all Magento stores.

Magento Commerce User Guide

985

Check / Money Order

CHAPTER 61: Basic Payment Methods

Check / Money Order
Magento Commerce allows you to accept payments by check or money order. The Check /
Money Order payment method is enabled for your story by default. You can accept checks and
money orders from only specific countries, and fine-tune the configuration with minimum and
maximum order total limits.

Check / Money Order

986

Magento Commerce User Guide

CHAPTER 61: Basic Payment Methods

Check / Money Order

To configure payment by check or money order:
1.

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

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

Expand

the Check / Money Order section. Then, do the following:

To accept payment by check or money order, set Enabled to “Yes.”

Enter a Title to identify the Check / Money Order payment method during checkout.

Set New Order Status to "Pending” until receipt of payment is confirmed.

Set Payment from Applicable Countries to one of the following:
All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

In the Make Check Payable To field, enter the name of the party to whom the check must
be payable.

In the Send Check To field, enter the street address or PO Box where the checks are
mailed.

Set Minimum Order Total and Maximum Order Total to the order amounts required to
qualify for this payment method.
An order qualifies if the total falls between, or exactly matches, the minimum or maximum total
values.

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

When complete, tap Save Config .

Magento Commerce User Guide

987

Cash On Delivery

CHAPTER 61: Basic Payment Methods

Cash On Delivery
Magento Commerce allows you to accept COD payments for purchases. You can accept COD
payment from only specific countries, and fine-tune the configuration with minimum and
maximum order total limits.
The shipping carrier receives payment from the customer at the time of delivery, which is then
transferred to you. You can make an adjustment for any fee charged by the carrier service in
your shipping and handling charges.

Cash On Delivery Payment

988

Magento Commerce User Guide

CHAPTER 61: Basic Payment Methods

Cash On Delivery

To set up cash on delivery payments:
1.

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

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

Expand

the Cash On Delivery Payment section. Then, do the following:

To activate Cash On Delivery Payment, set Enabled to “Yes.”

Enter a Title to identify the COD payment method during checkout.

Set New Order Status to “Pending” until receipt of payment is confirmed.

Set Payment from Applicable Countries to one of the following:
All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

Enter the Instructions for accepting delivery of a COD order.

Set Minimum Order Total and Maximum Order Total to the order amounts that are
required to qualify for COD payment.
An order qualifies if the total is between, or matches, the minimum or maximum order total.

Enter a Sort Order number to determine the sequence in which Cash On Delivery is listed
with other payment methods during checkout. (0 = first, 1 = second, 2 = third, and so on.)

When complete, tap Save Config .

Magento Commerce User Guide

989

Bank Transfer

CHAPTER 61: Basic Payment Methods

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

Bank Transfer Payment

990

Magento Commerce User Guide

CHAPTER 61: Basic Payment Methods

Bank Transfer

To configure bank transfer payments:
1.

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

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

Expand

the Bank Transfer Payment section. Then, do the following:

To activate bank transfers, set Enabled to “Yes.”

Enter a Title to identify the Bank Transfer Payment method during checkout.

Set New Order Status to “Pending” until payment is authorized.

Set Payment from Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

Enter the Instructions your customers must follow to set up a bank transfer. Depending on
the country where your bank is located and the requirements of the bank, you might need
to include the following information:
l

Bank account name

Bank account number

Bank routing code

Bank name

Bank address

Set Minimum Order Total and Maximum Order Total to the amounts required to qualify to
use this payment method.
An order qualifies if the total falls between, or exactly matches, the minimum or maximum total
values.

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

When complete, tap Save Config .

Magento Commerce User Guide

991

Purchase Order

CHAPTER 61: Basic Payment Methods

Purchase Order
A purchase order (PO) allows commercial customers to pay for authorized purchases by
referencing the PO number. The purchase order is authorized and issued in advance by the
company that is making the purchase. During checkout, the customer chooses Purchase Order
as the method of payment. Upon receipt of your invoice, the company processes the payment
in their accounts payable system, and pays for the purchase.
Before accepting payment by purchase order, always establish the credit worthiness of the
commercial customer.

Purchase Order

992

Magento Commerce User Guide

CHAPTER 61: Basic Payment Methods

Purchase Order

To configure payment by purchase order:
1.

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

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

Expand

the Purchase Order section. Then, do the following:

To activate this payment method, set Enabled to “Yes.”

Enter a Title to identify this payment method during checkout.

Set New Order Status to “Pending” until payment is authorized.

Set Payment from Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

Set Minimum Order Total and Maximum Order Total to the amounts required to qualify
for this payment method.
An order qualifies if the total falls between, or exactly matches, the minimum or maximum total
values.

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

When complete, tap Save Config .

Magento Commerce User Guide

993

Zero Subtotal Checkout

CHAPTER 61: Basic Payment Methods

Zero Subtotal Checkout
Zero Subtotal Checkout is available only for orders created from the Admin, and can be used for
orders with a subtotal of zero that are taxed after a discount is applied. For example, Zero
Subtotal Checkout might be used in the following situations:
l

A discount covers the entire price of the purchase, with no additional charge for shipping.

The customer adds a downloadable or virtual product to the shopping cart, and the price
equals zero.

The price of a simple product is zero, and the Free Shipping method is available.

A coupon code covers the full price of products and shipping.

To save time, zero subtotal orders can be set to invoice automatically.

Zero Subtotal Checkout

994

Magento Commerce User Guide

CHAPTER 61: Basic Payment Methods

Zero Subtotal Checkout

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

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

Click to expand the Zero Subtotal Checkout section. Then, do the following:
a.

Enter a Title to identify the Zero Subtotal method during checkout.

Set Enabled to “Yes” to activate Zero Subtotal Checkout.

If orders typically wait for authorization, set New Order Status to “Pending” until payment
is authorized.
The order is waiting for authorization.

Processing

Payment has been authorized, and the transaction is being
processed.

Set Automatically Invoice All Items to “Yes” if you want to automatically invoice all items
that have a zero balance.

Set Payment from Applicable Countries to one of the following:

Pending

All Allowed
Countries

Customers from all countries specified in your store configuration
can use this payment method.

Specific Countries

After choosing this option, the Payment from Specific Countries list
appears. Select each country in the list where customers can make
purchases from your store.

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

When complete, tap Save Config .

Magento Commerce User Guide

995

996

Magento Commerce User Guide

CHAPTER 62:

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

PayPal Fraud Management Filter

Fraud Protection Solutions on Magento Marketplace

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

Step 1: Sign Up for a Signifyd Account
1.

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

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

Complete the Signifyd configuration for your Magento installation.

Step 2: Configure Your Magento Store
1.

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

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

Under Signifyd, expand

Magento Commerce User Guide

the Configuration section. Then, do the following:

997

Signifyd Guaranteed Fraud Protection

CHAPTER 62: Fraud Protection

Signifyd Configuration

998

Set Enable this Solution to “Yes”.

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

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

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

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

When complete, tap Save Config.

Magento Commerce User Guide

Shipping

999

Contents
Studies show that stores offering customers a
choice of several shipping methods have higher
conversion rates than those that use a single
method for all shipments. In this section of the
guide, you will learn how to set up a variety of
shipping methods and carriers, and print
shipping labels.

Shipping Settings
Shipping Policy
Basic Shipping Methods
Free Shipping
Flat Rate
Table Rate
Dimensional Weight
Carriers
Shipping Labels
Shipping Label Workflow
Configuring Shipping Labels
Creating Shipping Labels

1000

CHAPTER 63:

Shipping Settings
The shipping configuration establishes the point of origin for all shipments, your shipping
policy, and the handling of shipments to multiple addresses.
l

Point of Origin

Shipping to Multiple Addresses

Shipping Policy

Shipping Settings

Magento Commerce User Guide

1001

Point of Origin

CHAPTER 63: Shipping Settings

Point of Origin
The point of origin is used to calculate the charge for shipments made from your store or
warehouse, and also determines the tax rate for products sold. When calculating EU taxes,
make sure that the Default Tax Destination Calculation for each store view corresponds to the
Shipping Settings point of origin.

Origin

To establish the point of origin:
1.

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

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

Expand

1002

the Origin section, and complete the following:

Country

Region / State

ZIP / Postal Code

City

Street Address (and line 2, if needed)

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 63: Shipping Settings

Multiple Addresses

Multiple Addresses
The Multiaddress Shipping options enable customers to ship an order to multiple addresses
during checkout, and determine the maximum number of addresses to which an order can be
shipped.

To configure multiple address shipping:
1.

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

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

Expand

the Options section. Then, do the following:

Set Allow Shipping to Multiple Addresses to “Yes.”

Enter the Maximum Qty Allowed for Shipping to Multiple Addresses.

When complete, tap Save Config.

Multiaddress Shipping Options

Magento Commerce User Guide

1003

Shipping Policy

CHAPTER 63: Shipping Settings

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

Shipping Policy During Checkout

1004

Magento Commerce User Guide

CHAPTER 63: Shipping Settings

Shipping Policy

To configure your shipping policy:
1.

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

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

Expand

the Shipping Policy Parameters section, and do the following:

Set Apply Custom Shipping Policy to “Yes.”

Either paste or enter your Shipping Policy into the text box.
If you use a word processor to compose the text, make sure to save the document as a .txt file
to remove any control characters from the text. Then, copy and paste the text into the Shipping
Policy text box.

Shipping Policy Parameters
4.

When complete, tap Save Config .

Magento Commerce User Guide

1005

1006

Magento Commerce User Guide

CHAPTER 64:

Basic Shipping Methods
Magento Commerce supports a wide range of shipping methods and carriers. In this chapter
you will learn how to set up that shipping methods that do not require an account with a
third-party provider.
l

Free Shipping

Flat Rate

Table Rates

Dimensional Weight

Magento Commerce User Guide

1007

Free Shipping

CHAPTER 64: Basic Shipping Methods

Free Shipping
Free shipping is one of the most effective promotions you can offer. It can be based on a
minimum purchase, or set up as a cart price rule that is applied when a set of conditions is
met. If both apply to the same order, the configuration setting takes precedence over the cart
rule.
Check your shipping carrier configuration for any additional settings that may be required for free
shipping.

Free Shipping

Step 1: Configure Free Shipping

1008

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

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

Expand

the Free Shipping section. Then, do the following:

Set Enabled to “Yes.”

Enter a Title to identify the Free Shipping method during checkout.

Magento Commerce User Guide

CHAPTER 64: Basic Shipping Methods

Free Shipping

Enter a Method Name to describe this shipping method.

Enter the Minimum Order Amount to qualify for free shipping.
To use Free Shipping with Table Rates, make the Minimum Order Amount so high that it is
never met. This prevents Free Shipping from going into effect, unless it is triggered by a price
rule.

In the Displayed Error Message box, type the message to appear if free shipping becomes
unavailable.

Set Ship to Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use free shipping.

Specific Countries

After choosing this option, the Ship to Specific Countries list
appears. Select each country in the list where free shipping can be
used.

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

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

Shows the Free Shipping method only when applicable.

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

When complete, tap Save Config .

Step 2: Enable Free Shipping in the Carrier Configuration
Make sure to complete any configuration that is required for each carrier that you plan to use
for free shipping. For example, if your UPS configuration is otherwise complete, make the
following settings to enable and configure free shipping:
1.

From the Shipping Methods configuration, click to expand the UPS section.

Expand

To require a minimum order for free shipping, set Free Shipping with Minimum Order

the UPS section. Then, set Free Method to “Ground.”

Amount to “Enable.”
4.

Enter the required amount in the Minimum Order Amount for Free Shipping field.

When complete, tap Save Config .

Magento Commerce User Guide

1009

Flat Rate

CHAPTER 64: Basic Shipping Methods

Flat Rate
Flat rate is a fixed, predefined charge that can be applied per item, or per shipment. Flat rate is
a simple shipping solution, especially when used with the flat-rate packaging that is available
from some carriers. When enabled, Flat Rate appears as an option during checkout. Because no
specific carrier is specified, you can use a carrier of your choice.

Flat Rate

To set up flat rate shipping:

1010

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

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

Expand

the Flat Rate section. Then, do the following:

Magento Commerce User Guide

CHAPTER 64: Basic Shipping Methods

Flat Rate

Set Enabled to “Yes.”
Flat Rate appears as an option in the Estimate Shipping and Tax section of the shopping
cart, and also in the Shipping section during checkout.

Enter a descriptive Title for the Flat Rate method.

Enter a Method Name to appear next to the calculated rate in the shopping cart. The
default method name is “Fixed.” If you charge a handling fee, you can change the Method
Name to “Plus Handling,” or something else that is suitable.

To describe how flat rate shipping can be used, set Type to one of the following:
None

Disables the payment type. The Flat Rate option is listed in the
cart, but with a rate of zero—which is the same as free shipping.

Per Order

Charges a single flat rate for the entire order.

Per Item

Charges a single flat rate for each item. The rate is multiplied by the
number of items in the cart, regardless of whether there are multiple
quantities of the same, or of different items.

Enter the Price that you want to charge for flat rate shipping.

If charging an additional handling fee, set Calculate Handling Fee to one of the following:
l

Fixed

Percent

Then, enter the Handling Fee rate according to the method used to calculate the fee. For
example, if the fee is calculating based on a percentage, enter 0.06 for 6 percent. If using a
fixed amount calculation, enter the fee as a decimal.
g.

In the Displayed Error Message box, type the message that appears if Flat Rate Shipping
becomes unavailable.

Set Ship to Applicable Countries to one of the following:

All Allowed
Countries

Customers from all countries specified in your store configuration
can use flat rate shipping.

Specific Countries

After choosing this option, the Ship to Specific Countries list
appears. Select each country in the list where flat rate shipping can
be used.

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

When complete, tap Save Config .

Magento Commerce User Guide

1011

Table Rates

CHAPTER 64: Basic Shipping Methods

Table Rates
The table rate shipping method references a table of data to calculate shipping rates based on a
combination of conditions, including:
l

Weight v. Destination

Price v. Destination

# of Items v. Destination

For example, if your warehouse is in Los Angeles, it costs less to ship to San Diego than to
Vermont. You can use table rate shipping to pass the savings on to your customers.
The data that is used to calculate tables rates is prepared in a spreadsheet and imported into
your store. When the customer requests a quote, the results appear in the shipping estimate
section of the shopping cart.
Only one set of table rate data can be active at a time.

Table Rate in Shopping Cart

1012

Magento Commerce User Guide

CHAPTER 64: Basic Shipping Methods

Table Rates

Process Overview:
Step 1: Complete the Default Settings
Step 2: Prepare the Table Rate Data
Step 3: Import the Table Rate Data
Step 4: Verify the Rates

Step 1: Complete the Default Settings
The first step is to complete the default settings for table rates. You can complete this step
without changing the scope of the configuration.
1.

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

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

Expand
a.

the Table Rates section. Then, do the following:

Set Enabled to “Yes.”
If necessary, clear the Use system value checkbox to edit for any field to be edited.

Enter the Title that you want to appear for table rates section during checkout. (The
default title is “Best Way.”)

Enter the Method Name that you want to appear as a label next to the calculated rate in
the shopping cart.

Set Condition to one of the following calculation methods:

Weight v. Destination

Price v. Destination

# of Items v. Destination

For orders that include virtual products, set Include Virtual Products in Price Calculation
to “Yes” if you want to be able to include the virtual product(s) in the calculation.
Because virtual products—such as services—have no weight, they cannot change the result of
a calculation that is based on the Weight v. Destination condition. However, virtual products
can change the result of a calculation that is based on either the Price v. Destination or # of
Items vs Destination condition.

If charging a handling fee, set Calculate Handling Fee to one of the following:
l

Fixed

Percent

Then, enter the Handling Fee rate according to the method used to calculate the fee.

Magento Commerce User Guide

1013

Table Rates

CHAPTER 64: Basic Shipping Methods

If the handling fee is based on a percent, enter the whole number without the percent sign.

In the Displayed Error Message box, type the message that appears when this method is
not available.

Set Ship to Applicable Countries to one of the following:

All Allowed
Countries

Customers from any country specified in your store configuration
can use table rate shipping.

Specific Countries

After choosing this option, the “Ship to Specific Countries” list
appears. Select each country where customers can use table rate
shipping.

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

When complete, tap Save Config .

Table Rates

1014

Magento Commerce User Guide

CHAPTER 64: Basic Shipping Methods

Table Rates

Step 2: Prepare the Table Rate Data
1.

In the upper-left corner, set Store View to “Main Website,” or to any other website where the
configuration applies. When prompted to confirm, tap OK.
The Export and Import options now appear in the Table Rates section, with “Use Default”
checkboxes to the right of each option.
To change any of the current settings, you must first clear the “Use Default” checkbox next to the
field.

To change the Condition, clear the Use Default checkbox. Then, choose another option.

Tap Export CSV . Then, save the tablerates.csv file to your computer.

Export CS
4.

Open the file in a spreadsheet. Then, complete the table with appropriate values for the
shipping calculation condition.
l

Use an asterisk (*) as a wildcard to represent all possible values in any category.

The Country column must contain a valid three-character code for each row.

Sort the data by Region/State so the specific locations are at the top of the list, and the
wildcard locations at the bottom. This will process the rules with the absolute values first,
and the wildcard values later.

Magento Commerce User Guide

1015

Table Rates

CHAPTER 64: Basic Shipping Methods

Weight vs. Destination (Australia)
5.

When complete, save the tablerates.csv file.

Step 3:Import the Table Rate Data
1.

Return to the Table Rates section of your store configuration.

In the upper-left corner, set Store View to the website where this method will be used.

Next to the Import field, tap Choose File . Select your completed tablerates.csv file, and import
the rates.

Import Table Rates
4.

1016

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 64: Basic Shipping Methods

Table Rates

Step 4: Verify the Rates
To make sure that the table rate data is correct, go through the payment process with several
different addresses to make sure the shipping and handling rates are calculated correctly.

Example 1: Price v. Destination
This example uses the Price v. Destination condition to create a set of three different shipping
rates based on the amount of the order subtotal for the continental United States, Alaska, and
Hawaii. The asterisk (*) is a wildcard that represents all values.

COUNTRY

REGION /
STATE

ZIP / POSTAL
CODE

ORDER
SUBTOTAL
(and above)

SHIPPING
PRICE

USA

100

USA

100

USA

100

USA

Magento Commerce User Guide

1017

Table Rates

CHAPTER 64: Basic Shipping Methods

Example 2: Weight v. Destination
This example uses the Weight v. Destination condition to create different shipping rates based on the
weight of the order.

REGION /
STATE

COUNTRY

ZIP / POSTAL
CODE

WEIGHT (AND

ABOVE)

SHIPPING
PRICE

AUS

39.95

AUS

19.95

AUS

VIC

19.95

AUS

VIC

5.95

AUS

39.95

AUS

19.95

AUS

29.95

AUS

9.95

Example 3: Restrict Free Shipping to the Continental United States
1.

Create a tablerates.csv file that includes all the state destinations to which you are
willing to provide free shipping.

Complete the table rate configuration with the following settings:

SETTING

VALUE

Condition

Price v. Destination

Method Name

Free Shipping

Ship to Applicable Countries

Specific Countries

Ship to Specific Countries

Select only United States

Show method if not applicable No
3.

1018

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

Magento Commerce User Guide

CHAPTER 64: Basic Shipping Methods

Dimensional Weight

Dimensional Weight
Dimensional weight, sometimes called volumetric weight, is a common industry practice that
bases the transportation price on a combination of weight and package volume. In simple
terms, dimensional weight determines the shipping rate based on the amount of space a
package occupies in the cargo area of the carrier. Dimensional weight is typically used when a
package is relatively light compared to its volume.
All major carriers apply dimensional weight to some shipments. However, the manner in which
dimensional weight pricing is applied varies from one carrier to another.
We recommend that you use Magento Shipping to calculate dimensional weight for all
carriers.If your company has a high volume of shipments, even a slight difference in shipping
price can translate to thousands of dollars over the course of a year.

Magento Commerce User Guide

1019

1020

Magento Commerce User Guide

CHAPTER 65:

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

Provides accelerated revenue growth, and boost business efficiency.

Manages multiple carriers from a single, integrated portal.

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

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

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

Changes in the Latest Release
Release 2.2.5
New Feature
l

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

Other Enhancements
l

Batch Processing MVP
Easier to batch-process large shipments.

Improved pagination in Admin

Multi-version API

Magento Commerce User Guide

1021

Quick Look

CHAPTER 65: Magento Shipping

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

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

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

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

1022

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Quick Look

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

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

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

Magento Commerce User Guide

1023

Quick Look

CHAPTER 65: Magento Shipping

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

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

Shipping Rate and Carrier

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

Collection Point Selection

1024

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

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

Step 1: Sign Up for Magento Shipping
1.

On the Admin sidebar under Settings, choose Configuration.

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

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

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

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

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

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

Complete the Early Access to Magento Shipping form.

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

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

Magento Commerce User Guide

1025

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Early Access to Magento Shipping

Step 2: Generate Your API Tokens
1.

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

Take a moment to read the Getting Started steps.

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

Magento Shipping Portal

1026

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

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

Account Details
5.

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

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

Test API Token

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

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

API Tokens

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

Set Enabled to “Yes.”

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

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

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

Magento Commerce User Guide

1027

Setting Up Magento Shipping

API Endpoint

Account ID

API Token

CHAPTER 65: Magento Shipping

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

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

Enable Collection Points at Checkout
6.

Complete the following settings as needed.
a.

1028

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

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

Specific Countries

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

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

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

Shows the Magento Shipping method only when applicable.

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

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

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Magento Shipping

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

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

Magento Shipping Options During Checkout

Magento Commerce User Guide

1029

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

To complete the Checkout View Settings, tap Configure.

Configure Checkout View Settings
2.

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

Checkout View Settings
3.

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

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

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

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

Address Type
4.

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

Authority to Leave
5.

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

Signature Required

1030

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

When complete, tap Save.

Advanced Settings
1.

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

Configure Advanced Settings
2.

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

To synchronize shipment entities, mark the Shipment checkbox.

Advanced Settings
4.

When complete, tap Save Config.

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

Locations

To add a new shipping location:
1.

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

Tap Create New Location. Then, do the following.

Magento Commerce User Guide

1031

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

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

Set the location Type to one of the following:

Store

Warehouse

Drop Shipper

Headquarters

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

Basic Settings
3.

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

) button, or

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

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

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

Address
6.

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

) button, or refer

to the Field Descriptions at the end of this topic.

1032

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Contact
7.

When complete, tap Save Config.

Magento Commerce User Guide

1033

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Field Descriptions
FIELD

DESCRIPTION

Location Name

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

Type

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

Enable Click & Collect

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

ADDRESS
Type

Identifies the type of address. Options: Business/Residential

Country

The country where the shipping facility is located.

Address Line 1

The street address of the shipping location.

Address Line 2

Additional street address information, if needed.

City

The city where the shipping facility is located.

State / Province

The state or province where the shipping facility is located.

Zip / Postal Code

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

Dependent Locality

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

Longitude

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

Latitude

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

CONTACT

1034

Organisation Name

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

Person First Name

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

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Field Descriptions (cont.)
FIELD

DESCRIPTION

Person Last Name

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

National Identification
Number

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

Tax Identification Number

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

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

Phone Number

The telephone number of the shipping location.

Fax Number

The fax number of the shipping location.

Magento Commerce User Guide

1035

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

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

Shipping Partners

To add a new carrier:
1.

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

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

1036

To complete the setup, click Connect.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Shipping Partners
4.

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

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

Step 1
b.

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

Magento Commerce User Guide

1037

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Step 2
c.

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

Step 3

To edit an existing carrier:

1038

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

Make the necessary changes to the carrier profile.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

When complete, tap Save.

Field Descriptions
FIELD

DESCRIPTION

Carrier Connection
Nickname

The name that is used for the carrier during checkout.

Locations

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

Services

Identifies each shipping service that is provided by the carrier.

Magento Commerce User Guide

1039

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

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

Packaging

To add a package:
1.

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

Enter the Name of the package.

Choose the package Type.

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

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

Basic Settings

1040

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

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

)

button, or refer to the Field Descriptions at the end of this topic.

Outer Dimensions
3.

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

)

button, or refer to the Field Descriptions at the end of this topic.

Inner Dimensions
4.

When complete, tap Save Config.

Field Descriptions
FIELD

DESCRIPTION

Name

The name of the packaging type.

Type

Describes the basic packaging type. Options:
Box
Carton
Crate
Cylinder
Document Envelope
Flat Pack
Letter
Pallet
Parcel
Satchel/Bag
Other

Magento Commerce User Guide

1041

Setting Up Magento Shipping

CHAPTER 65: Magento Shipping

Field Descriptions (cont.)
FIELD

DESCRIPTION

Tare Weight

The weight of the empty container that is used to calculate the
shipment load when added to content weight.

Tare Weight Unit

The unit of measurement that is used to describe tare weight.
g

Gram

Ounce

Kilogram

Pound

Maximum Weight

The maximum weight allowed for this packaging type.

Maximum Weight Unit

The unit of measurement that is used to describe the maximum
weight.
g

Gram

Ounce

Kilogram

Pound

OUTER DIMENSIONS
Length

The package length when measured from the outside.

Width

The package width when measured from the outside.

Height

The package height when measured from the outside.

Unit

Determines the unit of measurement for the outer dimensions of the
package. Options:
cm

Centimeter

Inch

Meter

Millimeter

Foot

INNER DIMENSIONS

1042

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Setting Up Magento Shipping

Field Descriptions (cont.)
FIELD

DESCRIPTION

Length

The package length when measured from the inside.

Width

The package width when measured from the inside.

Height

The package height when measured from the inside.

Unit

Determines the unit of measurement for the inner dimensions of the
package. Options:

Magento Commerce User Guide

Centimeter

Inch

Meter

Millimeter

Foot

1043

Shipping Experience Rules

CHAPTER 65: Magento Shipping

Shipping Experience Rules
The Shipping Experiences tab of the Magento Shipping Portal allows you to create rules to
automate the shipping process. You can create the following types of rules:
Qualification

Qualification rules control the availability of the rule. For example, you
can add conditions that determine when the shipping method becomes
available, and set the shipping charge.

Quoting

Quoting rules control the list of available carriers that appears when you
get quotes for a shipment.

To create a shipping experience rule:
1.

Choose the Shipping Experiences tab. Then, tap Create New Experience.

Shipping Experiences
3.

Enter a Name for the rule.

For now, accept the default Status of “Draft.”
When you are ready to “go live” with the rule in your store, you can change the Status to
“Production.”

1044

Click the tab for the type of experience that you want to create:
l

Qualification

Quoting

Tap Create Rule. Then, follow the instructions for the type of rule:

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Shipping Experience Rules

New Experience

Qualification Rule
1.

Enter a brief Description of the rule.

Click Add Condition. Then, do the following:
a.

Set Input to the shipping parameter that the condition is based upon.

Choose the Operator that is needed to describe the condition.

Enter the Value that is needed to complete the condition.

To add another condition, click Add Condition. Then, repeat these steps.

Conditions
3.

In the Outcomes section, do the following:
a.

Choose the Action that is applied when the conditions are met.

Enter the Shipping Method Label that appears during checkout.

Choose the Currency to be used to display the shipping charge.

To add an additional action, click Add Outcome.

Magento Commerce User Guide

1045

Shipping Experience Rules

CHAPTER 65: Magento Shipping

Outcomes
4.

When complete, tap Save.
The description of the new rule appears in the list of Qualification Rules on the
Qualification tab.

Qualification Rules
5.

Tap Finish to return to the Shipping Experiences tab.

Quoting Rule
1.

Enter a brief Description of the rule.

Click Add Condition. Then, do the following:
a.

1046

Set Input to one of the following parameters:
l

Destination Country

Destination Postal Code

Choose the Operator that is needed to describe the condition.

Select each Country or Postal Code that is needed to complete the condition.

To add another condition, click Add Condition. Then, repeat these steps.

Magento Commerce User Guide

CHAPTER 65: Magento Shipping

Shipping Experience Rules

Conditions
3.

In the Outcomes section, do the following:
a.

Choose one of the following Action to apply when the conditions are met:
Quote with
All Carriers

The rule applies to all available carriers.

Quote with Carrier Allows you to choose specific carriers to be available for the
Services
rule.
b.

Enter the Shipping Method Label that appears during checkout.

Choose the Currency to be used to display the shipping charge.

To add an additional action, click Add Outcome.

Outcomes
4.

When complete, tap Save.

The description of the new rule appears in the list of Quoting Rules on the Quoting tab.

Quoting Rules
5.

Tap Finish to return to the Shipping Experiences tab.

Magento Commerce User Guide

1047

Troubleshooting

CHAPTER 65: Magento Shipping

Troubleshooting
The following issues have been identified in this release of Magento Shipping.
Currency Conversion
Issue

Currency conversion problem for shipping methods during checkout
when store supports multiple currencies.

Workaround

Follow these best practices to ensure that the experience currency,
base currency, and display currency are the same:
l

The Magento base currency is the same as the experience
currency.
The Magento currency rates are the same as the experience and
base currency.

Shipping Experience Rules

1048

Issue

When a user chooses a shipping method during checkout, Magento
might select two shipping methods.

Workaround

Make sure that only one rule with a “Show Shipping Method”
outcome can be applied to a single scenario. Consider these
example rules:
Rule 1:

Show 'Free Shipping' for Country is Canada
and Cost is not greater than $99.99

Rule 2:

Show 'Free Shipping' for Country is not
Canada and Cost is greater than $100

Magento Commerce User Guide

CHAPTER 66:

Carriers
If you have a commercial account with a supported carrier, you can offer your customers the
convenience of choosing that carrier during checkout. The rates are automatically downloaded,
so you do not need to look up the information.
Before you can offer your customers a selection of shipping carriers, you must first complete the
shipping settings to establish the point of origin for your store. Then, complete the
configuration for each carrier service that you want to offer. The configuration options vary for
each carrier. However, all require that you first open a shipping account with the carrier, and
enter your account number or user ID, and the gateway URL to their system into the
configuration of your store. See Magento Connect for additional shipping services for your
Magento Commerce installation.

Magento Commerce User Guide

1049

CHAPTER 66: Carriers

See the online user guide for step-by-step configuration instructions for the following carriers:

UPS
United Parcel Service offers domestic and international
shipping services by land and air to more than 220
countries.

USPS
The United States Postal Service is the independent
postal service of United States government. USPS
offers domestic and international shipping services by
land and air.

FedEx
Offers domestic and international shipping services by
land and air to more than 220 countries.

DHL
Offers integrated international services and tailored,
customer-focused solutions for managing and
transporting letters, goods and information.

1050

Magento Commerce User Guide

CHAPTER 67:

Shipping Labels
Magento Commerce includes a high level of integration with major shipping carriers, which
gives you access to carrier shipping systems to track orders, create shipping labels, and more.
Shipping labels can be created for regular shipments and products with return merchandise
authorization. In addition to the information provided by the shipping carrier, the label also
includes the Magento order number, number of the package, and the total quantity of packages
for the Magento shipment.

USPS Priority Shipping Label

Magento Commerce User Guide

1051

Shipping Label Workflow

CHAPTER 67: Shipping Labels

Shipping Label Workflow
Shipping labels can be produced at the time a shipment is created, or later. Shipping labels are
stored in PDF format and are downloaded to your computer.
Administrator submits shipping label request. The store Administrator completes
the information necessary to generate labels, and submits the request.

Request sent to carrier. Magento contacts the shipping carrier, and creates an order in
the carrier’s system. A separate order is created for each package that is shipped.

Carrier sends label and tracking number. The carrier sends the shipping label and
tracking number for the shipment.
l

A single shipment with multiple packages receives multiple shipping labels.
If you generate the same shipping labels multiple times, the original tracking numbers
are preserved.
For returned products with RMA numbers, the old tracking numbers are replaced with
new ones.

Administrator downloads and prints the label. After the shipping label is generated,
the new shipment is saved and the label can be printed. If the shipping label cannot be
created due to problems with the connection or any other reason, the shipment is not
created.
Depending on your browser settings, the PDF file can be opened and printed. Each label
appears on a separate page in the PDF.

1052

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Configuring Shipping Labels

Configuring Shipping Labels
The following settings must be made at the product level, as well as in the configuration of
each carrier that is used to print labels. To print labels, all carriers require that you open an
account. Then, complete the configuration in your store for each carrier that you plan to use.

Step 1: Verify the Country of Manufacture
The country of manufacture is required for all products that are shipped internationally by
USPS and FedEx, If you have many products that need to be updated, you can either import
the updates, or use the Inventory grid to update multiple records.
1.

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

Method 1: Update a Single Record
a.

In the grid, find the product to be updated, and open in edit mode.

In the panel on the left under Advanced Settings, choose Autosettings.

Update the Country of Manufacture field.

When complete, tap Save.

Country of Manufacture

Magento Commerce User Guide

1053

Configuring Shipping Labels

CHAPTER 67: Shipping Labels

Method 2: Update Multiple Records
a.

In the grid, mark the checkbox of each product to be updated. For example, all products
that are manufactured in China.

Set the Actions control to “Update Attributes.” Then, tap Submit.

In the Update Attributes form, find the Country of Manufacture field and mark the
Change checkbox. Then, choose the country.

When complete, tap Save.

Step 2: Verify the Store Information
1.

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

In the panel on the left, under Sales, choose Shipping Settings. then, do the following:
a.

Expand

the Origin section, and verify that the following fields are complete:

Street Address

The street address of the place from which shipments are sent. For
example, the location of your company or warehouse. This field is
required for shipping labels.

Street Address
Line 2

Any additional address information, such as the floor, entrance and
so on. We strongly recommend that you use this field.

Origin
b.

In the panel on the left under Sales, choose Shipping Methods. Then, expand
USPS section, and verify that the following fields are complete:
Secure Gateway
URL

Magento automatically enters the gateway URL.

Password

The password is provided by USPS, and gives you access to their
system through Web Services.

Length, Width

The default dimensions of the package. To make these fields
appear, set Size to “Large.”

Height, Girth

1054

the

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Expand

Configuring Shipping Labels

the FedEx section, and verify that the following fields are complete:

Meter Number

Key

Password

This information is provided by the carrier, and is required to gain access to their system
through Web Services.
d.

In the panel on the left under General, choose General. Expand
section, and verify that the following fields are complete:

the Store Information

Store Name

The name of the store or store view.

Store Contact
Telephone

The telephone number of the primary contact for the store or store
view.

Country

The country where your store is based.

VAT Number

If applicable the Value Added Tax number of your store. (Not
required for stores based in the U.S.)

Store Contact
Address

The street address of the primary contact for the store or store view.

If you have multiple stores, and the contact information differs from the default, set Store
View for each, and verify that the information is complete. If the information is missing,
you’ll get an error when you try to print the labels.

Store Information
3.

When complete, tap Save Config.

Magento Commerce User Guide

1055

Configuring Shipping Labels

CHAPTER 67: Shipping Labels

Carrier Requirements
CARRIER

1056

REQUIREMENTS

USPS

Requires a USPS account. As of February 23, 2018, USPS requires all
shipping labels to include postage.

UPS

Requires a UPS account. Shipping labels are available only for shipments
that originate in the U.S. Specific credentials are required for stores outside
the US.

FedEx

Requires a FedEx account. For stores outside of the U.S., shipping labels
are supported for international shipments only. FedEx does not allow
domestic shipments that originate outside of the U.S

DHL

Requires a DHL account. Shipping labels are supported only for shipments
that originate in the U.S.

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Creating Shipping Labels

Creating Shipping Labels
To create shipping labels, you must first set up your shipping carrier account to support labels.
Then, follow the prompts to enter a description of the package and its contents.
Process Overview:
Step 1: Contact Your Shipping Carriers
Step 2: Update the Configuration for Each Carrier
Step 3: Create Shipping Labels
Step 4: Print the Labels

Step 1: Contact Your Shipping Carriers
Before you begin, make sure that your shipping accounts are set up to process labels. Some
carriers might charge an additional fee to add shipping labels to your account.
1.

Contact each carrier that you use to activate shipping labels for your store.

Follow the instructions provided by each carrier to add shipping label support to your account.
FedEx

Contact FedEx Web Services regarding their label evaluation process.

USPS

Contact uspstechsupport@esecurecare.net to request that API Signature
Confirmation V3 be enabled for your live USPS API Access account.

UPS

Contact UPS to confirm your account type supports shipping labels. To
generate shipping labels, you must use the UPS XML option.

DHL

Contact the DHL Resource Center to learn more about their services or send
an inquiry through their Contact Center.

Step 2: Update the Configuration for Each Carrier
1.

Make sure that your Store Information is complete.

Follow the instructions below for each carrier account that has been activated for label printing.

Magento Commerce User Guide

1057

Creating Shipping Labels

CHAPTER 67: Shipping Labels

UPS Configuration
United Parcel Service ships both domestically and internationally. However, shipping labels
can be generated only for shipments that originate within the United States.
1.

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

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

Expand

the UPS section. Then, verify that your UPS Shipper Number is correct. Your

Shipper Number appears only when United Parcel Service XML is enabled.
4.

When complete, tap Save Config.

USPS Configuration
The United States Postal Service ships both domestically and internationally.
1.

Continuing in the Shipping Methods configuration, expand

the USPS section. Then, do

the following:
a.

Verify that the Secure Gateway URL is entered. The correct URL should be entered
automatically.

1058

Enter the Password provided to you by USPS.

Set Size to “Large.” Then, enter the following dimensions:
l

Length

Width

Height

Girth

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Creating Shipping Labels

FedEx Configuration
FedEx ships domestically and internationally. Stores located outside the United States can
create FedEx labels for international shipments only.
1.

Continuing in the Shipping Methods configuration, expand

the FedEx section. Then,

make sure that the following FedEx credentials are correct:

Meter Number

Key

Password

When complete, tap Save Config.

DHL Configuration
DHL provides international shipping services.
1.

Continuing in the Shipping Methods configuration, expand

the DHL section. Then, do the

following:

Verify that the Gateway URL is entered. The correct URL should be entered automatically.

Make sure that the following credentials are complete:
l

Access ID

Password

Account Number

When complete, tap Save Config.

Magento Commerce User Guide

1059

Creating Shipping Labels

CHAPTER 67: Shipping Labels

Step 3: Create Shipping Labels
Process Overview:
Method 1: Create Label for New Shipment
Method 2: Create Label for Existing Shipment

Method 1: Create Label for New Shipment
1.

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

Find the order in the grid, and open the record. The status of the order must be either
“Pending” or “Processing.”

In the upper-right corner, tap Ship. Then, confirm the shipping information according to
carrier requirements.

In the lower-right corner, mark the Create Shipping Label checkbox. Then, tap Submit
Shipment, and do the following:
a.

To add products from the order to the package, tap Add Products. The Quantity
column shows the maximum number of products that are available for the package.

Mark the checkbox of each product to be added to the package, and enter the
Quantity of each. Then, tap Add Selected Product(s) to Package.

To add a new package, tap Add Package.

To delete a package, tap Delete Package.
If you use a package type other than the default, or require a signature, the cost of shipping
might differ from what you have charged the customer. Any difference in the cost of shipping is
not reflected in your store.

When complete, tap OK.

If you need to cancel an order, tap Cancel. A shipping label will not be created, and the Create
Shipping Label checkbox is cleared.
Magento connects to the shipping carrier system, submits the order, and receives a shipping
label and tracking number for each package.
l

If the label is successfully created, the shipment is submitted, the tracking number
appears in the form, and the label is ready to print.

If the carrier cannot create the label due to the problems with connection, or for any
other reason, the shipment is not processed.

1060

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Creating Shipping Labels

Method 2: Create Label for Existing Shipment
1.

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

Find the order in the grid, and open the Shipping form. Then, do the following:
a.

In the Shipping and Tracking Information section, tap Create Shipping Label.

Distribute the ordered product(s) to the appropriate package(s), and tap OK.

To review the package information, tap Show Packages.

Magento connects to the shipping carrier system, submits an order, and receives a shipping
label and a tracking number.
If a shipping label for this shipment already exists in the system, it is replaced with a new one.
However, existing tracking numbers are not replaced. Any new tracking number is added to
the existing one.

Step 4: Print the Labels
Shipping labels are generated in PDF format, and can be printed from the Admin. Each label
includes the order number and package number.
Because an individual shipment order for each package is created, multiple shipping labels might
be received for a single shipment.

Process Overview:
Method 1: Print Label from Shipment Form
Method 2: Print Labels for Multiple Orders

Magento Commerce User Guide

1061

Creating Shipping Labels

CHAPTER 67: Shipping Labels

Method 1: Print Label from Shipment Form
1.

On the Admin sidebar, tap Sales. Then, do one of the following:
l

Choose Orders. Find the order in the grid, and open the record. In the panel on the left,
choose Shipments. Then, open the shipment record.

Choose Shipments. Find the order in the grid, and open the record.

To download the PDF file, go to the Shipping and Tracking section of the form, and tap
Print Shipping Label. Depending on your browser settings, the shipping labels can be
viewed and printed directly from the PDF file.

The Print Shipping Label button appears only after the carrier generates labels for the
shipment. If the button is missing, click Create Shipping Label. The button appears after
Magento receives the label from the carrier.

Method 2: Print Labels for Multiple Orders
1.

On the Admin sidebar, tap Sales. Then, choose one of the following:
l

Orders

Shipments

In the grid, mark the checkbox of each order with shipping labels to be printed.

Set the Actions control to "Print Shipping Labels."

Tap Submit.

A complete set of shipping labels is printed for each shipment that is related to the selected
orders.

Required Carrier Configuration Settings
SETTING
Type

DESCRIPTION
Package types differ by carrier and method. The default package
type for each carrier is initially selected.
USPS does not require the package type for domestic shipments.

1062

Customs Value

(International shipments only) The declared value or sales price of the
contents of an international shipment.

Total Weight

The total weight of all products added to the package is calculated
automatically. The value can also be changed manually, and entered
as pounds or kilograms.

Length, Width, Height

(Optional) The package dimensions are used for custom packages
only. You can specify the measurements units as inches or
centimeters.

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Creating Shipping Labels

Required Carrier Configuration Settings (cont.)
SETTING

DESCRIPTION
Not Required

No confirmation of delivery is sent to the
store by the shipping carrier.

No Signature

A delivery confirmation without the signature
of the recipient is sent to the store by the
shipping carrier.

Signature Required

The shipping carrier obtains the signature of
the recipient and provides the store with a
printed copy.

Direct

(FedEx Only) FedEx obtains a signature from
someone at the delivery address. If no one is
available to sign for the package, the carrier
tries to deliver the package at another time.

Indirect

(FedEx Residential Deliveries Only) FedEx
obtains the signature of someone, possibly a
neighbor or building manager, at the delivery
address. The recipient can leave a signed
FedEx door tag to authorize the package to
be left without anyone present to sign for it.

Contents

(USPS Only) Select one of the following
descriptions of the package:
Gift
Documents
Commercial Sample
Returned Goods
Merchandise
Other

Magento Commerce User Guide

Explanation

(USPS Only) A detailed description of the
package contents.

Adult Required

The shipping carrier obtains the signature of
an adult recipient and provides the store with
a printed copy.

1063

Creating Shipping Labels

CHAPTER 67: Shipping Labels

Label Packages
The Create Packages window appears when you choose to create a shipping label. You can start
configuring the first package immediately.

To configure a package:
1.

Complete the fields as described below.
If you select the non-default value in the Type field or choose to require a signature confirmation,
the price of a shipment may differ from the one you charged to the customer.

To view a list of shipped products and add them to the package, tap Add Products.
The Qty column shows the maximum quantity that is available to add. For the first package,
the number is the total quantity of the product to be shipped.

Specify the products and quantities. To add the products to the package, tap Add Selected
Product(s) to Package.
l

To add a new package, tap Add Package. You can add several packages, and edit them at
the same time.

To delete a package, tap Delete Package.

After products are added to the package, the quantity cannot be edited directly.

To increase the quantity:
1.

Tap Add Selection .

Enter the additional quantity.

The number is added to the previous quantity of the product in the package.

1064

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Creating Shipping Labels

To decrease the quantity:
1.

Delete the product from the package.

Tap Add Selection.

Enter the new, smaller value.

After you distribute all products, the total number of the packages you are going to use equals
the number of the last package in the list. The OK button is disabled until all shipped items are
distributed to packages, and all necessary information is complete.
4.

When complete, tap OK to generate the labels.
If you need to stop the process, tap Cancel. The packages are not saved, and the shipping label
process is canceled.

Magento Commerce User Guide

1065

Creating Shipping Labels

CHAPTER 67: Shipping Labels

Field Descriptions
FIELD
Type

DESCRIPTION
Specifies the type of a package. Select one of the predefined values.
Available package types are different for each shipping carrier.
When the Create Packages pop-up window opens, the default
package for the shipping carrier appears in the Type field. If you
select a package that is not designed by a shipping carrier, you must
enter the dimensions of the package.
For shipping labels created for DHL, FedEx, and UPS shipments, the
“Type of Goods” field is set to “Merchandise.” For USPS, the Type
field reflects the value from the Contents field in the Create
Packages window.

1066

Total Weight

The total weight of a package. The field is pre-populated with the total
weight of products in a package. The unit of measurement can be set
to either pounds or kilograms.

Length

The length of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The unit of
measurement can be set to either inches or centimeters.

Magento Commerce User Guide

CHAPTER 67: Shipping Labels

Creating Shipping Labels

Field Descriptions (cont.)
FIELD

DESCRIPTION

Width

The width of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The measurement
units can be specified using the drop-down menu next to the Height
field; select between inches and centimeters.

Height

The height of a package, integer and floating point numbers. The field
is enabled if the custom package type is used. The measurement
units can be specified using the drop-down menu next to the Height
field; select between inches and centimeters.

Signature

Confirmation Defines delivery confirmation. Options:
Not Required

No delivery confirmation letter is sent to you.

No Signature

A delivery confirmation letter without a
recipient’s signature is sent to you.

Signature Required

The shipping carrier obtains the recipient’s
signature and provides you with its printed
copy.

Adult Required

The shipping carrier obtains the adult
recipient’s signature and provides you with
its printed copy.

Direct (FedEx only)

FedEx obtains a signature from someone at
the delivery address and reattempts delivery
if no one is available to sign for the package.

Indirect (FedEx
only)

FedEx obtains a signature in one of three
ways: (1) from someone at the delivery
address; (2) from a neighbor, building
manager or other person at a neighboring
address; or (3) the recipient can leave a
signed FedEx Door Tag authorizing release
of the package without anyone present.
Available for residential deliveries only.
The options may vary slightly for different
shipping methods. For the most up to date
information refer to shipping carrier’s
resources.

Magento Commerce User Guide

1067

Creating Shipping Labels

CHAPTER 67: Shipping Labels

Field Descriptions (cont.)
FIELD
Contents

DESCRIPTION
(Available for USPS shipments only) Description of the package
contents. Options:
Gift
Documents
Commercial Sample
Returned Goods
Merchandise
Other

Explanation

1068

(USPS shipments only) Detailed description of the package content.

Magento Commerce User Guide

REPORTS

1069

Contents
In this section of the guide, you will learn how to
filter data and online generate reports. The report
data can be opened in a spreadsheet or imported
into other applications.

Reports Menu
Statistics
Marketing
Reviews
Sales
Customers
Products
New Relic Reporting
New Relic Queries

1070

CHAPTER 68:

Reports Menu
Magento Commerce provides a wide selection of reports to keep you informed on your
marketing efforts, sales products, and customer activity. The Reports menu provides easy
access to current information about your sales, products, customers, and promotions.

Reports Menu

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

Magento Commerce User Guide

1071

Menu Options

CHAPTER 68: Reports Menu

Menu Options
Marketing
A selection of marketing reports, including Products in Cart, Search Terms, Abandoned Carts, and
Newsletter Problem Reports.

Reviews
The selection of product review reports includes By Customer and By Product.

Sales
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and settlement
reports for PayPal and Braintree.

Customers
The selection of customer reports includes Order Total, Order Account, and New.

Products
The selection of product reports includes Views, Bestsellers, Low Stock, Ordered, and Downloads.

Statistics
Statistics is a tool that reduces the performance impact of generating reports by calculating and storing
statistical data. Rather than recalculate the statistics every time a report is generated, the stored statistics
are used until you refresh the statistics.

Business Intelligence
The Advanced Reporting dashboard gives you valuable insight with a dynamic set of product, order, and
customer reports, powered by Magento Business Intelligence. for more sophisticated reporting and
analysis, sign up for a free trial of BI-Essentials.

1072

Magento Commerce User Guide

CHAPTER 68: Reports Menu

Refresh Statistics

Refresh Statistics
To reduce the performance impact of generating sales reports, Magento calculates and stores
the required statistics for each report. Rather than recalculate the statistics every time a report
is generated, the stored statistics are used, unless you refresh the statistics. To include the
most recent data, the report statistics must be refreshed before a sales report is generated.

Refresh Statistics

To refresh report statistics:
1.

On the Admin sidebar, tap Reports. Then under Statistics, choose Refresh Statistics.

In the list, mark the checkbox of each report to be refreshed.

Set the Actions control to one of the following:

Refresh Lifetime Statistics

Refresh Statistics for the Last Day

When complete, tap Submit .

Magento Commerce User Guide

1073

1074

Magento Commerce User Guide

CHAPTER 69:

Marketing Reports
Marketing reports provide information about the status of shopping carts, the use of search
terms, and newsletter transmissions.

Products in Cart Report

Magento Commerce User Guide

1075

Reports

CHAPTER 69: Marketing Reports

Reports
Products in Cart
The Products in Cart Report lists all products currently in
shopping carts, and includes the name and price of each
item, the number of carts with the item, and the number
of times each item has been ordered.

Search Terms
The Search Terms Report shows what your customers
are looking for in each store view. The report includes the
number of matching items found in the catalog, and how
many times the search term has been used.

Abandoned Carts
The Abandoned Carts Report lists all registered
customers who have abandoned carts that have not yet
expired. The report includes the customer name and
email address, the number of products in the cart and
subtotal, the date created, and date last updated.

Newsletter Problems
The Newsletter Problems Report includes information
about any newsletter queue that failed to transmit
successfully. The report includes the name of each
subscriber, and queue date and subject, the information
about the error.

1076

Magento Commerce User Guide

CHAPTER 70:

Review Reports
The Review Reports provide information about product reviews by customer and by product.
l

By Customers

By Products

Review Report by Product

Magento Commerce User Guide

1077

Reports

CHAPTER 70: Review Reports

Reports
By Customers
The Customer Reviews Report lists all customer who
have submitted product reviews. The report includes the
number of reviews submitted by each customer, and a
link to the list of reviews.

By Products
The Product Reviews Report lists all products that have
been reviewed by customers. The report includes the
number of reviews and average rating, the product was
last reviewed, and a link to the list of reviews for each
product.

1078

Magento Commerce User Guide

CHAPTER 71:

Sales Reports
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and
PayPal Settlement.

Shipping Report

Magento Commerce User Guide

1079

Reports

CHAPTER 71: Sales Reports

Reports
Orders
The Orders Report can be filtered by time interval, date
and status. The report includes the number of orders
placed and canceled, with totals for sales, amounts
invoiced, refunded, tax collected, shipping charged, and
discounts.

Tax
The Tax Report can be filtered by time interval, date, and
status. The report includes the tax rule applied, tax rate,
number of orders, and amount of tax charged.

Invoiced
The Invoice Report can be filtered by time interval, date,
and status. The report includes the number of orderss
and invoices during the time period, with amounts
invoiced, paid, and unpaid.

1080

Magento Commerce User Guide

CHAPTER 71: Sales Reports

Reports

Shipping
The Shipping Report can be filtered by time interval, date,
and status. The report includes the number of orders for
carrier or shipping method used,with amounts for total
sales shipping and and total shipping.

Refunds
The Refunds Report can be filtered by time interval, date,
and status. The report includes the number of refunded
orders, and total amount refunded online and offline.

Coupons
The Coupons Report can be filtered by time interval,
date, and status. The report includes each coupon code
used during the specified time interval, related price rule,
and number of times used with totals and subtotals for
sales and discounts.

PayPal Settlement
The PayPal Settlement Report can be filtered by date,
merchant account, transaction ID, invoice ID, or PayPal
reference ID. The report includes the type of event, such
as a debit card transaction, the start and finish dates,
gross amount, and related fees. The report can be
automatically updated with the most current data from
PayPal.

Magento Commerce User Guide

1081

1082

Magento Commerce User Guide

CHAPTER 72:

Customer Reports
Customer reports provide insight into customer activity during a specified period of time or
date range.

Order Total Report

Magento Commerce User Guide

1083

Reports

CHAPTER 72: Customer Reports

Reports
Order Total
The Order Total Report shows customer orders for a
specified time interval or date range. The report includes
the number of orders per customer, average order
amount, and total amount.

Order Count
The Order Count Report shows the number of orders per
customer for a specified time interval or date range. The
report includes the number of orders per customer,
average order amount, and total amount.

New Accounts
The New Accounts Report shows the number of new
customer accounts opened during a specified time
interval or date range.

1084

Magento Commerce User Guide

CHAPTER 73:

Product Reports
The product reports give you insight regarding products viewed and ordered, bestsellers, stock
levels, and downloads.

Product Views Report

Magento Commerce User Guide

1085

Reports

CHAPTER 73: Product Reports

Reports
Product Views
The Product Views Report shows the products that have
been viewed during a time interval or range of dates. The
report includes the product name, price, and number of
views.

Bestsellers
The Bestsellers Report shows the five top-selling five
during an interval of time or date range. The report
includes the product name, price, and quantity ordered.

Low Stock
The Low Stock Report lists all products with stock levels
within a specified range.

1086

Magento Commerce User Guide

CHAPTER 73: Product Reports

Reports

Ordered Products
The Ordered Products Report lists all products ordered
for a specified time interval or date range. The report
includes the product name and quantity ordered.

Downloads
The Downloads Report lists all downloads during the
specified time interval or date range. The report includes
the product name, download link, and SKU, with the
number of purchases and downloads.

Magento Commerce User Guide

1087

1088

Magento Commerce User Guide

Business Intelligence

1089

Contents
Magento advanced reporting and business
intelligence tools give you the insight you
need to make sound business decisions.
Analyze your top-performing customers,
products, and promotions to find new
opportunities for growth. Then, share the
insights across your organization with just a
few clicks.

1090

Advanced Reporting
BI Essentials
New Relic Reporting

CHAPTER 74:

Advanced Reporting
Advanced Reporting gives you access to a suite of dynamic reports that are based on your
product, order, and customer data, with a personalized dashboard that is tailored to your
business needs. Advanced Reporting is a free, cloud-based service that is powered by Magento
Business Intelligence.
For technical information, see Advanced Reporting in our developer documentation.

Advanced Reporting Dashboard

Requirements
The website must run on a public web server.

The domain must have a valid security (SSL) certificate.
Magento must have been installed or upgraded successfully without error.

In the Magento configuration, the Base URL (Secure) setting for the store view must point
to the secure URL. For example https://yourdomain.com

Magento Commerce User Guide

1091

CHAPTER 74: Advanced Reporting

In the Magento configuration, Use Secure URLs on Storefront, and Use Secure URLs in
Admin must be set to “Yes.”
Make sure that Magento crontab is created and cron jobs are running on the installed server.

The initial release of Advanced Reporting supports only one base currency.

Step 1: Enable Advanced Reporting
In the Magento configuration, Advanced Reporting is enabled by default, and starts
automatically if cron is configured and running. An attempt to establish the subscription is
initiated at the beginning of each hour over the next 24-hours until successful. The
subscription status is “pending” until the subscription is successfully established.
1.

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

In the panel on the left, choose General. Then under Advanced Reporting, do the following:
a.

Verify that Advanced Reporting Service is set to “Enable.” (This is the default setting.)

Set the Time of day to send data to the hour, minute, and second, according to a 24-hour
clock, that you want the service to receive updated data from your store. By default, data
is sent at 2:00 AM.

Under Industry Data, choose the Industry that best describes your business.

Advanced Reporting
3.

When complete, tap Save Config.

When prompted, click the Cache Management in the message at the top of the page. Then,
refresh any invalid caches.

1092

Magento Commerce User Guide

CHAPTER 74: Advanced Reporting

Wait overnight, or until after the time of your next scheduled update. Then, check the status of
your subscription. If the status is still “pending,” make sure that your installation meets all of
the requirements.

Step 2: Access Advanced Reporting
1.

Do one of the following:
l

In the Admin sidebar, choose Dashboard. Then, tap Advanced Reporting.

On the Admin sidebar, choose Reports. Then under Business Intelligence, choose
Advanced Reporting.

The Advanced Reporting dashboard provides a quick summary of your orders, customers, and
products. Make sure to scroll down to see the full dashboard.
2.

To get a better view of the data, set the Filters in the upper-right corner to the time period and
store view that you want to include in the report. Then, do the following:
l

Hover over any data point for more information.

Click each tab to see all dashboard reports.

Data Point

Magento Commerce User Guide

1093

CHAPTER 74: Advanced Reporting

To access your data resources:
1.

In the upper-right corner of the Advanced Reporting dashboard, click Additional Resources.

Troubleshooting
If you get a 404 “Page Not Found” message, verify that your store meets the requirements for
Advanced Reporting. Then, follow the instructions to verify that the integration is installed.

Advanced Reporting Not Available

1094

Magento Commerce User Guide

CHAPTER 74: Advanced Reporting

Verify that the Integration is Active
1.

On the Admin menu, choose System. Then under Extensions, choose Integration.

Verify that the Magento Analytics user integration appears in the list, and that the Status is
“Active.”

To reestablish the user, click Reauthorize. Then, do the following:

Reauthorize
a.

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

Reauthorize Access to API Resources
b.

Verify that the list of Integration Tokens for Extensions is complete. Then, tap Done.

Magento Commerce User Guide

1095

CHAPTER 74: Advanced Reporting

Integration Tokens
4.

Look for the message that indicates the integration “Magento Analytics user” has been
reauthorized.

Wait overnight, or until after the time of your next scheduled update.

Dashboard Reports
FIELD

DESCRIPTION

ORDERS

1096

Revenue

Shows all revenue received by the store view during the defined time
period.

Orders

Shows all orders placed through the store view during the defined
time period.

AOV

Shows the average order value placed through the store view during
the defined time period.

Refunds

Shows all refunds processed through the store view during the
defined time period.

Tax Collected

Shows all tax collected through the store view during the defined time
period.

Shipping Collected

Shows all shipping fees collected through the store view during the
defined time period.

Orders by Status

Shows the number of orders by status, for the store view during the
defined time period.

Orders by Status

Lists a summary of the number of orders by status.

Magento Commerce User Guide

CHAPTER 74: Advanced Reporting

Dashboard Reports (cont.)
FIELD

DESCRIPTION

Coupon Usage

Lists all coupon codes and the number of users for each, redeemed
through the store view during the defined time period.

Orders and Revenue by
Billing Region

Lists the number of orders and revenue by region for the store view
during the defined time period.

Tax Collected by Billing
Region

Lists the amount of tax collected by region for the store view during
the defined time period.

Shipping Fees Collected
by Shipping Region

Lists the shipping fees collected by region for the store view during
the defined time period.

CUSTOMERS
Unique Customers

Shows the number of unique customer accounts associated with the
store view during the defined time period.

New Registered Accounts

Shows the number of new customer accounts registered with the
store view during the defined time period.

Top Coupon Users

Lists the top coupon users by Customer ID, and the number of orders
placed with coupons for the store view during the defined time period.

Customer KPI Table

Lists the number of orders, revenue, and average order value by
Customer ID for the store view during the defined time period.

PRODUCTS
Quantity of Products Sold

Shows the number of products sold through the store view during the
defined time period.

Products Added to
Wishlists

Lists all products added to wishlists through the store view during the
defined time period.

Best Selling Products by
Quantity

Lists the best-selling products and quantity sold through the store
view during the defined time period.

Best Selling Products by
Revenue

Lists the best-selling products and revenue generated by the sale of
the product through the store view during the defined time period.

Magento Commerce User Guide

1097

1098

Magento Commerce User Guide

CHAPTER 75:

BI Essentials
Magento Business Intelligence is a cloud-based subscription service that gives you access to
sophisticated dynamic reports. You can sign up for a seven-day free trial from the Reports
section of the Admin. The price for continued access is based on your monthly gross
merchandise (GMV) volume, and starts at $100 per month.
The instructions in this section walk you through the setup, and introduce some basic features
of Magento BI Essentials. For more detailed information, see the Magento BI Help Center.

To sign up for Magento BI Essentials:
1.

On the Admin sidebar, choose Reports. Then under Business Intelligence, choose
BI Essentials.

Choose the range of Your Annual GMV. Then, tap Join Now.

Complete the sign-up form. Then, tap Create Account.

Magento Commerce User Guide

1099

CHAPTER 75: BI Essentials

Create Account
4.

When prompted, enter a password for your account.
Your password must be eight characters long, and include at least one special character.

Enter Your Password
5.

Check your email for a Welcome message from the Magento BI Team, with your login
credentials. To learn more, see the Essentials Quick Start Video Series.

To access Magento BI Essentials:
Method 1: From the Admin
1.

From the Dashboard of your store, tap Go to Advanced Reporting.

In the upper-right corner, click Additional Resources. Then under Magento Business
Intelligence, choose Magento BI Website.

1100

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Your Data Resources

Method 2: From your browser
1.

Go to the Magento BI website.

Enter your Email Address and Password. Then, tap Sign In.

Your Magento BI dashboard appears.

Magento Commerce User Guide

1101

CHAPTER 75: BI Essentials

Magento BI Essentials Dashboard

1102

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Dashboards

Dashboards
BI Dashboards give you a quick view of your store’s performance and sales activity at a glance.
Individual dashboards can be shared with other users, and organized into logical groups. You
can also set different levels of permission to others users.
It’s easy to create a new report, add it to a dashboard, and export the data to Excel. Charts and
reports can be resized and dragged into position on the dashboard.

Dashboard

To create a new dashboard:
1.

On the menu, choose Dashboards.

The name of the default dashboard appears in the upper-left corner of the dashboard header.
Click the down arrow (

) to show the available options.

Create Dashboard

Magento Commerce User Guide

1103

Dashboards

CHAPTER 75: BI Essentials

Tap Create Dashboard. Then, do the following:
a.

Enter a Name for your dashboard.

To create a new Group for the dashboard, enter the name of the group.
For example, if your Magento installation has multiple store views, you might create a
Group for each store view.

Tap Create.

Dashboard Name
d.

The name of your new dashboard appears in the upper-left corner. Click the down arrow to
show the options. If you created a group, the new dashboard appears below the group in
the list.

Add Report
4.

1104

To add a report, do one of the following:
l

Click the Add a report prompt on the page.

In the dashboard header, click Add Report.

Click Create Report. to show the Report Builder Options.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Dashboards

Report Builder Options

To arrange items on a dashboard:
l

To resize a chart or report, drag the lower-right corner to the new size.

To move a chart or report, hover over the title or header until the cursor changes to a cross.
Then, drag it into position.

To manage dashboard settings:
1.

On the menu, choose Manage Data. Then in the sidebar, choose Dashboards.

If applicable, enter a new Dashboard Name.

To assign the dashboard to a specific Dashboard Group, choose from the list of groups.

Permissions
To give all users the same level of access to the dashboard, do the following:
1.

Under Shared with, choose one of the following options:
l

View

Edit

None

When prompted for confirm, tap OK to update the permissions level for each user.

To change the permission level of an individual, find the user in the list change the
permission level. The change is automatically saved.

To make this dashboard the default for your BI Essentials account, tap Make Default.

To remove the dashboard, tap Delete Dashboard.

Magento Commerce User Guide

1105

Report Builder

CHAPTER 75: BI Essentials

Report Builder
Visual Report Builder
The Visual Report Builder is the easiest way to visualize
your data. Create charts, add metrics, and segment your
data all with a few clicks.

SQL Report Builder
The SQL Report Builder gives you the power to directly
query your data warehouse, view the results, and quickly
transform them into a chart.

1106

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Visual Report Builder
Visual Report Builder makes it easy to create quick reports based on predefined metrics. Each
metric includes a query that defines the set of data for the report.
The following example shows how to create a simple report, group the data by an additional
dimension, set the date and time interval, change the chart type, and save the report to a
dashboard.

To create a simple report:
1.

In the BI Essentials menu, choose Report Builder.

Under Visual Report Builder, tap Create Report. Then, do the following:
a.

Tap Add Metric.
The available metrics can be listed alphabetically or by table.

Visual Report Builder
b.

Choose the metric that describes the set of data that you want to use for the report.
The New Customers metric used in this example counts all customers, and sorts the list by
the date the customer signed up for an account. The initial report includes a simple line
graph, followed by the table of data.
The summary on the left shows the name of the current metric, followed by the result of
any calculations on column data that are specified in the metric. In this example, the
summary displays the total customer count.

Magento Commerce User Guide

1107

Report Builder

CHAPTER 75: BI Essentials

Visual Report Builder
3.

In the chart, hover over each data point on the line. Each data point shows the total number of
new customers who signed up during that month.

Follow these instructions to group the data, change the date range, and chart type.

Group By
The Group By control gives you the ability to add multiple dimensions by group or segment.
Dimensions are columns in the table that can be used to group the data.
1.

Choose one of the available dimensions from the list of Group By options.
For this example, the system found five coupon codes that were used by customers while
placing their first order.

Group by
2.

The Group By detail lists each coupon used by customers. The coupons that were used to
place the initial order are marked with a checkbox The chart now has multiple colored
lines that represent the each coupon that was used for a first order. The legend is colorcoded to correspond to each row of data.
Click Apply to close the Group By detail.

1108

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Multiple Dimensions
3.

Hover over a few data points on each line to see the number of customers during the
month who used that coupon while placing their first order.

The table of data now has an addition dimension, with a column for each month, and a
row for each coupon code.

Group by Table Data
5.

Click the Transpose (
orientation of the data.

) control in the upper-right corner of the table to change the

The axis of the data is flipped, and the table now has a column for each coupon code, and
a row for each month. You might find this orientation easier to read.

Transposed Data

Magento Commerce User Guide

1109

Report Builder

CHAPTER 75: BI Essentials

Date Range
The Date Range control shows the current date range and time interval settings, and is located
just above the chart to the right.
1.

Click the Date Range control, which in this example is set to “All-Time by Month.”

Date Range
2.

Make the following changes:
a.

To zoom in for a closer view, change the date range to Last Full Quarter.

Under Select Time Interval, choose “Week.”

When complete, tap Save.

The report now includes only the data for the last quarter, by week.

Report for Last Quarter by Week

Chart Type
Click the controls in the upper-right corner to find the best chart for the data.
Some chart types are not compatible with multidimensional data.

1110

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Line graph

Horizontal Bar

Horizontal Stacked Bar

Vertical Bar

Vertical Stacked Bar

Pie

Area

Funnel

To give the report a title, replace the “Untitled Report” text at the top of the page with a
descriptive title.

In the upper-right corner, tap Save. Then do the following:
a.

For Type, accept the default setting, “Chart.”

Choose the Dashboard where the report is to be available.

Tap Save to Dashboard.

Magento Commerce User Guide

1111

Report Builder

CHAPTER 75: BI Essentials

Save to Dashboard
7.

To view the chart in a dashboard, do one of the following:
l

Click Go to Dashboard in the message at the top of the page.

In the menu, choose Dashboards. Click the name of the current dashboard to display the
list. Then, click the name of the dashboard where the report was saved.

Report in Dashboard

Filters
One or more filter(s) can be added to limit the data that is used to product a report. Each filter
is an expression that includes a column from the associated table, an operator, and a value. For
example to include only repeat customers, you might create a filter that includes only
customers who have placed more than one order. Multiple filters can be used with logical
“AND/OR” operators to add logic to the report.
A report can have a maximum of 3,500 data points. To reduce the number of data points, use a filter
to reduce the amount of data that is used to generate the report.

1112

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Magento BI includes a selection of filters that you can use “out of the box,” or modify to suit
your needs. There is no limit to the number of filters you can create.

To add a filter
1.

In the chart, hover over each data point. In this report, each data point shows the total number
of customers for the month.

In the panel on the left, click the Filters (

) icon.

Add Filter
3.

Tap Add Filter.
Filters are numbered alphabetically, and the first is [A]. The first two parts of the filter are
drop-down lists of options, and the third part is a value.

Magento Commerce User Guide

1113

Report Builder

CHAPTER 75: BI Essentials

Click the first part of the filter, and choose the column that you want to use as the subject
of the expression.

Choose First Part of Filter
b.

Click the second part of the filter, and choose the operator.

Choose the Operator
c.

1114

In the third part of the filter, enter the value that is needed to complete the expression.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Enter the Value
d.

When the filter is complete, tap Apply.
The report now includes only repeat customers, and the number of customer records
retrieved for the report has been reduced from 33K to 12.6k.

Filtered Report
4.

In the sidebar, click the Perspective (

) icon.

Perspective
5.

In the list of settings, choose Cumulative. Then, tap Apply.

Magento Commerce User Guide

1115

Report Builder

CHAPTER 75: BI Essentials

Cumulative Perspective
The Cumulative perspective distributes the change over time, rather than showing the jagged
up and downs for each month.
6.

Enter a Title for the report. Then, Save it as a Chart to your dashboard.

Save to Dashboard

Formulas
A formula combines multiple metrics and mathematical logic to answer a question. For
example, how much of the revenue per product during the holiday season was generated by
new customers?

1116

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Holiday Sales in Dashboard

Step 1: Create the Basic Report
1.

In the menu, choose Report Builder.

Tap Add Metric, and choose the first metric for the report.
For this example, the “Revenue by products ordered” metric is used.

Tap Add Metric again, and choose the second metric for the report.
For this example, the “New Customers” metric is used.

In the sidebar, click Details to display information about each metric.

Revenue by Products Ordered

Magento Commerce User Guide

1117

Report Builder

CHAPTER 75: BI Essentials

In the sidebar, click the name of each metric to open the settings page in a new browser tab.
Scroll down to see each component of the metric, including the metric query, filter, and
dimensions.

Metric Settings
6.

To return to your report, click the previous browser tab.

In the chart, hover over a few data points on each line to see the amounts associated with each
metric.

Step 2: Add a Formula
1.

At the top of the sidebar, tap Add Formula.
The formula box shows the metrics as available inputs A and B, and includes an input box
where you can enter the formula.
Do the following:
a.

In the Enter your Formula input box, enter “A/B”.
This will divide the revenue by products ordered by the number of new customers.

1118

Set Select format to “123Number.”

In the sidebar, replace “Untitled” with a name for the formula.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Formula Settings
2.

When complete, tap Apply.
The report now has a new line for the formula, “New Customer Revenue,” and the sidebar
shows the total amount of revenue generated by new customers.

Report with Formula

Step 3: Add a Date Range
1.

Click the Date Range control in the upper-right corner.

On the Fixed Date Range tab, do the following:
a.

On the calendars, choose the date range.
For this example, the holiday season is from November 1 through December 31.

Under Select Time Interval, choose “Day.”

Magento Commerce User Guide

1119

Report Builder

CHAPTER 75: BI Essentials

Fixed Date Range
c.

When complete, click Apply.
The report is now limited to the holiday season, with a data point for each day.

Fixed Date Range

Step 4: Save the Report
In this step, you will save the report as a chart, and also as a table.
1.

Click the “Untitled Report” text at the top of the page, and enter a descriptive title. For this
example, the report title is “2017 Holiday Sales.”
Then, do the following:

1120

In the upper-right corner, tap Save.

For Type, accept the default setting, “Chart.”

Choose the Dashboard where the report is to be available.

Tap Save to Dashboard.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Report Builder

Click the report title, and change the name. For this example, the report title is changed to
“2017 Holiday Sales Data”
Then, do the following:

In the upper-right corner, tap Save a Copy.

Set Type to “Table.”

Choose the Dashboard where the report is to be available.

Tap Save a Copy to Dashboard.

To see the reports in your dashboard, do one of the following:
l

Click Go to Dashboard in the message at the top of the page.

In the menu, choose Dashboards. Click the name of the current dashboard to display the
list. Then, click the name of the dashboard where the report was saved.

Magento Commerce User Guide

1121

Manage Data

CHAPTER 75: BI Essentials

Manage Data
Manage Data provides access to a variety of tools for managing integrations, report and chart
data, dashboards, and exports.

To access Manage Data:
1.

In the menu, choose Manage Data.

In the sidebar, choose the topic that you want under the following headings:
l

Data Sources

Manage Data

Export Data

Manage Data

1122

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Metrics
Each report includes at least one query that defines the set of data, or “metrics” for the report.
The metrics statement describes the data that is to be retrieved, and consists of an operator,
column, table, and sorting order. Magento BI includes a set of default, “out of the box” metrics
that can be easily customized. You can create an unlimited number of custom metrics.

To access the available metrics:
1.

On the menu, choose Manage Data.

In the sidebar, choose Metrics.

Metrics
3.

Click the name of any metric to display detailed information. To show the Metric Options,
click the Settings (

) icon on the right.

Metric Detail

Magento Commerce User Guide

1123

Manage Data

CHAPTER 75: BI Essentials

Click Details to display more information about the metric.

Metrics

Default Metrics by Table
FIELD

DESCRIPTION

customer_entity
Avg first 30 day revenue

Avg lifetime coupons

Average on the Customer’s first 30 day revenue column in the
customer_entity table (Change) ordered by the created_at (use)
column

Filter A

Seconds since customer’s first order date
>=2592000

Filter B

Registered accounts we count (Saved Filter
Set)

Average on the Customer’s lifetime number of coupons column in
the customer_entity table (Change) ordered by the created_at
(use) column

Filter A

Avg lifetime orders

Average on the Customer’s lifetime number of orders column in
the customer_entity table (Change) ordered by the created_at
(use) column

Filter A

1124

Registered accounts we count (Saved Filter
Set)

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Default Metrics by Table (cont.)
FIELD
Avg Lifetime revenue

DESCRIPTION
Average on the Customer’s lifetime number of orders column in
the customer_entity table (Change) ordered by the created_at
(use) column

Filter A

New Customers

Count on the entity_id column in the customer_entity table
(Change) ordered by the created_at (use) column

Filter A

Registered accounts

Registered accounts we count (Saved Filter
Set)

Count on the entity_id column in the customer_entity table
(Change) ordered by the created_at (use) column

Filter A

Registered accounts we count (Saved Filter
Set)

customer_group
New Metric

Count on the customer_group_id column in the customer_group

table (Change) ordered by the [NONE] column

sales_flat_order
Avg order value

Average on the base_grand_total column in the sales_flat_order

table (Change) ordered by the created_at (use) column

Filter A
Avg time between orders

Orders we count (Saved Filter Set)

Average on the Seconds since previous order column in the sales_

flat_order table (Change) ordered by the created_at (use) column

Filter A

Magento Commerce User Guide

Orders we count (Saved Filter Set)

1125

Manage Data

CHAPTER 75: BI Essentials

Default Metrics by Table (cont.)
FIELD
Median time between
orders

DESCRIPTION
Median on the Seconds since previous order column in the sales_
flat_order table (Change) ordered by the created_at (use) column

Filter A
New Metric 2
(Number of orders)

Count on the entity_id column in the sales_flat_order table

(Change) ordered by the [input] created_at (use) column

Filter A
Orders

Orders we count (Saved Filter Set)

Count on the entity_id column in the sales_flat_order table

(Change) ordered by the [input] created_at (use) column

Filter A
Revenue

Orders we count (Saved Filter Set)

Sum on the base_grand_total column in the sales_flat_order table

(Change) ordered by the created_at (use) column

Filter A
Shipping

Sum on the base_shipping_amount column in the sales_flat_order
table (Change) ordered by the created_at (use) column

Filter A
Tax

Orders we count (Saved Filter Set)

Sum on the base_tax_amount column in the sales_flat_order table

(Change) ordered by the created_at (use) column

Filter A
Unique Customers

Orders we count (Saved Filter Set)

Count Distinct Values on the customer_email column in the sales_
flat_order table (Change) ordered by the created_at (use) column

Filter A

Orders we count (Saved Filter Set)

sales_flat_order_item

1126

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Default Metrics by Table (cont.)
FIELD
Products Ordered

DESCRIPTION
Sum on the qty_ordered column in the sales_flat_order_item table

(Change) ordered by the created_at (use) column

Filter A
Revenue by products
ordered

Ordered products we count (Saved Filter Set)

Sum on the Order item total value (quantity * price) column in the

sales_flat_order_item table (Change) ordered by the created_at
(use) column

Filter A

Ordered products we count (Saved Filter Set)

Metric Options
FIELD
Operator

DESCRIPTION
Average
Count
Sum
Average
Maximum Value
Minimum Value
Count Distinct Values
Median
First Quartile
Third Quartile
Tenth Percentile
Ninetieth Percentile

Table

addresses
categories
customer_entity
customer_group
sales_flat_order
sales_flat_order_address
sales_flat_order_item

Magento Commerce User Guide

1127

Manage Data

CHAPTER 75: BI Essentials

Metric Options (cont.)
FIELD
Target Column by Table

DESCRIPTION
customer_entity

Customer’s first 30 day revenue
Customer’s lifetime number of coupons
Customer’s lifetime number of orders
Customer’s lifetime revenue
entity_id
group_id
Seconds since customer’s first order date

customer_group

customer_group_id

sales_flat_order

base_grand_total
base_shipping amount
base_tax_amount
billing_address_id
Customer’s lifetime number of coupons
Customer’s lifetime number of orders
Customer’s lifetime revenue
customer_id
entity_id
Number of items in order
Seconds between customer’s first order date
and this order
Seconds since previous order
shipping_address_id
store_id

sales_flat_order_
item

base_price
Customer’s lifetime number of orders
Customer’s lifetime revenue
item_id
Order item total value (quantity * price)
order_id
product_id
qty_ordered

Order Column

[NONE]
created_at (use)
updated_at
[input] created at

1128

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Filter Sets
A filter set is based on a table, and can include multiple statements with logic to select the data
for a report or chart. Magento BI includes several default filter sets that you can use “as is” or
modify. There is no limit to the number of filter sets that you can create.
A filter set can be applied to any metric that uses the same table. To learn more, see Creating
filter sets for metrics in the Magento BI Help Center.

To see the available filter sets:
1.

On the menu, choose Manage Data. Then in the sidebar under Manage Data, choose Filter
Sets.

Click Expand All to display the detail of each filter set that is currently available.

Filter Sets

To create a new filter set:
1.

In the upper-right corner of the Filter Sets page, tap Create New Filter Set. Then, do the
following:

Create Filter Set

Magento Commerce User Guide

1129

Manage Data

CHAPTER 75: BI Essentials

Under Select a Table, choose the table upon which the filter set is based.

Select a Table
b.

Enter the Filter Set Name.

Tap Add Filter. Then, follow the instructions to build each part of the expression.

Add Filter

To add another filter, tap Add Filter. Then, build the expression.

To complete the Filter Logic, use the AND/OR operators to describe how multiple
statements in the filter are to be applied.

When complete, tap Save.
The new filter appears in the list of Available Filter Sets by Table.

Default Filters by Table
FIELD
customer_entity

DESCRIPTION
Registered accounts we count (Saved Filter Set)
created_at (use)
Customer’s first 30 day revenue
Customer’s first order’s billing region
Customer’s first order’s coupon code

1130

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Manage Data

Default Filters by Table (cont.)
FIELD

DESCRIPTION
Customer’s first order date
Customer’s group code
Customer’s lifetime number of coupons
Customer’s lifetime number of orders
Customer’s lifetime revenue
email
entity_id
group_id
Seconds since customer’s first order date
updated_at
[input] created at

sales_flat_order

Orders we count (Saved Filter Set)
base_grand_total
base_shipping_amount
base_tax_amount
Billing address city
Billing address country
Billing address region
billing_address_id
coupon_code
created_at (use)
Customer’s creation date
Customer’s first order date
Customer’s group code
Customer’s lifetime number of coupons
Customer’s lifetime revenue
Customer’s order number
Customer’s order number (previous-current)
customer_email
customer_id
entity_id
Is customer’s last order?
Number of items in order
order_currency_code
Seconds between customer’s first order date and this order

Magento Commerce User Guide

1131

Manage Data

CHAPTER 75: BI Essentials

Default Filters by Table (cont.)
FIELD

DESCRIPTION
Seconds since previous order

sales_flat_order_item

Ordered products we count(Saved Filter Set)
base_price
created_at (use)
Customer’s lifetime number of orders
Customer’s lifetime revenue
Customer’s order number
item_id
name
Order’s coupon_code
Order item total value (quantity * price)
order_id
product_id
product_type
qty_ordered
sku
updated_at
[input] created_at

1132

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Export Data

Export Data
Raw report data can be exported from the Magento BI data warehouse to a CSV or Excel file.
You can also create a list of raw, exported data from tables that refreshes every 15 seconds to
ensure that the data is always current.

To export report data:
1.

In the header of a report, click the Settings (

) control.

Report Settings
2.

Choose one of the following options:
l

Full CSV Export

Full Excel Export

Watch the bottom of the window for the export file. Then, open the file.

Exported Data in Excel

To create an export list:
1.

On the menu, choose Manage Data.

In the sidebar under Export Data, choose Raw Data Export.

Magento Commerce User Guide

1133

Export Data

CHAPTER 75: BI Essentials

Raw Data Export
3.

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

Choose the Table.

Choose Table
b.

Enter the Export Name.

Under Available Columns, tap Add All.

Choose Columns
d.

1134

If you want to add a filter, tap Add Filter. Then, follow the instructions to create a filter
for the exported data.

Magento Commerce User Guide

CHAPTER 75: BI Essentials

Export Data

The filters in this example includes all customers who placed their first order during the
2018 holiday season.

Filters
4.

When ready, tap Export Data.
Look for a message that says the export is successfully queued. The export appears in the list
when the process is complete.

Export List
5.

To download the exported data, tap Download. Then, look for the exported zip file at the
bottom of the window.

Magento Commerce User Guide

1135

1136

Magento Commerce User Guide

CHAPTER 76:

New Relic Reporting
New Relic is a SaaS based subscription service that provides detailed real-time visibility into
business and performance metrics for data-driven decision making.

Step 1: Sign Up for a New Relic Account
1.

Visit the New Relic website, and sign up for an account. You can also sign up for a free trial
account.

Follow the instructions on the site. When prompted choose the product that you want to
install first.

While you are in your account, locate the following credentials that you will need to complete
the configuration:
Account ID

From your New Relic account dashboard, the Account ID is the number in
the URL after: /accounts

Application ID

From your New Relic account dashboard, tap New Relic APM. In the menu,
choose Applications. Then, choose your application. The Application ID is
the number in the URL after: /applications/

New Relic API Key

From your New Relic account dashboard, tap Account Settings. In the menu
on the left under Integrations, choose Data Sharing. Your API key can be
created, regenerated, or deleted from this page.

Insights API Key

From your New Relic account dashboard, tap Insights. In the menu on the
left under Administration, choose API Keys. Your Insights API Key(s) appear
on this page. If necessary, click the plus sign (+) next to Insert Keys to
generate a key.

Step 2: Install the New Relic Agent on Your Server
To use New Relic APM Pro to gather and transmit data, the PHP agent must be installed on
your server.
1.

When prompted to choose a web agent, tap PHP.

Follow the instructions to set up the PHP agent on your server. If you need help, see: New Relic
for PHP.

Make sure that cron is running on your server. To learn more, see: Configure and run cron.

Magento Commerce User Guide

1137

CHAPTER 76: New Relic Reporting

Step 3: Configure Your Store
1.

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

In the panel on the left under General, choose New Relic Reporting. Then, do the following:

New Relic Reporting

Set Enable New Relic Integration to “Yes.”

In the Insights API URL, replace the percent (% symbol with your New Relic Account ID.

Enter your New Relic Account ID.

Enter your New Relic Application ID.

Enter your New Relic API Key.

Enter you Insights API Key.

In the New Relic Application Name field, enter a name to identify the configuration for
internal reference.

When complete, tap Save Config.

Step 4: Enable Cron for New Relic Reporting
1.

Expand

the Cron section.

Cron

1138

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

Set Enable Cron to”Yes.

When complete, tap Save Config.

New Relic Queries
New Relic Insights data is based on statements that are written in New Relic Query Language
(NRQL), as well as any custom parameters that you might include. Data can be returned from
adhoc queries, or by queries saved to your dashboard. To learn more, see the NRQL Reference in
the New Relic documentation.

Admin Events
Active Admin Users
Widget Name:

Active Admin Users

Description:

Returns the number of active admin users.

SELECT uniqueCount(AdminId)
FROM Transaction
WHERE appName='' SINCE 15 minutes ago

Currently Active Admins
Widget Name:

Currently Active Admins

Description:

Returns the names of active admin users.

SELECT uniques(AdminName)
FROM Transaction
WHERE appName='' SINCE 15 minutes ago

Recent Admin Activity
Widget Name:

Recent Admin Activity

Description:

Returns the number of recent admin actions.

SELECT count(AdminId)
FROM Transaction
WHERE appName ='' FACET AdminName SINCE 1 day ago

Magento Commerce User Guide

1139

New Relic Queries

CHAPTER 76: New Relic Reporting

Latest Admin Activity
Widget Name:

Latest Admin Activity

Description:

Returns detail information about recent admin actions, including the admin
username, duration, and application name.

SELECT AdminName, duration, name
FROM Transaction
WHERE appName='' AND AdminName IS NOT NULL
AND AdminName != 'N/A' LIMIT 50

Cron Events
Category Count
Widget Name:

Category Count

Description:

Returns the number of application events by category during the specified
time period.

SELECT average(CatalogCategoryCount)
FROM Cron
WHERE CatalogCategoryCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Current Catalog Count
Widget Name:

Current Catalog Count

Description:

Returns the average number of application events in the catalog by category
during the specified time period.

SELECT average(CatalogCategoryCount)
FROM Cron
WHERE CatalogCategoryCount IS NOT NULL
AND CatalogCategoryCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

1140

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

Active Products
Widget Name:

Active Products

Description:

Returns the number of application events by product during the specified
time period.

SELECT average(CatalogProductActiveCount)
FROM Cron
WHERE CatalogProductActiveCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Active Product Count
Widget Name:

Active Product Count

Description:

Returns the average number of active application events by product during
the specified time period.

SELECT average(CatalogProductActiveCount)
FROM Cron
WHERE CatalogProductActiveCount IS NOT NULL
AND CatalogProductActiveCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

Configurable Products
Widget Name:

Configurable Products

Description:

Returns the average number of application events forconfigurable products
during the specified time period.

SELECT average(CatalogProductConfigurableCount)
FROM Cron
WHERE CatalogProductConfigurableCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Configurable Product Count
Widget Name:

Configurable Product Count

Description:

Returns the average number of application events by configurable product
during the specified time period.

Magento Commerce User Guide

1141

New Relic Queries

CHAPTER 76: New Relic Reporting

SELECT average(CatalogProductConfigurableCount)
FROM Cron
WHERE CatalogProductConfigurableCount IS NOT NULL
AND CatalogProductConfigurableCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

Product Count (all)
Widget Name:

Product Count (all)

Description:

Returns the total number of application events for all products.

SELECT average(CatalogProductCount)
FROM Cron
WHERE CatalogProductCount IS NOT NULL
AND appName = '' TIMESERIES 2 minutes

Current Product Count (all)
Widget Name:

Current Product Count (all)

Description:

Returns the average number of application events for all products during the
specified time period.

SELECT average(CatalogProductCount)
FROM Cron
WHERE CatalogProductCount IS NOT NULL
AND CatalogProductCount > 0
AND appName = '>' SINCE 2 minutes ago LIMIT 1

Customer Count
Widget Name:

Customer Count

Description:

Returns the average number of application events by customer.

SELECT average(CustomerCount)
FROM Cron
WHERE CustomerCount IS NOT NULL

1142

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

AND CustomerCount > 0
AND appName = '' TIMESERIES 2 minutes

Currrent Customer Count
Widget Name:

Current Customer Count

Description:

Returns the average number of customers during the specified time
period.

SELECT average(CustomerCount)
FROM Cron
WHERE CustomerCount IS NOT NULL
AND CustomerCount > 0
AND appName = '' SINCE 2 minutes ago LIMIT 1

Module Status
Widget Name:

Module Status

Description:

Returns the average number of times application modules are enabled,
disabled, or installed during the specified time period.

SELECT average(ModulesDisabled), average(ModulesEnabled), average
(ModulesInstalled)
FROM Cron
WHERE appName = '' TIMESERIES 2 minutes

Current Module Status
Widget Name:

Current Module Status

Description:

Returns the average number of times modules were enabled, disabled, or
installed during the specified time period.

SELECT average(ModulesDisabled), average(ModulesEnabled), average
(ModulesInstalled)
FROM Cron
WHERE appName = '' SINCE 2 minutes ago LIMIT 1

Magento Commerce User Guide

1143

New Relic Queries

CHAPTER 76: New Relic Reporting

Website and Store Counts
Widget Name:

Website and Store Counts

Description:

Returns the average number of application events by website and store
during the specified time period.

SELECT average(StoreViewCount), average(WebsiteCount)
FROM Cron
WHERE appName = '' TIMESERIES 2 minutes

Current Website and Store Counts
Widget Name:

Current Website and Store Counts

Description:

Returns the average number of current application events during the
specified tim e period.

SELECT average(StoreViewCount), average(WebsiteCount)
FROM Cron
WHERE appName = '' SINCE 2 minutes ago LIMIT 1

Cron - All Data from Event
Widget Name:

Cron - All Data from Event

Description:

Returns all application event data.

SELECT *
FROM Cron
WHERE appName = ''

Customers
Active Customer Count
Widget Name:

Active Customer Count

Description:

Returns the number of active customers during the specified time period.

SELECT uniqueCount(CustomerId)
FROM Transaction

1144

Magento Commerce User Guide

CHAPTER 76: New Relic Reporting

New Relic Queries

WHERE appName = '' SINCE 15 minutes ago

Active Customers
Widget Name:

Active Customers

Description:

Returns the names of active customers during the specified time period.

SELECT uniques(CustomerName)
FROM Transaction
WHERE appName='' SINCE 15 minutes ago

Top Customers
Widget Name:

Top Customers

Description:

Returns the top customers during the specified time period.

SELECT count(CustomerId)
FROM Transaction
WHERE appName = '' FACET CustomerName SINCE 1 day ago

Recent Admin Activity
Widget Name:

Recent Admin Activity

Description:

Returns a defined number of records of recent activity, that include the
customername and duration of visit.

SELECT CustomerName, duration, name
FROM Transaction
WHERE appName=''
AND CustomerName IS NOT NULL
AND CustomerName != 'N/A' LIMIT 50

Orders
Number of Orders Placed
Widget Name:

Number of Orders Placed

Description:

Returns the number of orders placed during the specified time period.

Magento Commerce User Guide

1145

New Relic Queries

CHAPTER 76: New Relic Reporting

SELECT count(`Order`)
FROM Transaction SINCE 1 day ago

Total Order Value
Widget Name:

Total Order Value

Description:

Returns the total number of line items ordered during the specified time
period.

SELECT sum(LineItemCount)
FROM Transaction SINCE 1 day ago

Total Line Items Ordered
Widget Name:

Total Line Items Ordered

Description:

Returns the total number of line items ordered during the specified time
period.

SELECT sum(LineItemCount)
FROM Transaction SINCE 1 day ago

1146

Magento Commerce User Guide

CHAPTER 77:

Marketing Automation
The Marketing Automation section of the Reports menu includes a wide selection of reports to
help you track campaign activity and performance.

Marketing Automation Reports

To access Marketing Automation reports:
1.

On the Admin sidebar, choose Reports.

In the menu under Marketing Automation, choose one of the following reports:
l

Importer Status

Automation Enrollment

Campaign Sends

Cron Tasks

Dashboard

Log Viewer

Abandoned Carts

Magento Commerce User Guide

1147

1148

Magento Commerce User Guide

OPERATIONS

1149

U.S. Tax Guidelines

Stores

Canadian Tax Guidelines

In this section of the guide, you’ll learn how to
set up a store hierarchy, create attributes, and
manage the settings used by each store to
calculate taxes, and currency rates,

EU Tax Guidelines

Stores Menu

Warning Messages
Currency
Currency Configuration
Currency Symbols

All Stores
Adding Store Views

Updating Currency Rates
Attributes

Editing a Store View
Adding a Language
Translating Products

Creating an Attribute

Translating Content

Attribute Sets

Adding Stores
Adding Websites
Store URLs
Using a Custom Admin URL
Configuration
Taxes
General Tax Settings
Cross-Border Price Consistency
Tax Rules
Tax Classes
Configuring Tax Classes
Default Tax Destination
EU Place of Supply for Digital Goods
Fixed Product Tax
Configuring FPT
Price Display Settings
Tax Zones and Rates
Import/Export Tax Rates
Value Added Tax (VAT)
Configuring VAT
VAT ID Validation
Configuring VAT ID Validation
Tax Quick Reference
International Tax Guidelines

1150

Product Attributes

CHAPTER 78:

Stores Menu
The Stores menu manages settings that are used less frequently, but referenced throughout your
Magento installation, including setting up the store hierarchy, configuration, sales and order
settings, tax and currency, product attributes, product review ratings, and customer groups.

Stores Menu

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

Magento Commerce User Guide

1151

Menu Options

CHAPTER 78: Stores Menu

Menu Options
All Stores
Manage the hierarchy of websites, stores and store
views in your Magento installation, and all configuration
settings. In addition, you can set up the Terms and
Conditions of a sale, and manage order status settings.

Taxes
Set up the tax rules for your store, define customer and
product tax classes, and manage tax zones and rates.
You can also import tax rate data into your store.

Currency
Manage the rates for the currencies that are accepted as
payment in your store, and customize the currency
symbols that appear in product prices and sales
documents.

Attributes
Manage attributes that are used for product information
and product ratings. You can create new attributes, edit
existing attributes, and manage attribute sets.

Shipping
Manage the Carrier, Location, and Packaging profiles for
Magento Shipping.

1152

Magento Commerce User Guide

CHAPTER 79:

All Stores
When Magento Commerce is installed, a hierarchy that includes a main website, store, and
store view is created. You can create additional websites, stores, and store views, as needed. For
example, in addition to your main website, you might have a additional websites with a
different domain. Within each website, you can have multiple stores, and within each store,
separate store views. Many installations have one website and one store, but with multiple
store views to support different languages.
Before you begin, plan your store hierarchy in advance because it is referred to throughout the
configuration. Each store can have a separate root category, which makes it possible to have an
entirely different set of main menu options for each store.

Store Hierarchy

Magento Commerce User Guide

1153

Adding Store Views

CHAPTER 79: All Stores

Adding Store Views
Store views are typically used to make the store available in different locales. Shoppers can use
the language chooser in the header of the store to change the store view.

Multiple Store Views

To create a new store view:
1.

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

All Stores
2.

1154

Tap Create Store View . Then, do the following:

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Store Views

Store View Information

Set Store to the parent store of this view.

Enter a Name for this store view. The name appears in the language chooser in the store
header. For example: Spanish.

Enter a Code in lowercase characters to identify the view. For example: spanish.

To activate the view, set Status to “Enabled.”

(Optional) Enter a Sort Order number to determine the sequence in which this view is
listed with other views.

When complete, tap Save Store View .

Magento Commerce User Guide

1155

Adding Store Views

CHAPTER 79: All Stores

Editing a Store View
Because the view name appears in the language chooser, you might eventually want to change
the name of the default view to something more descriptive. The Name field is simply a label,
and can be easily changed.
If your Magento installation has a multisite or multistore setup, do not change the store Code
field without verifying that the value is not referenced in the index.php file. If you do not have
access to the server to examine the file, ask a developer for help.

FIELD

ORIGINAL VALUE

UPDATED VALUE

Name

Default Store View

English

Code

default

english

To edit a store view:
1.

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

In the Store View column of the grid, click the name of the view that you want to edit.
When editing the default view, the Store and Status fields are not available.

Editing the Default View

1156

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Store Views

Update the following fields as applicable:
l

Store (non-default views only)

Name

Code (only if not used in index.php)

Status (non-default views only)

Sort Order

When complete, tap Save Store View.

Stores

Magento Commerce User Guide

1157

Adding Store Views

CHAPTER 79: All Stores

Adding a Language
Most of the text that appears to be hard-coded on pages throughout your store can be instantly
changed to a different language by changing the locale of the view. Changing the locale doesn’t
actually translate the text word-for-word, but simply references a different translation table
that provides the interface text that is used throughout the store. The text that can be changed
includes navigational titles, labels, buttons, and links such as “My Cart” and “My Account.”
You can also use the Inline Translation tool to touch up text in the interface.
Language packs can be found under "Translations & Localization" on Magento Marketplace.
New extensions are continually added to Marketplace, so check back often!

Step 1: Install a Language Pack
Follow the standard instructions to install the language pack extension from Component
Manager.

Step 2: Create a Store View for the Language
1.

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

Tap Create Store View. Then, do the following:
a.

Choose the Store that is the parent of the view.

Enter a Name for the store view. For example: Portuguese.
In the header of the store, the name appears in the “language chooser.”

1158

Enter a Code in lowercase characters to identify the view. For example: portuguese.

To activate the view, set Status to “Enabled.”

(Optional) Enter a Sort Order number to determine the sequence in which this view is
listed with other views.

When complete, tap Save Store View.

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Store Views

Step 3: Change the Locale of the Store View
1.

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

In the upper-left corner, set Store View to the specific view where the configuration is to apply.
When prompted to confirm scope switching, tap OK.

Expand

the Locale Options section.

Clear the Use Website checkbox after the Locale field. Then, set Locale to the language that
you want to assign to the view.
If there are several variations of the language available, make sure to choose the one for the
specific region or dialect.

When complete, tap Save Config.
After you change the language of the locale, the remaining content that you have created,
including product names and descriptions, categories, CMS pages, and blocks must be
translated separately for each store view.

Magento Commerce User Guide

1159

Adding Store Views

CHAPTER 79: All Stores

Translating Products
If your store has multiple views in different languages, the same products are available in each
store view. You can use the same basic product information, such as SKU, price, and inventory
level, regardless of language. Then, translate only the product name, description fields, and
meta data as needed for each language.
Process Overview:
Step 1: Translate Product Fields
Step 2: Translate Field Labels
Step 3: Translate All Categories

Step 1: Translate Product Fields
1.

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

In the grid, find the product to be translated, and open in edit mode.

In the upper-left corner set Store View to the view for the translation. When prompted to
confirm, tap OK .

For each field to be edited, do the following:
a.

Clear the Use Default Value checkbox to the right of the field.

Either paste or type the translated text into the field.

Make sure to translate all text fields, including image labels and Alt text, Search Engine
Optimization fields and any Custom Options information.
5.

When complete, tap Save .

Step 2: Translate Field Labels
1.

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

In the list, find the attribute to be translated, and open in edit mode.

In the panel on the left, choose Manage Labels.

In the Manage Titles section, enter a translated label for each store view.

Enter Translated Labels

1160

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Store Views

When complete, tap Save Attribute .

Step 3: Translate All Categories
1.

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

In the upper-left corner set Store View to the view for the translation. When prompted to
confirm, tap OK .

In the tree, find the category to be translated and open in edit mode.

On the General Information tab, translate the following fields:

Name

Description

Page Title

Meta Keywords

Meta Description

To translate the URL Key, do the following:
a.

Clear the Use Default Value checkbox to the right of the field.

Enter the translated text.

Make sure that the Create Permanent Redirect for old URL checkbox is selected

Translate URL Key
6.

When complete, tap Save Category .

Repeat the process for all categories used in the store.

Magento Commerce User Guide

1161

Adding Store Views

CHAPTER 79: All Stores

Translating Content
If your store has multiple views in different languages, and you have set the locale for each
view to a different language, the result is a partially translated site. The next step is to create a
translated version of each page that is available from the specific store view. The Store View
column of the Manage Pages list shows each view that has a translated version of the page.
To translate a content page, you must create a new page that has the same URL Key as the
original, but is assigned to the specific store view. Then, update the page for the specific view
with the translated text. The following example shows how to create a translated version of the
“About Us” page for the Spanish store view.

To create a translated page for a view:
1.

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

In the grid, find the page to be translated, and open in edit mode.

Copy the URL Key to the clipboard. Then, press the Back button to return to the Pages grid.

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

Enter the translated Page Title.

Paste the URL Key that you copied from the original page.

In the Store View box, choose the store view where the page is to be available.

In the panel on the left, choose Content. Then, complete the translated text for the page.

On the Design tab, set the column Layout of the page.

On the Meta Data tab, enter the translated text for the Keywords and Description.

When complete, tap Save Page. Then when prompted, refresh any invalid caches.

To verify the translation, go to the storefront and use the language chooser to change the store
view.
Notice that there are still some elements on the page that need to be translated, including the
company footer links block, the welcome message, and product information.

1162

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Stores

Adding Stores
A single installation of Magento can have multiple stores that share the same Admin. Stores
that are under the same website have the same IP address and domain, use the same security
certificate, and share a single checkout process.
The important thing to understand is that the stores use the same Magento code, and share the
same Admin. Each store can have a separate catalog, or share the same catalog. Each store can
have a separate root category, which makes it possible to have a different main menu for each
store. Stores can have different branding, presentation, and content. Before you begin, take
some time to plan your store hierarchy with future growth in mind, because it is used
throughout the configuration.

Multiple Stores
Here are some examples of how URLs can be configured for multiple stores:
yourdomain.com/store1

Each store has a different path, but shares the same domain.

yourdomain.com/store2
store1.yourdomain.com

Each store has a different subdomain of the primary domain.

store2.yourdomain.com

Process Overview:
Step 1: Choose the Store Domain
Step 2: Create the New Store
Step 3: Create a Default Store View
Step 4: Configure the Store URL

Magento Commerce User Guide

1163

Adding Stores

CHAPTER 79: All Stores

Step 1: Choose the Store Domain
The first step is to choose how you want to position the store. Will the stores share the same
domain, each have a subdomain, or have distinctly different domains? For each store, do one
of the following:
l

To place the store one level below the primary domain, you don’t have to do anything.

Set up a subdomain of your primary domain.

Set up a different primary domain.

Step 2: Create the New Store
1.

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

Tap Create Store. Then, do the following:
a.

Choose the Web Site that is to be the parent of the new store. If the installation has only
one web site, accept the default, “Main Website.”

Enter a Name for the new store. The name is for internal reference only.

Enter a Code in lowercase characters to identify the store. For example: mainstore.

Set Root Category to the root category that defines the category structure for the main
menu of the new store. If you have already created a specific root category for the store,
select it. Otherwise, select “Default Category.” You can come back later and update the
setting.

Store Information
3.

When complete, tap Save Store .

New Store

1164

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Stores

Step 3: Create a Default Store View
1.

Tap Create Store View . Then, do the following:
a.

Set Store to the new store you created.

Enter a Name for the view. For example, "English."

Enter a Code for the view in lowercase characters.

Set Status to "Enabled."

In the Sort Order field, enter a number to determine the store's position when listed with
other stores.

Tap Save Store View .
If you were to open your store in edit mode, you would see that it now has a default view.

New Store with Default View

Step 4: Configure the Store URL
1.

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

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

In the upper-left corner, set Store View to the view that you created for the new store. When
prompted to confirm scope switching, tap OK .

Magento Commerce User Guide

1165

Adding Stores

CHAPTER 79: All Stores

Choose the New Store View
4.

Expand

the Base URLs section. Then, do the following:

After the Base URL field, clear the Use Website checkbox.

Enter the Base URL for the store.

Base URLs
5.

Expand

the Secure Base URLs section, and repeat the previous step as needed to

configure the store’s secure URL.
6.

1166

When complete, tap Save Config.

Magento Commerce User Guide

CHAPTER 79: All Stores

Adding Websites

Adding Websites
Multiple websites can be set up that use the same Magento installation. The websites can be set
up to use the same domain, or different domains. If you want each store to have a dedicated
checkout process under its own domain, each store must have a distinct IP address and
separate security certificate.

Multiple Websites

Step 1: Create a New Website
1.

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

Tap Create Website . Then, do the following:

Website Information

Magento Commerce User Guide

1167

Adding Websites

CHAPTER 79: All Stores

In the Name field, enter the domain of the new website. For example, “domain.com.”

Enter a Code that will be used on the server to point to the domain.
The code must begin with a lowercase (a-z) letter, and can include any combination of
letters (a-z), numbers (0-9), and the underscore (_) symbol.

(Optional) Enter a Sort Order number to determine the sequence in which this site is
listed with other sites. Enter a zero to make this site appear at the top of the list.

Set Default Store to the store that is to be used as the default for this website.

When complete, tap Save Website .

Set up each store and store view that is needed for the new website.

Step 2: Configure the Store URL
Follow the instructions to configure the store URLs.

1168

Magento Commerce User Guide

CHAPTER 79: All Stores

Store URLs

Store URLs
Each website in a Magento installation has a base URL that is assigned to the storefront, and
another URL that is assigned to the Admin. Magento uses variables to define internal links in
relation to the base URL, which makes it possible to move an entire store from one location to
another without updating the links. Standard base URLs begin with http, and secure base
URLs begin with https.
Base URL

http://www.yourdomain.com/magento/

Secure Base URL

https://www.yourdomain.com/magento/

URL with IP address

http://###.###.###.###/magento/
https://###.###.###.###/magento/

Important! Do not change the Admin URL from the default Base URL configuration. To change the
Admin URL or path, see: Using a Custom Admin URL.

Use Secure Protocol
The base URLs for your store were initially set up during the Web Configuration step of the
Magento installation. If a security certificate was available at the time, you could specify for
secure (https) URLs to be used for the store, Admin, or both. If your Magento installation
includes multiple stores, or if you plan to later add more stores, you can include the store code
in the URL. All Magento resources and operations can be used with secure protocol.
If a security certificate wasn't available for the domain at the time of the installation, make sure
to update the configuration before launching your store. After a security certificate is
established for your domain, you can configure either or both base URLs to operate with
encrypted Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocol.
Magento strongly recommends for all pages of a production site, including content and product
pages, to be transmitted with secure protocol.

Magento can be configured to deliver all pages over https by default. If your store has been
running up until now with standard protocol, you can improve security by enabling
HTTP Strict Transport Security (HSTS). and by upgrading any insecure page requests that are
received by the store. HSTS is an opt-in protocol that prevents browsers from rendering
standard http pages that are transmitted with unsecure protocol for the specificed domain.
Because search engines might have already indexed each page of your store with standard http
URLs, you can configure Magento to automatically upgrade any unsecure page requests to
https, so you don't lose any traffic. When Magento is configured to use secure URLs for both
the store and Admin, two additional fields appear that allow you to enable HSTS.

Magento Commerce User Guide

1169

Store URLs

CHAPTER 79: All Stores

To configure the base URL:
1.

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

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

Expand

the Base URL section, and do the following:

Enter the fully qualified Base URL for your store. Make sure to end the URL with a

forward slash, so it can be extended with additional URL Keys from your store. For
example:
http://yourdomain.com/

Do not change the placeholder in the Base Link URL field. It is a placeholder that is used to
create relative links to the base URL.

(Optional) To specify an alternate location for the Base URL for Static View Files, enter
the path starting with the following placeholder:
{{unsecure_base_url}}

(Optional) To specify an alternate location for the Base URL for User Media Files, enter
the path starting with the following placeholder:
{{unsecure_base_url}}

For a typical installation, there is no need to update the paths for the static view files or
media files because they are relative to the base URL.

Base URLs
Placeholders enclosed in double braces are markup tags for variables.

1170

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 79: All Stores

Store URLs

To configure the secure base URL:
If your domain has a valid security certificate, you can configure the URLs of both the
storefront and Admin to transmit data over a secure (https) channel. Without a valid security
certificate, your store cannot operate with secure (SSL/TLS) protocol.
1.

Expand

the Base URLs (Secure) section. Then, do the following:

Base URLs (Secure)
a.

Enter the full Secure Base URL, followed by a forward slash. For example:
https://yourdomain.com/

Do not change the placeholder in the Secure Base Link URL field. It is used to create
relative links to the secure base URL.

(Optional) To specify an alternate location for the Secure Base URL for Static View Files,
enter the path starting with the following placeholder:
{{secure_base_url}}

(Optional) To specify an alternate location for the Secure Base URL for User Media Files,
enter the path starting with the following placeholder:
{{secure_base_url}}

Magento Commerce User Guide

1171

Store URLs

CHAPTER 79: All Stores

To enhance security, set both of the following options to "Yes."
l

Use Secure URLs on Storefront

Use Secure URLs in Admin

When the following additional fields appear , do the following:

Enhanced Security Settings
a.

If you want your store to display only secure https page requests, set Enable HTTP Strict
Transport Security (HSTS) to "Yes."

1172

To upgrade any requests for standard unsecured http pages to secure https, set Upgrade
Insecure Requests to "Yes."

When complete, tap Save Config .

Magento Commerce User Guide

CHAPTER 79: All Stores

Store URLs

To include the store code in URLs:
1.

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

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

Expand

Set Add Store Code to your preference.

the URL Options section.

URL with Store Code

http://www.yourdomain.com/magento/[store-code]/index.php/url-identifier
URL without Store Code

http://www.yourdomain.com/magento/index.php/url-identifier

URL Options
5.

When complete, tap Save Config .

After the setting is saved, you will be prompted to refresh the cache. Tap the Cache
Management link in the message at the top of the workspace. Then, follow the instructions to
refresh the cache.

Refresh Cache

Troubleshooting
If after following the configuration instructions, some pages continue to be served with the
unsecure URL (http://), do the following:
l

Change the (unsecure) base URL to the secure (https://) URL.

On the server, edit the .htaccess file (or load balancer) so the unsecure URL is redirected to
the secure URL.

Magento Commerce User Guide

1173

Store URLs

CHAPTER 79: All Stores

Using a Custom Admin URL
As a security best practice, Magento recommends that you use a unique, custom Admin URL
instead of the default “admin” or a common term such as “backend”. Although it will not
directly protect your site from a determined bad actor, it can reduce exposure to scripts that try
to gain unauthorized access.
Check with your hosting provider before implementing a custom Admin URL. Some hosting providers
require a standard URL to meet firewall protection rules.

In a typical Magento installation, the Admin URL and path is immediately below the Magento
base URL. The path to the store Admin is one directory below the root.

Default Base URL
http://yourdomain.com/magento/

Default Admin URL and Path
http://yourdomain.com/magento/admin

Although it is possible to change the Admin URL and path to another location, any mistake
removes access to the Admin, and must be corrected from the server.
As a precaution, do not try to change the Admin URL by yourself unless you know how to edit
configuration files on the server.

Method 1: Change from the Magento Admin
1.

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

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

Expand

the Admin Base URL section. Then, do the following:

Clear the first Use system value checkbox. Then, set Use Custom Admin URL to “Yes”.

Clear the next Use system valuel checkbox. Then, enter the Custom Admin URL in the
following format:
http://yourdomain.com/magento/

Important! The Admin URL must be in the same Magento installation, and have the same
document root as the storefront.

1174

Clear the next Use system valuel checkbox. Then, set Custom Admin Path to “Yes”.

Clear the next Use system valuel checkbox. Then, enter the Custom Admin Path.

Magento Commerce User Guide

CHAPTER 79: All Stores

Store URLs

The path that you enter is appended to the Custom Admin URL after the last forward
slash.
sample_custom_admin

Admin Base URL
4.

When complete, tap Save Config.

After the changes are saved, Sign Out of the Admin. Then, log back in using the new Admin
URL and path.

Method 2: Change from the Server Command Line
1.

Open the app/etc/env.php file in a text editor, and change the name of the [admin] path.
Make sure to use only lowercase characters. Then, save the file.
On the server, the admin path is located in the app/etc/env.php file. Look for the
argument in the section:
Default Admin Path

#
New Admin Path

Use one of the following methods to clear the Magento cache:
l

On the Admin sidebar, tap System. Under Tools, choose Cache Management. Then, tap
Flush Magento Cache.

On the server, navigate to the var/cache folder, and delete the contents of the cache folder.

Magento Commerce User Guide

1175

1176

Magento Commerce User Guide

CHAPTER 80:

Configuration
The online Configuration Reference has field descriptions for every configuration setting in
Magento Commerce. To learn how to apply configuration settings to specific store views, see:
Scope.

Configuration

Configuration Tabs
General
Includes basic configuration settings for the store, URLs,
theme, currency, email addresses, store contacts, editor,
and dashboard reports.

Catalog
Determines product and inventory settings, controls
sitemap and RSS feed generation, and specifies the
email template that is used to share products with
friends.

Magento Commerce User Guide

1177

Configuration Tabs

CHAPTER 80: Configuration

Customers
Establishes basic customer account and login options,
newsletter settings, ,wish list, and the format of autogenerated coupon codes.

Sales
Determines checkout and tax settings, payment and
shipping options, sales email and PDF print-outs, and
Google API settings.

Services
Configures Magento API settings, including SOAP and
OAuth.

Advanced
Determines default Admin settings, various system
configuration settings, advanced module controls, and
developer tools.

1178

Magento Commerce User Guide

CHAPTER 81:

Taxes
In this section of the guide, you will learn how to set up taxes according to the requirements of
your locale. You can set up tax classes for products and customer groups, and create tax rules
that combine product and customer classes, tax zones, and rates. In addition, you'll learn more
advanced topics such as setting up fixed product taxes, compound taxes, and how to display
consistent prices across international borders. If you are required to collect a value-added tax,
you will learn how to set up your store to automatically calculate the appropriate amount with
validation.
Magento provides a variety of options to define taxes. Tax classes are used to define “tax rules.”
Tax rules are a combination of a Product Class, a Customer Class and a Tax Zone and Rate.
Magento also supports the calculation of Value-Added Tax (VAT) for business-to-business
transactions in the European Union.

Magento Commerce User Guide

1179

1180

Magento Commerce User Guide

Vertex Cloud
Vertex is a cloud-based solution that automates your sales and use tax compliance, and
generates a signature-ready PDF for your monthly returns.

Automate Tax Calculations & Returns
Vertex saves time, reduces risk, and helps you file your
tax returns on time.

Sales & Use Tax
Vertex Cloud calculates sales tax in the shopping cart
based on the tax profile of each product that is
purchased, and the jurisdiction.

Manage Exception Certificates
Vertex makes it easy to manage customers by
jurisdiction who have non-standard tax requirements.

Generate Returns
Vertex Cloud automatically regenerates signature-ready
PDF returns and sends a message when the returns are
available.

Magento Commerce User Guide

1181

Vertex Cloud

Your Vertex Account
Vertex offers three pricing plans, plus access to additional services. All Vertex accounts include
tiered pricing and award-winning customer support, but without extra fees for fees or annual
transaction estimations. Don’t hesitate to contact Vertex if you need help choosing the right
pricing plan for your business. Then, sign up for an account on Vertex Cloud.

Pricing

1182

Magento Commerce User Guide

Vertex Cloud

To sign up for a Vertex account:
1.

Visit the Vertex web site to learn more about their services and pricing. Then in the menu at the
top of the page, choose Pricing.

Choose the pricing plan you want, and tap Request Info.
Vertex Cloud is available to companies located in the U.S. or Canada.

You will receive an email with a link to register your Vertex Cloud account. Click the link, and
complete the registration as follows:
Enter your Username, Password, and Password Confirmation.

Your username and password are case sensitive. Make sure to write them down for future
reference.

Complete the fields in the Company Information section.

Complete the fields in the Contact Information section.

To continue, mark the I agree to the terms of service checkbox.

Under Subscription Information, choose one of the following Subscription Levels,
according to your pricing plan.
l

Standard

Professional

Premium

Then, mark the checkbox of any optional features and services that you want to add to your
account.
5.

Under Billing Information, do the following:
Complete your Billing Address.

Your company’s billing address is required if paying by credit card, and must be located in either
the U.S. or Canada.

Choose the Payment Method that you want to use. Then, complete the required
information.

To complete the process, tap Submit Billing Information & Finish.
Some of our instructions include links for more information in the Vertex Cloud Help Center. You
must be logged in to your account to gain access to the Vertex Cloud Help Center.

Magento Commerce User Guide

1183

Vertex Cloud

See the instructions in the online user guide to complete both the Vertex Cloud and Magento
configuration.

Vertex Cloud Dashboard

1184

Magento Commerce User Guide

General Tax Settings

General Tax Settings
The following instructions take you through the basic tax configuration for your Magento
installation. Before setting up your taxes, make sure that you are familiar with the tax
requirements of your locale. Then, complete the tax configuration according to your
requirements.
Admin permissions can be set to restrict access to tax resources, based on the business “need to
know.” To create an Admin role with access to tax settings, choose both the Sales/Tax and
System/Tax resources. If setting up a website for a region that differs from your default
shipping point of origin, you must also allow access to the System/Shipping resources for the
role. The shipping settings determine the store tax rate that is used for catalog prices.

To configure the general tax settings:
1.

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

For a multisite configuration, set Store View to the website and store that is the target of the
configuration.

Complete the following configuration settings. If necessary, clear the Use System value
checkbox of any settings that are grayed out.

Tax Classes
1.

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

Expand

the Vertex Tax Classes section. Then, do the following:

Tax Classes
a.

Set Tax Class for Shipping to the appropriate class. The default classes are:
l

None

Taxable Goods

Set Default Tax Class for Product to the appropriate class. The default classes are:
l

None

Taxable Goods

Set Default Tax Class for Customer to the appropriate class. The default class is:

Magento Commerce User Guide

1185

General Tax Settings

Retail Customer

Wholesale Customer

When complete, tap Save Config.

Calculation Settings
1.

Expand the Calculation Settings section. Then, do the following:

Calculation Settings
a.

1186

Set Tax Calculation Method Based On to one of the following:
Unit Price

The price of each product.

Row Total

The total of the line item in the order, less discounts.

Total

The order total

Set Tax Calculation Based On to one of the following:
Shipping Address

The address where the order is to be shipped.

Billing Address

The billing address of the customer.

Shipping Origin

The address that is specified as the point of origin for your
store.

Set Catalog Prices to one of the following:
l

Excluding Tax

Including Tax

Set Shipping Prices to one of the following:

Magento Commerce User Guide

General Tax Settings

Excluding Tax

Including Tax

Set Apply Customer Tax to one of the following to determine whether tax is applied
to the original or discounted price.
l

After Discount

Before Discount

Set Apply Discount on Prices to one of the following to determine if discounts
include or exclude tax.
l

Excluding Tax

Including Tax

Set Apply Tax On to one of the following:
l

Custom price if available

Original price only

Set Enable Cross-Border Trade to one of the following:
Yes

Use consistent pricing across different tax rates. If the catalog price
includes tax, choose this setting to fix the price regarless of the customer’s
tax rate.

Vary the price by tax rate.

Important! If cross-border trade is enabled, the profit margin changes by tax rate. Profit is
determined by the formula (Revenue - CustomerVAT - CostOfGoodsSold). To enable
cross-border trade, prices must be set to include tax.

Expand
the Default Tax Destination Calculation section. Then, specify the country
that is to be the default for tax calculations.

Default Tax Destination Calculation
3.

When complete, tap Save Config.

Price Display Settings
Important! Some combinations of settings related to a price display that both includes and
excludes tax can be confusing to the customer. To avoid triggering a warning message, see the

Magento Commerce User Guide

1187

General Tax Settings

recommended settings.
1.

Expand

the Price Display Settings section Then, do the following:

Price Display Settings
a.

Set Display Product Prices in Catalog to one of the following:
Excluding Tax

Catalog prices that appear in the storefront do not include tax.

Including Tax

Catalog prices in the storefront include tax only if a tax rule
matches the tax origin, or if the customer’s address matches
the tax rule. This might happen after a customer creates an
account, logs in, or uses the Estimate Tax and Shipping tool
in the cart.

Including and
Excluding Tax

Catalog prices that appear in the storefront are displayed both
with, and without tax.

Set Display Shipping Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Expand

the Shopping Cart Display Settings section.

For each of the following settings, choose how you want taxes and prices to appear in the
cart, according to the requirements of your store and locale.
a.

1188

Set Display Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Subtotal to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Amount to one of the following:

Magento Commerce User Guide

General Tax Settings

Excluding Tax

Including Tax

Including and Excluding Tax

Set the following to either “Yes” or “No,” according to your needs:
l

Include Tax in Order Total

Display Full Tax Summary

Display Zero Tax Subtotal

Shopping Cart Display Settings
3.

Expand
the Orders, Invoices, Credit Memos Display Settings section. Then, do the
following to specify how prices and taxes appear in orders, invoices, and credit memos.
a.

Set Display Prices to one of the following.
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Subtotal to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Amount to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set the following to “Yes” or “No,” according to your requirements:

Magento Commerce User Guide

1189

General Tax Settings

Include Tax in Order Total

Display Full Tax Summary

Display Zero Tax Subtotal

Orders, Invoices, Credit Memos Display Settings
4.

When complete, tap Save Config.

Cross-Border Price Consistency
Cross-border trade (also referred to as price consistency) supports European Union (EU) and
other merchants who want to maintain consistent prices for customers whose tax rates are
different than the store tax rate.
Merchants operating across regions and geographies can show their customers a single price by
including the tax in the price of the product. Pricing is clean and uncluttered regardless of tax
structures and rates that vary from country to country.
Important! When cross-border trade is enabled, your profit margin changes by tax rate. Profit is
determined by the formula: (Revenue - CustomerVAT - CostOfGoodsSold).

To enable cross-border price consistency:
1.

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

For a multisite configuration, set Store View to the website and store that is the target of the
configuration.

1190

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

Expand

the Calculation Settings section. Then, do the following:

Magento Commerce User Guide

General Tax Settings

Calculation Settings

Set Catalog Prices to “Including Tax.”

To enable cross-border price consistency, set Enable Cross Border Trade to “Yes.”

When complete, tap Save Config.

Magento Commerce User Guide

1191

Tax Rules

Tax Rules
Tax rules incorporate a combination of product class, customer class and tax rate. Each
customer is assigned to a customer class, and each product is assigned a product class.
Magento analyzes the shopping cart of each customer and calculates the appropriate tax
according to the customer and product classes, and the region (based on the customer’s
shipping address, billing address or shipping origin).
When numerous taxes must be defined, you can simplify the process by importing them.

Tax Rules

Step 1: Complete the Tax Rule Information
1.

On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Rules.

In the upper-right corner, tap Add New Tax Rule .

Under Tax Rule Information, enter a Name for the new rule.

Choose the Tax Rate that applies to the rule. If you need to edit an existing tax rate, do the
following:

1192

Hover over the tax rate, and tap the Edit

icon.

Update the form as needed, and tap Save .

Magento Commerce User Guide

Tax Rules

Tax Rule Information
To enter tax rates, use either of the following methods:

Method 1: Enter Tax Rates Manually
1.

Tap Add New Tax Rate.

Complete the form as needed. For more information, see: Tax Zones and Rates.

When complete, tap Save .

New Tax Rate

Magento Commerce User Guide

1193

Tax Rules

Method 2: Import Tax Rates
1.

Scroll down to the section at the bottom of the page.

To import tax rates, do the following:

Tap Choose File, and navigate to the CSV file with the tax rates to be imported.

Tap Import Tax Rates.

To export tax rates, tap Export Tax Rates.
To learn more, see: Import/Export Tax Rates.

Import / Export Tax Rates

Step 2: Complete the Additional Settings
4.

Tap Additional Settings to open the section. Then, do the following:
a.

Choose the Customer Tax Class to which the rule applies.
l

To edit a customer tax class, tap the edit

icon. Then, update the form as needed, and

tap Save .
l

To create a new tax class, tap Add New Tax Class. Then, complete the form as needed,
and tap Save .

Choose the Product Tax Class to which the rule applies.
l

To edit a product tax class, tap the edit

icon. Then, update the form as needed, and

tap Save .
l

To create a new tax class, tap Add New Tax Class. Then, complete the form as needed,
and tap Save .

1194

In the Priority field, enter a number to indicate the priority of this tax, when more than
one tax applies. If two tax rules with the same priority apply, then the taxes are added
together. If two taxes with different priority settings apply, then the taxes are
compounded.

If you want taxes to be based on the order subtotal, mark the Calculate off Subtotal Only
checkbox.

In the Sort Order field, enter a number to indicate the order of this tax rule when listed
with others.

Magento Commerce User Guide

Tax Rules

Additional Settings
5.

When complete, tap Save Rule .

Magento Commerce User Guide

1195

Tax Rules

Tax Classes
Tax classes can be assigned to customers, products, and shipping. Magento analyzes the
shopping cart of each customer and calculates the appropriate tax according to the class of the
customer, the class of the products in the cart, and the region (as determined by the customer’s
shipping address, billing address or shipping origin). New tax classes can be created when a
tax rule is defined.

Customer
You can create as many customer tax classes as you
need, and assign them to customer groups. For example,
in some jurisdictions, wholesale transactions are not
taxed, but retail transactions are. You can associate
members of the Wholesale Customer group with the
Wholesale tax class.

Product
Product classes are used in calculations to determine the
correct tax rate is applied in the shopping cart. When you
create product, it is assigned to a specific tax class. For
example, food might not be taxed, or be taxed at a
different rate.

Shipping
If your store charges an additional tax on shipping, you
should designate a specific product tax class for
shipping. Then in the configuration, specify it as the tax
class that is used for shipping.

1196

Magento Commerce User Guide

Tax Rules

Configuring Tax Classes
The tax class that is used for shipping, and the default tax classes for products and customers
are set in the Sales configuration.

Tax Classes

To configure tax classes:
1.

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

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

Expand

the Tax Classes section. Then, choose the tax class for each of the following:

Set Tax Class for Shipping

Default Tax Class for Product

Default Tax Class for Customer

When complete, tap Save Config.

Magento Commerce User Guide

1197

Tax Rules

Adding New Tax Classes
Tax classes for customers and products can be easily added, and then assigned to individual
customers and products, and used in tax rules.

New Tax Classes

To add a new tax class:
1.

On the Admin sidebar, choose Stores. Then under Taxes, choose Tax Rules.

Tap Add New Tax Rule. Then, expand

To add a new Customer Tax Class, do the following:
a.

the Additional Settings section.

Under Customer Tax Class, tap Add New Tax Class.

Add New Tax Class
b.

Enter the Name of the new tax class in the text box. Then, click the checkmark to add the
new class to the list of available customer tax classes.

Wholesale Tax Class

1198

Magento Commerce User Guide

Tax Rules

To add a new Product Tax Class, do the following:
a.

Under Product Tax Class, tap Add New Tax Class.

Enter the Name of the new tax class in the text box. Then, click the checkmark to add the
new class to the list of available product tax classes.

Digital Product Tax Class
5.

When complete, tap Back in the button bar to return to the Tax Rules grid.

Magento Commerce User Guide

1199

Tax Rules

Default Tax Destination
The default tax destination settings determine the country, state, and ZIP or postal code that
are used as the basis of tax calculations.

Default Tax Destination Calculation

To configure the default tax destination for calculations:
1.

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

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

Expand

1200

the Default Tax Destination Calculation section. Then, do the following:

Set Default Country to the country upon which tax calculations are based.

Set Default State to the state or province that is used as the basis of tax calculations.

Set Default Post Code to the ZIP or postal code that is used as the basis of local tax
calculations.

When complete, tap Save Config.

Magento Commerce User Guide

Tax Rules

EU Place of Supply for Digital Goods
European Union (EU) merchants must report their digital goods sold by quarter to each
member country. Digital goods are taxed based on the customer's shipping address. The law
requires merchants to run a tax report and identify the relevant tax amounts for digital goods,
as opposed to physical goods.
Merchants must report all digital goods sold by EU member countries on a quarterly basis to a
central tax administration, along with payment due for tax collected during the period.
Merchants who have not yet reached the threshold (50k/100k Euro of annual business) must
continue to report physical goods sold to the EU states where they have registered VAT
numbers.
Merchants who are audited for taxes paid for digital goods, must provide two pieces of
supporting information to establish the customer place of residence.
l

The customer’s shipping address and a record of a successful payment transaction can be
used to establish the customer place of residence. (Payment is accepted only if the shipping
address matches payment provider information.)

The information can also be captured directly from the data store in the Magento database
tables.

To collect digital goods tax information:
1.

Load the tax rates for all EU member countries.

Create a digital goods product tax class.

Assign all your digital goods to the digital goods product tax class.

Create tax rules for your physical goods, using physical product tax classes, and associate them
with the appropriate tax rates.

Create tax rules for your digital goods, using the product tax class for digital goods, and
associate them with the appropriate tax rates for EU member countries.

Run the tax report for the appropriate period, and collect the required digital goods
information.

Export the tax amounts that are related to the tax rates for the digital goods product tax class.

See also:
European Commission Taxation and Customs Union
EU 1015 Place of Supply Changes

Magento Commerce User Guide

1201

Tax Rules

Fixed Product Tax
Some tax jurisdictions have a fixed tax that must be added to certain types of products. You
can set up a fixed product tax (FPT) as needed for your store's tax calculations. For example, in
some countries FPT can be used to set up a Waste Electrical and Electronic Equipment
Directive (WEEE) tax, also known as "ecological tax" or "eco tax," that is collected on certain
types of electronics to offset the cost of recycling. This tax is a fixed amount, rather than a
percentage of the product price.
Fixed product taxes apply at the item level, based on the product. In some jurisdictions this
tax is subject to an additional % tax calculation. Your tax jurisdiction might also have rules
about how the product price appears to customers, either with or without tax. Be sure that you
understand the rules, and set your FPT display options accordingly.
We recommend that you exercise caution when quoting FPT prices in email, because the
difference in price can affect customer confidence in their orders. For example, if you display
Order Review prices without showing FPT, customers who buy items with associated FPT will
see a total that includes the FPT tax amount, but without an itemized breakdown. The
difference in price might lead some customers to abandon their carts because the total differs
from the amount expected.

FPT Display Prices
FPT
Not Taxed

Taxed

1202

DISPLAY SETTING AND CALCULATION
Excluding FPT

FPT appears as a separate row in the cart, and the
value is used in appropriate tax calculations.

Including FPT

FPT is added to the base price of an item; but is not
included in tax- rule-based calculations.

Excluding FPT,
FPT Description,
Final Price

Prices appeare without FPT amount or description.
FPT is not included in tax-rule-based calculations.

Excluding FPT

FPT appears as a separate row in the cart, and the
value is used in appropriate tax calculations.

Including FPT

FPT is included in the price of an item, and no change
to tax calculations is required.

Excluding FPT,
FPT Description,
Final Price

Prices appear without the FPT amount or description.
However, FPT is included in tax-rule-based
calculations.

Magento Commerce User Guide

Tax Rules

Configuring FPT
The Fixed Product Tax input type creates a section of fields for managing tax for each region.
The following instructions show how to set up a fixed product tax for your store, using “eco
tax” as an example. After setting the scope for the tax and the countries and states where the
tax applies, and depending on the options you choose, the input fields can change according to
the local requirements. To learn more, see: Creating Attributes.
Process Overview:
Step 1: Enable Fixed Product Tax
Step 2: Create an FPT Attribute
Step 3: Add the FPT Attribute to an Attribute Set
Step 4: Apply FPT to Products

Step 1: Enable Fixed Product Tax
1.

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

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

Expand

the Fixed Product Taxes section. Then, do the following:

Set Enable FPT to “Yes.”

To determine how fixed product taxes are used in store prices, choose the FPT setting for
each of the following price display locations. (The options are the same for each location.)
l

Product View Page

Sales Modules

Emails

OPTIONS
Including FPT Only
Including FPT and FPT description
Excluding FPT. Including FPT description and final price
Excluding FPT
c.

Set Apply Tax to FPT as needed.

Set Include FPT in Subtotal as needed.

Magento Commerce User Guide

1203

Tax Rules

Fixed Product Taxes
4.

When complete, tap Save Config.

Step 2: Create an FPT Attribute
1.

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

In the upper-right corner, tap Add New Attribute. Then, do the following:
a.

Enter a Default Label to identify the attribute.

Set Catalog Input for Store Owner to “Fixed Product Tax.”

Attribute Properties
3.

Expand
a.

the Advanced Attribute Properties section. Then, do the following:

In the Attribute Code field, enter a unique identifier in lowercase, without spaces or
special characters. The maximum length is 30 characters. You can leave the field blank to
the text from the Default Label field.

1204

If you want the FPT field to appear in the Inventory grid, set Add to Column Options to
“Yes.”

If you want to be able to filter products in the grid based on the value of the FPT field, set
Use in Filter Options to “Yes.”

Magento Commerce User Guide

Tax Rules

Advanced Attribute Properties
4.

(Optional) In the panel on the left, choose Manage Labels. Then, enter a label to use instead of
the default label for each store view.

Manage Labels
5.

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

Magento Commerce User Guide

1205

Tax Rules

Step 3: Add the FPT Attribute to an Attribute Set
1.

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

In the list, tap the attribute set to open the record in edit mode.

Drag the FPT attribute from the list of Unassigned Attributes on the right to the Groups list
in the center column.
Each group folder corresponds to a section of product information. You can place the attribute
wherever you want it to appear when the product is open in edit mode.

Edit Attribute Set
4.

1206

When complete, tap Save.

Magento Commerce User Guide

Tax Rules

Repeat this step for each attribute set that needs to include fixed product tax.

Step 4: Apply FPT to Specific Products
1.

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

Open the product that needs a fixed product tax in edit mode.

Find the FPT section of fields that you added to the attribute set. Tap Add Tax, and do the
following:

Fixed Product Tax for Belgium
a.

If your Magento installation has multiple websites, choose the appropriate Website and
base currency. In this example, the field is set by default to “All Websites [USD],”

Set Country/State to the region where the fixed product tax applies.

Enter the fixed product tax as a decimal amount in the Tax field.

To add more fixed product taxes, tap Add Tax, and repeat the process.

When complete, tap Save.

Magento Commerce User Guide

1207

Price Display Settings

Price Display Settings
The price display settings determine if product and shipping prices include or exclude tax, or
show two versions of the price; one with, and the other without tax.
If the product price includes tax, the tax appears only if there is a tax rule that matches the tax
origin, or if a customer address matches the tax rule. Events that can trigger a match include
when a customer creates an account, logs in, or generates a tax and shipping estimate from the
shopping cart.
Important! Showing prices that include and exclude tax can be confusing to the customer. To avoid
triggering a warning message, see the guidelines for your country, and recommended settings. to
avoid warning messages.

Price Display Settings

Step 1: Configure Price Display Settings
1.

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

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

Expand
a.

1208

the Price Display Settings section. Then, do the following:

Set Display Product Prices in Catalog to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Magento Commerce User Guide

Price Display Settings

Step 2: Configure Shopping Cart Display Settings
1.

Expand

the Shopping Cart Display Settings section. Then, do the following:

Shopping Cart Display Settings
a.

Set Display Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Subtotal to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Amount to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set the following to “Yes” or “No” according to your preference:
l

Include Tax in Order Total

Display Full Tax Summary

Display Zero Tax Subtotal

Magento Commerce User Guide

1209

Price Display Settings

Step 3: Configure Order, Invoice & Credit Memo Display Settings
1.

Expand

the Orders, Invoices, Credit Memos Display Settings section. Then, do the

following:

Orders, Invoices, Credit Memos Display Settings
a.

1210

Set Display Prices to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Subtotal to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set Display Shipping Amount to one of the following:
l

Excluding Tax

Including Tax

Including and Excluding Tax

Set the following to “Yes” or “No” according to your preference:
l

Include Tax in Order Total

Display Full Tax Summary

Display Zero Tax Subtotal

When complete, tap Save Config.

Magento Commerce User Guide

Tax Zones and Rates

Tax Zones and Rates
Tax rates generally apply to transactions that take place within a specific geographical area.
The Tax Zones and Rates tool enables you to specify the tax rate for each geographical area
from which you collect and remit taxes. Because each tax zone and rate has a unique identifier,
you can have multiple tax rates for a given geographic area (such as places that do not tax food
or medicine, but do tax other items).
Store tax is calculated based on the store’s address. The actual customer tax for an order is
calculated after the customer completes the order information. Magento then calculates the tax
based upon the tax configuration of the store.

Tax Zones and Rates

To define a new tax rate:
1.

On the Admin sidebar, tap Stores. Under Taxes, choose Tax Zones and Rates.

In the upper-right corner, tap Add New Tax Rate.

Enter a Tax Identifier.

To apply the tax rate to a single ZIP or postal code, enter the code in the Zip/Post Code field.

The asterisk wildcard (*) can be used to match up to ten characters in the code. For example,
90* represents all ZIP codes from 90000 through 90999.

To apply the tax rate to a range of ZIP or postal codes, do the following:

Magento Commerce User Guide

1211

Tax Zones and Rates

Mark the Zip/Post is Range checkbox. Then in the Range From and Range To fields,
enter the first and last ZIP or postal code to define the range.

ZIP/Post is Range

Choose the State where the tax rate applies.

Choose the Country where the tax rate applies.

Enter the Rate Percent that is used for the tax rate calculation.

When complete, tap Save Rate .

New Tax Rate

To edit an existing tax rate:
1.

On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Zones and Rates.

Find the tax rate in the Tax Zones and Rates grid, and open the record in edit mode.
If there are many rates in the list, use the filter controls to find the rate you need.

1212

Make the necessary changes to the Tax Rate Information.

Update the Tax Titles as needed.

When complete, tap Save Rate .

Magento Commerce User Guide

Tax Zones and Rates

Import/Export Tax Rates
If you conduct business in several states and ship a large quantity of product, it is more
efficient to download tax rates by ZIP code than enter the rates manually. The rates can then be
imported into Magento. The following example shows how to import a set of California tax
rates that was downloaded from the Avalara website. Avalara is a Magento Technology Partner,
and provides tax rate tables that can be downloaded at no charge for every ZIP code in the
United States.
Process Overview:
Step 1: Export the Magento Tax Rate Data
Step 2: Prepare the Import Data
Step 3: Import the Tax Rates

Step 1: Export the Magento Tax Rate Data
1.

On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export Tax
Rates.

Tap Export Tax Rates . Look for the download file in the lower-left corner of the browser
window.

Save the file, and then open it in a spreadsheet. (In this example, we use OpenOffice Calc.)
The exported Magento tax rate data includes the following columns:
l

Code

Country

State

Zip/Post Code

Rate

Range From

Range To

A column for each store view

Exported Tax Rate Data
4.

Open the new tax rate data in a second instance of the spreadsheet, so you can see both, side
by side.

Magento Commerce User Guide

1213

Tax Zones and Rates

In the new tax rate data, take note of any additional tax rate data that you might need to set
up in your store before the data is imported. For example, the tax rate data for California also
includes:
l

TaxRegionName

CombinedRate

StateRate

CountyRate

CityRate

SpecialRate

If you need to import additional tax zones and rates, you must first define them from the
Admin of your store, and update the tax rules as needed. Then, export the data, and open the
file in OpenOffice Calc, so it can be used for reference. However, to keep this example simple,
we will import only the standard tax rate columns.

Step 2: Prepare the Import Data
You now have two spreadsheets open, side by side. One with the Magento export file structure,
and the other with the new tax rate data that you want to import.
1.

To create a place to work in the spreadsheet with the new data, insert as many blank columns
at the far left as needed. Then, use cut and paste to rearrange the columns so they match the
order of the Magento export data.

Rename the column headers to match the Magento export data.

Delete any columns that have no data. Otherwise, the structure of the import file should match
the original Magento export data.

Before saving the file, scroll down and make sure that the tax rate columns contain only
numeric data. Any text found in a tax rate column will prevent the data from being imported.

Save the prepared data as a .CSV file. When prompted, verify that a comma is used a Field
delimiter, and double quotes as the Text delimiter. Then, tap OK .

1214

Magento Commerce User Guide

Tax Zones and Rates

Step 3: Import the Tax Rates
1.

On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export Tax
Rates.

Tap Browse , and choose the .CSV tax rate file that you prepared to import. Then, tap Import
Tax Rates .

It might take several minutes to import the data. When the process is complete, the message,
"The tax rate has been imported" appears. If you receive an error message, correct the problem
in the data and try again.
3.

On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Zones and Rates. The
imported rates appear in the list. Use the page controls to view the new tax rates.

Imported Tax Rates
4.

Run some test transactions in your store with customers from different ZIP codes to make sure
that the new tax rates work correctly.

Magento Commerce User Guide

1215

Value Added Tax (VAT)

Value Added Tax (VAT)
Some countries charge a value-added tax, or VAT, on goods and services. There can be different
VAT rates depending on which stage you as a merchant are at in the manufacture or
distribution of the products, materials, or services that you sell to your customers. In some
cases, you might need to use more than one VAT rate in your store for tax calculation purposes.
Magento can be set up to charge a value-added tax if both the merchant and customer are
located in the same EU country. No VAT is charged if the merchant and customer are located
in different EU countries.
However, for the sale of downloadable products — or digital goods —, the VAT rate is based on
the shipping destination, rather than the merchant location. To learn more, see: EU Place of
Supply for Digital Goods.
Magento uses the following fields and configuration settings to address different scenarios.

Summary of VAT Fields
SECTION

DESCRIPTION

MERCHANT INFORMATION
Stores > Configuration > General > General > Store Information
Store Information

VAT Number

Validate VAT
Number

The value-added tax number that is
assigned to the merchant.
VAT validation confirms that the VAT
Number matches the corresponding record
in the European Commission database.

CUSTOMER INFORMATION
Customers > All Customers > Edit

1216

Account Information

Tax/VAT Number

If applicable, the tax number or valueadded tax number that is assigned to the
customer.

Addresses

VAT Number

If applicable, the value-added tax number
that is associated with a specific billing or
shipping address of the customer. For the
sale of digital goods within the EU, the
amount of the VAT is based on shipping
destination.

Magento Commerce User Guide

Value Added Tax (VAT)

Summary of VAT Fields (cont.)
SECTION

DESCRIPTION

Configure > Customers > Customer Configuration
Create New Account
Options

Show VAT Number
on Storefront

Determines if the customer VAT Number
field is included in the Address Book that is
available in the customer account.

Default Value for
Disable Automatic
Group Changes
Based on VAT ID

VAT ID is an internal identifier for the VAT
Number of the customer when used in VAT
Validation. During VAT Validation,
Magento confirms that the number
matches the European Commission
database. Customers can be automatically
assigned to one of the four default
customer groups based on the validation
results.

Configuring VAT
The following instructions include a sample procedure to set up a 20% VAT in the U.K. for
sales to retail customers. For other tax rates and countries, follow the general procedure but
enter specific information that corresponds to your country, VAT rate, customer types, and so
on.
Before proceeding, make sure to find out which rules and regulations apply to VAT in your area.

In certain business-to-business transactions, VAT is not assessed. Magento can validate a
customer’s VAT ID to ensure that VAT is assessed (or not assessed) properly. To learn more,
see: VAT ID Validation.
Process Overview:
Step 1: Set Up Customer Tax Classes
Step 2: Set Up Product Tax Classes
Step 3: Set Up Tax Zones and Rates
Step 4: Set Up Tax Rules
Step 5: Apply Tax Classes to Products

Magento Commerce User Guide

1217

Value Added Tax (VAT)

Step 1: Set Up Customer Tax Classes
1.

On the Admin sidebar, tap Stores. Then, choose, Tax Zones and Rates.

Ensure that there is a customer tax class that is appropriate to use with the VAT. For this
example, ensure that there is a customer tax class named Retail Customer. If Retail Customer
does not exist, click the Add New button and add it.

Step 2: Set Up Product Tax Classes
1.

On the Admin menu, select Sales > Tax > Product Tax Classes.

Click the Add New button and create three new classes:

VAT Standard

VAT Reduced

VAT Zero

Click the Save Class button for each new class that you add.

Step 3: Set Up Tax Zones and Rates
1.

On the Admin menu, select Sales > Tax > Manage Tax Zones & Rates.
For this example you can remove the U.S. tax rates, or leave them as they are.

Click the Add New Tax Rate button. Add new rates as follows:

NEW TAX RATE
VAT Standard

VAT Reduced

SETTINGS
Tax Identifier:

VAT Standard

Country and State:

United Kingdom

Rate Percent:

20.00

Tax Identifier:

VAT Reduced

Country and State:

United Kingdom

Rate Percent:

5.00

Click the Save Rate button for each rate.

Step 4: Set Up Tax Rules
A tax rule is a combination of a customer tax class, a product tax class, and a tax rate.

1218

Magento Commerce User Guide

Value Added Tax (VAT)

On the Admin menu, select Sales > Tax > Manage Tax Rules.

Add new tax rules as follows:

NEW TAX RULE
VAT Standard

VAT Reduced

SETTINGS
Name:

VAT Standard

Customer Tax Class:

Retail Customer

Product Tax Class:

VAT Standard

Tax Rate:

VAT Standard Rate

Name:

VAT Reduced

Customer Tax Class:

Retail Customer

Product Tax Class:

VAT Reduced

Tax Rate:

VAT Reduced Rate

Click the Save Rule button for each rate.

Step 5: Apply Tax Classes to Products
1.

On the Admin menu, select Catalog > Manage Products.

Open a product from your catalog in edit mode.

On the General page, find the Tax Class field. Then, select the VAT Class that applies to the
product.

When complete, click the Save button.

Magento Commerce User Guide

1219

Value Added Tax (VAT)

VAT ID Validation
VAT ID Validation automatically calculates the required tax for B2B transactions that take
place within the European Union (EU), based on the merchant and customer locale. Magento
performs VAT ID validation using the web services of the European Commission server.
VAT-related tax rules do not influence other tax rules, and do not prevent the application of other tax
rules. Only one tax rule can be applied at a given time.
l

VAT is charged if the merchant and customer are located in the same EU country.

VAT is not charged if the merchant and customer are located in different EU countries, and
both parties are EU-registered business entities.

The store administrator creates more than one default customer group that can be
automatically assigned to the customer during account creation, address creation or update,
and checkout. The result is that different tax rules are used for intra-country (domestic) and
intra-EU sales.
Important: If you sell virtual or downloadable products, which by their nature do not require
shipping, the VAT rate of a customer’s location country should be used for both intra-union and
domestic sales. You must create additional individual tax rules for product tax classes that
correspond to the virtual products.

Customer Registration Workflow
If VAT ID Validation is enabled, after registration each customer is proposed to enter the VAT
ID number. However only those who are registered VAT customers are expected to fill this field.
After a customer specifies the VAT number and other address fields, and chooses to save, the
system saves the address and sends the VAT ID validation request to the European
Commission server. According to the results of the validation, one of the default groups is
assigned to a customer. This group can be changed if a customer or an administrator changes
the VAT ID of the default address or changes the whole default address. The group can be
temporarily changed (group change will be emulated) in some cases during one-page checkout.
If enabled, you can override VAT ID Validation for individual customers by selecting the
checkbox on the Customer Information page.

1220

Magento Commerce User Guide

Value Added Tax (VAT)

Checkout Workflow
If a customer’s VAT validation is performed during checkout, the VAT request identifier and
VAT request date are saved in the Comments History section of the order.
The system behavior concerned with the VAT ID validation and the customer group change
during the checkout depends on how the Validate on Each Transaction and the Disable
Automatic Group Change settings are configured. This section describes the implementation of
the VAT ID Validation functionality for the checkout on the frontend.
In case a customer uses Google Express Checkout, PayPal Express Checkout or another
external checkout method, when the checkout is performed completely on the side of the
external payment gateway, the Validate on Each Transaction setting cannot be applied. Thus
the customer group cannot change during checkout.

VAT Validation Checkout Workflow

Magento Commerce User Guide

1221

Value Added Tax (VAT)

Configuring VAT ID Validation
To configure VAT ID validation, you must first set up the customer groups that are needed,
and create the related tax classes, rates, and rules. Then, enable VAT ID validation for the
store, and complete the configuration.
The following examples show how tax classes and rates are used for VAT ID Validation. Take a
look at the examples, and then follow the instructions to set up the tax classes and rules that
are needed for your store.

Example: Minimal Tax Rules Required for VAT ID Validation
TAX RULE #1
Customer Tax Class

Customer tax classes must include:
A class for domestic customers
A class for customers with invalid VAT ID
A class for customers, for whom VAT ID validation failed

Product Tax Class

Product tax classes must include a class for products of all types,
except bundle and virtual.

Tax Rate

The tax rate must include the VAT rate of the merchant’s country.

TAX RULE #2
Customer Tax Class

A class for intra-union customers.

Product Tax Class

A class for products of all types, except virtual.

Tax Rate

VAT rates for all EU countries, except merchant’s country. Currently
this rate is 0%.

TAX RULE #3 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)
Customer Tax Class

Customer tax classes must include:
A class for domestic customers
A class for customers with invalid VAT ID
A class for customers, for whom VAT ID validation failed

Product Tax Class

A class for virtual products.

Tax Rate

VAT rate of the merchant’s country.

TAX RULE #4 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)
Customer Tax Class

1222

A class for intra-union customers.

Magento Commerce User Guide

Value Added Tax (VAT)

TAX RULE #4 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)
Product Tax Class

A class for virtual products.

Tax Rate

VAT rates for all EU countries, except merchant’s country. Currently
this rate is 0%.

Process Overview:
Step 1: Create VAT-Related Customer Groups
Step 2: Create VAT-Related Classes, Rates and Rules
Step 3: Enable and Configure VAT ID Validation
Step 4: Set your VAT ID and Location Country
Step 5: Verify the List of EU Member Countries

Step 1: Create VAT-Related Customer Groups
VAT ID Validation automatically assigns one of the four default customer groups to customers
according to VAT ID validation results:
l

Domestic

Intra-EU

Invalid VAT ID

Validation error

You can create new customer groups for VAT ID Validation or use existing groups, if they
comply with your business logic. When configuring VAT ID Validation, you must assign each
of the created customer groups as a default for customers with appropriate VAT ID validation
results.

Step 2: Create VAT-Related Classes, Rates, and Rules
Each tax rule is defined be three entities:
l

Customer Tax Classes

Product Tax Classes

Tax Rates

Create the tax rules that you need to use VAT ID Validation effectively.
l

Tax rules include tax rates and tax classes.

Tax classes are assigned to customer groups.

Step 3: Enable and Configure VAT ID Validation
1.

On the Admin sidebar, tap Stores. Under Settings, choose Configuration.

If necessary, set the Store View for the configuration.

Magento Commerce User Guide

1223

Value Added Tax (VAT)

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

Expand

the Create New Account Options section.

In the following screenshot, the general customer settings that are not related to VAT
Validation are grayed out.

Create New Account Options
5.

Set Enable Automatic Assignment to Customer Group to “Yes.” Then complete the following
fields as needed.

1224

Magento Commerce User Guide

Value Added Tax (VAT)

Default Group

Default Value for Disable Automatic Group Changes Based on VAT ID

Show VAT Number on Storefront

When complete, tap Save Config.

Step 4: Set Your VAT ID and Location Country
1.

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

Expand

the Store Information section. Then, do the following:

Store Information

Select your Country.

Enter your VAT Number. Then, tap Validate VAT Number. The result appears immediately.

When complete, tap Save Config.

Step 5: Verify the List of EU Member Countries
1.

Continuing in the General configuration section, expand

the Countries Options section.

In the list of European Union Countries, verify that each member country of the EU is
selected.
To change the default setting, clear the Use system values checkbox. Then, hold down the Ctrl
key, and click each country that you want to add, or remove.

When complete, tap Save Config.

Magento Commerce User Guide

1225

Value Added Tax (VAT)

Countries Options

1226

Magento Commerce User Guide

Tax Quick Reference

Tax Quick Reference
Some tax settings have a choice of options that determines the way the tax is calculated and
presented to the customer. To learn more, see: International Tax Guidelines.

Tax Calculation Methods
Tax calculation method options include Unit Price, Row Total, and Total. The following table
explains how rounding (to two digits) is handled for different settings.

Tax Configuration Options
SETTING

CALCULATION AND DISPLAY

Unit Price

Magento calculates the tax for each item and displays prices taxinclusive. To calculate the tax total, Magento rounds the tax for each
item, and then adds them together.

Row Total

Magento calculates the tax for each line. To calculate the tax total,
Magento rounds the tax for each line item and then adds them
together.

Total

Magento calculates the tax for each item and adds those tax values
to calculate the total unrounded tax amount for the order. Magento
then applies the specified rounding mode to the total tax to determine
the total tax for the order.

Magento Commerce User Guide

1227

Tax Quick Reference

Catalog Prices With or Without Tax
The possible display fields vary depending on the calculation method and whether the catalog
prices include or exclude taxes. Display fields have two-decimal precision in normal
computations. Some combinations of price settings display prices that both include and
exclude tax. When both appear on the same line item, it can be confusing to customers, and
triggers a warning.

Tax Configuration Options
SETTING

CALCULATION AND DISPLAY

Excluding Tax

Using this setting, the base item price is used as it is entered and the
tax calculation methods are applied.

IncludingTax

Using this setting, the base item price excluding tax is calculated
first. This value is used as the base price, and the tax calculation
methods are applied.

Important! Changes have been made from earlier versions for EU merchants or other VAT merchants
who display prices including tax and operate in several countries with multiple store views. If you load
prices with more than two digits of precision, Magento automatically rounds all prices to two digits to
ensure that a consistent price is presented to buyers.

Shipping Prices With or Without Tax
Tax Configuration Options
SETTING

DISPLAY

CALCULATION

Excluding Tax

Appears without tax.

Normal calculation. Shipping is added
to cart total, typically displayed as a
separate item.

Including Tax

Can be tax inclusive, or tax
can be displayed
separately.

Shipping is treated as another item in
cart with taxes, using the same
calculations.

Tax Amounts as Line Items
To display two different tax amounts as separate line items, such as GST and PST for Canadian
stores, you must set different priorities for the related tax rules. However, in previous tax
calculations, taxes with different priorities would automatically be compounded. To correctly display
separate tax amounts without an incorrect compounding of the tax amounts, you can set different
priorities, and also select the Calculate off subtotal only checkbox. This produces correctly
calculated tax amounts that appear as separate line items.

1228

Magento Commerce User Guide

International Tax Guidelines

International Tax Guidelines
U.S. Tax Configuration
TAX OPTION

RECOMMENDED SETTING

Load catalog prices

Excluding tax

FPT

No, because FPT is not taxed.

Tax based on

Shipping origin

Tax Calculation

On total

Tax shipping?

Apply Discount

Before tax

Comment

All tax zones are the same priority; ideally, a zone for state and one or
more zones for zip code lookup.

UK B2C Tax Configuration
TAX OPTION

RECOMMENDED SETTING

Load catalog prices

Excluding tax

FPT

Yes, including FPT and description

Tax based on

Shipping address

Tax Calculation

On total

Tax shipping?

Yes

Apply Discount

Before tax, discount on prices, including tax.

Comment

For merchants marking up supplier invoices (including VAT).

U.K. B2B Tax Configuration
TAX OPTION

RECOMMENDED SETTING

Load catalog prices

Excluding tax

FPT

Yes, including FPT and description

Tax based on

Shipping address

Tax Calculation

On item

Magento Commerce User Guide

1229

International Tax Guidelines

U.K. B2B Tax Configuration (cont.)
TAX OPTION

RECOMMENDED SETTING

Tax shipping?

Yes

Apply Discount

Before tax, discount on prices, including tax.

Comment

For B2B merchants to provide simpler VAT supply chain
considerations. Tax calculation on row is also valid; however, check
with your taxing jurisdiction. Setup assumes a merchant is in the
supply chain and that goods sold are used by other vendors for VAT
rebates and so on. This makes it easy to discern tax by item for
faster rebate generation. Note that some jurisdictions require different
rounding strategies not currently supported by Magento, and that not
all jurisdictions allow item or row level tax.

Canada Tax Configuration
TAX OPTION

RECOMMENDED SETTING

Load catalog prices

Excluding tax

FPT

Yes, including FPT, description, and apply tax to FPT.

Tax based on

Shipping origin

Tax Calculation

On total

Tax shipping?

Yes

Apply Discount

Before tax

Comment

Merchants located in a GST/PST province (Montreal) should create
one tax rule and show a combined tax amount.
Be sure to consult a qualified tax authority if you have any questions.
For information about the tax requirements of specific provinces, see
the following:
Revenu Québec
Government of Saskatchewan
Manitoba Information for Vendors

1230

Magento Commerce User Guide

International Tax Guidelines

U.S. Tax Guidelines
These recommended settings can be used for most tax configurations for stores within the
United States.

Tax Classes
TAX CLASS
Tax Class for Shipping

RECOMMENDED SETTING
None

Calculation Settings
CALCULATION

RECOMMENDED SETTING

Tax Calculation Method Based On Total
Tax Calculation Based On

Shipping Origin

Catalog Prices

Excluding Tax

Shipping Prices

Excluding Tax

Apply Customer Tax

After Discount

Apply Discount on Prices

Excluding Tax

Default Tax Destination Calculation
SETTING

RECOMMENDED SETTING

Default Country

United States

Default State

State where business is located.

Default Post Code

The postal code that is used in your tax zones.

Price Display Settings
SETTING

RECOMMENDED SETTING

Display Product Prices in Catalog Excluding Tax
Display Shipping Prices

Excluding Tax

Shopping Cart Display Settings
SETTING

RECOMMENDED SETTING

Display Prices

Excluding Tax

Display Subtotal

Excluding Tax

Magento Commerce User Guide

1231

International Tax Guidelines

SETTING

RECOMMENDED SETTING

Display Shipping Amount

Excluding Tax

Display Gift Wrapping Prices Excluding Tax
Display Printed Card Prices

Excluding Tax

Include Tax in Grand Total

Yes

Display Full Tax Summary

Yes

Display Zero Tax Subtotal

Yes

Orders, Invoices, Credit Memos, Display Settings
SETTING

RECOMMENDED SETTING

Display Prices

Excluding Tax

Display Subtotal

Excluding Tax

Display Shipping Amount

Excluding Tax

Include Tax in Grand Total

Yes

Display Full Tax Summary

Yes

Display Zero Tax Subtotal

Yes

Fixed Product Taxes
SETTING
Enable FPT

1232

RECOMMENDED SETTING
No, except in California.

Magento Commerce User Guide

International Tax Guidelines

Canadian Tax Guidelines
The following example shows how to set up GST tax rates for Canada and PST tax rates for
Saskatchewan, with tax rules that calculate and display the two tax rates. Because this is an
example configuration, be sure to verify the correct tax rates and rules for your tax
jurisdictions. When setting up taxes, set the store scope to apply the configuration to all
applicable stores and websites.
l

Fixed product tax is included for relevant goods as a product attribute.

In Quebec, PST is referred to as TVQ. If you need to set up a rate for Quebec, make sure to
use TVQ as the identifier.
Process Overview:
Step 1: Complete the Tax Calculation Settings
Step 2: Set Up Canadian Goods & Services Tax (GST)
Step 3: Set Up Canadian Provincial Sales Tax (PST)
Step 4: Create a GST Tax Rule
Step 5: Create a PST Tax Rule for Saskatchewan
Step 6: Save and Test the Results

Step 1: Complete Tax Calculation Settings
1.

On the Admin menu, select System > Configuration. Then in the panel on the left, under
Sales, select Tax.

Click to expand each section, and complete the following settings:

Tax Calculation Settings
FIELD

RECOMMENDED SETTING

Tax Calculation Method Based On Total
Tax Calculation Based On

Shipping Address

Catalog Prices

Excluding Tax

Shipping Prices

Excluding Tax

Apply Customer Tax

After Discount

Apply Discount on Prices

Excluding Tax

Apply Tax On

Custom Price (if available)

Magento Commerce User Guide

1233

International Tax Guidelines

Tax Classes
FIELD
Tax Class for Shipping

RECOMMENDED SETTING
Shipping (shipping is taxed)

Default Tax Destination Calculation
FIELD

RECOMMENDED SETTING

Default Country

Canada

Default State

(as appropriate)

Default Postal Code

* (asterisk)

Shopping Cart Display Settings
FIELD

RECOMMENDED SETTING

Include Tax in Grand Total

Yes

Display Full Tax Summary

Yes

Display Zero in Tax Subtotal Yes

Fixed Product Taxes
FIELD

1234

RECOMMENDED SETTING

Enable FPT

Yes

All FPT Display Settings

Including FPT and FPT description

Apply Discounts to FPT

Apply Tax to FPT

Yes

Include FPT in Subtotal

Magento Commerce User Guide

International Tax Guidelines

Step 2: Set Up Canadian Goods & Services Tax (GST)
To print the GST number on invoices and other sales documents, include it in the name of the
applicable tax rates. The GST will appear as part of the GST amount on any order summary.

Manage Tax Zones & Rates
FIELD

RECOMMENDED SETTING

Tax Identifier

Canada-GST

Country

Canada

State

* (asterisk)

Zip/Post is Range

Zip/Post Code

* (asterisk)

Rate Percent

5.0000

Step 3: Set Up Canadian Provincial Sales Tax (PST)
Set up another tax rate for the applicable province.

Tax Rate Information
FIELD

RECOMMENDED SETTING

Tax Identifier

Canada-SK-PST

Country

Canada

State

Saskatchewan

Zip/Post is Range

Zip/Post Code

* (asterisk)

Rate Percent

5.0000

Magento Commerce User Guide

1235

International Tax Guidelines

Step 4: Create a GST Tax Rule
To avoid compounding the tax and to correctly display the calculated tax as separate line
items for GST and PST, you must set different priorities for each rule, and select the “Calculate
off subtotal only” checkbox. Each tax appears as a separate line item, but the tax amounts are
not compounded.

Tax Rule Information
FIELD

RECOMMENDED SETTING

Name

Retail-Canada-GST

Customer Tax Class

Retail Customer

Product Tax Class

Taxable Goods
Shipping

1236

Tax Rate

Canada-GST

Priority

Calculate off subtotal only

Select this checkbox.

Sort Order

Magento Commerce User Guide

International Tax Guidelines

Step 5: Create a PST Tax Rule for Saskatchewan
For this tax rule, make sure to set the priority to 0 and select the "Calculate off subtotal only"
checkbox. Each tax appears as a separate line item, but the tax amounts are not compounded.

Tax Rule Information
FIELD

RECOMMENDED SETTING

Name

Retail-Canada-PST

Customer Tax Class

Retail Customer

Product Tax Class

Taxable Goods
Shipping

Tax Rate

Canada-SK-PT

Priority

Calculate off subtotal only

Select this checkbox.

Sort Order

Step 6: Save and Test the Results
1.

When complete, click the Save Config button.

Return to your storefront, and create a sample order to test the results.

Magento Commerce User Guide

1237

International Tax Guidelines

EU Tax Guidelines
The following example depicts a store based in France that sells > 100k Euros in France and >
100k Euros in Germany.
l

Tax calculations are managed at the website level.

Currency conversion and tax display options are controlled individually at the store view
level, (Click the Use Website checkbox to override the default).

By setting the default tax country you can dynamically show the correct tax for the
jurisdiction.

Fixed product tax is included for relevant goods as a product attribute.

It might be necessary to edit the catalog to ensure that it shows up in the correct
category/website/store view.
Process Overview:
Step 1: Create Three Product Tax Classes
Step 2: Create Tax Rates for France and Germany
Step 3: Set Up the Tax Rules
Step 4: Set Up a Store View for Germany
Step 5: Configure Tax Settings for France
Step 6: Configure Tax Settings for Germany

Step 1: Create Three Product Tax Classes
For this example, it is assumed that multiple VAT-Reduced product tax classes are not needed.

1238

Create a VAT-Standard product tax class.

Create a VAT-Reduced product tax class.

Create a VAT-Free product tax class.

Magento Commerce User Guide

International Tax Guidelines

Step 2: Create Tax Rates for France and Germany
Create the following tax rates:

Tax Rates
TAX RATE
France-StandardVAT

France-ReducedVAT

Germany-StandardVAT

Germany-ReducedVAT

Magento Commerce User Guide

SETTING
Country:

France

State/Region:

ZIP/Postal Code:

Rate:

20%

Country:

France

State/Region:

ZIP/Postal Code:

Rate:

Country:

Germany

State/Region:

ZIP/Postal Code:

Rate:

19%

Country:

Germany

State/Region:

ZIP/Postal Code:

Rate:

1239

International Tax Guidelines

Step 3: Set Up the Tax Rules
Create the following tax rules:

Tax Rules
TAX RULE
Retail-France-StandardVAT

Retail-France-ReducedVAT

Retail-GermanyStandardVAT

Retail-GermanyReducedVAT

1240

SETTING
Customer Class:

Retail Customer

Tax Class:

VAT-Standard

Tax Rate:

France-StandardVAT

Priority:

Sort Order:

Customer Class:

Retail Customer

Tax Class:

VAT Reduced

Tax Rate:

France-ReducedVAT

Priority:

Sort Order:

Customer Class:

Retail Customer

Tax Class:

VAT-Standard

Tax Rate:

Germany-StandardVAT

Priority:

Sort Order:

Customer Class:

Retail Customer

Tax Class:

VAT-Reduced

Tax Rate:

Germany-ReducedVAT

Priority:

Sort Order:

Magento Commerce User Guide

International Tax Guidelines

Step 4: Set Up a Store View for Germany
1.

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

Under the default website, create a store view for Germany. Then, do the following:

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

In the upper-left corner, set Default Config to the French store.

On the General page, expand
country to “France.”

Complete the locale options as needed.

the Countries Options section, and set the default

In the upper-left corner, choose the German Store View. Then, do the following:
a.

On the General page, expand

Countries Options, and set the default country to

“Germany.”
b.

Complete the locale options as needed.

Step 5: Configure Tax Settings for France
Complete the following General tax settings:

General Settings
FIELD

RECOMMENDED SETTING

TAX CLASSES
Tax Class for Shipping

Shipping (shipping is taxed)

CALCULATION SETTINGS
Tax Calculation Method Based
On

Total

Tax Calculation Based On

Shipping Address

Catalog Prices

Including Tax

Shipping Prices

Including Tax

Apply Customer Tax

After Discount

Apply Discount on Prices

Including Tax

Apply Tax On

Custom Price (if available)

Magento Commerce User Guide

1241

International Tax Guidelines

General Settings (cont.)
FIELD

RECOMMENDED SETTING

DEFAULT TAX DESTINATION CALCULATION
Default Country

France

Default State
Default Postal Code

* (asterisk)

SHOPPING CART DISPLAY SETTINGS
Include Tax in Grand Total

Yes

FIXED PRODUCT TAXES

1242

Enable FPT

Yes

All FPT Display Settings

Including FPT and FPT description

Apply Discounts to FPT

Apply Tax to FPT

Yes

Include FPT in Subtotal

Yes

Magento Commerce User Guide

International Tax Guidelines

Step 6: Configure Tax Settings for Germany
1.

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

In the upper-right corner, set Store View to the view to the German store. When prompted to
confirm, tap OK.

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

In the Default Tax Destination Calculation section, do the following:
a.

Clear the Use Website checkbox after each field,

Update the following values to match your site's Shipping Settings point of origin.
l

Default Country

Default State

Default Post Code

This setting ensures that tax is calculated correctly when product prices include tax.

Default Tax Destination Calculation
5.

When complete, tap Save Config.

Magento Commerce User Guide

1243

Warning Messages

Warning Messages
Some combinations of tax-related options might be confusing to customers and trigger a
warning. These conditions might occur when the tax calculation method is set to “Row” or
“Total,” and the customer is presented with prices that both exclude and include tax, or a tax
on an item basis in the cart. Because the tax calculation is rounded, the amount that appears
in the cart might differ from the amount that a customer expects to pay.
If your tax calculation is based on a problematic configuration, the following warnings appear:
Warning. Tax discount configuration might result in different discounts than a customer
might expect for store(s); Europe Website (French), Europe Website (German). Please
see source for more details.
Warning. Tax configuration can result in rounding errors for store(s): Europe Websites
(French), Europe Websites (German).

Calculation Settings
Use the following tables for reference when configuring tax calculation settings:

Tax Calculation Method Based On: Excluding Tax
Tax Excluded
PRICE DISPLAY

UNIT PRICE

ROW TOTAL

TOTAL

Tax Class for Shipping Shipping (is taxed)
Excluding tax

Including tax

Including and
Excluding tax

Warning

Catalog Prices: Including Tax
Tax Included
PRICE DISPLAY

1244

UNIT PRICE

ROW TOTAL

TOTAL

Excluding tax

Including tax

Including and
Excluding tax

Warning

Magento Commerce User Guide

Warning Messages

Calculation Settings

Discount Settings
We strongly recommend that you use the following settings to avoid issues when configuring
taxes in relation to discounts.

Recommended Settings
FIELD
Apply Customer Tax
Apply Discount on Prices

Magento Commerce User Guide

RECOMMENDED SETTING
After Discount
US and Canada

Excluding Tax

Including Tax

1245

1246

Magento Commerce User Guide

CHAPTER 82:

Currency
Magento Commerce gives you the ability to accept currencies from more than two hundred
countries around the world. If the store supports multiple currencies, a Currency Chooser
appears in the header after currency rates are updated.
If you accept payment in multiple currencies, make sure to monitor the currency rate settings,
because any fluctuation can impact your profit margin.

Currency symbols appear in product prices and sales documents such as orders and invoices.
You can customize the currency symbols as needed, and also set the display of the price
separately for each store or view.

Currency Chooser

Magento Commerce User Guide

1247

Currency Configuration

CHAPTER 82: Currency

Currency Configuration
Before setting up individual currency rates, you must first set the scope of the base currency,
By default, it is set to global, which applies the base currency setting to the entire store
hierarchy. If you have a multisite installation of Magento, you can manage multiple base
currencies by setting the scope to the website level.
Then, specify which currencies you accept, and the currency that you want to use for the
display of prices in your store. In the following illustration, the scope of the base currency is set
at the website level, so each website can have a different base currency.

Scope of Base Currency

Process Overview:
Step 1: Choose the Accepted Currencies
Step 2: Configure the Import Connection
Step 3: Configure the Scheduled Import Settings
Step 4: Update the Currency Rates

1248

Magento Commerce User Guide

CHAPTER 82: Currency

Currency Configuration

Step 1: Choose the Accepted Currencies
1.

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

In the upper-right corner, set Store View to the store view where the cconfiguration applies.

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

Expand

the Currency Options section, and do the following:

Set Base Currency to the primary currency that you use for online transactions.

Set Default Display Currency to the currency that you use to display pricing in the store
view.

In the Allowed Currencies list, select all currencies that you accept as payment in the
store view. Make sure to also select your primary currency. (For multiple currencies, hold
down the Ctrl key and select each option.)

Currency Options
5.

When prompted to refresh the cache, tap the Close (

)box in the upper-right corner of the

system message. We’ll refresh the cache later.
6.

To define the scope of the base currency, do the following:
a.

In the panel on the left under Catalog, choose Catalog. Then, scroll down and expand
the Price section.

Set Catalog Price Scope to either “Global” or “Website.”

Price

Magento Commerce User Guide

1249

Currency Configuration

CHAPTER 82: Currency

Step 2: Configure the Import Connection
1.

Scroll back up to the top of the page. In the panel on the left under General, choose Currency
Setup.

Expand

the WebserviceX section.

In the Connection Timeout in Seconds field, enter the number of seconds of inactivity to
allow before the connection times out.

WebserviceX

Step 3: Configure the Scheduled Import Settings
1.

Continuing with Currency Setup, expand

the Scheduled Import Settings section.

To automatically update currency rates, set Enabled to "Yes." Then, do the following:
a.

Set Service to the rate provider. The default value is “Webservicex.”

Set Start Time to the hour, minute, and second that the rates will be updated according to
the schedule.

To determine how often the rates are updated, set Frequency to one of the following:
l

Daily

Weekly

Monthy

In the Error Email Recipient field, enter the email address of the person who is to receive
email notification if an error occurs during the import process. To enter multiple email
addresses, separate each with a comma.

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

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

When complete, tap Save Config.

When prompted to update the cache, tap the Cache Management link. Then, refresh the
invalid cache.

1250

Magento Commerce User Guide

CHAPTER 82: Currency

Currency Configuration

Refresh Cache

Step 4: Update the Currency Rates
The currency rates must be updated with the current values before they go into effect. Follow
the instructions to update the rates manually or to import the rates automatically.

Magento Commerce User Guide

1251

Currency Symbols

CHAPTER 82: Currency

Currency Symbols
Manage Currency Symbols gives you the ability to customize the symbol associated with each
currency that is accepted as payment in your store.

Currency Symbols

To customize currency symbols:
1.

On the Admin sidebar, tap Stores. Then under Currency, choose Currency Symbols.
Each currency that is currently enabled for your store appears in the Currency list.

Enter a custom symbol for each currency you want to use, or mark the Use Standard checkbox
to the right of each currency.

To override the default symbol, clear the Use Standard checkbox. Then, enter the symbol that
you want to use.
It is not possible to change the alignment of the currency symbol from left to right.

When complete, tap Save Currency Symbols.

When prompted to update the cache, tap the Cache Management link. Then, refresh any
invalid cache.

Refresh Cache

1252

Magento Commerce User Guide

CHAPTER 82: Currency

Updating Currency Rates

Updating Currency Rates
Currency rates can be set manually, or imported into the store. To ensure that your store has
the most current rates, you can configure the currency rates to be updated automatically on
schedule.
Before importing currency rates, complete the Currency Rate Setup to specify the currencies
that you accept, and to establish the import connection and schedule.

Updating Currency Rates

To manually update a currency rate:
1.

On the Admin sidebar, click Stores. Then under Currency, choose Currency Rates.

Tap the rate you want to change, and enter the new value for each currency supported.

When complete, tap Save Currency Rates.

To import currency rates:
1.

On the Admin sidebar, tap Stores. Then under Currency, choose Currency Rates.

Set Import Service to the currency rate provider. WebserviceX is the default provider.

Tap Import.
The updated rates appear in the Currency Rates list. If the rates have changed since the last
update, the old rate appears below for reference.

When complete, tap Save Currency Rates.

When prompted to update the cache, tap the Cache Management link. Then, refresh all
invalid caches.

Magento Commerce User Guide

1253

Updating Currency Rates

CHAPTER 82: Currency

Refresh Invalid Caches

To import currency rates on schedule:
1.

Make sure that Cron is enabled for your store.

Complete the Currency Rate Setup to specify the currencies that you accept, and to establish
the import connection and schedule.

To verify that the rates are imported on schedule, check the Currency Rates list. Then, wait for
the duration of the frequency setting established for the schedule, and check the rates again.

1254

Magento Commerce User Guide

CHAPTER 83:

Attributes
Magento uses attributes to manage the information associated with products, customers, and
product ratings. Attributes are pieces of information that might appear as fields in forms,
reports, product reviews, layered navigation, and email messages. Some attributes are built into
the system, and others can be created to address specific needs.
To learn more about creating and managing product attributes, see:
l

Product Attributes

Attribute Sets

To learn more about importing and exporting attributes, see:
l

Data Transfer

Using Product Attributes

Product Attribute Reference

Customer Attribute Reference

Magento Commerce User Guide

1255

Product Attributes

CHAPTER 83: Attributes

Product Attributes
Product attribute properties determine how an attribute can be used in the catalog, its
appearance and behavior in the store, and in data transfer operations. The properties and labels
associated with each attribute determine how it can be used, and its presentation in the store.
Properties

The Properties section includes both basic and advanced attribute
properties.

Labels

The label identifies an attribute in the Admin and also in the storefront
of each store view. If your store is available in multiple languages, you
can enter a different translated label for each language.

Storefront
Properties

The Storefront Properties determine how an attribute can be used in your
store, its appearance, and behavior. You can specify if attributes are
available for search, layered navigation, product comparisons, price
rules, and sorting. For text attributes, you can enable the WYSIWYG
editor, and determine if HTML tags can be used to format the values.

To learn how to use attributes while creating a product, see: Product Attributes.

Product Attributes Page

1256

Magento Commerce User Guide

CHAPTER 83: Attributes

Product Attributes

Properties
Property Descriptions
PROPERTY

DESCRIPTION

ATTRIBUTE PROPERTIES
Default Label

The label that identifies the attribute during data entry.

Catalog Input Type for
Store Owner

Determines the data type and input control that is used to manage
the product from the store Admin. Options include:

Magento Commerce User Guide

Text Field

A single line input field for text.

Text Area

A multiple-line input field that can display
paragraphs of text formatted with HTML.

Date

An input field for date values. The date can
be typed directly into the field, or selected
from a list or calendar.

Yes/No

A drop-down list with predefined options of
“Yes” and “No.”

Multiple Select

A drop-down list of options that allows
multiple selections. To select more than one
option, hold down the Ctrl key and click each
item.

Dropdown

A drop-down list of options that allows only
one selection.

Price

An input type that can be used to create
price fields in addition to the predefined
attributes: Price, Special Price, Tier Price
and Cost.

Media Image

An additional image that can be included in
the attribute set of a product.

Visual Swatch

Displays a swatch that depicts the color,
texture, or pattern of a configurable product.
A visual swatch can be filled with a
hexadecimal color value, or display an
uploaded image that represents the color,
material, texture, or pattern of the option.

1257

Product Attributes

CHAPTER 83: Attributes

Property Descriptions (cont.)
PROPERTY

Values Required

DESCRIPTION
Text Swatch

A text-based representation of a configurable
product option that is frequently used for
size. Text swatches can also include
hexadecimal color values.

Fixed Product Tax

An input type that gives you the ability to
define FPT rates based on the requirements
of your locale.

To require that a value to be entered in this field before the record can
be saved, set Values Required to “Yes.” Options include: Yes / No

ADVANCED ATTRIBUTE PROPERTIES
Attribute Code

(Required) A unique identifier for internal use. The Attribute Code
must begin with a letter, but can include a combination of lowercase
letters (a-z) and numbers (0-9). The code must be less than thirty
characters in length and cannot include any special characters or
spaces, although an underscore (_) can be used to indicate a space.

Scope

Limits the use of an attribute to a specific store view or website.
Options include:
Store View
Website
Global

Default Value

Assigns a starting value to the attribute to help during data entry. To
assign a default value for Multiple Select or Dropdown input types,
see: Creating Product Attributes.
A default value cannot be set for Multiple Select, Dropdown, or Fixed
Product Tax input types.

1258

Unique Value

Requires the attribute value to be different from all other values
entered in the same attribute, within the context of the scope setting.
Unique value should be enabled for any attribute that is used as an
ID number. For example, because SKU is used to identify products
throughout the hierarchy, it has a unique value with a global scope.
Options: Yes / No

Input Validation for Store
Owner

Performs a validation check of the data entered in the field, based on
the following options:

Magento Commerce User Guide

CHAPTER 83: Attributes

Product Attributes

Property Descriptions (cont.)
PROPERTY

DESCRIPTION
None
Decimal Number
Integer Number
Email
URL
Letters
Letters (a-z, A-Z) or Numbers (0-9)

Add to Column Options

Determines if the column appears in the product grid. Options: Yes /
No

Use in Filter Options

Determines if the attribute is used as a filter control at the top of
columns in the grid. Options: Yes / No

Storefront Properties
Property Descriptions
PROPERTY
Use in Search

DESCRIPTION
Select “Yes” if you want people to be able to search the catalog
based on the value of this attribute. Options include: Yes / No
The following attributes appear when Search is enabled:
Search Weight

To weight the search results, set Search
Weight to a number from 1 to 10.

Visible in Advanced Gives shoppers the ability to enter search
Search
criteria through a form. Options
include: Yes / No
Using too many attributes can slow down
search.

Comparable on Storefront

Select “Yes” to include this attribute as a row in the Compare
Products report. Options include: Yes / No

Use In Layered Navigation

(Dropdown, Multiple Select and Price input types only) Includes the
attribute as a filter in the “Shop By” section of layered navigation.
Options include:

Magento Commerce User Guide

1259

Product Attributes

CHAPTER 83: Attributes

Property Descriptions (cont.)
PROPERTY

DESCRIPTION
No

The attribute is not available to be used as a
filter in layered navigation.

Filterable (with
results)

Layered navigation includes only those
filters for which matching products can be
found. Any attribute value that already
applies to all products shown in the list does
not appear as an available filter. Attribute
values with a count of zero (0) product
matches are also omitted from the list of
available filters.
The filtered list of products includes only
those that match the filter. The products list
is updated only if the selected filter(s)
change what is currently shown.

Filterable (no
results)

Layered navigation includes filters for all
available attribute values and their product
counts, including those with zero (0) product
matches. If the attribute value is a swatch,
the value appears as a filter, but is crossed
out.

Use In Search Results
Layered Navigation

To include the attribute in the layered navigation for search results,
select “Yes.” Options include: Yes / No

Position

Determines the position of the attribute in layered navigation in
relation to other filterable attributes.

Use for Promo Rule
Conditions

To make the attribute available for use in price rules, select “Yes.”
Options include: Yes / No

Allow HTML Tags on
Storefront

(Text Field and Text Area input types only) To be able to format the
attribute value with HTML tags, select “Yes.” Options include: Yes /
No

Visible on Catalog Pages
on Storefront

(Simple and virtual products only) To include the attribute on the
Additional Information tab of the product page, select “Yes.” Options
include: Yes / No

Used in Product Listing

Depends on the theme. To include the attribute in product summaries
that appear in catalog listings, select “Yes.”

Used for Sorting in Product Depending on theme, includes the attribute as a “Sort By” option for
Listing
catalog listings. Options: Yes / No

1260

Magento Commerce User Guide

System

1261

Contents

Configuring Admin Security
CAPTCHA

In this section of the guide, you’ll learn how to
import and export data, manage security and
permissions, install extensions and integrations,
and use the many tools that are available to
maintain your store at peak performance.
System Menu

Encryption Key
Session Validation
Browser Capabilities Detection
Tools
Cache Management
Full Page Cache

Data Transfer
Working with CSV Files
Data Validation
Import
Import History

Index Management
IndexTrigger Events
Backups
Cron (Scheduled Tasks)
Developer Tools

Product Images

Frontend Development Workflow

Importing Tier Prices

Using Static File Signatures

Import Guidelines

Optimizing Resource Files

Export
Export Criteria
Exporting Tier Prices
Product Attribute Reference

Developer Client Restrictions
Template Path Hints
Translate Inline
Web Setup Wizard

Complex Data

Extension Manager

Advanced Pricing

Module Manager

Customer Attribute Reference

System Upgrade
System Configuration

Integrations
Magento Marketplace
Permissions
Adding Users
Locked Users
User Roles
Role Resources
Alternate Media Storage
Using a Database
Using a CDN
Security
Security Scan
Security Best Practices
Security Action Plan
1262

CHAPTER 84:

System Menu
The System Menu includes tools to import and export data, install extensions, manage system
caches and indexes, manage permissions, backups, system notifications, and custom variables.

System Menu

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

Magento Commerce User Guide

1263

Menu Options

CHAPTER 84: System Menu

Menu Options
Data Transfer
The Import and Export tools give you the ability to
manage multiple records in a single operation. You
can import new items, and also update, replace, and
delete existing products and tax rates.

Extensions
Manage integrations and extensions for your store.

Tools
Manage your system resources, including cache and
index management, backups, and installation
settings.

Permissions
Magento uses roles and permissions to create different
levels of access for Admin users, which gives you the
ability to grant permission on a “need to know” basis
to people who work on your site.

Other Settings
Manage the notifications in your inbox, create custom
variables, and generate a new encryption key.

1264

Magento Commerce User Guide

CHAPTER 84: System Menu

Menu Options

Amazon Logs
Provides access to Client and IPN logs, if enabled in
the Develothe per Options section of the Amazon Pay
configuration.

Magento Commerce User Guide

1265

1266

Magento Commerce User Guide

CHAPTER 85:

Data Transfer
The Import and Export tools give you the ability to manage multiple records in a single
operation. You can not only import new items, but also update, replace, and delete existing
sets of products. For example, you can add new products to your inventory, update product
data and advanced price data, and replace a set of existing products with new products. If you
have a large catalog of products, it’s much easier to export the data, edit the data in a
spreadsheet, and import it back into your store.
l

Working with CSV Files

Import

Export

Product Attribute Reference

Customer Attribute Reference

Magento Commerce User Guide

1267

Working with CSV Files

CHAPTER 85: Data Transfer

Working with CSV Files
The comma-separated-value (CSV) file format is used as the basis of data transfer operations,
and is supported by all spreadsheet and database applications. The following file types are
supported for import and export:
Import

CSV and ZIP (a compressed CSV file.)

Export

CSV

Important! We recommend that you use a program that supports UTF-8 encoding, such as
Notepad++ or OpenOffice Calc, to edit CSV files. Microsoft Excel inserts additional characters into
the column header of the CSV file, which can prevent the data from being imported back into
Magento. If you work on the Mac, you can save your data in the CSV (Windows) format.
CSV files have a specific structure that must match the database. Each column heading
corresponds to the Attribute Code of the field that is represented by the column. To ensure that
the column headings can be read by Magento, first export the data from your store as a CSV
file. You can then edit the data and re-import it into Magento.
If you open an exported CSV file in a text editor, you will see that values are separated by
commas, and multiple values are enclosed in double-quotes. During import, you can specify a
custom separator character, although a comma is the default.

Product CSV Structure
A full export of the product database contains information about each product in the catalog,
and the relationships between them. Each record has fixed selection of columns that
corresponds to the attributes in the catalog, although the order of the attributes is ignored
during the import process.

Exported Product CSV in OpenOffice Calc

1268

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Working with CSV Files

The first row of the table contains the names of each attribute, which are used as column
headers. The remaining rows describe the individual product records. Any row that begins with
a value in the SKU column is the beginning of a new product record. A single product might
include several rows that contain information about multiple images or product options. The
next row that has a value in the SKU column begins a new product.
The category column contains a path for each category to which the product is assigned. The
path includes the root category, followed by a forward slash (/) between each level. By default,
the pipe “|” character is used to separate different category paths. For example:
Default Category/Gear|Default Category/Gear/Bags.
To import data, you need to include only the SKU and any columns with changes. Any blank
columns are ignored during the import process. It is not possible to add attributes during the
import process. You can include only existing attributes.
For a detailed description of each product attribute, see: Product Attribute Reference.

Exported Product CSV in Notepad++

CSV Product Structure
COLUMN NAME

DESCRIPTION

Column headers that begin with an underscore contain service entity
properties or complex data. Service columns are not product
attributes.

Column headers with an attribute code or field name identify the
column of data. A column might represent a system attribute, or one
that was created by the store administrator.

Magento Commerce User Guide

1269

Working with CSV Files

CHAPTER 85: Data Transfer

Customer CSV Structure
The customers CSV file contains customer information from the database, and has the
following structure:

Exported Customer CSV in OpenOffice Calc
The first row of the table contains the names of the attribute columns (which are the same as
attribute codes). There are two types of column names, as shown in the following table. Other
rows contain attribute values, service data, and complex data. Each row with non-empty
values in the “email” and “_website” columns starts the description of the subsequent
customer. Each row can represent customer data with or without address data, or the address
data only. In case a row contains only the address data, values in the columns, related to the
customer profile, will be ignored and may be empty.
To add or replace more than one address for a customer, in the import file add a row for each
new address with empty customer data and the new or updated address data below the
customer data row.
For a detailed description of each customer attribute, see: Customer Attribute Reference.

Exported Customer CSV in Notepad++

CSV Customer Structure
COLUMN NAME

1270

DESCRIPTION

Column headers that begin with an underscore contain service entity
properties or complex data. Service columns are not customer
attributes.

The names of the columns with values of both system-created
attributes, and attributes created by the store administrator.

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Working with CSV Files

Data Validation
All data must pass validation before it can be imported into the store, to ensure that the values
are consistent with the system database. Validation begins when you tap the Check Data
button. During the process, all entities in the import file are verified for the following:
Attributes

Column header names are verified to ensure that they match the
corresponding attributes in the system database. The value of
each attribute is checked to ensure that it meets the requirements
of the data type (decimal, integer, varchar, text, and datetime)

Complex Data

Values that originate from a defined set, such as a drop-down or
multiple select input type, are verified to ensure that the values
exist in the defined set.

Service Data

The values in service data columns are verified to ensure that the
properties or complex data values are consistent with what is
already defined in the system database.

Required Values

For new entities, the presence of required attribute values in the
file is checked. For existing entities, there is no need to re-check
the existence of required attribute values.

Separators

Although the separators aren’t visible when viewed in a
spreadsheet, data values in a CSV file are separated by comma,
and text values are enclosed in double-quotes. During the
validation process, the separators are verified, and each set of
quotes that enclose character strings is verified to be formatted
correctly.

The results of the validation appear in the Validation Results section, and include the following
information:
l

The number of entities checked

The number of invalid rows

The number of errors found

If the data is valid, an “Import Success” message appears.

File is Valid!

Magento Commerce User Guide

1271

Working with CSV Files

CHAPTER 85: Data Transfer

If validation fails, read the description of each error, and correct the problem in the CSV file.
For example, if a row contains an invalid SKU, the import process stops, and that row, and all
subsequent rows are not imported. After correctly the problem, import the data again. If many
errors are encountered, it might take several attempts to pass validation.

Data Validation Messages
MESSAGES
DATA VALIDATION
l

Product with specified SKU not found in rows: 1

URL key for specified store already exists

'7z' file extension is not supported

'txt' file extension is not supported

ERRORS
l

Wrong field type. Type in the imported file %decimal%, expected type is %text%.

Value is not allowed. Attribute value does not exist in the system.

Field %column name% is required.

Wrong value separator is used.

Wrong encoding used. Supported character encoding is UTF-8 and Windows-1252.

Imported file does not contain SKU field.

SKU does not exist in the system.

Column name %column name% is invalid. Should start with a letter. Alphanumeric.

Imported file does not contain a header.

%website name% website does not exist in the system.

%storeview name% storeview does not exist in the system.

Imported attribute %attribute name% does not exist in the system.

Imported resource (image) does not exist in the local media storage.

Product creation error displayed to the user equal to the one seen during manual product save.

1272

Imported resource (image) could not be downloaded from external resource due to timeout or
access permissions.

Advanced Price creation error displayed to the user equal to the one seen during the manual
product save.
Customer creation error displayed to the user equal to the one seen during the manual customer
save.

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Import

Import
Data for all product types can be imported into the store. In addition, you can import
products, advanced pricing data, customer data, customer address data, and product images.
Import supports the following operations:
l

Add/Update

Replace

Delete

The size of the import file is determined by the settings in the php.ini file on the server. The
system message on the Import page indicates the current size limit.
Special characters — such as the equal sign, greater and less than symbols, single and double
quotes, backslash, pipe, and ampersand symbols — can cause problems during data transfer.
To ensure that such special characters are correctly interpreted, they can be marked as an
“escape sequence.” For example, if the data includes a string of text such as
code=”str”,code=”str2”, choosing to enclose the text in double quotes ensures that the original
double quotes are understood to be part of the data. When the system encounters a double set
of double quotes, it understands that the outer set of double quotes is enclosing the actual
data.

Import

Process Overview:
Step 1: Prepare the Data
Step 2: Choose the Import Behavior
Step 3: Identify the Import File
Step 4: Check the Import Data

Magento Commerce User Guide

1273

Import

CHAPTER 85: Data Transfer

Step 1: Prepare the Data
1.

On the Admin sidebar, tap System. Then under Data Transfer, choose Import.

Under Import Settings, set Entity Type to one of the following:

Advanced Pricing

Products

Customers and Addresses

Customers Main File

Customer Addresses

Tap Download Sample File. Then on the download menu in the lower-left corner of your
browser window, choose Open.

Download Sample File
The sample file includes column headings with placeholder data for example product types.

Downloaded Sample File

1274

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Import

Examine the structure of the sample file. As you prepare your CSV import file, make sure that
the column headings are spelled correctly.

Verify that the size of your import file does not exceed the limit shown in the message.

If the import data includes paths to product images, make sure that the image files have been
uploaded to the appropriate location. The default location on the Magento server is:
pub/media/import.

If the images reside on an external server, make sure that you have the full URL to the
directory that contains the images.

Step 2: Choose the Import Behavior
1.

Set Import Behavior to one of the following:
l

Add/Update

Replace

Delete

To determine what happens when an error is encountered when importing data, choose one of
the following:
l

Stop on Error

Skip error entries

Then in the Allowed Errors Count field, enter the number of errors that can occur before the
import is canceled. The default value is 10.
3.

Do the following:
a.

Accept the default value of a comma (,) for the Field separator.

Accept the default value of a comma (,) for the Multiple value separator.
In a CSV file, a comma is the default separator. To use a different character, make sure
that the data in the CSV file matches the character that you specify.

If you want to enclose any special characters that might be found in the data as an
“escape sequence,” mark the Fields Enclosure checkbox.

Magento Commerce User Guide

1275

Import

CHAPTER 85: Data Transfer

Import Behavior

Step 3: Identify the Import File
1.

Tap Choose File to select the file to import.

Find the CSV file that you prepared to import, and tap Open .

In the Images File Directory field, enter the relative path to the location on the Magento server
where uploaded images are stored. For example: var/import.
To learn more about importing product images, see: Importing Product Images.

File to Import

Step 4: Check the Import Data
1.

In the upper-right corner, tap Check Data .

Then, wait a few moments for the validation process to complete. If the import data is valid,
the following message appears:

File is Valid!
3.

If the file is valid, tap Import . Otherwise, correct each problem with the data that is listed in
the message, and try to import the file again.

1276

The import process continues to the end of the data, unless an error is encountered.

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Import

If an error message appears in the Validation Results, correct the problem in the data, and
import the file again.

URL Key Already Exists
A message appears when the import is complete.

Import Behavior
OPERATION
Add/Update

DESCRIPTION
New product data is added to the existing product data for the
existing entries in the database. All fields except sku can be updated.
New tax classes that are specified in the import data are created
automatically.
New product categories that are specified in the import file are
created automatically.
New SKUs that are specified in the import file are created
automatically

Replace

The existing product data is replaced with new data.
Exercise caution when replacing data because the existing product
data will be completely cleared and all references in the system will
be lost.

If a SKU in the import data matches the SKU of an existing entity, all
fields, including the SKU are deleted, and a new record is created
using the CSV data. An error occurs if the CSV file references a SKU
that does not exist in the database. You can Check Data to display
error.
Delete

Any entities in the import data that already exist in the database are
deleted from the database.
Delete ignores all columns in the import data, except for SKU. You
can disregard all other attributes in the data.
An error occurs if the CSV file references a SKU that does not exist
in the database. You can Check Data to display error.

Magento Commerce User Guide

1277

Import

CHAPTER 85: Data Transfer

Import History
Maintains a record of data that has been imported into your store, including the start date and
time, user, execution time, and a link to the imported file.

To view the import history:
1.

On the Admin sidebar, tap System.

Under Data Transfer, choose Import History.

Import History

1278

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Import

Importing Product Images
Multiple product images of each type can be imported into Magento, and associated with a
specific product. The path and file name of each product image is entered in the CSV file, and
the image files to be imported are uploaded to the corresponding path on the Magento server or
external server.
Magento creates its own directory structure for product images that is organized alphabetically.
When you export product data with existing images to a CSV file, you can see the alphabetized
path before the file name of each image. However, when you import new images, you don’t
need to specify a path, because Magento manages the directory structure automatically. Just
make sure to enter the relative path to the import directory before the file name of each image
to be imported.
To upload images, you must have login credentials and correct permissions to access to the
Magento folder on the server. With the correct credentials, you can use any SFTP utility to
upload the files from your desktop computer to the server.
Before you try to import a large amount of images, review the steps in the import method that
you want to use, and run through the process with a few products. After you understand how it
works, you’ll feel confident importing large quantities of images.
Important! We recommend that you use a program that supports UTF-8 encoding to edit CSV files,
such as Notepad++ or OpenOffice Calc. Microsoft Excel inserts additional characters into the
column header of the CSV file, which can prevent the data from being imported back into Magento.

Method 1: Import Images from the Local Server
1.

On the Magento server, upload the image files to the pub/media/import folder. This is the
default folder for importing product images.
[magento installation folder]/pub/media/import

You can use a different folder on the Magento server, as long as the path to the folder is
specified during the import process.
2.

In the CSV data, enter the name of each image file to be imported on the correct row, by sku,
and in the correct column according to image type (base_image, small_image, thumbnail_
image, or additional_images).
For images in the default import folder(/pub/media/import), do not include the path before the
filename in the CSV data.

The CSV file must include only the sku column and the related image columns.

Magento Commerce User Guide

1279

Import

CHAPTER 85: Data Transfer

CSV Import Image from Default Location
3.

Follow the instructions to import the data.
After selecting the file to import, enter the relative path following Images File Directory:
/pub/media/import

Images File Directory
If importing multiple images for a single sku, insert a blank row below the sku, and enter the
additional image file names in the appropriate columns. The additional rows are understood to
belong to the parent sku.

Method 2: Import Images from External Server
1.

Upload the images to be imported to the designated folder on the external server.

In the CSV data, enter the full URL for each image file in the correct column by image type
(base_image, small_image, thumbnail_image, or additional_images).
http://example.com/images/image.jpg

1280

Follow the instructions to import the data.

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Import

Import Guidelines
New Entities
Entities are added with the attribute values specified in the CSV file.

If there is no value, or there is a non-valid value, for a required attribute with no default value
set, then the entity (the corresponding row or rows) cannot be imported.
If there is no value, or there is a non-valid value, for a required attribute with the default
value set, then the entity (the corresponding row or rows) is imported, and the default value
is set for the attribute.
If the complex data is not valid, then the entity (the corresponding row or rows) cannot be
imported.

Existing Entities
For attributes that are not complex data, the values from the import file, including the empty
values for the non-required attributes, replace the existing values.
If there is no value, or there is a non-valid value, for a required attribute, then the existing
value is not replaced.
If the complex data for the entity is invalid, the entity (the corresponding row or rows)
cannot be imported, except the case, when Delete Entities was selected in the Import
Behavior drop-down menu.

Magento Commerce User Guide

1281

Import

CHAPTER 85: Data Transfer

Complex Data
If an attribute that is specified in the import file already exists, and its value is derived from a
defined set of values, the following applies:
If the value is not already included in the defined set of values, the row can be imported and
a default value, if defined, is set for the attribute.
If the value is already included in the defined set, the corresponding row cannot be
imported.
If an attribute name is specified in the import file but is not yet defined in the system, it is not
created, and its values are not imported.

Invalid Files
A file cannot be imported if all rows are invalid.

A non-existing service data or complex data name is specified in the import file, such as a
column with a _ heading.

1282

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Export

Export
The best way to become familiar with the structure of your database is to export the data and
open it in a spreadsheet. Once you become familiar with the process, you’ll find that it is an
efficient way to manage large amounts of information.
Special characters — such as the equal sign, greater and less than symbols, single and double
quotes, backslash, pipe, and ampersand symbols — can cause problems during data transfer.
To ensure that such special characters are correctly interpreted, they can be marked as an
“escape sequence.” For example, if the data includes a string of text such as
code=”str”,code=”str2”, choosing to enclose the text in double quotes ensures that the original
double quotes are understood to be part of the data. When the system encounters a double set
of double quotes, it understands that the outer set of double quotes is enclosing the actual
data.

To export data:
1.

On the Admin sidebar, tap System. Then under Data Transfer, choose Export.

In the Export Settings section, specify the following:
a.

Set Entity Type to one of the following:
l

Products

Customers Main File

Customer Addresses

Accept the default Export File Format of “CSV.”

If you want to enclose any special characters that might be found in the data as an “escape
sequence,” mark the Fields Enclosure checkbox.

Export Settings
3.

The Entity Attributes section lists all the available attributes in alphabetical order. You can use
the standard list controls to search for specific attributes, and to sort the list. The Search and
Reset Filter controls control the display of the list, but have no effect on the selection of
attributes to be included in the export file.

Magento Commerce User Guide

1283

Export

CHAPTER 85: Data Transfer

Filtered Entity Attributes
4.

To filter the exported data based on attribute value, do the following:
l

To export only records with specific attribute values, enter the required value in the Filter
column. The followng example exports only a specific SKU.

Export Product Based on SKU
l

To omit an attribute from the export, mark the Exclude checkbox at the beginning of the
row. For example, to export only the sku and image columns, select the checkbox of every
other attribute. The column appears in the export file, but without any values.

Exclude Attributes
5.

Scroll down and tap Continue in the lower-right corner of the page.
Look for the download prompt in the lower-right corner of your browser. The exported CSV file
can be saved or opened in a spreadsheet. You can edit the data and import it back into your
store.

1284

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Export

Export Criteria
Export filters are used to specify the data that you want to in the export file, based on attribute
value. In addition, you can specify which attribute data you want to include or exclude from
the export.

Export Criteria

Magento Commerce User Guide

1285

Export

CHAPTER 85: Data Transfer

Export Filters
You can use filters to determine which SKUs are included in the export file. For example, if you
enter a value in the Country of Manufacture filter, the exported CSV file will incude only
products manufactured in that country.
The type of filter corresponds to the data type. For date fields, you can choose the date from the
. To learn more, see: Attribute Input Types. The format of the date is determined
Calendar
by the locale.
To inlcude only records with a specific value, such as a sku, type the value into the Filter field.
Some fields such as Price, Weight, and Set Product as New have a from/to range of values.

Exclude Attributes
The checkbox in the first column is used to exclude attributes from the export file. If an
attribute is excluded, the associated column in the export data is included, but empty.

Export Criteria
EXCLUDE

1286

FILTER

RESULT

The exported file contains each attribute for all existing records.

Yes

The export file contains each attribute with only the records allowed
by the filter.

The export file does not include the column for the excluded
attribute, but does include all existing records.

Yes

The export file does not include the column for the excluded
attribute, and contains only the records allowed by the filter.

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Data Transfer Examples

Data Transfer Examples
This section of the guide contains examples that show how to import and export catalog data
for specific product types and scenarios.
l

Configurable Products

Tier Prices

Importing Configurable Products
The best way to understand how configurable product data is structured, is to export a
configurable product and its variations, and examine the data in a spreadsheet.
In the following example, you will add a set of product variations for a new size in each color.
First, you will export the configurable product, and examine the data structure. Then, you will
update the data and import it back into the catalog. If you don’t want to go through the
exercise of exporting the data, you can download the CSV file that is used in the example.

New Size Variation Added for Each Color

Step 1: Verify Attribute Settings and Values
1.

Before you begin, make sure that the attributes that are used for product variations have the
required property settings.
Scope

Global

Catalog Input Type for
Store Owner

The input type of any attribute that is used for a product
variation must be one of the following:
Dropdown

Magento Commerce User Guide

1287

Data Transfer Examples

CHAPTER 85: Data Transfer

Visual Swatch
Text Swatch
Multi-Select.
Values Required
2.

Yes

If you are adding a new size or color, or making any other change to an existing attribute,
make sure to update the attribute with the new value.
a.

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

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

Add the new value to the attribute. In the following example, a new size is added to a Text
Swatch.

Add New Value
3.

When complete, tap Save Attribute.

If you are adding a new attribute, follow the instructions to create the attribute before you
begin.

Step 2: Export the Configurable Product
1.

On the Admin sidebar, choose Catalog. Then, tap Products, and do the following:
a.

Tap Filters. Then, set Type to “Configurable Product, and tap Apply Filters.

Choose the configurable product that you want to use for your test export, and take note
of the SKU.

On the Admin sidebar, choose System. Then under Data Transfer, choose Export.

Under Export Settings, do the following:
a.

Set Entity Type to “Products”.

Set Export File Format to “CSV”.

Export Settings

1288

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Data Transfer Examples

Under Entity Attributes, scroll down to SKU. Then, do the following:
a.

Enter the SKU of the configurable product that you have chosen to export, and tap
Continue.

SKU
b.

When the export file appears at the bottom of the window, click Open.
When opened in a spreadsheet, the CSV file has a separate row for each simple product
variation, and one row for the configurable product. The product_type column shows
multiple simple product variations that are associated with one configurable product.

Configurable Product with Variations
c.

Scroll to the far right of the worksheet to find the following columns. In this example, the
data can be found in columns CG and CH.
configurable_variations
Defines the one-to-many relationship between the configurable product
record and each variation.
configurable_variation_labels
Defines the label that identifies each variation.
Depending on the number of variations, the string of data in the configurable_
variations column can be quite long. The data is used an an index to the associated
product variations, and has the following structure:

Data Format
sku={{SKU_VALUE}},attribute1={{VALUE}},attribute2={{VALUE}}| sku={{SKU_
VALUE}},attribute1={{VALUE}},attribute2={{VALUE}}

Each sku is separated by a pipe symbol (|), and attributes are separated by a comma. The
value of each attribute is represented by the attribute code, rather than the attribute label.
Here’s how the actual data appears:

Magento Commerce User Guide

1289

Data Transfer Examples

CHAPTER 85: Data Transfer

Example Data
sku=MH01-XS-Black,size=XS,color=Black|sku=MH01-XSGray,size=XS,color=Gray|sku=MH01-XS-Orange,size=XS,color=Orange

When you understand the structure of configurable product data, you can edit the data, or add
new variations directly to the CSV file. To learn more, see: Complex Data.

Step 3: Edit the Data
In the following example, the set of XL sizes is copied and pasted into the worksheet to create a
new set of product variations for a new size in each color.
1.

Copy the set of product variations that you want to use as a template for the new products.

Copy Product Variations
2.

Insert the copied rows records into the worksheet. You now have two identical sets of the
simple product variations.

Paste New Product Variations into CSV File
3.

Update the data in the following columns of the new variations, as needed. For this example,
all the “XL” references are changed to “XXL”.

sku

name

url_key

additional_attributes

The next step is to update the information in the product_variations column of the
configurable product record, so the new variations are included as part of the configurable
product.

1290

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Data Transfer Examples

On the row with the configurable product record, click the cell that contains the product_

variations data. Then in the formula bar, copy the last set of parameters, beginning with

the pipe symbol.

product_variations
b.

Paste the parameters to the end of the data. Then, edit as needed for the new variations.
In this example, the sku and size parameters are updated for the new “XXL” size.

Before the data is imported back into the catalog, delete any rows that have not changed.
In this example. only the three new variations for the new size, and the row with the updated
configurable product are imported back into the catalog. The other rows can be deleted from
the CSV file. However, make sure not to delete the header row with column labels.

Data Ready to Import
6.

Save the CSV file.The data is ready to import into the catalog.
The size of an import file cannot be larger than 2 megabytes.

Step 4: Import the Updated Data
1.

On the Admin sidebar, choose System. Then under Data Transfer, choose Import.

Under Import Settings, set Entity Type to “Products”.

Import Settings
3.

Under Import Behavior, set Import Behavior to “Add/Update”.

Magento Commerce User Guide

1291

Data Transfer Examples

CHAPTER 85: Data Transfer

Import Behavior
4.

Under File to Import, tap Choose File. Then, navigate to the CSV file that you prepared for
import and choose the file.

File to Import
5.

In the upper-right corner tap Check Data.

If the file is valid, tap Import. Otherwise, correct any problems found in the data and try again.

Validation Results
7.

When the import is complete, click the Cache Management link in the message at the top of
the page. Then, refresh all invalid caches.
The new product variations are now available in the catalog from the Admin and in the
storefront. In this example, the hoodie is now available in size XXL for all colors.

1292

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Data Transfer Examples

Importing Tier Prices
Rather than entering tier prices manually for each product, it can be more efficient to import
the pricing data. Before you begin, create a sample file of exported tier price data that you can
use as a template.

Tier Pricing

Step 1: Export the Tier Price Data
The following example exports tier pricing data for a single product. Then, you can use the
exported data as a template for bulk imports of tier price data. To learn more about exporting
advanced pricing data, see: Advanced Pricing Data.

Tier Pricing
1.

On Admin sidebar, choose System. Then under Data Transfer, choose Export.

Under Export Settings, set Entity Type to “Advanced Pricing.”

In the Entity Attributes grid, scroll down to the SKU attributes. Then, do the following:

Magento Commerce User Guide

1293

Data Transfer Examples

CHAPTER 85: Data Transfer

For tier prices that are based on a discount percentage. enter the SKU of each product to
be exported, separated by a comma.

SKU(s) to Export
a.

For tier prices that are based on a fixed amount. enter the SKU of each product.

Scroll down and tap Continue.

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

Exported Tier Price Data
The following columns are included in the exported data:
l

sku

tier_price_website

tier_price_customer_group

tier_price_qty

tier_price

tier_price_value_type

You will use the exported data as a template for importing tier price data.

Step 2: Update the Data
1.

Update the tier price data for each product, as needed.

Any products without tier price updates can be deleted from the CSV file. There is no need to
reimport products that haven’t changed.

Save the updated CSV file.
The size of an import file cannot be larger than 2 megabytes.

1294

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Data Transfer Examples

Step 3: Import the Updated Data
1.

On Admin sidebar, choose System. Then under Data Transfer, choose Import.

Under Import Settings, set Entity Type to “Advanced Pricing.” Then, set Import Behavior to
“Add/Update”.

Under File to Import, tap Choose File. Then, select the file that you prepared to import from
your directory.

In the upper-right corner, tap Check Data.

If the file is valid, tap Import . Otherwise, correct each problem with the data that is listed in
the message, and try to import the file again.

Magento Commerce User Guide

1295

Product Attribute Reference

CHAPTER 85: Data Transfer

Product Attribute Reference
The following table lists the attributes from a typical product export, in the default order in
which they appear. Each attribute is represented in the CSV file as a column, and product
records are represented by rows. Columns that begin with an underscore contain service data
such as properties or option values for complex data. You can export a product from your
catalog, to see how each attribute is represented in the data.
The installation used to export this data has the sample data installed, and has two websites
and several store views. Although this list includes all columns that are typically exported, the
sku is the only required value. To import data, you can include only the columns with changes.
The sku should be the first column, but the order of the rest of the attributes doesn’t matter.

Simple Product CSV File Structure
ATTRIBUTE
sku

DESCRIPTION
(Required) The Stock-Keeping Unit is a unique,
alphanumeric identifier that is used to track inventory. A
SKU can be up to 64 characters in length. For example:
sku123
A SKU longer than 64 characters will cause import to
fail.

store_view_code

Identifies the specific store view(s) where the product is
available. If blank, the product is available at the default
store view. For example: storeview1,english,spanish

attribute_set_code

Assigns the product to a specific attribute set or product
template, according to product type. Once the product is
created, the attribute set cannot be changed. For
example:
default

product_type

1296

Indicates the type of product.Values:
simple

Tangible items that are generally
sold as single units or in fixed
quantities.

grouped

A group of separate products
that is sold as a set.

Magento Commerce User Guide

CHAPTER 85: Data Transfer

Product Attribute Reference

Simple Product CSV File Structure (cont.)
ATTRIBUTE

Magento Open Source User Guide, Version 2.2 Guide

Navigation menu

Versions of this User Manual:

Views

Navigation