Magento 2.1 Community Edition User Guide
Below you will find brief information for Community Edition 2.1. This 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.
Advertisement
Advertisement
Magento
Community Edition
User Guide
Version 2.1
ii
Contents
GETTING STARTED
About This Guide
Resources
Join the Conversation!
System Requirements
Installation
Prelaunch Checklist
Your Login Credentials
For Your Records
CHAPTER 3: Your Magento Account
Creating a Magento Account
Sharing Your Account
The Path to Purchase
Home Page
Catalog Page
Search Results
Product Page
Shopping Cart
Customer Journey
Attract New Customers
Engage Your Customers
Copyright © 2017 Magento, Inc. All rights reserved.
Contents
Moment of Purchase
Increase Average Order Value
Customer Retention
Loyalty & Advocacy
Success!
Basic Configuration
Admin Sign In
Your Admin Account
Admin Sidebar
Admin Workspace
Dashboard
Message Inbox
Global Search
Grid Controls
Grid Layout
Actions Control
Store Information
Locale Options
State Options
Country Options
Merchant Location
Currency
Store Email Addresses
Contact Us
CHAPTER 7: Storefront Branding
Uploading Your Logo
Adding a Favicon
Changing the Welcome Message
Magento Community Edition 2.1 User Guide
53
iii
iv
Copyright Notice
Store Demo Notice
CHAPTER 8: Websites, Stores & Views
Scope
Changing Scope
Product Scope
Price Scope
Customer Account Scope
Scope Quick Reference
Single Store Mode
CHAPTER 9: Industry Compliance
PCI Compliance Guidelines
Privacy Policy
Cookie Law Compliance
Cookie Restriction Mode
Cookie Reference
PRODUCTS
Catalog Workspace
Catalog URLs
Dynamic Media URLs
Using a Flat Catalog
Product Workspace
Default Field Values
Product Types
Simple Product
Magento Community Edition 2.1 User Guide
Contents
Contents
Configurable Product
Part 1: Creating a Configurable Product
Part 2: Adding Configurations
Grouped Product
Virtual Product
Bundle Product
Customizing the Bundle
Downloadable Product
Configuring Download Options
Advanced Product Settings
Other Product Settings
Content
Configurations
Product Reviews
Images and Video
Search Engine Optimization
Related Products, Up-Sells, and Cross-Sells
Related Products
Up-sells
Cross-sells
Customizable Options
Product in Websites
Design
Scheduled Design Update
Gift Options
Downloadable Information
Grouped Products
Bundle Items
Advanced Pricing
Magento Community Edition 2.1 User Guide
v
vi
Group Price
Special Price
Tier Price
Minimum Advertised Price
MAP Logic
Configuring MAP
CHAPTER 15: Managing Inventory
Stock Options
Product Stock Options
Stock Message Scenarios
Product Page Stock Messages
Product Page Stock Messages
Catalog Page Stock Messages
Catalog Page Stock Messages
Product Alerts
Product Alert Run Settings
Uploading Product Images
Adding Product Video
Media Gallery
Image Zoom
Light Boxes and Sliders
Placeholders
Watermarks
Swatches
Creating Swatches
Creating Categories
Root Categories
Hidden Categories
Content Settings
Contents
Magento Community Edition 2.1 User Guide
Contents
Display Settings
Search Engine Optimization
Products in Category
Design Settings
CHAPTER 18: Using Product Attributes
Adding an Attribute
Attribute Input Types
Date & Time Options
MARKETING
Opportunities to Engage
Email a Friend
Wish List
Configuring the Wish List
Sharing a Wish List
Product Relationships
Compare Products
Recently Viewed / Compared Products
Product Reviews
Product Ratings
Promotions
CHAPTER 21: Catalog Price Rules
Creating a Price Rule
Price Rule with Multiple SKUs
Creating a Cart Price Rule
Magento Community Edition 2.1 User Guide
339
vii
viii
Coupon Codes
Configuring Coupon Codes
Coupons Report
Free Shipping Promotion
Buy X Get Y Free
Discount with Minimum Purchase
Communications
Supported Email Clients
Preparing Your Email Logo
Configuring Email Templates
Configuring Sales Email
Payment Failed Email
Configuring Admin User Email
Customizing Email Templates
Header Template
Footer Template
Message Template
Email Template List
Configuring Email Communications
Preparing Your Invoice Logo
Adding Reference IDs to Header
Customer Address Templates
Configuring Newsletters
Newsletter Templates
Sending Newsletters
Managing Subscribers
379
Contents
Magento Community Edition 2.1 User Guide
Contents
Adding Predefined Variables
Adding Custom Variables
Markup Tags
Custom Variable
Using Markup Tags in Links
Variable Reference
SEO & Search
CHAPTER 28: Catalog Navigation
Top Navigation
Breadcrumb Trail
Product Listings
Pagination Controls
Layered Navigation
Layered Navigation with Filterable Attributes
Price Navigation
Configuring Layered Navigation
Quick Search
Advanced Search
Search Results
Weighted Search
Configuring Catalog Search
Popular Search Terms
Adding Search Terms
Search Terms Report
CHAPTER 31: SEO Best Practices
Magento Community Edition 2.1 User Guide
451
ix
x
Meta Data
Canonical Meta Tag
Example 1: Category Path Creates Duplicate URLs
Using a Sitemap
Sitemap Configuration
Search Engine Robots
URL Rewrite Configuration
Automatic Redirects
Creating URL Rewrites
Product Rewrites
Category Rewrites
CMS Page Rewrites
Custom Rewrites
Google Analytics
Google AdWords
CONTENT
Core Content
Default Pages
Workspace Controls
Page Search
Page Actions
Page Grid Layout
Adding a New Page
Switching Home Pages
Media Storage
Magento Community Edition 2.1 User Guide
Contents
Contents
Using the Editor
Inserting a Link
Inserting an Image
Inserting a Widget
Inserting a Variable
Configuring the Editor
Adding New Blocks
Adding Social Plugins
Adding a Lightbox or Slider
Positioning Blocks
Using a Widget
Using a Layout Update
Widget Types
Creating a Widget
New Products List
Design & Theme
Design Configuration
HTML Head
Header
Footer
Standard Page Layouts
Storefront Examples
Layout Updates
Standard Block Layout
Magento Community Edition 2.1 User Guide
587
xi
xii
Layout Update Examples
Layout Update Syntax
Controlling Block Order
XML Load Sequence
Using the Default Theme
Installing a New Theme
Theme Assets
Merging CSS Files
Merging JavaScript Files
Scheduling Design Changes
CUSTOMERS
All Customers
Now Online
Customer Sign In
Account Dashboard
Configuring Customer Accounts
Online Session Length
Login Landing Page
New Account Options
Name and Address Options
Password Options
SALES
Magento Community Edition 2.1 User Guide
Contents
Contents
Point of Purchase
Cart Configuration
My Cart Link
Cart Sidebar
Redirect to Cart
Quote Lifetime
Minimum Order
Cart Thumbnails
Persistent Shopping Cart
Persistent Cart Workflow
Remember Me
Remember Me
Continue Persistence on Logout (No)
Continue Persistence on Logout (No)
Clear Persistence on Logout (Yes)
Clear Persistence on Logout (Yes)
Configuring a Persistent Cart
Checkout Step 1: Shipping
Checkout Step 2: Review & Payments
Order Confirmation
Checkout Configuration
Checkout Options
Guest Checkout
Terms and Conditions
One Page Checkout
Gift Options
Checkout Totals Sort Order
CHAPTER 48: Shopping Assistance
Magento Community Edition 2.1 User Guide
657
xiii
xiv
Creating Customer Accounts
Updating Customer Accounts
Creating a Customer Order
Updating an Order
Order Management
Order Workspace
Order Actions
Order Search
Order Grid Layout
Order Workflow
Processing Orders
Allow Reorders
Order Status
Order Status Workflow
Custom Order Status
Scheduled Order Operations
Pending Payment Order Lifetime
Scheduled Grid Updates
Creating an Invoice
Printing Multiple Invoices
CHAPTER 51: Billing Agreements
Printing Credit Memos
Product Return Workflow
705
Contents
Magento Community Edition 2.1 User Guide
Contents
Payments
CHAPTER 55: Recommended Solutions
PayPal Express Checkout
Requirements
Checkout Workflow
Checkout Workflow
Setting Up PayPal Express Checkout
PayPal In-Context Checkout
PayPal Billing Agreements
PayPal Settlement Reports
Braintree
Setting Up Braintree
Other PayPal Solutions
PayPal Payments Advanced
Requirements
Checkout Workflow
Checkout Workflow
Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Advanced
PayPal Payments Pro
Requirements
Checkout Workflow
Checkout Workflow
Order Processing Workflow
Order Processing Workflow
Setting Up PayPal Payments Pro
PayPal Payments Standard
Merchant Requirements
Checkout Workflow
Checkout Workflow
Magento Community Edition 2.1 User Guide
753
xv
xvi
Setting Up PayPal Payments Standard
PayPal Payflow Pro
Requirements
Customer Workflow
Customer Workflow
Online Order Processing Workflow
Online Order Processing Workflow
Setting Up PayPal Payflow Pro
PayPal Payflow Link
Requirements
Customer Workflow
Customer Workflow
Order Workflow
Order Workflow
Setting Up PayPal Payflow Link
PayPal Quick Reference
PayPal Business Account
PayPal Fraud Management Filter
PayPal by Country
CHAPTER 56: Basic Payment Methods
Check / Money Order
Cash On Delivery
Bank Transfer
Purchase Order
Zero Subtotal Checkout
CHAPTER 57: Other Payment Methods
Authorize.Net Direct Post
Shipping
Point of Origin
Contents
821
Magento Community Edition 2.1 User Guide
Contents
Multiple Addresses
Shipping Policy
CHAPTER 59: Basic Shipping Methods
Free Shipping
Flat Rate Shipping
Table Rates
Dimensional Weight
Shipping Label Workflow
Configuring Shipping Labels
Creating Shipping Labels
Label Packages
REPORTS
Refresh Statistics
OPERATIONS
Adding Store Views
Magento Community Edition 2.1 User Guide
xvii
xviii
Editing a Store View
Adding a Language
Translating Products
Translating Content
Adding Stores
Adding Websites
Store URLs
Use Secure Protocol
Using a Custom Admin UR
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 Validation
Customer Registration Workflow
Checkout Workflow
Configuring VAT ID Validation
Tax Quick Reference
Tax Calculation Methods
Catalog Prices With or Without Tax
Shipping Prices With or Without Tax
Contents
Magento Community Edition 2.1 User Guide
Contents
Tax Amounts as Line Items
International Tax Guidelines
U.S. Tax Guidelines
Tax Classes
Calculation Settings
Default Tax Destination Calculation
Price Display Settings
Shopping Cart Display Settings
Orders, Invoices, Credit Memos, Display Settings
Fixed Product Taxes
Canadian Tax Guidelines
EU Tax Guidelines
Warning Messages
Calculation Settings
Discount Settings
Currency Configuration
Currency Symbols
Updating Currency Rates
Product Attributes
Creating Product Attributes
Attribute Sets
System
Working with CSV Files
Product CSV Structure
Customer CSV Structure
Magento Community Edition 2.1 User Guide
983
xix
xx
Data Validation
Import
Import History
Importing Product Images
Import Guidelines
Export
Export Criteria
Export Filters
Exclude Attributes
Product Attribute Reference
Complex Data
Advanced Pricing
Customer Attribute Reference
Onboarding Workflow
Magento Marketplace
Magento Connect
Adding Users
Locked Users
User Roles
Alternate Media Storage
Using a Database
Database Workflow
Using a Content Delivery Network
CDN Workflow
Security Best Practices
Start Right
Protect the Environment
Protect Magento
Contents
Magento Community Edition 2.1 User Guide
Contents
Don’t be Taken for a Ride
Be Prepared!
Monitor for Signs of Attack
Follow Your Disaster Recovery Plan
Configuring Admin Security
CAPTCHA
Admin CAPTCHA
Customer CAPTCHA
Encryption Key
Session Validation
Browser Capabilities Detection
Action Log
Cache Management
Full-Page Cache
Index Management
Index Trigger Events
Backups
Cron (Scheduled Tasks)
Advanced Developer Tools
Frontend Development Workflow
Using Static File Signatures
Optimizing Resource Files
Developer Client Restrictions
Template Path Hints
Translate Inline
Web Setup Wizard
Component Manager
Web Setup
Magento Community Edition 2.1 User Guide
xxi
APPENDICES
APPENDIX D: Configuration Reference
INDEX
Contents xxii Magento Community Edition 2.1 User Guide
GETTING STARTED
1
2
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.
CHAPTER 1:
Welcome
Welcome to the next generation of the world’s leading digital commerce platform! Built on open-source technology, Magento Community Edition 2.1 provides online merchants with unparalleled flexibility and control over the look, content, and functionality of their online stores. Magento’s intuitive Admin features powerful marketing, search engine optimization, and product management tools that give you the power to create sites that are tailored to your unique business needs. Robust and scalable, Magento 2.0 offers you a stable, secure, and customizable solution for your growing business.
Magento Community Edition 2.1 User Guide
Home Page
3
4
About This Guide CHAPTER 1: Welcome
About This Guide
This guide answers the “why, where, and how” questions that most merchants have when learning to use Magento. You’ll find lots of step-by-step instructions, screenshots and examples, plus a comprehensive online
that is linked throughout the material. After learning the basics, you can use this guide as a springboard to more advanced topics and resources.
Online User Guide
The online (HTML) guide is the primary user documentation for the current release of Magento
Community Edition 2.1. The content is continually updated to provide you with the best possible assistance.
To learn about recent additions or changes to existing topics, see the
at the end of the guide.
PDF User Guide
You’ll find the same great information in the PDF user guide, based on the date last updated. Simply click the link to open the PDF in your browser. You can also rightclick the download link to save the file to your computer.
See the Documentation Archive for previous versions of the user guide. Updated: 04/06/2017
Magento Community Edition 2.1 User Guide
CHAPTER 1: Welcome Resources
Resources
Magento provides a wealth of business and technical resources, self-help tools, and services to help you succeed.
Product Documentation
Whether you’re a merchant, designer, developer , or all of the above, this is where you’ll gain a deeper insight into how you can leverage the power of Magento to grow your business.
Magento Resources Library
Gain access to expert insight and online business resources to help develop and improve your store.
Ebooks, Magento whitepapers, and webinars.
Security Center
Join Magento’s Security Alert Registry to get the latest information on potential vulnerabilities and Security Best
Practices .
Forums
The Magento forums provide access to a network of dedicated Magento enthusiasts who share tips, tricks and support.
Magento Community Edition 2.1 User Guide 5
Resources CHAPTER 1: Welcome
Blog
Check out the Magento blog for the latest information about new features, trends, best practices, upcoming events, and more!
Webinars
Don't worry if you miss a live webinar! You can find the archived version here.
Video Archive
Catch up and review archived sessions from Imagine
2016!.
Events
Keep tabs on our calendar of upcoming events. There's always something happening in the Magento ecosystem!
6 Magento Community Edition 2.1 User Guide
CHAPTER 1: Welcome Resources
Magento Marketplace
Visit Magento’s next-generation marketplace of digital commerce solutions. Magento Marketplace offers merchants a curated selection of solutions, while providing qualified developers the tools, platform, and prime location for a thriving business.
Training & Certification
Learn how to unleash the power and flexibility of
Magento. We provide training for every role in your business, including marketers, designers, developers, and more. Experienced Magento professionals can validate their real-world skills by earning Magento certification.
Partners
Magento partners are committed to your success, and provide custom integrations, best-in-class customer experiences, strategic marketing initiatives, and expert performance and scalability optimization for both onpremise and cloud-based solutions.
Expert Consulting Services
Our Expert Consulting Group (ECG) helps Magento merchants and Solution Partners maximize their success. Our experts offer comprehensive analysis and best practice recommendations, from architecture planning through post-deployment.
Magento Community Edition 2.1 User Guide 7
8
Join the Conversation!
CHAPTER 1: Welcome
Join the Conversation!
Keep up with the latest news from the ecosystem, and connect with other merchants and developers on social media networks.
Magento Forums
This is the place to find solutions, become acquainted with international communities, and join a special interest chat! Share your knowledge and earn kudos from others!
Find out what’s happening and join the discussion on our
Facebook page!
Follow us on Twitter!
Join a Magento group on LinkedIn.
Magento Community Edition 2.1 User Guide
CHAPTER 1: Welcome
Google+
Add us to your circle on Google+.
Join the Conversation!
YouTube
Learn while you watch videos on our YouTube channel!
Meetup
Find a Magento Meetup near you!
Magento Community Edition 2.1 User Guide 9
10 Magento Community Edition 2.1 User Guide
CHAPTER 2:
About This Release
As a best practice, we recommend that you keep your Magento installation up to date, so you can benefit from the latest advancements. Release notes provide a detailed description of the changes in each product release, with links to additional technical information, installation instructions, and support resources. To learn more about current and past releases, see Release Information .
Magento Community Edition 2.1 User Guide
Magento Community Edition
11
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
Composer
Linux x86-64
Composer is required for developers who want to contribute to code base,or develop extensions.
Web Server
Apache 2.2 or 2.4
Nginx 1.8.x
The apache mod_rewrite module must be enabled. To learn more, see: Apache .
(or latest mainline version)
PHP
7.0.4
7.0.2 ,
7.0.6 to 7.1.0
5.6.5 and later
5.6.x
Magento 2.1.2 and later only.
Magento 2.1.x (all versions)
Magento 2.1.2
Magento 2.1.0 and 2.1.1
Not Supported:
PHP 7.1, 5.4
PHP 7.0.5
Not Supported
Known issue that affects code compiler.
Required PHP Extensions:
bc-math
(Enterprise Edition only) curl gd , ImageMagick 6.3.7 (or later) or both intl mbstring mcrypt mhash openssl
PDO_MySQL
SimpleXML soap
12 Magento Community Edition 2.1 User Guide
CHAPTER 2: About This Release System Requirements
SYSTEM REQUIREMENTS
xml xsl zip
Optional, but recommended
opcache This extension is bundled in many PHP distributions. To verify, see: CentOS or
Ubuntu .
php_xdebug2.2.0
or later
Recommended for development environments only.
Database
SSL
Additional configuration:
safe_mode off memory_limit minimum 512 MB
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.
A valid security certificate is required for HTTPS.
Self-signed certificates are not supported.
Transport Layer Security (TLS) Requirements:
TSL 1.1 or later PayPal and repo.magento.com require TSL
1.1 or later.
Mail Server Mail Transfer Agent (MTA) or SMTP server
Supported Applications
NAME
Reverse Proxy / Web
Accelerator
DESCRIPTION
Varnish 3.5
Varnish 4.x (or latest stable version.)
Cache Storage
Session Storage
Redis 3.x
Memcache 1.4.x
memcached latest stable version for session storage with either memcache or memcached PHP extensions (latest stable version)
Magento Community Edition 2.1 User Guide 13
System Requirements CHAPTER 2: About This Release
Supported Applications (cont.)
NAME
Search
DESCRIPTION
Elasticsearch
Apache Solr
Versions 1.7 and 2.x (recommended)
2.x supported from Linux repository.
2.0 branch supported from PHP repository.
(Enterprise Edition only)
Messaging
Supported Browsers
BROWSER
STOREFRONT/ADMIN
Firefox
Chrome
Safari
Microsoft Edge
RabbitMQ (Enterprise Edition only)
VERSION
Latest, latest -1
*
Latest, latest -1
Latest, latest -1
Version 11 or later
OS
Any
Any
Mac OS
Windows
STOREFRONT ONLY
Internet Explorer Version 9 or later
MOBILE STOREFRONT
Safari Mobile
Chrome for Mobile iPhone 4 or later
Latest, latest -1
Windows
DESKTOP STOREFRONT
Safari Mobile iPad 2 iPad Mini iPad with Retina Display OS 7 or later
IOS 7 or later
Android 4 or later
*
The version before the most current.
14 Magento Community Edition 2.1 User Guide
CHAPTER 2: About This Release Installation
Installation
To install Magento 2 on your server, see the Installation Guide in our technical documentation.
For an overview of the second part of the installation process, see
in the
System Operations section of this guide.
Installation Guide
Magento Community Edition 2.1 User Guide 15
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
General Settings
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.
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
Update the default email templates to reflect your brand. Make sure to update the configuration if you create new templates.
Make sure that your invoices and packing slips include the correct business information and reflect your brand.
Magento is integrated with Google API to allow your business to use Google Analytics and Google AdWords.
Sales & Marketing Settings
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.
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.
16 Magento Community Edition 2.1 User Guide
CHAPTER 2: About This Release Installation
Make sure that taxes are properly configured according to your business tax rules and local requirements.
Enable all carriers and shipping methods to be used by the company.
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.
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 jobs are used to process email, catalog price rules, newsletters, customer alerts,
Google sitemaps, update currency rates, and so on, Make sure that Cron jobs are set to run at the appropriate time interval, in minutes.
Magento Community Edition 2.1 User Guide 17
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.
18 Magento Community Edition 2.1 User Guide
CHAPTER 2: About This Release Installation
For Your Records
As a best practice, keep a record of the details of your installation, your login credentials, and the email address that is associated with each account. You can print this page, write down your credentials, and keep it in a safe, convenient place.
Store and Admin
Store URL:
Admin URL:
Admin User Name:
Admin Password:
Admin Email Address:
Magento Account
User Name:
Password:
Email Address:
Test Customer Account
User Name:
Password:
Email Address:
Installation Information
Installation Date:
Magento Version:
Encryption Key:
Database Name:
Database User Name:
Database Password:
Magento Community Edition 2.1 User Guide 19
20 Magento Community Edition 2.1 User Guide
CHAPTER 3:
Your Magento Account
Your Magento account has a separate login from your store, and can be accessed from either the Magento website or from your store’s Admin. From the dashboard of your
Magento account, you can find information that is related to the products and services that you have purchased, as well as your contact and billing information.
Your Magento Account
Magento Community Edition 2.1 User Guide 21
Creating a Magento Account CHAPTER 3: Your Magento Account
Creating a Magento Account
Anyone can open a free Magento account from our website. The email address that is used to open a Magento account can be associated with only one account, and the screen name that you enter becomes your identity in the Magento forums.
To create a Magento account:
1.
Visit the Magento site at:
http://www.magento.com
2.
In the upper-right corner, choose My Account. Then under New Customers, tap
Register
.
22
Log In to Your Account
3.
Under Personal Information, do the following:
a.
Enter your First Name, Last Name, and Email Address.
b.
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.
4.
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.
b.
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.
c.
When complete, tap
Submit
. Your account dashboard appears.
Magento Community Edition 2.1 User Guide
CHAPTER 3: Your Magento Account Creating a Magento Account
Create an Account
To log in to your Magento account:
1.
Go to the Magento site:
http://www.magento.com
2.
In the upper-right corner, click My Account.
3.
Enter the Email address that is associated with your account. Then, enter your Password.
4.
When complete, tap
Login
.
To receive a new password:
1.
If you forget your password, click Forgot Your Password?
2.
Enter the Email Address that is associated with your account, and tap
Submit
.
You will receive an email from Magento with a temporary password that you can use to log into your account. Then, reset your password from the dashboard of your account.
Magento Community Edition 2.1 User Guide 23
Creating a Magento Account CHAPTER 3: Your Magento Account
To reset your password:
1.
Log in to your Magento account.
2.
In the panel on the left, choose Account Settings. Then, tap
Change Password
3.
Enter your Current Password.
If you forgot your password, enter the temporary password that was sent to you.
4.
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.
5.
When complete, tap
Save
.
24
Change Password
Magento Account Password Requirements
FIELD
Password
DESCRIPTION
Your Magento password must be between 8-16 characters, and include at least one capital letter, one number, and one special character or lowercase letter.
Magento Community Edition 2.1 User Guide
CHAPTER 3: Your Magento Account Sharing Your Account
Sharing Your Account
Your Magento account contains information that can be useful to trusted employees and service providers who help to manage your site. As the primary account holder, you have authority to grant limited access to your account to other Magento account holders. When your account is shared, all sensitive information—such as your billing history or credit card information— remains protected. It is not shared at any time with other users.
All actions taken by users with shared access to your account are your sole responsibility. Magento
Inc. is not responsible for any actions taken by users to whom you grant shared account access.
Shared Access
To set up a shared account:
1.
Before you begin, get the following information from the new user’s Magento account: l
Account ID l
Email address
2.
Log in to your
3.
In the panel on the left, under Shared Access, choose Add New User. Then, do the following: l
Enter the Acct ID of the new user’s Magento account.
l
Enter the Email address that is associated with the new user’s Magento account.
4.
In the Shared Information section, do the following:
Magento Community Edition 2.1 User Guide 25
Sharing Your Account CHAPTER 3: Your Magento Account
a.
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.
b.
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 l
Your Phone
5.
In the Grant Account Permissions section, mark the checkbox of each Magento product and service that you want to share.
6.
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.
26
Manage Permissions
Magento Community Edition 2.1 User Guide
CHAPTER 3: Your Magento Account Sharing Your Account
To access a shared account:
1.
When you receive the invitation to a shared account, log in to your own Magento account.
Your account dashboard has a new Switch Accounts control in the upper-right corner, with options for “My Account” and the name of the shared account.
2.
To gain access to the shared account, set Switch Accounts to the name of the shared account.
The shared account displays a welcome message and contact information. The left panel includes only the items that you have permission to use.
Switch Accounts
3.
When you are ready to return to your own account, set Switch Accounts to “My Account.”
Magento Community Edition 2.1 User Guide 27
28 Magento Community Edition 2.1 User Guide
CHAPTER 4:
Quick Tour
In this quick tour, we’ll take a look at each page that customers usually visit while shopping in your store. The path that customers follow that leads to a sale is sometimes called the “path to purchase.” Then, we’ll take a look at the major landmarks along the journey, and how Magento Community 2.1 can be used to attract and engage customers, increase the average order, and to build loyalty and advocacy.
Customer Journey
Magento Community Edition 2.1 User Guide 29
The Path to Purchase CHAPTER 4: Quick Tour
The Path to Purchase
The path customers follow that leads to a sale is sometimes called the “path to purchase.” In this quick tour, we’ll take a look at pages of strategic value that customers usually visit while shopping in your store. Then, we’ll consider different store features that can be leveraged at each stage of the customer journey.
Home Page
Your home page is like the front window display of your store. As the primary landing page, its design entices visitors to come inside for a closer look.
Catalog Page
This page shows products from your catalog in either a list or grid format. The selection can be based on a category chosen from the main menu, a choice made in the layered navigation on the left, or the results of a search. Any item can be examined in more detail, or placed directly into the shopping cart.
Search Results
Did you know that people who use search are nearly twice as likely to make a purchase as those who rely on navigation alone? You might consider these shoppers to be “pre-qualified.”
30 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour The Path to Purchase
Product Page
The product page provides detailed information about a specific item in your catalog. Shoppers can read reviews, add the product to their wish lists, compare it to other products, share the link with friends, and most importantly, place the item into their shopping carts.
Shopping Cart
The shopping cart lists each item by price and quantity selected, and calculates the subtotal. Shoppers can apply discount coupons, and generate an estimate of shipping and tax charges.
Magento Community Edition 2.1 User Guide 31
The Path to Purchase CHAPTER 4: Quick Tour
Home Page
Did you know that most people spend only a few seconds on a page before they decide to stay or go somewhere else? That’s not long to make an impression! Studies show that people also love photographs, especially of other people. Whatever design you choose, everything on your home page should move visitors along toward the next step in the sales process. The idea is to guide their attention in a cohesive flow from one point of interest to the next.
Callouts
l
Main Menu l
Search l
Your Account l
Feature a Brand l
Offer a Promotion l
Offer a Discount l
Hear from an Expert l
Appeal to a Lifestyle l
Shop by Fabric l
Popular Products l
Footer Links Block l
Footer Content l
Subscribe!
32 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour The Path to Purchase
Magento Community Edition 2.1 User Guide
Home Page
33
The Path to Purchase CHAPTER 4: Quick Tour
Catalog Page
Catalog page listings typically have small product images and brief descriptions, and can be formatted as a list or as a grid. You can add banners, videos, and keyword-rich descriptions, and also create special designs for a promotion or season. You might create a special category to feature a lifestyle or brand that is a curated collection of products from different categories.
The initial product description usually gives shoppers just enough information to merit a closer look. People who know what they want can add the product to their carts and go. Customers who shop while logged in to their accounts enjoy a personalized shopping experience.
Callouts
l
Mini Shopping Cart l
Breadcrumb Trail l
Change the List Style l
Sort the List l
Filter the List l
Go to Next Page l
Read a Review l
Show More per Page
34 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour The Path to Purchase
Magento Community Edition 2.1 User Guide
Catalog Page
35
The Path to Purchase CHAPTER 4: Quick Tour
Search Results
Did you know that people who use search are nearly twice as likely to make a purchase as those who rely on navigation alone? You might consider these shoppers to be “pre-qualified.”
Your store has a Search box in the upper-right corner, and a link to Advanced Search in the footer. All of the search terms that shoppers submit are saved, so you can see exactly what they’re looking for. You can offer suggestions, and enter synonyms and common misspellings.
Then, display a specific page when a search term is entered.
Callouts
l
Search Criteria l
Sort By l
Search Results l
Show per Page l
Next Page l
Advanced Search
36 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour The Path to Purchase
Magento Community Edition 2.1 User Guide
Search Results Page
37
The Path to Purchase CHAPTER 4: Quick Tour
Product Page
The product page has a lot going on! The first thing that catches your eye on the product page is the main image with a high-resolution zoom and thumbnail gallery. In addition to the price and availability, there’s a tabbed section with more information and a list of related products.
Callouts
l
Mini Shopping Cart l
A little help… l
Product Rating l
Stock Availability l
Choose the Options l
Zoom l
Buy it Now!
l
Email a Friend l
Add to Your Wish List l
Compare Products l
Thumbnail l
Product Details l
Add All to Cart l
Related Products
38 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour The Path to Purchase
Magento Community Edition 2.1 User Guide
Product Page
39
The Path to Purchase CHAPTER 4: Quick Tour
Shopping Cart
The cart is where order total can be determined, along with discount coupons and estimated shipping and tax, and is a great place to display your trust badges and seals. It’s also an ideal opportunity to offer one last item. As a cross-sell, you can select certain items to be offered as an impulse purchase whenever a specific item appears in the cart.
Callouts
l
One Item in Cart l
Change the Quantity l
Estimate Shipping & Tax l
Go to Checkout l
Edit Line Item l
Update the Cart l
Checkout with Multiple Addresses l
Use a Coupon l
Cross-sells l
Special Price
40 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour The Path to Purchase
Shopping Cart Page
Magento Community Edition 2.1 User Guide 41
Customer Journey
Customer Journey
CHAPTER 4: Quick Tour
Attract New Customers
Magento Community Edition 2.1 includes SEO functionality out of the box. Improve your search ranking and attract the most visitors to your site.
Engage Your Customers
Design your site with prepared templates, or create a custom design with features that invite people to interact with your store.
Increase AOV
Increase average order value with promotions and content that encourage your customers to shop more.
42 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour Customer Journey
Moment of Purchase
Give your customers a faster and easier way to check out. Calculate shipping and taxes automatically, and integrate multiple payment methods on a single page.
Customer Retention
Create and manage newsletters and promotions to keep your customers coming back for more.
Loyalty & Advocacy
Encourage customers to write product reviews, create wish lists, and send email about products to their friends.
This will strengthen your relationship with your customers, who in return, will speak positively of your business to friends and family.
Magento Community Edition 2.1 User Guide 43
Customer Journey CHAPTER 4: Quick Tour
Attract New Customers
Magento Community Edition 2.1 is packed with features that make it easy to create a “search engine friendly” websites and increase the likelihood of bringing the right customers to your site.
Search Engine Optimization
Magento offers powerful, native capabilities to streamline Search Engine Optimization (SEO) practices for content and site exposure that are integrated with the Admin, and tied directly into the user experience.
Custom URLs
Custom URLs are short, clean, and easy to remember. You can also autogenerate search-friendly
URLs to streamline your purchase path.
Meta Data
Improve your search engine rankings by choosing specific criteria that helps search engines to find and index your products more easily. Meta data can be entered for product, category, and content pages.
Sitemap
Link to a sitemap from the footer of your store to give customers an overview of the catalog structure, with links to all categories and products in the store. Easy integration with Google Sitemap.
Analytics
In addition to monitoring your site from the Admin dashboard, you can integrate third-party analytics tools such as Google Analytics, for detailed statistics on traffic and sales.
44 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour Customer Journey
Engage Your Customers
Magento Community Edition 2.1 makes it easy to create a customized, engaging site experience. Encourage your customers to spend more time exploring your site, and give them the tools to make it easy to find what they want faster.
Content Management
Magento’s CMS makes it easy to store pages, or parts of pages, that you can use in your store. It’s so intuitive that someone without a technology background can create and manage site content.
Design & Theme
Control the visual elements of your store with a collection of templates and skin files. You can apply these visual elements to all pages in your store, giving your store a cohesive look and feel.
Multiple Stores, Sites & Views
Control the look and feel of multiple sites, introduce new market and languages, and track analytics from a single
Admin.
Multiple Devices
Magento’s powerful features make it easy to create storefronts optimized for iPhone, Android, and Mobile
Opera browsers to help you engage consumers with mobile commerce now, and into the future.
Magento Community Edition 2.1 User Guide 45
Customer Journey CHAPTER 4: Quick Tour
Shopping Tools
Your store includes a set of shopping tools that create opportunities for your customers to interact with your store, connect on social media, and share with friends.
Sophisticated Search
Filter product by price, manufacturer, or any other criteria to reduce the time to purchase.
46 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour Customer Journey
Moment of Purchase
Now that you’ve given your customer an engaging shopping experience, make it easy for them to complete their purchases. Magento is designed to help you streamline your checkout process experience while boosting conversion rates.
Order Processing
Magento supports a complete order processing workflow. It's easy to customize order statuses and track communications between sales reps and customers.
Shipping Labels
Merchants have complete control over package characteristics such as weight and size. Shipping labels, rate, and bar code information originates directly from the carrier. Labels can be generated for single or multiple orders.
Multiple Shipping Options
Magento supports a variety of shipping methods so you can give your customers a choice at checkout. Customers can see a real-time estimate of shipping charges right from the shopping cart.
Multiple Payment Options
Magento Community Edition 2.1 supports the payment methods and currencies needed for global commerce. You can choose the ones you want to offer, and at checkout, your customers can choose the ones they prefer.
PayPal Merchant Solutions
It's easy to integrate a PayPal Payments account to provide your customers faster, more secure checkout options.
Shopping Assistance
Assisted shopping makes it easy for customer service reps to create orders for customers.
Security
Whether an order is fulfilled online or over the phone, Magento provides sophisticated security, including CAPTCHA and SSL encryption, with best-in-breed encryption and hashing algorithms to protect the security of the system.
Magento Community Edition 2.1 User Guide 47
Customer Journey CHAPTER 4: Quick Tour
Increase Average Order Value
Magento Community Edition 2.1 provides a range of tools to help you tailor the shopping experience, and encourage your customers to put more items in their shopping carts and spend more money.
Promotions
Use catalog and shopping cart price rules to create promotions that kick into gear when a set of conditions is met.
Coupons
Create limited-time offers and coupons that customers can scan with their phone and apply to a purchase.
Product Suggestions
Another way to increase AOV is to offer suggestions for related products and opportunities to up-sell and cross-sell at strategic points along the path to conversion.
User Permissions & Roles
Restrict access to data in the Admin on a “need to know” basis. Create multiple admin roles for readonly or and editing privileges. Track and review all activity at a granular level to specific stores and websites.
Full-Page Caching
Enhance performance by caching primary pages. Caching pages improves server response times, reduces load, and increases sustainable traffic.
You can use tags to define which components to cache, so only relevant pages are cached as updates take place. It also has the ability to identify and differentiate visitors from shoppers.
48 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour Customer Journey
Customer Retention
Magento makes it easy for you to get repeat business and build brand loyalty. Magento gives you total control and flexibility over creating and revising goodies like rewards programs, custom coupons and automated emails to keep your customers coming back again and again.
Custom Coupons
Create coupons codes for social media, email, or print campaigns. You can incorporate coupon codes into any design you like.
Newsletters
Stay in touch with current customers who’ve opted to receive newsletters. You can create as many newsletter templates as you want.
RSS Feed
When RSS feeds are enabled, any additions to products, specials, categories, and coupons are automatically sent to the subscribers of each feed. A link to all RSS feeds that you publish is in the footer of your store.
Magento Community Edition 2.1 User Guide 49
Customer Journey CHAPTER 4: Quick Tour
Loyalty & Advocacy
Give customers a direct connection to your brand by allowing them to create customer accounts where they can see their purchase history, wishlist, and newsletter subscriptions. Use product ratings and reviews to give new customers objective product opinions and promote a sense of community. These features turn customer satisfaction into one of the most powerful and costefficient marketing tools at your disposal.
Dashboard Snapshots
Knowing what’s of interest on your site is crucial to maximize your marketing budget. Use this information to determine what you should cross- and up-sell to loyal customers, or which products to put on sale.
Customer Accounts
Opening an account provides customers with a personalized shopping experience that they can share with their friends. Customers can save their shopping preferences, and manage their own store billing and shipping information.
Advocacy Tools
Customers who share their wishlists with family and friends make a powerful endorsement of your brand. Customers create these personalized lists from products they choose. When shared by email or RSS feed, these simple lists become powerful advocacy tools.
Reviews & Ratings
Product reviews give your customers a way to engage with your brand while fostering a sense of community. You can curate your reviews with tools to help you edit and approve comments for inappropriate content before they go live.
50 Magento Community Edition 2.1 User Guide
CHAPTER 4: Quick Tour Customer Journey
Success!
Opening your Magento store for business requires the following areas of consideration. While there are virtually any number of customizations you can make to the storefront and Admin, you can use each link in this is list as a place to start.
Implementation
If you need help setting up your store, you can choose from our vast network of Magento Solutions Partners.
Design
You can use a prepared theme and design your own home page, or work with an experienced Magento designer or Magento Associate to customize your site.
Product Catalog
Configure products, create categories, import existing product catalogs, and leverage APIs or third-party data management solutions.
Payment Methods
Magento supports a wide variety of payment methods, services, and gateways that you can offer for your customers’ convenience.
Magento Community Edition 2.1 User Guide 51
Customer Journey CHAPTER 4: Quick Tour
Shipping Methods
Magento shipping methods are easy to set up and give you the ability to connect with carriers who can ship your products all over the world.
Taxes
Manage your taxes with our native tools, or add thirdparty extensions from Magento Marketplace.
Thanks for your order!
Magento can help you to build relationships with your customers, and bring them back to your store, again and again.
52 Magento Community Edition 2.1 User Guide
Basic Configuration
53
54
Contents
This section of the guide introduces your store's
Admin, and walks you through the basic configuration settings. You’ll learn the concepts of store hierarchy and configuration scope, and establish best practices for industry standards and requirements.
CHAPTER 5:
Store Admin
Your store Admin is the password-protected back office where you can set up products, promotions, manage orders, and perform other administrative tasks. All basic configuration tasks and store management operations are performed from the Admin.
l
l
l
l
Your initial sign-in credentials were set up during the Magento installation. If you forget your password, a temporary password can be sent to the email address that is associated with the account. For increased security, you can configure your store to require a casesensitive user name and password. For additional security, the Admin login can be configured to require a
. To learn more, see:
Magento Community Edition 2.1 User Guide
Admin Sidebar and Dashboard
55
Admin Sign In CHAPTER 5: Store Admin
Admin Sign In
The first thing you will learn is how to sign in and out of the Admin, and to reset your password. All of the instructions in the rest of this guide are written for a user with full administrative privileges, and begin with the assumption that you are logged in to the Admin.
To learn more about Admin users and roles, see:
The Advanced Admin configuration determines how many times an admin user can try to log in before the account is locked. By default, six attempts are allowed. To unlock a user account, see:
56
Admin Sign In
To sign in to the Admin:
1.
In the address bar of your browser, enter the URL that was specified during the installation, followed by the base URL of your store’s Admin. The default Admin URLs look something like this: http://www.yourdomain.com/admin
You can bookmark the page, or save a shortcut on your desktop for easy access.
2.
Enter your Admin User Name and Password.
3.
Tap
Login
.
Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin
To reset your password:
1.
If you forget your password, click the Forgot Your Password? link.
Admin Sign In
Forgot Password
2.
Enter the Email Address that is associated with the Admin account.
3.
Tap
Retrieve Password
.
If an account is associated with the email address, an email will be sent to reset your password.
Your Admin password must be seven or more characters long, and include both letters and numbers.
To sign out of the Admin:
In the upper-right corner, tap the Account ( ) icon. Then on the menu, choose Sign Out.
Sign Out
The Sign-In page returns, with a message that you are logged out. It’s always a good idea to sign out of the Admin whenever you leave your computer unattended.
Magento Community Edition 2.1 User Guide 57
Your Admin Account CHAPTER 5: Store Admin
Admin Password Requirements
FIELD
Password
DESCRIPTION
An Admin password must be seven or more characters long, and include both letters and numbers. For additional password options, see:
.
Your Admin Account
Your Admin account was initially set up during the installation, and might contain placeholder information. You can personalize your user name and password, and update your first and last name, and email address at any time. To learn more about Admin accounts and roles, see:
To edit your account information:
1.
In the upper-right corner, tap the Account ( ) icon. Then, choose Account Setting.
2.
Make any changes necessary changes to your account information. If you change your login credentials, make sure to write them down.
3.
When complete, tap
Save Account
.
58
Account Information
Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin Admin Sidebar
Admin Sidebar
The sidebar on the left is the main menu for your store’s Admin, and is designed for both desktop and mobile devices. The flyout menu provides access to all the tools you need to manage your store on a daily basis.
Dashboard
The Dashboard provides a quick overview of the sales and customer activity in your store, and is usually the first page that appears when you log in to the Admin.
Sales
The Sales menu is where you can find everything related to the operations of processing orders, invoices, shipments, credit memos, and transactions.
Products
The Products menu controls everything related to your product catalog and inventory.
Customers
The Customers menu is where you can manage customer accounts, and see which customers are online at the moment.
Marketing
The Marketing menu is where you set up catalog and shopping cart price rules and coupons. Price rules trigger actions when a set of specific conditions is met.
Magento Community Edition 2.1 User Guide 59
Admin Sidebar CHAPTER 5: Store Admin
Content
The Content menu is where you manage the content elements and design of your store. You will learn how to create pages, blocks, and frontend apps, and manage the presentation of your store.
Reports
The Reports menu provides a broad selection of reports that give you insight into every aspect of your store, including sales, shopping cart, products, customers, tags, reviews, and search terms.
Stores
The Store menu includes tools to configure and maintain every aspect of your store.
System
The System menu includes tools install extensions and manage Web Services for integration with other applications.
Find Partners & Extensions
This is where you can find a marketplace Magento
Partners and solutions for your store.
60 Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin Admin Workspace
Admin Workspace
The Admin workspace provides access to all the tools, data, and content that you need to run your store. The main pages have a grid that lists the data for the section, with a set of tools to search, sort, filter, select, and apply actions.
Admin Workspace
Workspace Controls
CONTROL
Search
DESCRIPTION
The Global Search box can be used to find any value in the database, including product, customer, and order records.
Sort
Filter
Paginate
Actions
Mass Actions
The header of each column can be used to sort the list in ascending or descending order.
The filters in the header of each column can be used to limit the list to specific values. Some filters have additional options that can be selected from a list box, and for others, you can simply type the value you want to find.
The pagination controls are used to view the additional pages of results.
The Actions control applies an operation to all selected records. To select a record, mark the checkbox in the first column, or use the Mass Actions control to select multiple records.
The Mass Actions control is used to select multiple records to be the target of action. Options: Select All / Unselect All, Select Visible / Unselect Visible
Magento Community Edition 2.1 User Guide 61
Admin Workspace CHAPTER 5: Store Admin
Dashboard
The dashboard is usually the first page that appears when you log in to the Admin, and gives an overview of sales and customer activity. The blocks on the left provide a snapshot of lifetime sales, average order amount, the last five orders, and search terms. The graph shows the orders and amounts for the selected date range. You can use the tabs above the graph to toggle between the two views. The tabs at the bottom provide quick reports about your best-selling and most viewed products, new customers and those who have purchased the most.
The dashboard is the default startup page for the Admin, although you can change the configuration to display a different page when you log in. You can also set the starting dates used in dashboard reports, and disable the display of the charts section.
You can produce Dashboard snapshot reports for each store view. The tabs at the bottom of the page summarize your best-selling and most viewed products, new customers, and those who have purchased the most during the time period specified.
Dashboard
62 Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin Admin Workspace
To configure the chart:
1.
On the Admin sidebar, tap Stores. Under Settings, choose Configuration. Then, do any of the following:
Enable Charts
1.
In the panel on the left, under Advanced, choose Admin.
2.
In the Dashboard section, set Enable Charts to “Yes.”
Dashboard
Set the Beginning Dates
1.
In the panel on the left under General, choose Reports.
2.
In the Dashboard section do the following:
a.
Set Year-To-Date Starts to the Month and Day.
b.
Set Current Month Starts to the Day.
Dashboard
Magento Community Edition 2.1 User Guide 63
Admin Workspace CHAPTER 5: Store Admin
Choose the Data Source
If you have a lot of data to process, the performance of the Dashboard can be improved by turning off the display of real time data.
1.
In the panel on the left, tap to expand Sales. Then, choose Sales.
2.
Tap to expand the Dashboard section, and do the following: l
For real-time data, set Use Aggregated Data (beta) to “Yes.” l
For historical data, set Use Aggregated Data (beta) to “No.”
Dashboard
Change the Startup Page
1.
In the panel on the left, tap to expand Advanced. Then, choose Admin.
2.
Tap to expand the Startup Page section.
3.
Choose the Startup Page that you want to appear when you log in to the Admin. The list includes every page in the Admin menu structure.
2.
When complete, tap
Save Config
.
Startup Page
64 Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin Admin Workspace
Dashboard Reports
REPORT
Sales
Orders
Amounts
Search Terms
Products
Customers
DESCRIPTION
The Dashboard reports on Lifetime Sales, Revenue, Tax, Shipping, and Quantity for the time period specified.
The Orders tab at the top displays a chart of all orders during the specified time period. Below the chart is the total revenue, tax, shipping, and quantity ordered. The lifetime sales amount and the last five orders are on the left.
The Amounts tab at the top displays a chart of all order amounts during the specified time period. The average order amount and the last five orders are on the left.
The last five search terms, and top five search terms appear on the left.
The Bestsellers tab shows the price and quantity ordered of your best-selling products. The products that have been viewed the most during the specified time period are listed on the Most Viewed
Products tab.
The Customers tab at the bottom lists the customers who have ordered the most during the specified range of time. The New
Customers tab lists all new customers who have registered for an account during the time period. On the left, the Last Orders section lists the most recent orders by customer.
Magento Community Edition 2.1 User Guide 65
Admin Workspace CHAPTER 5: Store Admin
Message Inbox
Your store receives messages from Magento on a regular basis. The messages might refer to system updates, patches, new releases, scheduled maintenance or upcoming events, and are rated by importance. The bell icon in the header indicates the number of unread messages in your inbox.
66
Incoming Messages
Any message of critical importance appears in a pop-up window when you log into your store.
The notice continues to appear after each login until the message is either marked as read, or removed.
Message of Critical Importance
The Notifications grid lists all messages ranked by severity, with the most recent at the top.
The Action commands can be used to mark individual messages as read, view more detailed information, or to remove the message from the inbox.
The configuration determines how often the inbox is updated, and how the messages are delivered. If your store Admin has a secure URL, notifications must be delivered over HTTPS
Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin Admin Workspace
To view incoming messages:
1.
Tap the Notification icon in the header, and read the summary. Then, do one of the following: l
If necessary, tap the message to display the full text.
l
To delete the message, tap the delete icon to the right of the message.
l
To display the Notifications grid, click See All.
2.
For a message of critical importance, do one of the following: l
Click Read Details.
l
To remove the popup, but keep the message active, tap Close.
To view all notifications:
1.
Do one of the following: l
Tap the Notification icon in the header. Then in the footer of the summary, click See All.
l
On the Admin sidebar, tap System. Then under Other Settings, choose Notifications.
2.
In the Action column, do any of the following: l
For more information, tap Read Details. The linked page opens in a new window.
l
To keep the message in your inbox, tap Mark As Read.
l
To delete the message, tap Remove.
Magento Community Edition 2.1 User Guide
All Notifications
67
Admin Workspace CHAPTER 5: Store Admin
3.
To apply an action to multiple messages, do one of the following: l
Mark the checkbox in the first column to select each message to be managed.
l
To select multiple messages, set the Mass Actions control as needed.
4.
Set the Actions control to one of the following: l
Mark as Read l
Remove
5.
Tap
Submit
to complete the process.
To configure notifications:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
Scroll down, and in the panel on the left under Advanced, choose System.
3.
Expand the Notifications section, and do the following:
a.
If your store Admin runs over a
, set Use HTTPS to Get Feed to “Yes.”
b.
Set Update Frequency to determine how often your inbox is updated. The interval can be from one to twenty-four hours.
4.
When complete, tap
Save Config
.
Notifications
68 Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin Admin Workspace
Global Search
The spy glass in the header of the Admin can be used to find any record in the database. The results can include customers, products, orders, or any related attribute. For example, if you enter a customer name, the results might include the customer record as well as any orders that are associated with the name.
Search
To find a match:
1.
In the header, tap the spy glass to open the search box. Then, do one of the following: l
To find a close match, enter the first few letters of what you want to find.
l
To find an exact match, enter the word, or multiple words that you want to find.
2.
In the search results, click any item to open the record.
Magento Community Edition 2.1 User Guide 69
Admin Workspace CHAPTER 5: Store Admin
Grid Controls
Admin pages that manage data display a collection of records in a grid. The controls at the top of each column can be used to sort the data. The current sort order is indicated by an ascending or descending arrow in the column header. You can specify which columns appear in the grid, and drag them into different positions. You can also save different column arrangements as views that can be used later. The Action column lists operations that can be applied to an individual record. The data from the current view can be exported to a CSV or XML file.
70
Orders Grid
To sort the list:
1.
Tap any column header. The arrow indicates the current order as either ascending or descending.
2.
Use the pagination controls to view additional pages in the collection.
To paginate the list:
1.
Set the Pagination control to the number of records that you want to view per page.
2.
Tap Next and Previous to page through the list, or enter a specific Page Number.
Next and Previous
Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin
To filter the list:
1.
Tap
Filters
.
2.
Complete as many filters as necessary to describe the record you want to find.
3.
Tap
Apply Filters
.
Admin Workspace
Filter Controls
Grid Layout
The selection of columns and their order in the grid can be changed according to your preference, and saved as a “view.” By default, only nine of twenty available columns are visible in the grid.
Magento Community Edition 2.1 User Guide
Order Grid Columns
71
Admin Workspace CHAPTER 5: Store Admin
To change the selection of columns:
1.
In the upper-right corner, tap the Columns control. Then, do the following: l
Mark the checkbox of any column you want to add to the grid.
l
Clear the checkbox of any column you want to remove from the grid.
2.
Make sure to scroll down to see all available columns.
To move a column:
1.
Tap the header of the column, and hold.
2.
Drag the column to the new position, and release.
To save a grid view:
1.
Tap the View control. Then, tap Save Current View.
2.
Enter a name for the view. Then, click the arrow to save all changes.
The name of the view now appears as the current view.
To change the grid view:
Tap the View control. Then, do one of the following: l
To use a different view, tap the name of the view.
l
To change the name of a view, tap the Edit icon. Then, update the name.
72 Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin Admin Workspace
Actions Control
When working with a collection of records in the grid, you can use the Actions control to apply an operation to one or more records. The Actions control lists each operation that is available for the specific type of data. For example, for product records, you can use the Actions control to update the attributes of selected products, change the status from “Disabled” to “Enabled,” or to delete records from the database. .
You can make as many changes as necessary, and then update the records in a single step. It’s much more efficient than changing the settings individually for each product.
The selection of available actions varies by list, and additional options might appear, depending on the action selected. For example, when changing the status of a group of records, a Status box appears next to the Actions control with additional options.
Applying an Action to Selected Records
Step 1:
Select Records
The checkbox in the first column of the list identifies each record that is a target for the action.
The
can be used to narrow the list to the records you want to target for the action.
1.
Mark the checkbox of each record that is a target for the action. Or, use one of the following
Mass Actions
to select a group of records: l
Select All / Unselect All l
Select Visible / Unselect Visible
2.
If needed, set the filters at the top of each column to show only the records that you want to include.
Magento Community Edition 2.1 User Guide 73
Admin Workspace CHAPTER 5: Store Admin
3.
In the first column, set the checkbox state to one of the following:
Any
Yes
No
Lists all records, regardless of filter settings.
List only records that match the filter settings.
List only records that do not match the filter settings.
Step 2:
Apply an Action to Selected Records
1.
Set the Actions control to the operation that you want to apply.
Example:
Update Attributes
1.
In the list, mark the checkbox of each record to be updated.
2.
Set the Actions control to “Update Attributes,” and tap
Submit
.
The Update Attributes page lists all the available attributes, organized by group in the panel on the left.
74
Update Attributes
3.
Mark the Change checkbox next to each attribute, and make the necessary changes.
4.
Tap
Save
to update the attributes for the group of selected records.
2.
When complete, tap
Submit
.
Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin
Mass Actions
ACTION
Select All
Unselect All
Select Visible
Unselect Visible
Checkbox States
STATE
Any
Yes
No
Actions by Grid
MENU LIST
SALES
Orders
DESCRIPTION
Marks the checkbox of all records in the list.
Clears the checkbox of all records in the list.
Marks the checkbox of records on the current page.
Clears the checkbox of records on the current page.
DESCRIPTION
Lists all records, regardless of checkbox status.
Lists only records with the checkbox selected.
Lists only records without the checkbox selected.
ACTIONS
Invoices
Shipments
Credit Memos
Cancel
Hold
Unhold
Print Invoices
Print Packing Slips
Print Credit Memos
Print All
Print Shipping Labels
PDF Invoices
PDF Packing Slips
Print Shipping Labels
PDF Credit Memos
PRODUCTS
Catalog Delete
Change Status
Update Attributes
Admin Workspace
Magento Community Edition 2.1 User Guide 75
Admin Workspace
Actions by Grid (cont.)
MENU LIST
CUSTOMERS
All Customers
ACTIONS
CHAPTER 5: Store Admin
Delete
Subscribe to Newsletter
Unsubscribe from Newsletter
Assign a Customer Group
Edit
MARKETING
Communications
Newsletter Subscribers
SEO & Search
Search Terms
User Content
Reviews
Unsubscribe
Delete
Delete
Delete
Update Status
CONTENT
Elements
Pages
Blocks
Delete
Disable
Enable
Edit
Delete
Edit
REPORTS
Refresh Statistics Refresh Lifetime Statistics
Refresh Statistics for the Last Day
STORES
76 Magento Community Edition 2.1 User Guide
CHAPTER 5: Store Admin
Actions by Grid (cont.)
MENU LIST
Settings
Order Status
SYSTEM
Tools
Cache Management
Backups
Index Management
Other Settings
Notifications
ACTIONS
Unassign
Enable
Disable
Refresh
Delete
Update on Save
Update by Schedule
Mark as Read
Remove
Admin Workspace
Magento Community Edition 2.1 User Guide 77
78 Magento Community Edition 2.1 User Guide
CHAPTER 6:
Store Details
The basic information for your store includes the store name and address, telephone number and email address, that appear on email messages, invoices, and other communications sent to your customers.
General Configuration
Magento Community Edition 2.1 User Guide 79
Store Information CHAPTER 6: Store Details
Store Information
The Store Information section provides the basic information that appears on sales documents and in other communications.
Store Information
80 Magento Community Edition 2.1 User Guide
CHAPTER 6: Store Details Store Information
To enter your store information:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose General.
3.
Expand the Store Information section, and do the following:
a.
Enter the Store Name that you want to use in all communications.
b.
Enter the Store Phone Number, formatted as you want it to appear.
c.
In the Store Hours of Operation field, enter the hours your store is open for business. For example: Mon - Fri, 9-5, Sat 9-noon PST.
d.
Select the Country where your business is located.
e.
Select the Region/State with the country.
f.
Enter the Store Address. If the address is long, continue the address on Store Address
Line 2
.
g.
If applicable, enter the VAT Number of your store. To verify the number, click the Validate
VAT Number
button.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 81
Locale Options CHAPTER 6: Store Details
Locale Options
The locale determines the language, country, tax rate, and other settings that are used throughout the store. The Locale Options determine the time zone and language used for each store, and identify the days of the work week in your area.
82
Locale Options
To set the store locale:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose General.
3.
Expand the Locale Options section.
4.
Select your Timezone from the list. Then, do the following:
a.
Set Locale to the store language.
b.
Set Weight Unit to the unit of measurement that is typically used for shipments from your locale.
c.
Set First Day of the Week to the day that is considered to be the first day of the week in your area.
d.
In the Weekend Days list, select the days which fall on a weekend in your area. (To select multiple options, hold down the Ctrl (PC) or Command (Mac) key.)
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 6: Store Details State Options
State Options
In many countries, the state, province, or region is a required part of a postal address. The information is used for shipping and billing information, to calculate tax rates, and so on. For countries where the state is not required, the field can be omitted entirely from the address, or included as an optional field.
Because standard address formats vary from one country to another, you can also edit the template that is used to format the address for invoices, packing slips, and shipping labels.
State Options
To set up the state options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose General.
3.
Expand the State Options section, and do the following:
a.
In the State is required for list, select each country where Region/State is a required entry.
b.
Set the Allow to Choose State if It is Optional for Country field to one of the following:
Yes
No
In countries where the state field is not required, includes the State field as an optional entry.
In countries where the state field is not required, omits the State field.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 83
Country Options CHAPTER 6: Store Details
Country Options
The Country Options identify the country where your business is located, and the countries from which you accept payment.
84
Country Options
Magento Community Edition 2.1 User Guide
CHAPTER 6: Store Details Country Options
To set the country options for your store:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose General.
3.
Expand the Country Options section, and do the following:
a.
Choose the Default Country where your business is located.
b.
In the Allow Countries list, select each country from which you accept orders. By default, all countries in the list are selected. To select multiple countries, hold down the Ctrl (PC) or Command (Mac) key.
c.
In the Zip/Postal Code is Optional for list, select each country where you conduct business that does not require a ZIP or postal code to be included as part of the street address.
d.
In the European Union Countries list, select each country in the EU where you conduct business. By default, all EU countries are selected.
e.
In the Top Destinations list, select the primary countries that you target for sales.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 85
Merchant Location CHAPTER 6: Store Details
Merchant Location
The Merchant Location setting is used to configure
. If no value is entered, the
setting is used.
Merchant Location
To enter the merchant location:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Payment Methods.
3.
Expand the Merchant Location section. Then, choose your Merchant Country.
4.
When complete, tap
Save Config
.
86 Magento Community Edition 2.1 User Guide
CHAPTER 6: Store Details
Currency
Currency
Currency Setup
Defines the base currency and any additional currencies that are accepted as payment. Also establishes the import connection and schedule that is used to update currency rates automatically.
Currency Symbols
Defines the currency symbols that appear in product prices and sales documents such as orders and invoices.
Magento support currencies from over two hundred countries around the world.
Updating Currency Rates
Currency rates can be updated manually or imported into your store as needed, or according to a predefined schedule.
Currency Chooser
If multiple currencies are available, the currency chooser appears in the header of the store.
Magento Community Edition 2.1 User Guide 87
Store Email Addresses CHAPTER 6: Store Details
Store Email Addresses
You can have up to five different email addresses to represent distinct functions or departments for each store or view. In addition to the following predefined email identities, there are two custom identities that you can set up according to your needs.
l
General Contact l
Sales Representative l
Customer Support
Each identity and its associated email address can be associated with specific automated email messages and appear as the sender of email messages that are sent from your store.
Process Overview:
Step 1: Set Up the Email Addresses for Your Domain
Step 2: Configure the Email Addresses for Your Store
Step 3: Update the Sales Email Configuration
Step 1:
Set Up the Email Addresses for Your Domain
Before you can configure email addresses for the store, each must be set up as a valid email address for your domain. Follow the instructions from your server administrator or email hosting provider to create each email addresses that is needed.
Step 2:
Configure the Email Addresses for Your Store
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Store Email Addresses.
3.
Expand the General Contact section, and do the following:
88
General Contact
a.
In the Sender Name field, type the name of the person to appear as the sender of any email messages that is associated with the General Contact identity.
b.
In the Sender Email field, type the associated email address.
4.
Repeat this process for each store email addresses that you plan to use.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 6: Store Details Store Email Addresses
Step 3:
Update the Sales Email Configuration
If you use custom email addresses, make sure to update the configuration of any related email messages, so the correct identity appears as the sender.
1.
In the panel on the left, under Sales, choose Sales Emails. The page has a separate section for each of the following: l
Order and Order Comments l
Invoice and Invoice Comments l
Shipment and Shipment Comments l
Credit Memo and Credit Memo Comments
2.
Starting with Order, expand the section for each message, and make sure that the correct sender is selected.
Sales Email Order Configuration
3.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 89
Contact Us CHAPTER 6: Store Details
Contact Us
The Contact Us link in the footer of the store is an easy way for customers to keep in touch with you. Customers can complete the form to send a message to your store.
Contact Us in Footer
After the form is submitted, a thank you message appears. The contact-us-info
contains the form, and can be easily customized.
90
Contact Us Form
To configure Contact Us:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Contacts.
Magento Community Edition 2.1 User Guide
CHAPTER 6: Store Details
3.
Expand the Contact Us section. If necessary, set Enable Contact Us to “Yes.”
Contact Us
4.
Expand
Contact Us
the Email Options section. Then, do the following:
Email Options
a.
In the Send Emails to field, enter the email address where messages from the Contact Us form are sent.
b.
Set Email Sender to the store identity that appears as the sender of the message from the
Contact Us form. For example: Custom Email 2.
c.
Set Email Template to the template that is used for messages sent from the Contact Us form.
5.
When compete, tap
Save Config
.
To customize the Contact Us form:
1.
On the Admin sidebar, tap Content. Then under Elements, choose Blocks.
2.
Find the Contact Us Info block in the list, and open in Edit mode.
Magento Community Edition 2.1 User Guide
Contact Us Info
91
Contact Us
3.
Scroll down to the Content field, and make any changes necessary.
l
Use the editor
to format the text, and add
and
l
Tap
Show / Hide Editor
to work directly with the HTML.
CHAPTER 6: Store Details
92
4.
When complete, tap
Save Block
.
Contact Us Content
Magento Community Edition 2.1 User Guide
CHAPTER 7:
Storefront Branding
One of the first things you’ll want to do is to change the logo in the header, and upload a favicon for the browser. You’ll also want to update the copyright notice in the footer,.
These are a few simple design tasks that you can take care of right away. While your store is in development, you can turn on the store demo notice, and then remove it when you’re ready to launch.
Storefront Branding
Magento Community Edition 2.1 User Guide 93
Uploading Your Logo CHAPTER 7: Storefront Branding
Uploading Your Logo
The size and location of the logo in the header is determined by the store’s theme. Your logo can be saved as either a GIF, PNG, JPG, or SVG file type, and uploaded from the Admin of your store. The default Magento logo in the sample data is an SVG file, which is a scalable
XML-based vector graphic format.
Logo in Header
The logo image resides in the following location on the server. Any image file with by that name and at that location is used as the theme logo.
Actual path:
Relative path:
app/design/frontend/[vendor]/[theme]/web/images/logo.svg
images/logo.svg
If you don’t know the size of the logo, or any other image that is used in your theme, open the page in a browser, right-click the image, and inspect the element.
In addition to the logo in the header, your logo also appears on
and on
and other sales documents. The logos used for email templates and invoices have different size requirements, and must be uploaded separately. To learn more, see:
.
94 Magento Community Edition 2.1 User Guide
CHAPTER 7: Storefront Branding Uploading Your Logo
To upload your logo:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
Design Configuration
2.
Find the store view that you want to configure, and in the Action column, click Edit.
3.
Expand the Header section. Then, do the following:
Header
a.
To upload a new logo, tap
Upload
. Then, choose the file from your computer.
b.
Enter the Logo Image Width and Logo Image Height.
c.
In the Logo Image Alt field, enter the text that you want to appear when someone hovers over the image.
4.
When complete, tap
Save Configuration
.
Magento Community Edition 2.1 User Guide 95
Uploading Your Logo
Logo File Formats
FILE FORMAT
PNG
GIF
JPG/JPEG
SVG
CHAPTER 7: Storefront Branding
DESCRIPTION
(Portable Network Graphics) This newer alternative to the GIF format supports up to 16 million colors (24 bit). The lossless compression format produces a high-quality bitmap image with crisp text, but a larger file size than some formats. The PNG format supports transparent layers, and is designed to be both viewed and streamed online. The related MNG (APNG) formats support simple animation.
(Graphics Interchange Format) A widely supported, and older bitmap format that is limited to 256 (8 bit) colors. The GIF format supports simple animation and transparent layers.
(Joint Photographics Expert Group) A compressed bitmap format that is used by most digital cameras. The lossy compression causes some data loss, which is sometimes noticeable as blurry spots in text.
(Scalable Vector Graphic) An XML-based open standard, scriptable vector format developed by the World Wide Web Consortium. SVG files support both animation and interaction.
96 Magento Community Edition 2.1 User Guide
CHAPTER 7: Storefront Branding Adding a Favicon
Adding a Favicon
Favicon is short for “favorite icon,” and refers to the little icon on the tab of each browser page.
Depending on the browser, the favicon also appears in address bar, just before the URL.
Favicons are generally 16 x 16 pixels or 32 x 32 pixels in size. Magento accepts ICO, PNG, JPG, and SVG file types, although not all browsers support these formats. The most widelysupported file format to use for a favicon is ICO. Other image file types can be used, although the format might not be supported by all browsers. There are many free tools available online that you can use to generate an ICO image or convert an exiting image to the format.
Favicon in Address Bar
Process Overview:
Step 2: Upload the Favicon to Your Store
Step 1:
Create a Favicon
1.
Create a 16x16 or 32x32 graphic image of your logo, using the image editor of your choice.
2.
(Optional) Use one of the available online tools to convert the file to the .ico format. Then, save the file to your computer.
Step 2:
Upload the Favicon to Your Store
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
In the grid, find the store view that you want to configure. Then in the Action column, click
Edit
.
3.
Under Other Settings, expand the HTML Head section. Then, do the following:
Magento Community Edition 2.1 User Guide 97
Adding a Favicon CHAPTER 7: Storefront Branding
HTML Head
a.
Tap
Upload
. Then, navigate to the favicon file that you prepared, and tap
Open
.
98
Favicon
b.
If you want to delete the current favicon, tap Delete in the lower-left corner of the image. Then, upload another.
4.
When complete, tap
Save Configuration
.
Step 3:
Refresh the Cache
1.
When prompted to refresh the cache, click the Cache Management link in the message at the top of the workspace.
2.
In the list, mark the Page Cache checkbox that is marked “Invalidated.”
3.
Set Actions to “Refresh.” Then, tap
Submit
.
4.
To view the new favicon, return to your storefront and press F5 to refresh the browser.
Magento Community Edition 2.1 User Guide
CHAPTER 7: Storefront Branding Changing the Welcome Message
Changing the Welcome Message
The Welcome message in the header expands to include the name of the customer who is logged in. Before you launch your store, be sure to change the default Welcome text for each store view.
Welcome Message
To change the welcome message:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
In the grid, find the store view that you want to configure. Then in the Action column, click
Edit
. Then, do the following:
Design Configuration
a.
Under Other Settings, expand the Header section.
b.
Enter the Welcome Text that you want to appear in the header of your store.
Magento Community Edition 2.1 User Guide 99
Copyright Notice CHAPTER 7: Storefront Branding
100
Header
3.
When complete, tap
Save Configuration
.
4.
When prompted to update the Page Cache, click the Cache Management link at the top of the workspace. Then, follow the instructions to refresh the cache.
Copyright Notice
Your store has a copyright notice in the footer of each page. As a best practice, the copyright notice should include the current year, and identify your company as the legal owner of the content on the site.
Copyright Notice
The &Copy; character code is used to insert the copyright symbol, as shown in the following examples:
Long Format Example
Copyright &Copy; 2016 Magento, Inc. All rights reserved.
Short Format Example
&Copy; 2016 Magento, Inc. All rights reserved.
To change the copyright notice:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
In the grid, find the store view that you want to configure. Then in the Action column, click
Edit
, and do the following:
Magento Community Edition 2.1 User Guide
CHAPTER 7: Storefront Branding Copyright Notice
a.
Under Other Settings, expand
Design Configuration
the Footer section.
Footer
b.
In the Copyright box, enter the copyright notice that you want to appear in the footer of each page. Use the &Copy; character code to insert a copyright symbol.
3.
When complete, tap
Save Configuration
.
Magento Community Edition 2.1 User Guide 101
Store Demo Notice CHAPTER 7: Storefront Branding
Store Demo Notice
If your store is online, but still under construction, you can display a store demo notice at the top of the page to let people know that the store is not yet open for business. When you are ready to “go live,” simply remove the message. It’s like flipping the sign hanging in the window from “Closed” to “Open.” The format of the demo notice is determined by the theme of your store.
Store Demo Notice
To set the store demo notice:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
In the grid, find the store view that you want to configure. Then in the Action column, click
Edit
.
3.
Under Other Settings, expand the HTML Head section.
4.
Scroll down to the bottom, and set the Display Demo Store Notice to your preference.
102 Magento Community Edition 2.1 User Guide
CHAPTER 7: Storefront Branding
5.
When complete, tap
Save Configuration
.
HTML Head
Store Demo Notice
Magento Community Edition 2.1 User Guide 103
104 Magento Community Edition 2.1 User Guide
CHAPTER 8:
Websites, Stores & Views
Every Magento installation has a
of website(s), store(s), and store view(s). The term “scope” determines where in the hierarchy a database entity — such as a product, attribute, or category — content element, or configuration setting applies. Websites, stores, and store views have one-to-many parent/child relationships. A single installation can have multiple websites, and each website can have multiple stores and store views.
Websites
Magento installations begin with a single website which by default, is called “Main Website.” You can also set up multiple websites for a single installation, each with its own IP address and domain.
Stores
A single website can have multiple stores, each with its own main menu. The stores share the same product catalog, but can have a different selection of products and design. All stores under the same website share the same Admin and checkout.
Store Views
Each store that is available to customers is presented according to a specific "view". Initially, a store has a single default view. Additional store views can be added to support different languages, or for other purposes. Customers can use the language chooser in the header to change the store view.
Magento Community Edition 2.1 User Guide 105
Scope CHAPTER 8: Websites, Stores & Views
Scope
If your Magento installation has a hierarchy of websites, stores, or views, you can set the context, or “scope” of a configuration setting to apply to a specific part of the installation. The context of many database entities can also be assigned a specific scope to determine how it is used in the store hierarchy. To learn more, see:
and
.
Some configuration settings such as postal code, have a [global] scope because the same value is used throughout the system. The [website] scope applies to any stores below that level in the hierarchy, including all stores and their views. Any item with the scope of [store view] can be set differently for each view, and is typically used to support multiple languages.
Unless the store is running in
Single Store Mode , the scope of each configuration setting
appears in small text below the field label. If your installation includes multiple websites, stores or views, you should always choose the
where the settings apply before making any changes.
106
Scope Settings
SCOPE
Global
Website
Store
Store View
Hierarchy of Websites, Stores, and Store Views
DESCRIPTION
System-wide settings and resources that are available throughout the
Magento installation.
Settings and resources that are limited to the current website. Each website has a default store.
Settings and resources that are limited to the current store. Each store has a default root category (main menu) and default store view.
Setting and resources that are limited to the current store view.
Magento Community Edition 2.1 User Guide
CHAPTER 8: Websites, Stores & Views Scope
Changing Scope
The Store View chooser in the upper-left corner of many Admin pages filters the view of the page for a specific scope, and also sets the value of some entities that are used by Magento. It lists each level in the hierarchy by name, and is used to change the scope to another level. Any settings that represent the current scope are grayed out, so only those that represent a scope change are available. The scope is initially set to “Default Config.” For Admin users with restricted access, the list of available store views includes only those which the user has
to access.
The checkbox to the right of many configuration settings can be used to either apply or override the default setting, according to the current scope. The field value cannot be changed when the checkbox is marked. To change the current value, first clear the checkbox, and then enter the new value. You are prompted to confirm whenever you change scope. The checkbox label changes according to the current scope, and always refers to the parent level which is one step up in the hierarchy. Because the parent level is a container for all the items below that level, the value from the parent level is inherited unless it is overridden.
Default Config with "Use System Value" Checkboxes
To set the configuration scope:
Before making a configuration setting that applies only to a specific website, store, or view, do the following:
1.
On the Admin sidebar, do one of the following: l
For most configuration settings, tap Stores. Then under Settings, choose Configuration.
l
For
design-related settings , tap Content. Under Design, choose Configuration. Then in the
grid, choose the applicable store view.
2.
Navigate to the configuration setting to be changed. Then, do the following:
Magento Community Edition 2.1 User Guide 107
Scope CHAPTER 8: Websites, Stores & Views
a.
In the upper-left corner, set Store View to the specific view where the configuration applies. When prompted to confirm scope switching, tap
OK
.
A checkbox appears after each field, and additional fields might become available.
b.
Clear the Use system value checkbox after any field that you want to edit. Then, update the value for the view.
c.
Repeat this process for every field that needs to be updated on the page.
3.
When complete, tap
Save Config
.
108
Store Hierarchy
LEVEL
Default Config
Main Website
Main Website Store
Default Store View
Stores Configuration
Setting the Locale of the French Store View
DESCRIPTION
The default system configuration.
The name of the website at the top of the hierarchy.
The name of the default store that is associated with the parent website.
The name of the default store view that is associated with the parent store.
Jumps to the Stores grid, and is the same as choosing Stores > All
Stores from the Admin sidebar.
Magento Community Edition 2.1 User Guide
CHAPTER 8: Websites, Stores & Views Scope
Default Value Options
CHECKBOX DESCRIPTION
Use system value The “Use system value” checkbox appears when the configuration scope is set to “Default Config.”
Use Default
Use Website
The “Use Default” checkbox appears when the configuration scope is set to
“Main Website,” and refers to the default store that is assigned to the website.
The “Use Website” checkbox appears when the configuration scope set to a specific store view. When marked, it uses the setting from the parent website that is associated with the store view. In this case, the store level is skipped because it is understood to apply to the default store that is associated with the website.
Magento Community Edition 2.1 User Guide 109
Scope CHAPTER 8: Websites, Stores & Views
Product Scope
For installations with multiple websites, stores, and views, the
setting determines where products are available for sale, and the product information that is available for each store view. Initially, all products that you create are published to the default website, store, and store view.
110
Multisite Installation
If you have only a single store with the default view, you can run your store in
to hide the scope settings. However, if your store has multiple views, a scope indicator appears below the name of each field.
l
To edit product information for a specific view, use the Store View control in the upper-left corner to choose the view. Additional controls become available for any field that can be edited at the store view level.
l
To define the scope of a product in a multisite installation, see the
section of product information.
The process of editing a product for a store view is like adding a layer of product information that is specific to the view.
In the following example, although the Spanish store view is selected, the product information still appears in the original language of the default store view. To translate the product information, you must switch to the Spanish view, and translate the text fields — such as product title, description, and the meta data. To learn more, see:
Magento Community Edition 2.1 User Guide
CHAPTER 8: Websites, Stores & Views Scope
To edit a product for a different view:
1.
In the upper-left corner, set Store View to the specific view to be edited. When prompted to confirm, tap
OK
to switch scope.
Store View
2.
A checkbox appears below any field that can be edited for the store view. To override the default value, clear the Use Default Value checkbox. Then, update the field with the new value for the store view.
Translating Product Name for Spanish Store View
3.
When complete, tap
Save
.
4.
In the upper-left corner, set the Store View chooser back to the default.
5.
To verify the change in your store, do the following:
a.
In the upper-right corner, tap the Admin menu arrow. Then, choose Customer View.
Customer View
b.
In the upper-right corner of the store, set the Language Chooser to the store view of the product that you edited. Then, find the product that you edited for the view.
Magento Community Edition 2.1 User Guide 111
Scope CHAPTER 8: Websites, Stores & Views
Price Scope
The scope of the
that is used for product prices can be configured to apply at either the global or website level. If applied at the global level, the same price is used throughout the store hierarchy. If the price configuration is set to the website level, the same product can be available at different prices in different stores. By default, the scope of catalog pricing is global.
Different factors can affect the price of the same product in one location and not another. For example, there might be additional costs to bring the product to market, and other considerations that impact the price of products sold in a specific store. The following illustration shows a multisite installation with the base currency set to the website level. In each store, the same product has a different price.
Price Scope
112 Magento Community Edition 2.1 User Guide
CHAPTER 8: Websites, Stores & Views
To configure price scope:
1.
On the Admin menu, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Scroll down to the Price section. Then, set Catalog Price Scope to one of the following: l
Global l
Website
The scope setting that you choose appears below price fields in your catalog.
Scope
4.
When complete, tap
Save Config
.
Catalog Price Scope
Magento Community Edition 2.1 User Guide 113
Scope CHAPTER 8: Websites, Stores & Views
Customer Account Scope
The scope of customer accounts can be limited to the website where the account was created, or shared with all websites and stores in the store hierarchy.
To set the scope of customer accounts:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Customers, choose Customer Configuration.
3.
Expand the Account Sharing Options section.
Account Sharing Options
4.
If necessary, clear the User system value checkbox. Then, set Share Customer Accounts to one of the following:
Global
Per Website
Shares customer account information with every website and store in the
Magento installation.
Limits customer account information to the website where the account was created.
5.
When complete, tap
Save Config
.
114 Magento Community Edition 2.1 User Guide
CHAPTER 8: Websites, Stores & Views Scope
Scope Quick Reference
DESCRIPTION SCOPE
GLOBAL
Admin
Default Config
Catalog Prices
Product Configurations
Customers
All websites, stores, and store views in the installation are managed from the same
The global
settings are used through the store hierarchy, unless they are overridden at a lower level.
can be configured to be applied at either a global or website level.
Attributes that are used as
options must have a global scope.
Customer accounts can be configured to be applied at a global or website level. Each website can have a separate set of
, or share the same customer accounts with other websites in the installation.
WEBSITE
Domain
Customers
Currency
Product
Catalog Prices
Payment Methods
Additional
can be set up as subdomains of the primary domain, or have separate IP addresses and dedicated domains.
Customer accounts can be configured to be applied at a global or website level. Each website can have a separate set of
, or share the same customer accounts with other websites in the installation.
Each website can be assigned a different
. The base currency is used to process all transactions, although a different display currency might appear to the customer, according to the locale of the store view.
Individual products are assigned to the hierarchy at the website level.
The
setting identifies each website where the product is available.
can be configured to be applied at either a global or website level.
are configured at the website level, although the title and instructions can be configured for each store view.
Magento Community Edition 2.1 User Guide 115
Scope
SCOPE
Checkout
STORE
Catalog
Root Category
Checkout
STORE VIEW
Subcategories
Locale
Languages
Display Currency
CHAPTER 8: Websites, Stores & Views
DESCRIPTION
The
takes place at the website level, although some display options can be configured for each store view.
Each store can have a separate catalog and main menu that is based on a "root" category and subcategories. The Catalog grid lists all products in the catalog.
Each catalog has a
that is assigned at the store level.
All stores associated with a website have the same
.
The
that make up the main menu (under the root) are assigned at the store view level.
Each store view can be assigned a different
currency, units of measurement, and most of the Admin interface are specific to the locale.
To support multiple languages, all content, including product descriptions, must be
for each store view.
A different
can be used for each store view, although the transactions are processed at the website level using the base currency.
116 Magento Community Edition 2.1 User Guide
CHAPTER 8: Websites, Stores & Views Single Store Mode
Single Store Mode
If your Magento installation has only a single store and store view, you can simplify the display by turning off all store view options and scope indicators. Most of the screenshots in this guide were taken with Single Store Mode disabled to show the scope indicator for each setting. Single Store Mode is overridden if you
later.
Single Website, Store, and View
To set single store mode:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
Under General, scroll down to the bottom of the page, and expand the Single-Store Mode section.
3.
Set Enable Single-Store Mode to “Yes.”
Single Store Mode
4.
Tap
Save Config
.
Magento Community Edition 2.1 User Guide 117
Single Store Mode CHAPTER 8: Websites, Stores & Views
5.
When prompted to refresh the cache, do the following:
a.
Tap the Cache Management link in the system message at the top of the page.
System Message
b.
Mark the Page Cache checkbox.
c.
With Actions set to “Refresh,” tap
Submit
.
118 Magento Community Edition 2.1 User Guide
CHAPTER 9:
Industry Compliance
Magento Community Edition 2.1 offers a range of security and privacy capabilities that meet legal requirements and industry guidelines for online merchants. Some are mandated by the payment card industry, and others are required by law, depending on your location.
l
Legal Requirements l
Industry Guidelines l
Best Practices
In this chapter, you will learn about PCI compliance, and the importance of establishing procedures to protect payment information. You will also learn how to bring your store into compliance with the Cookie Law, which is a requirement in some countries, and considered a “best practice” in others. In addition, you will learn how to customize and maintain a privacy policy for your store.
Magento Community Edition 2.1 User Guide 119
PCI Compliance Guidelines CHAPTER 9: Industry Compliance
PCI Compliance Guidelines
The Payment Card Industry (PCI) has established a set of requirements for businesses that accept payment by credit card over the Internet. In addition to maintaining a secure server environment, merchants who handle customer credit card information must meet the following guidelines:
PCI Requirements
Install and maintain a firewall configuration to protect cardholder data.
Do not use vendor-supplied defaults for system passwords and other security parameters.
Protect stored cardholder data.
Encrypt transmission of cardholder data across open, public networks.
Use and regularly update antivirus software.
Develop and maintain secure systems and applications.
Restrict access to cardholder data by business need to know.
Assign a unique ID to each person with computer access.
Restrict physical access to cardholder data.
Track and monitor all access to network resources and cardholder data.
Regularly test security systems and processes.
Maintain a policy that addresses information security.
To learn more, see: Magento Approach to PCI Compliance .
As your business grows, you may be required to file a compliance report on an annual basis.
PCI reporting requirements increase in proportion to merchant level, but are waived for businesses that process fewer than 20,000 credit card transactions per year. To learn more, visit the PCI Security Standards Council website.
120 Magento Community Edition 2.1 User Guide
CHAPTER 9: Industry Compliance Privacy Policy
Privacy Policy
Your store includes a sample privacy policy that must be updated with your own information.
Your privacy policy should describe the type of information that your company collects, and how it is used. It should also list the filenames of
that are placed on the computers of people who visit your store. Any additional cookies that are associated with third-party extensions and add-ons should be included in the list.
Privacy Policy
To edit your privacy policy:
1.
On the Admin sidebar, tap Content. Then under Elements, choose Pages.
2.
In the grid, find Privacy Policy. Then in the Action column, set Select to Edit.
3.
Expand the Content section, and make the necessary changes to the content. To learn more, see:
.
Magento Community Edition 2.1 User Guide 121
Privacy Policy CHAPTER 9: Industry Compliance
Content
If you change the URL key of the privacy policy page, you must also create a
to redirect traffic to the new URL key. Otherwise, the link in the footer will return “404 Page Not
Found.”
4.
When complete, tap
Save Page
.
122 Magento Community Edition 2.1 User Guide
CHAPTER 9: Industry Compliance Cookie Law Compliance
Cookie Law Compliance
Cookies are small files that are saved to the computer of each visitor to your site, and used as temporary holding places for information. Information that is saved in cookies is used to personalize the shopping experience, link visitors to their shopping carts, measure traffic patterns, and improve the effectiveness of promotions. To keep pace with legislation in many countries regarding the use of cookies, Magento offers merchants a choice of methods for obtaining customer consent:
Method 1:
Implied Consent
Implied consent means that visitors to your store have a clear understanding that cookies are a necessary part of operations, and by using your site, have indirectly granted permission to use them. The key to gaining implied consent is to provide enough information for a visitor to make an informed decision. Many stores display a message at the top of all standard pages that provides a brief overview of how cookies are used, with a link to the store’s privacy policy.
The privacy policy should describe the type of information that your store collects, and how it is used.
Method 2:
Expressed Consent
Operating your store in
requires visitors to express their consent before any cookies can be saved to their computers. Unless consent is granted, many features of your store will be unavailable. For example, if Google Analytics is available for your store, it can be invoked only after the visitor has granted permission to use cookies.
Magento Community Edition 2.1 User Guide 123
Cookie Law Compliance CHAPTER 9: Industry Compliance
Cookie Restriction Mode
When Cookie Restriction Mode is enabled, visitors to your store are notified that cookies are required for full-featured operations. Depending on your theme, the message might appear above the header, below the footer, or somewhere else on the page. The message links to your privacy policy for more information, and encourages visitors to click the Allow button to grant consent. After consent is granted, the message disappears.
Your
should include the name of your store and contact information, and explain the purpose of each cookie that is used by your store. To learn more, see:
If you change the URL key of the privacy policy, you must also create a custom URL rewrite to redirect traffic to the new URL key. Otherwise, the link in the Cookie Restriction Mode message will return “404 Page Not Found.”
124
Cookie Restriction Notice In Footer
Step 1:
Enable Cookie Restriction Mode
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Web. Expand the Default Cookie Settings section, and do the following:
Magento Community Edition 2.1 User Guide
CHAPTER 9: Industry Compliance Cookie Law Compliance
Default Cookie Settings
a.
Enter the Cookie Lifetime in seconds.
b.
If you want to make cookies available to other folders, enter the Cookie Path. To make the cookies available anywhere in the site, enter a forward slash.
c.
To make the cookies available to a subdomain, enter the subdomain name in the Cookie
Domain
field. (subdomain.yourdomain.com) To make cookies available to all subdomains, enter the domain name preceded by a period. (.yourdomain.com)
d.
To prevent scripting languages such as JavaScript from gaining access to cookies, make sure that Use HTTP Only is set to “Yes.”
e.
Set Cookie Restriction Mode to “Yes.”
3.
When complete, tap
Save Config
.
4.
When prompted to update the cache, click the Cache Management link in the system message.
Then, refresh the invalid cache.
Step 2:
Update Your Privacy Policy
Update your
as needed to describe the information that your company collects, and how it is used.
Magento Community Edition 2.1 User Guide 125
Cookie Law Compliance CHAPTER 9: Industry Compliance
Cookie Reference
Magento Standard Cookies
COOKIE NAME
CART
COOKIE DESCRIPTION
The association with the customer's shopping cart.
CATEGORY_INFO
Stores the category info on the page to load pages faster.
COMPARE
The items in the customer's Compare Products list.
CUSTOMER
An encrypted version of the shopper's customer ID.
CUSTOMER_AUTH
CUSTOMER_INFO
Indicates if the customer are currently logged in to the store.
An encrypted version of the shopper's customer group.
EXTERNAL_NO_CACHE
Indicates if caching is disabled or enabled.
FRONTEND
The customer's session ID.
GUEST-VIEW
Determines if guests can edit their orders.
The last category visited by the shopper.
LAST_CATEGORY
LAST_PRODUCT
The most recent product viewed by the shopper.
NEWMESSAGE
Indicates whether a new message has been received.
NO_CACHE
PERSISTENT_SHOPPING_CART
RECENTLYCOMPARED
Indicates if the cache can be used to store information.
A link to information about the shopper's cart and viewing history.
Items recently compared b the shopper.
STF
STORE
Information on products the shopper has emailed to friends.
The store view or language chosen by the shopper.
USER_ALLOWED_SAVE_COOKIE
Indicates if the shopper allows cookies to be saved.
126 Magento Community Edition 2.1 User Guide
CHAPTER 9: Industry Compliance Cookie Law Compliance
Magento Standard Cookies (cont.)
COOKIE NAME
VIEWED_PRODUCT_IDS
COOKIE DESCRIPTION
The products recently viewed by the shopper.
WISHLIST
An encrypted list of products added to the shopper's wishlist.
WISHLIST_CNT
The number of items in the shopper's wishlist.
Google Analytics Cookies
COOKIE
_utma
DESCRIPTION
Identifies shoppers and sessions.
Determines new sessions/visits.
_utmb
_utmc
_utmz
Determines if the shopper is in a new session/visit.
Saves the traffic source or campaign that explains how the shopper reached your site.
Magento Community Edition 2.1 User Guide 127
128 Magento Community Edition 2.1 User Guide
PRODUCTS
129
130
Contents
Product Settings
Related Products, Up-sells, and Cross-sells
CHAPTER 10:
Products Menu
The Products Menu provides easy access to product creation, category and inventory management, as well as tools to manage catalog content.
Products Menu
To display the Products menu:
On the Admin sidebar, tap
Products
.
Magento Community Edition 2.1 User Guide 131
Menu Options
CHAPTER 10: Products Menu
Catalog
Create new products of every type, and manage your inventory.
Categories
Create the category structure that is the foundation of your store’s navigation.
132 Magento Community Edition 2.1 User Guide
CHAPTER 11:
Product Catalog
Magento uses the term "catalog" to refer to the products in the database. Access to the catalog data is determined by several factors, including the
setting, the catalog configuration, and the
that is assigned to the store. The catalog includes products that are enabled and available for sale, as well as those that are currently not offered for sale.
From the Admin, all products in the database are accessible through the
. If your Magento installation has multiple websites, each website can offer a different selection of products for sale from the same database.
In sales, the term "catalog" has a more narrow definition, and usually refers to a specific selection of products that is available for sale. For example, a store might have a "Spring
Catalog" and a "Fall Catalog".
Like the table of contents of a printed catalog, the main menu of your store — or "top navigation" — organizes products by category to make it easy for customers to find what they want. The main menu is based on a "root category," which is a container for the menu that is assigned to the store. Because the specific menu options are defined at the store view level, each view can have a different main menu based on the same root category.
Within each menu, you can offer a curated selection of products that is suitable for the store.
Magento Community Edition 2.1 User Guide
Product Catalog in Store Hierarchy
133
Catalog Workspace CHAPTER 11: Product Catalog
Catalog Workspace
The Catalog grid lists all products in the catalog. Use the standard
to sort and filter the list, find products, and apply
to selected products. From the grid, you can create new products and edit existing ones.
134
Catalog Grid
Workspace Controls
CONTROL
Add Product
Actions
Filters
DESCRIPTION
Initiates the process to create a new simple product. To choose a specific product type, click the down arrow. Options:
Lists all actions that can be applied to selected products in the list. To apply an action to a product or group of products, mark the checkbox in the first column of each product. Options:
Delete
Change Status
Update Attributes
Initiates a catalog search based on the current filters.
Magento Community Edition 2.1 User Guide
CHAPTER 11: Product Catalog Catalog Workspace
Workspace Controls (cont.)
CONTROL
[Default] View
DESCRIPTION
Indicates the current grid column layout. If there are saved grid column views, you can choose another.
Columns
Mass Actions
Submit
Lists all actions that can be applied to selected products in the list. To apply an action to a product or group of products, mark the checkbox in the first column of each product. Product list actions include:
Delete
Change Status
Update Attributes
Can be used to select multiple records as the target of action. The checkbox is marked in the first column of each selected record.
Options: Select All, Unselect All, Select Visible, and Unselect
Visible
Applies the current action to selected product records.
Edit Opens the product in edit mode. You can accomplish the same thing by clicking anywhere on the row.
Columns
COLUMN
Multiple Selection
DESCRIPTION
Selects multiple records to be subject to an action. The checkbox in the first column of each selected record is marked . Options:
Select All Selects all records found that match the current filter settings.
Select All on
This Page
Selects only the records found on the current page that match the filter settings.
ID
Thumbnail
Name
Type
Attribute Set
SKU
A unique, sequential number that is assigned when a new product is saved for the first time.
Displays a thumbnail of the main product image.
The product name.
The product type.
The name of the attribute set that is used as a template for the product.
The unique Stock Keeping Unit that is assigned to the product.
Magento Community Edition 2.1 User Guide 135
Catalog Workspace
Columns (cont.)
COLUMN
Price
Quantity
Visibility
Status
Websites
Action
CHAPTER 11: Product Catalog
DESCRIPTION
The unit price of the product.
The quantity that is currently in stock.
Indicates where the product is visible in the catalog. Options:
Not Visible Individually
Catalog
Search
Catalog, Search
Indicates the current status of the product. Options:
Enabled
Disabled
Indicates the website(s) where the product is available.
Opens the product in Edit mode.
136 Magento Community Edition 2.1 User Guide
CHAPTER 11: Product Catalog Catalog URLs
Catalog URLs
The URLs you assign to products and categories play a major role in determining how well your site is indexed by search engines. Before you start building your catalog is an ideal time to consider the available options.
URL Formats
Dynamic URL
A dynamic URL is created “on the fly,” and might include a query string with variables for the product ID, sort order, and the page where the request was made. When a customer searches for a product in your store, the resulting URL might look something like this: http://mystore.com/catalogsearch/result/?q=racer+back http://mystore.com/women/tops-women.html?style_general=135
Static URL
A static URL is a fixed address for a specific page. A static URL can be displayed in a searchengine friendly format, or one that references products and categories by ID. Search-engine friendly URLs include words that people might use to look for a product, and require Web
Server Rewrites to be enabled. Files with static URLs are commonly used for product and category pages, content pages, and
.
http://mystore.com/antonia-racer-tank.html
URL Components
URL Key
The URL key is the part of a static URL that describes the product or category. When you create a product or category, an initial URL key is automatically generated, based on the name. To change the URL key, see the
section of the product information.
The URL key should consist of lowercase characters with hyphens to separate words. A welldesigned, “search engine friendly” URL key might include the product name and key words to improve the way it is indexed by search engines. The URL key can be configured to create an automatic redirect if the URL key changes.
Magento Community Edition 2.1 User Guide 137
Catalog URLs CHAPTER 11: Product Catalog
HTML Suffix
Your catalog can be configured to either include or exclude the suffix as part of category and product URLs. There are various reasons why people might choose to use or to omit the suffix.
Some believe that the suffix no longer serves any useful purpose, and that pages without a suffix are indexed more effectively by search engines. However, your company might have a standardized format for URLs that requires a suffix.
Because the suffix is controlled by the system configuration, you should never type it directly into the URL key of a category or product. (Doing so will result in a double suffix at the end of the URL.) Whether you decide to use the suffix or not, be consistent and use the same setting for all your product and category pages. Here are examples of URLs with—and withou—a suffix.
http://mystore.com/helena-hooded-fleece.html
http://mystore.com/helena-hooded-fleece.htm
http://mystore.com/helena-hooded-fleece
Category Path
You can configure the URL to either include or exclude the category path. By default, the category path is included in all category and product pages. The following examples show the same product URL with, and without, the category path.
URL with Category Path
http://mystore.com/women/tops-women/hoodies-and-sweatshirts-women/helenahooded-fleece.html
URL without Category Path
http://mystore.com/helena-hooded-fleece.html
To prevent search engines from indexing multiple URLs that lead to the same content, you can exclude the category path from the URL. Another method is to use a canonical meta tag to let search engines know which URLs to index and which to ignore. By default, Magento does not include the category path in product URLs.
138 Magento Community Edition 2.1 User Guide
CHAPTER 11: Product Catalog Catalog URLs
To configure catalog URLs:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Search Engine Optimizations section, and do the following:
a.
Set Product URL Suffix to “html” or “htm.” Enter the suffix without a period, because it is applied automatically.
b.
Set Category URL Suffix to “html” or “htm.” Enter the suffix without a period, because it is applied automatically.
c.
Set Use Categories Path for Product URLs to your preference.
Search Engine Optimization
4.
When complete, tap
Save Config
.
5.
When prompted, click the Cache Management link in the system message, and refresh the invalid cache.
Refresh Cache
Magento Community Edition 2.1 User Guide 139
Catalog URLs CHAPTER 11: Product Catalog
Dynamic Media URLs
A dynamic media URL is a relative reference to an image or other media asset. When enabled, dynamic media URLs can be used to link directly to assets on your server, or to files stored on a
. The use of dynamic media URLs can impact catalog performance, and the
can be configured to use either static or dynamic media URLs for catalog product and category descriptions.
As with all
markup tags , the code is enclosed in double curly braces. The format of a dynamic
media URL looks like this:
{{media url="path/to/image.jpg"}}
To configure dynamic media URLs:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog. Then, expand section, and do the following: the Storefront
140
Storefront
Magento Community Edition 2.1 User Guide
CHAPTER 11: Product Catalog Catalog URLs
a.
Scroll down to Allow Dynamic Media URLs in Products and Categories. Then, clear the
Use system value
checkbox.
b.
Set Allow Dynamic Media URLs in Products and Categories to your preference.
3.
When complete, tap
Save Config
.
To use static URLs by default for media files:
By default, images inserted into the catalog from media storage have relative, dynamic URLs.
If you prefer to use a static URL, you can change the configuration setting.
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Content Management.
3.
Expand the WYSIWYG Options section.
WYSIWYG Options
4.
Set Use Static URLs for Media Content in WYSIWYG for Catalog to “Yes.”
5.
When complete,tap
Save Config
.
Magento Community Edition 2.1 User Guide 141
Using a Flat Catalog CHAPTER 11: Product Catalog
Using a Flat Catalog
Magento typically stores catalog data in multiple tables, based on the Entity-Attribute-Value
(EAV
1
) model. Because product attributes are stored in many tables, SQL queries are sometimes long and complex.
In contrast, a flat catalog creates new tables on the fly, where each row contains all the necessary data about a product or category. A flat catalog is updated automatically—either every minute, or according to your cron job. Flat catalog indexing can also speed up the processing of catalog and cart price rules. A catalog with as many as 500,000 SKUs can be indexed quickly as a flat catalog.
Before you enable a flat catalog for a live store, make sure to test the configuration in a development environment.
Process Overview:
Step 1:
Step 2:
Step 1:
Enable the Flat Catalog
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Storefront section. Then, do the following:
a.
Set Use Flat Catalog Category to “Yes.” If necessary, clear the Use system value checkbox.
b.
Set Use Flat Catalog Product to “Yes.”
142
Flat Catalog Configuration
4.
When complete, tap
Save Config
.
5.
When prompted to update the cache, click the Cache Management link in the system message, and follow the instructions to refresh the cache.
1Entity Attribute Value
Magento Community Edition 2.1 User Guide
CHAPTER 11: Product Catalog Using a Flat Catalog
Step 2:
Verify the Results
Method 1:
Verify the Results for a Single Product
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
a.
Open a product in edit mode.
b.
In the Name field, add the text “_TEST” to the end of the product name.
2.
Tap
Save
.
3.
On a new browser tab, navigate to the home page of your store. Then, do the following:
a.
Search for the product you edited.
b.
Use the navigation to browse to the product under its assigned category.
If necessary, refresh the page to see the results. The change will appear within the minute, or according to your
schedule.
Storefront with Flat Catalog
Method 2:
Verify the Results for a Category
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2.
In the upper-left corner, verify that Store View is set to "All Store Views."
If prompted, tap OK to confirm.
3.
In the category tree, select an existing category. Then, tap
Add Subcategory
, and do the following:
Magento Community Edition 2.1 User Guide 143
Using a Flat Catalog
a.
In the Category Name field, enter “Test Category.”
b.
When complete, tap
Save
.
CHAPTER 11: Product Catalog
c.
Expand products.
Test Subcategory
the Products in Category section. Then, click Reset Filter to display all
d.
Mark the checkbox of several products to add them to the new category. Then, tap
Save
.
144
Test Category Products
4.
On a new browser tab, navigate to the home page of your store. Then, use the store navigation to browse to the category you created.
Magento Community Edition 2.1 User Guide
CHAPTER 11: Product Catalog Using a Flat Catalog
If necessary, refresh the page to see the results. The change will appear within the minute or according to your cron schedule.
Step 3:
Remove the Test Data
Remove the test category:
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2.
In the category tree, select the test subcategory that you created.
3.
In the upper-right corner, tap
Delete
. Then when prompted to confirm, tap
OK
.
This will not remove the products that are assigned to the category.
Restore the original product name:
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
Open the test product in edit mode.
3.
Remove the "_TEST" that you added to the Product Name.
4.
In the upper-right corner, tap
Save
.
Restore the original catalog configuration:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Storefront section," and do the following:
a.
Set Use Flat Catalog Category to “No.”
b.
Set Use Flat Catalog Product to “No.”
4.
When complete, tap
Save Config
. Then when prompted, refresh the cache.
Magento Community Edition 2.1 User Guide 145
146 Magento Community Edition 2.1 User Guide
CHAPTER 12:
Creating Products
Choosing a product type is one of the first things you must do to create a new product. In this chapter, you will learn how to create a product of each type. In addition to the basic product types, the term, complex product
1 refers to a product that requires the customer to choose from a selection of options before making a purchase. To learn more about the available options, see Basic Settings and
.
If you are just starting out, you can create a few sample products to experiment with each product type. For a deeper understanding, make sure to read about catalog
how to set up
and attributes, and the catalog
that are available to you.
Product Catalog
1A product that requires the customer to choose from a selection of options.
Magento Community Edition 2.1 User Guide 147
Product Workspace CHAPTER 12: Creating Products
Product Workspace
The product workspace is basically the same for all product types, although the selection of fields changes depending on the attribute set that is used. The product attributes are at the top of the form, followed by expandable sections of product information. When a new product is saved for the first time, the Store View chooser appears in the upper-left of the form.
148
Product Workspace
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Product Workspace
Enable Product
The online status of the product is indicated by the switch at the top of the form. To change the online status, simply set the Enable Product switch to the “Yes” or “No” position.
CONTROL DESCRIPTION
Indicates that the product is currently online.
Indicates that the product is currently offline.
Attribute Set
The name of the
appears in the upper-left corner, and determines the fields that appear in the product record. To choose a different attribute set, click the down arrow next to the default attribute set name.
Attribute Sets
Expand/Collapse
To expand or collapse a section, tap either the expand or collapse button to the right.
Magento Community Edition 2.1 User Guide 149
Product Workspace CHAPTER 12: Creating Products
Save Menu
The Save menu includes several options that let you save and continue, save and create a new product, save and duplicate the product, or save and close.
COMMAND
Save
DESCRIPTION
Save Menu
Save the current product, and continue working.
Save & New Save and close the current product, and begin a new product, based on the same product type and template.
Save & Duplicate Save and close the current product, and open a new duplicate copy.
Save & Close Save the current product and return to the Inventory workspace.
150 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Product Workspace
Default Field Values
To save time when creating products, the default value of several product fields references values from another field. You can either accept the default value, or enter another. The following fields have automatically generated default values:
FIELD
SKU
DESCRIPTION
Based on product Name.
Meta Title
Meta Keywords
Meta Description
Based on product Name.
Based on product Name.
Based on product Name and Description.
The placeholders that represent the value of another field are enclosed in double-curly braces.
Any attribute code that is included in the product
can be used as a placeholder.
Product Fields Auto-Generation
Magento Community Edition 2.1 User Guide 151
Product Workspace CHAPTER 12: Creating Products
To edit the placeholder value:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Product Fields Auto-Generation section. Then, make any changes needed to the placeholder values.
For example, if there’s a specific keyword that you want to include for every product, or a phrase that you want to include in every meta description, you can type the value directly into the appropriate field.
If you want to keep the existing placeholder values, be careful to preserve the double curly braces that enclose each markup tag.
4.
When complete, tap
Save Config
.
Common Placeholders
PLACEHOLDER
{{color}}
{{country_of_manufacture}}
{{description}}
{{gender}}
{{material}}
{{name}}
{{short_description}}
{{size}}
{{sku}}
152 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products
Product Types
Product Types
Simple Product
A simple product is a physical item with a single SKU.
Simple products have a variety of pricing and of input controls which makes it possible to sell variations of the product. Simple products can be used in association with grouped, bundle, and configurable products.
Configurable Product
A configurable product appears to be a single product with lists of options for each variation. However, each option represents a separate, simple product with a distinct SKU, which makes it possible to track inventory for each variation.
Grouped Product
A grouped product presents multiple, standalone products as a group. You can offer variations of a single product, or group them for a promotion. The products can be purchased separately, or as a group.
Virtual Product
Virtual products are not tangible products, and are typically used for products such as services, memberships, warranties, and subscriptions. Virtual products can be used in association with grouped and bundle products.
Magento Community Edition 2.1 User Guide 153
Product Types CHAPTER 12: Creating Products
Bundle Product
A bundle product let customers “build their own” from an assortment of options. The bundle could be a gift basket, computer, or anything else that can be customized. Each item in the bundle is a separate, standalone product.
Downloadable Product
A digitally downloadable product that consists of one or more files that are downloaded. The files can reside on your server or be provided as URLs to any other server.
154 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Simple Product
Simple Product
One of the keys to harnessing the power of product types is learning when to use a simple, standalone product. A simple products can be sold individually, or as part of a grouped, configurable, or bundle product. A simple product with custom options is sometimes referred to as a composite product.
The following steps take you through the process of creating a simple product using the default product template with basic settings. When you finish the basics, you can complete the advanced settings as needed.
Simple Product
Process Overview:
Step 1:
Step 2:
Step 3:
Complete the Required Settings
Step 4:
Step 5:
Complete the Product Information
Step 6:
Magento Community Edition 2.1 User Guide 155
Simple Product CHAPTER 12: Creating Products
Step 1:
Choose the Product Type
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
In the upper-right corner on the Add Product menu, choose Simple Product.
156
Add Simple Product
Step 2:
Choose the Attribute Set
To choose the
that is used as a template for the product, do one of the following: l
In the Search box, enter the name of the attribute set.
l
In the list, choose the attribute set that you want to use.
The form is updated to reflect the change.
Choose Attribute Set
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Simple Product
Step 3:
Complete the Required Settings
1.
Enter the product Product Name.
2.
Accept the default SKU that is based on the product name, or enter another.
3.
Enter the product Price.
4.
Because the product is not yet ready to publish, set the Enable Product switch to the “No” position.
5.
Tap
Save
and continue.
When the product is saved, the
chooser appears in the upper-left corner.
6.
Choose the Store View where the product is to be available.
Choose Store View
Step 4:
Complete the Basic Settings
1.
Set Tax Class to one of the following: l
None l
Taxable Goods
2.
Enter the Quantity of the product that is currently in stock.
Take note that by default, Stock Status is set to “In Stock.”
3.
Enter the Weight of the product.
4.
Accept the default Visibility setting, “Catalog, Search.”
5.
To assign Categories to the product, tap the Select… box. Then, do either of the following:
Choose an existing category:
a.
Start typing in the box to find a match.
b.
Mark the checkbox of each category that is to be assigned.
Magento Community Edition 2.1 User Guide 157
Simple Product CHAPTER 12: Creating Products
Create a new category:
a.
Tap
New Category
.
b.
Enter the Category Name and choose the Parent Category to determine its position in the menu structure.
c.
Tap
Create Category
.
6.
To feature the product in the list of
, mark the Set Product as New checkbox.
7.
Choose the Country of Manufacture.
158
Product Details
There might be additional individual attributes that describe the product. The selection varies attribute set, and you can complete them later.
Step 5:
Complete the Product Information
Scroll down and complete the information in the following sections as needed: l
l
l
Related Products, Up-Sells, and Cross-Sells
l
l
l
l
l
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Simple Product
Step 6:
Publish the Product
1.
If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” position.
2.
Do one of the following:
Method 1: Save and Preview
1.
In the upper-right corner, tap
Save
.
2.
To view the product in your store, choose Customer View on the Admin menu. The store opens in a new browser tab.
Customer View
Method 2: Save and Close
On the Save menu, choose Save & Close.
Save & Close
THINGS TO REMEMBER
Simple products can be included in configurable, bundle, and grouped product types.
A simple product can have custom options with a variety of input controls, which makes it possible to sell many product variations from a single SKU.
Magento Community Edition 2.1 User Guide 159
Configurable Product CHAPTER 12: Creating Products
Configurable Product
A configurable product looks like a single product with drop-down lists of options for each variation. Each option is actually a separate simple product with a unique SKU, which makes it possible to track inventory for each product variation. You could achieve a similar effect by using a simple product with custom options, but without the ability to track inventory for each variation.
160
Configurable Product
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Configurable Product
Part 1: Creating a Configurable Product
Although a configurable product uses more SKUs, and may initially take a little longer to set up, it can save you time in the long run. If you plan to grow your business, the configurable product type is a good choice for products with multiple options.
Process Overview:
Part I: Create Configurable Product
Step 1:
Step 3:
Complete the Required Settings
Step 4:
Step 5:
Step 1:
Choose the Product Type
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
In the upper-right corner on the Add Product menu, choose Configurable Product.
Add Configurable Product
Magento Community Edition 2.1 User Guide 161
Configurable Product CHAPTER 12: Creating Products
Step 2:
Choose the Attribute Set
The
determines the selection of fields that are used in the product. The field at the top of the page is initially set to the “Default” attribute set. For a configurable product, the attribute set must include at least one
. In addition, the scope of each drop-down attribute must be set to " Global ." The attribute set used in this example has dropdown attributes for color and size.
To choose the attribute set that is used as a template for the product, click the field at the top of the page and do one of the following: l
In the Search box, enter the name of the attribute set.
l
In the list, choose the attribute set that you want to use.
The form is updated to reflect the change.
162
Choose Template
Step 3:
Complete the Required Settings
1.
Enter the product Product Name.
2.
Accept the default SKU that is based on the product name, or enter another.
3.
Enter the product Price.
4.
Because the product is not yet ready to publish, set the Enable Product switch to the “No” position.
5.
Tap
Save
and continue.
When the product is saved, the
chooser appears in the upper-left corner.
6.
Choose the Store View where the product is to be available.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Configurable Product
Choose Store View
Step 4:
Complete the Basic Settings
1.
Set Tax Class to one of the following: l
None l
Taxable Goods
2.
The Quantity is determined by the product variations, so you can leave it blank for now.
The Stock Status of a configurable product is determined by each associated configuration.
Because the product was saved without entering a quantity, the Stock Status is now set to “Out of Stock.”
a.
Enter the product Weight.
b.
Accept the default Visibility setting, “Catalog, Search.”
3.
To feature the product in the list of
new products , mark the Set Product as New checkbox.
4.
To assign Categories to the product, tap the Select… box. Then, do either of the following:
Choose an existing category:
a.
Start typing in the box to find a match.
b.
Mark the checkbox of the category that is to be assigned.
Create a new category:
a.
Tap
New Category
.
b.
Enter the Category Name and choose the Parent Category to determine its position in the menu structure.
c.
Tap
Create Category
.
5.
To feature the product in the list of
new products , mark the Set Product as New checkbox.
6.
Choose the Country of Manufacture.
Magento Community Edition 2.1 User Guide 163
Configurable Product CHAPTER 12: Creating Products
164
Product Details
There might be additional attributes that are used to describe the product. The selection varies attribute set, and you can complete them later.
Step 5:
Save and Continue
This is a good time to save your work. In the next step, you’ll set up the configurations for each variation of the product.
1.
In the upper-right corner, tap
Save
.
2.
Continue with
.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Configurable Product
Part 2: Adding Configurations
The following example shows how to add configurations for three colors and three sizes. In all, nine simple products will be created with unique SKUs to cover every possible combination of variations. The progress bar at the top of the page shows where you are in the process, and guides you through each step.
Progress Bar
Process Overview:
Part II: Add Configurations
Step 1:
Step 2:
Step 3:
Configure the Images, Price, and Quantity
Step 4: Generate the Product Configurations
Step 5:
Step 6:
Step 7:
(Optional)
Step 1:
Choose the Attributes
1.
Continuing from Part I, scroll down to the Configurations section. Then, tap
Create
Configurations
.
Configurations
2.
Mark the checkbox of each attribute that you want to include as a configuration. For this example, we choose color and size.
3.
The list includes all attributes from the attribute set that can be used in a configurable product.
Magento Community Edition 2.1 User Guide 165
Configurable Product CHAPTER 12: Creating Products
Select Attributes
4.
If you need to add a new attribute,
Create New Attribute
. Complete the attribute properties, and tap
Save Attribute
. Then, mark the checkbox to select the attribute.
5.
In the upper-right corner, tap
Next
.
Step 2:
Enter the Attribute Values
1.
For each attribute, mark the checkbox of the values that apply to the product.
166
2.
To rearrange the attributes, grab the Change Order icon and move the section to a new position. The order determines the position of the drop-down lists on the product page.
3.
In the progress bar,
Next
.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Configurable Product
Step 3:
Configure the Images, Price, and Quantity
This step determines the images, pricing and quantity of each configuration. The available options are the same for each, and you can choose only one. You can apply the same setting to all SKUs, apply a unique setting to each SKU, or skip the settings for now.
1.
Choose the configuration options that apply.
Configure the Images
Method 1: Apply a Single Set of Images to All SKUs
1.
Select Apply single set of images to all SKUs.
2.
Browse to each image that you want to include in the product gallery, or drag them to the box.
Use Same Images for All SKUs
Method 2: Apply Unique Images for Each SKU
Because we already uploaded an image for the parent product, we’ll use this option to upload an image of each color. This is the image that will appear in the shopping cart when someone buys the shirt in a specific color.
1.
Select Apply unique images by attribute to each SKU.
2.
Select the attribute that the images illustrate. For example: color.
3.
For each attribute value, either browse to the images that you want to use for that configuration, or drag them to the box.
If you drag the an image to a value box, it appears in the sections for the other values, as well.
If you want to delete an image, tap the trashcan icon.
Magento Community Edition 2.1 User Guide 167
Configurable Product CHAPTER 12: Creating Products
Unique Images per SKU
Configure the Prices
Method 1: Apply the Same Price to All SKUs
1.
If the price is the same for all variations of the product, select Apply single price to all
SKUs
.
2.
Enter the Price.
Same Price per SKU
Method 2: Apply a Different Price for Each SKU
1.
If the price differs for each or for some variations of the product, select Apply unique
prices by attribute to each SKU
.
2.
Select the attribute that is the basis of the price difference.
3.
Enter the price for each attribute value. In this example, the XL size costs more.
168 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Configurable Product
Unique Price per SKU
Configure the Quantity
Method 1: Apply the Same Quantity to All SKUs
1.
If the quantity is the same for all SKUs, select Apply single quantity to each SKU.
2.
Enter the Quantity.
Same Quantity for All SKUs
Method 2: Apply Different Quantity by Attribute
1.
If the quantity is the different for each SKU, select Apply unique quantity by attribute to
each SKU
.
2.
Enter the Quantity for each.
Magento Community Edition 2.1 User Guide
Different Quantities per Attribute
169
Configurable Product
2.
When complete, tap
Next
in the upper-right corner.
Step 4:
Generate the Product Configurations
1.
Wait a moment for the list of products to appear.
2.
Do one of the following: l
If you are satisfied with the configurations, tap Next.
l
To make corrections, tap Back.
CHAPTER 12: Creating Products
Summary
The current product variations appear at the bottom of the Configuration section.
170
Current Configurations
Step 5:
Add a Product Image
1.
Scroll down to the Images and Videos section. Then, expand the section.
2.
Click the Camera tile, and browse to the main image that you want to use for the configurable product.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Configurable Product
To learn more, see:
Step 6:
Complete the Product Information
Scroll down and complete the information in the following sections as needed: l
l
Related Products, Up-Sells, and Cross-Sells
l
l
l
l
l
Step 7:
Publish the Product
1.
If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” position.
2.
Do one of the following:
Method 1: Save and Preview
1.
In the upper-right corner, tap
Save
.
2.
To view the product in your store, choose Customer View on the Admin menu. The store opens in a new browser tab.
Customer View
Method 2: Save and Close
On the Save menu, choose Save & Close.
Save & Close
Magento Community Edition 2.1 User Guide 171
Configurable Product CHAPTER 12: Creating Products
Step 8:
Configure the Cart Thumbnails
(Optional)
If you have a different image for each variation you can set the configuration to use the correct image for the shopping cart thumbnail.
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout. Then, expand section.
the Shopping Cart
3.
Set Configurable Product Image to “Product Thumbnail Itself.”
4.
When complete, tap
Save Config
.
Shopping Cart - Configurable Product Image
THINGS TO REMEMBER
A configurable product allows the shopper to choose options from drop-down lists. Each option is actually a separate, simple product.
Each drop-down list values is based on an attribute of the “Dropdown” input type. The dropdown attributes must be included in the attribute set, which is then used as a template for the configurable product.
The thumbnail image in the shopping cart can be set to display the image from the configurable product record, or from the product variation.
172 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Grouped Product
Grouped Product
A grouped product is made up of simple standalone products that are presented as a group.
You can offer variations of a single product, or group them by season or theme to create a set of different products. Each product can be purchased separately, or as part of the group. In the shopping cart, each item is listed separately.
Grouped Product
Process Overview:
Step 1:
Step 2:
Step 3:
Complete the Required Settings
Step 4:
Step 5:
Step 6:
Step 7:
(Optional)
Magento Community Edition 2.1 User Guide 173
Grouped Product CHAPTER 12: Creating Products
Step 1:
Choose the Product Type
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
In the upper-right corner on the Add Product menu, choose Simple Product.
174
Add Simple Product
Step 2:
Choose the Attribute Set
To choose the
that is used as a template for the product, do one of the following: l
In the Search box, enter the name of the attribute set.
l
In the list, choose the attribute set that you want to use.
The form is updated to reflect the change.
Choose Template
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Grouped Product
Step 3:
Complete the Required Settings
1.
Enter the product Product Name.
2.
Accept the default SKU that is based on the product name, or enter another.
Take note that the Quantity field is not available because the value is derived from the individual products that make up the group.
3.
Because the product is not yet ready to publish, set the Enable Product switch to the “No” position.
4.
Tap
Save
and continue.
When the product is saved, the
chooser appears in the upper-left corner.
5.
Choose the Store View where the product is to be available.
Choose Store View
Step 4:
Complete the Basic Settings
1.
Accept the Stock Status setting, “In Stock.”
2.
To assign Categories to the product, tap the Select… box. Then, do either of the following:
Choose an existing category:
a.
Start typing in the box to find a match.
b.
Mark the checkbox of the category that is to be assigned.
Create a new category:
a.
Tap
New Category
.
b.
Enter the Category Name and choose the Parent Category to determine its position in the menu structure.
c.
Tap
Create Category
.
Magento Community Edition 2.1 User Guide 175
Grouped Product CHAPTER 12: Creating Products
3.
Accept the Visibility settings, “Catalog, Search.”
4.
To feature the product in the list of
, choose the Set Product as New From and
To
dates on the calendar.
5.
Choose the Country of Manufacture.
There might be additional individual attributes that describe the product. The selection varies attribute set, and you can complete them later.
176
Grouped Product Details
Step 5:
Add Products to the Group
1.
Scroll down to the Grouped Products section. Then, tap
Add Products to Group
.
Grouped Products
2.
If necessary, use the
to find the products that you want to include in the group.
3.
In the list, mark the checkbox of each item that you want to include in the group.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Grouped Product
Add Selected Products
4.
Tap
Add Selected Products
to add them to the group.
The selected products appear in the Grouped Products section.
Products in Group
5.
Then, do any of the following: l
Enter a Default Quantity for any of the items.
l
To change the order of the products, grab the Change Order icon in the first column, and drag the product to the new position in the list.
l
To remove a product from the group, click Remove.
Step 5:
Complete the Product Information
Complete the information in the following sections as needed: l
l
l
Magento Community Edition 2.1 User Guide 177
Grouped Product CHAPTER 12: Creating Products l
Related Products, Up-Sells, and Cross-Sells
l
l
l
l
Step 6:
Publish the Product
1.
If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” position.
2.
Do one of the following:
Method 1: Save and Preview
1.
In the upper-right corner, tap
Save
.
2.
To view the product in your store, choose Customer View on the Admin menu. The store opens in a new browser tab.
Customer View
Method 2: Save and Close
On the Save menu, choose Save & Close.
178
Save & Close
Step 7:
Configure the Cart Thumbnails
(Optional)
If you have a different image for each product in the group, you can set the configuration to use the correct image for the shopping cart thumbnail.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Shopping Cart section. Then, do the following:
a.
If necessary, clear the Use system value checkbox.
b.
Set Grouped Product Image to “Product Thumbnail Itself.”
4.
Tap
Save Config
.
Grouped Product
Shopping Cart
THINGS TO REMEMBER
A grouped product is essentially a collection of simple associated products.
Simple and virtual products that are part of a grouped product cannot have custom options.
Each item purchased appears individually in the shopping cart, rather than as part of the group.
The thumbnail image in the shopping cart can be set to display the image from the grouped parent product, or associated product.
Magento Community Edition 2.1 User Guide 179
Virtual Product CHAPTER 12: Creating Products
Virtual Product
Virtual products are used to represent non-tangible items such as memberships, services, warranties, or subscriptions. Virtual products can be sold individually, or included as part of the following product types: l
l
Aside from the absence of the Weight field, the process of creating a virtual product and a simple product is the same.
180
Virtual Product
Process Overview:
Step 1:
Step 2:
Step 3:
Complete the Required Settings
Step 4:
Step 5:
Complete the Product Information
Step 6:
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products
Step 1:
Choose the Product Type
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
In the upper-right corner on the Add Product menu, choose Virtual Product.
Virtual Product
Add Virtual Product
Step 2:
Choose the Attribute Set
To choose the
that is used as a template for the product, do one of the following: l
In the Search box, enter the name of the attribute set.
l
In the list, choose the attribute set that you want to use.
The form is updated to reflect the change.
Choose Attribute Set
Magento Community Edition 2.1 User Guide 181
Virtual Product CHAPTER 12: Creating Products
Step 3:
Complete the Required Settings
1.
Enter the product Product Name.
2.
Accept the default SKU that is based on the product name, or enter another.
3.
Enter the product Price.
4.
Because the product is not yet ready to publish, set the Enable Product switch to the “No” position.
5.
Tap
Save
and continue.
When the product is saved, the
chooser appears in the upper-left corner.
6.
Choose the Store View where the product is to be available.
182
Choose Store View
Step 4:
Complete the Basic Settings
1.
Set Tax Class to one of the following: l
None l
Taxable Goods
2.
Enter the Quantity of the product that is currently in stock. Then, do the following:
a.
Accept the default Stock Status setting, “In Stock.”
Note that the Weight field is not used, because a virtual product is not shipped.
b.
Accept the default Visibility setting, “Catalog, Search.”
3.
To assign Categories to the product, tap the Select… box. Then, do either of the following:
Choose an existing category:
a.
Start typing in the box to find a match.
b.
Mark the checkbox of the category that is to be assigned.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Virtual Product
Create a new category:
a.
Tap
New Category
.
b.
Enter the Category Name and choose the Parent Category to determine its position in the menu structure.
c.
Tap
Create Category
.
There might be additional individual attributes that describe the product. The selection varies attribute set, and you can complete them later.
Step 5:
Complete the Product Information
Complete the information in the following sections as needed: l
l
l
l
Related Products, Up-Sells, and Cross-Sells
l
l
l
l
Step 6:
Publish the Product
1.
If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” position.
2.
Do one of the following:
Method 1: Save and Preview
1.
In the upper-right corner, tap
Save
.
2.
To view the product in your store, choose Customer View on the Admin menu. The store opens in a new browser tab.
Customer View
Magento Community Edition 2.1 User Guide 183
Virtual Product
Method 2: Save and Close
On the Save menu, choose Save & Close.
CHAPTER 12: Creating Products
Save & Close
THINGS TO REMEMBER
Virtual products are used for non-tangible products such as services, subscriptions, and warranties.
Virtual products are much like simple products, but without weight.
Shipping Options do not appear during checkout unless there is a tangible product in the cart.
184 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Bundle Product
Bundle Product
A bundle is a “build your own,” customizable product. Each item in a bundle can be based on one of the following product types: l
l
Bundle Product
Magento Community Edition 2.1 User Guide 185
Bundle Product CHAPTER 12: Creating Products
Customizing the Bundle
The selection of options appears when the customer taps either the Customize and Add to Cart button. Because the products that are included in the bundle vary, the SKU, Price, and Weight can be set to either a dynamic or fixed value.
Minimum Advertised Price (MAP) is not available for Bundle products with dynamic pricing.
186
Customize Bundle
The following instructions walk you through the process of creating a bundle product with the basic settings. Each required field is marked with a red asterisk (*). After you complete the required settings and save the product, you can complete the remaining information as needed.
Process Overview:
Step 1:
Step 2:
Step 3:
Complete the Required Settings
Step 4:
Step 5:
Step 6: Complete the Product Information
Step 7:
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products
Step 1:
Choose the Product Type
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
In the upper-right corner on the Add Product menu, choose Bundle Product.
Bundle Product
Add Bundle Product
Step 2:
Choose the Attribute Set
To choose the
that is used as a template for the product, do one of the following: l
In the Search box, enter the name of the attribute set, l
In the list, choose the attribute set that you want to use.
The form is updated to reflect the change.
Choose Template
Magento Community Edition 2.1 User Guide 187
Bundle Product CHAPTER 12: Creating Products
Step 3:
Complete the Required Settings
1.
Enter the product Product Name.
2.
You can either accept the default SKU that is based on the product name, or enter a different value. To determine the type of SKU that is assigned to each bundle item, do the following: l
A Dynamic SKU can be assigned automatically to each bundle item by adding a suffix to the default SKU. By default, Dynamic SKU is set to “Yes.” l
If you prefer to assign a unique SKU for each bundle item, set Dynamic SKU to the “No” position.
Dynamic SKU and Price
3.
To determine the price of the bundle, do one of the following: l
A Dynamic Price changes to reflect the options chosen by the customer. By default,
Dynamic Price is set to “Yes,” and the Price field is left blank.
l
To charge a fixed price for the bundle, set Dynamic Price to the “No.” enter the Price that you want to charge for the bundle.
position. Then,
4.
Because the product is not yet ready to publish, set the Enable Product switch to the “No” position.
5.
Tap
Save
and continue.
When the product is saved, the
chooser appears in the upper-left corner.
6.
Choose the Store View where the product is to be available.
188
Choose Store View
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Bundle Product
Step 4:
Complete the Basic Settings
1.
If the bundle has Fixed Pricing, set Tax Class to one of the following: l
None l
Taxable Goods
If the bundle has Dynamic Pricing, the tax is determined for each bundle item.
2.
Take note of the following: l
The Quantity is not available because the value is determined for each bundle item.
l
The Stock Status is set by default to “In Stock.”
3.
To determine the weight of the bundle, do one of the following: l
A Dynamic Weight changes to reflect the options chosen by the customer. By default,
Dynamic Weight is set to “Yes,” and the Weight field is left blank.
l
To assign a fixed weight to the bundle, set Dynamic Weight to the “No.”
Then, enter the Weight of the bundle.
position.
Dynamic Weight
4.
To feature the product in the list of
new products , mark the Set Product as New checkbox.
5.
Accept the default Visibility setting, “Catalog, Search.”
6.
To assign Categories to the product, tap the Select… box. Then, do either of the following:
Choose an existing category:
a.
Start typing in the box to find a match.
b.
Mark the checkbox of each category that is to be assigned.
Create a new category:
a.
Tap
New Category
.
b.
Enter the Category Name and choose the Parent Category to determine its position in the menu structure.
c.
Tap
Create Category
.
7.
Choose the Country of Manufacture.
Magento Community Edition 2.1 User Guide 189
Bundle Product CHAPTER 12: Creating Products
190
Bundle Details
There might be additional attributes that describe the product. The selection varies attribute set, and you can complete them later.
Step 5:
Add the Bundle Items
1.
Scroll down to the Bundle Items section. Then, set Ship Bundle Items to one of the following: l
Separately l
Together
2.
Tap
Add Option
, Then, do the following:
Bundle Items
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Bundle Product
Add Bundle Options
a.
Enter an Option Title to be used field label.
b.
Set Input Type to one of the following: l
Drop-down l
Radio buttons l
Checkbox (See Note .) l
Multiple Select (See Note .)
c.
To make the field a required entry, mark the Required checkbox.
d.
Tap
Add Products to Option
. Then, mark the checkbox of each product that you want to include in this option. If there are many products, use the
and
to find the products you need.
e.
Tap
Add Selected Products
.
Add Selected Products
f.
After the items appear in the Options section choose one to be the Default selection.
g.
In the Default Quantity column, enter the quantity of each item that is to be added to the bundle when a customer chooses the item.
h.
To allow customers to change the quantity of a bundle item, select the User Defined option.
Magento Community Edition 2.1 User Guide 191
Bundle Product CHAPTER 12: Creating Products
The quantity can be a preset or user-defined value. However, do not assign the User Defined property to checkbox or multiple-select input types.
By default, the Default Quantity that is included in a bundle item cannot be changed by the customer. However, the customer can enter the quantity of the item that is to be included in the bundle.
For example, if the Default Quantity of the Sprite Status Ball is set to 2, and the customer orders 4 of that bundle option, the total number of total balls purchased is 8.
192
Item Detail
3.
Repeat these steps for each item you want to add to the bundle.
4.
To remove any item from the bundle, tap the Delete icon.
5.
When complete, tap
Save
.
Step 6:
Complete the Product Information
Scroll down and complete the information in the following sections as needed: l
l
l
l
Related Products, Up-Sells, and Cross-Sells
l
l
l
l
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Bundle Product
Step 7:
Publish the Product
1.
If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” position.
2.
Do one of the following:
Method 1: Save and Preview
1.
In the upper-right corner, tap
Save
.
2.
To view the product in your store, choose Customer View on the Admin menu. The store opens in a new browser tab.
Customer View
Method 2: Save and Close
On the Save menu, choose Save & Close.
Save & Close
Magento Community Edition 2.1 User Guide 193
Bundle Product CHAPTER 12: Creating Products
Input Controls
CONTROL
Drop-down
DESCRIPTION
Displays a drop-down list of options with the product name and price.
Only one item can be selected.
Radio Buttons Displays a radio button for each option, followed by the product name and price. Only one item can be selected.
Checkbox Displays a checkbox for each option, followed by the product name and price. Multiple items can be selected.
Multiple Select Displays a list of options with the product name and price. To select multiple items, hold down the Ctrl (or Option) key, and click each item.
194 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Bundle Product
Field Descriptions
FIELD
SKU
DESCRIPTION
Determines if each item is assigned a variable, dynamic SKU, or if a fixed SKU is used for the bundle. Options include: Fixed / Dynamic.
Weight
Price View
Ship Bundle Items
Specifies the weight is calculated based on the items selected, or is a fixed weight for the entire bundle. Options include:
Fixed / Dynamic.
Determines if the product price is shown as a range, from the least expensive to the most expensive (Price Range), or with the least expensive shown (As Low As). Options include: Price Range / As
Low As.
Specifies if individual items can be shipped separately.
THINGS TO REMEMBER
Customers can “build their own” bundle product.
Bundle items can be simple or virtual products without custom options.
The Price View can be set to a price range or to “As Low As.”
SKU and Weight can be either “Fixed” or “Dynamic.”
The quantity can be a preset or user-defined value. However, do not assign the User
Defined property to checkbox or multiple-select input types.
Bundle items can be shipped together or separately.
Magento Community Edition 2.1 User Guide 195
Downloadable Product CHAPTER 12: Creating Products
Downloadable Product
A downloadable product can be anything that you can deliver as a file, such as an eBook, music, video, software application, or update. You can offer an album for sale, and sell each song individually. You can also use a downloadable product to deliver an electronic version of your product catalog.
Because the actual download doesn’t become available until after the purchase, you can provide samples, such as an excerpt from a book, a clip from an audio file, or a trailer from a video that the customer can try before purchasing the product. The files that you make available for download can be either uploaded to your server, or from a different server.
196
Downloadable Product
Downloadable products can be configured to require that the customer log in to an account to receive the link, or can be sent by email and shared with others. The status of the order before the download becomes available, default values, and other delivery options are set in the configuration. To learn more, see:
Configuring Download Options .
The following instructions take you through the process of creating a downloadable product with the basic fields. Each required field is marked in the Admin with a red asterisk (*). After you complete the required settings and save the product, you can add images and complete the remaining product information as needed.
Downloadable file names can include letters and numbers. Either a dash or underscore character can be used to represent a space between words. Any invalid characters in the file name are replaced with an underscore.
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Downloadable Product
Process Overview:
Step 1:
Step 2:
Step 3:
Complete the Required Settings
Step 4:
Step 5:
Complete the Downloadable Information
Step 6:
Complete the Product Information
Step 7:
Step 1:
Choose the Product Type
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
In the upper-right corner on the Add Product menu, choose Downloadable Product.
Add Downloadable Product
Step 2:
Choose the Attribute Set
The sample data includes an
called “Downloadable” that has special fields for downloadable products. You can use an existing template, or create another before the product is saved.
To choose the attribute set that is used as a template for the product, do one of the following: l
In the Search box, enter the name of the attribute set.
l
In the list, choose the “Downloadable” attribute set.
The form is updated to reflect the change.
Magento Community Edition 2.1 User Guide 197
Downloadable Product CHAPTER 12: Creating Products
198
Choose Attribute Set
Step 3:
Complete the Required Settings
1.
Enter the product Product Name.
2.
Accept the default SKU that is based on the product name, or enter another.
3.
Enter the product Price.
4.
Because the product is not yet ready to publish, set the Enable Product switch to the “No” position.
5.
Tap
Save
and continue.
When the product is saved, the
chooser appears in the upper-left corner.
6.
Choose the Store View where the product is to be available.
Choose Store View
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Downloadable Product
Step 4:
Complete the Basic Settings
1.
Set Tax Class to one of the following: l
None l
Taxable Goods
2.
Enter the Quantity of the product that is currently in stock.
Take note of the following: l
By default, Stock Status is set to “Out of Stock.” l
The Weight field is not used, because downloadble products are not shipped.
3.
Accept the default Visibility setting, “Catalog, Search.”
4.
To feature the product in the list of
new products , mark the Set Product as New checkbox.
5.
To assign Categories to the product, tap the Select… box. Then, do either of the following:
Choose an existing category:
a.
Start typing in the box to find a match.
b.
Mark the checkbox of each category that is to be assigned.
Create a new category:
a.
Tap
New Category
.
b.
Enter the Category Name and choose the Parent Category to determine its position in the menu structure.
c.
Tap
Create Category
.
6.
Set Format to one of the following: l
Download l
DVD
If necessary, you can edit the
to add more values.
Magento Community Edition 2.1 User Guide 199
Downloadable Product CHAPTER 12: Creating Products
200
Product Details
There might be additional attributes that describe the product. The selection varies attribute set, and you can complete them later.
Step 5:
Complete the Downloadable Information
1.
Scroll down to Downloadable Information, and expand
downloadable product?
checkbox.
the section. Then, mark the Is this
The Downloadable Information section has two parts. The first part describes each download link, and the second part describes each sample file. The default value for many of these options can be set in the
Downloadable Information
Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Downloadable Product
Part 1:
Complete the Links
1.
In the Links section, enter the Title that you want to use as a heading for the download links.
2.
If applicable, mark the Links can be purchased separately checkbox.
3.
Tap
Add Link
. Then, do the following:
a.
Enter the Title and Price of the download.
b.
For both File and Sample files, choose one of the following methods of distribution for the downloads:
Upload File
URL
To upload the the distribution file to the server, choose
“Upload File.” Then, browse to the file, and select it for upload.
To access the distribution file from a URL, choose “URL”
Then, enter the full URL to the download file.
c.
Set Shareable to one of the following:
No
Yes
Use Config
Requires customers to log in to their accounts to access the download link.
Sends the link by email, which customers can share with others.
Uses the method that is specified in the Dowloadable Product
Options configuration.
d.
Do one of the following: l
To limit downloads per customer, enter the number of Max. Downloads.
l
To allow unlimited downloads, mark the Unlimited checkbox.
Link Detail
4.
To add another link, tap
Add Link
. Then, repeat these steps.
Magento Community Edition 2.1 User Guide 201
Downloadable Product CHAPTER 12: Creating Products
Part 2:
Complete the Samples
1.
In the Samples section, enter the Title that you want to use as a heading for the samples.
2.
To complete the information for each sample, tap
Add Link
.
Samples
3.
Complete the link detail as follows:
a.
Enter the Title of the individual sample.
b.
Choose one of the following distribution methods:
Upload File
URL
To upload the the sample distribution file to the server, choose
“Upload File.” Then, browse to the file, and select it for upload.
To access the sample distribution file from a URL, choose
“URL” Then, enter the full URL to the download file.
c.
To add another sample, tap
Add Link
, and repeat these steps.
d.
To change the order of the samples, grab the Change Order icon, and drag the sample to a new position.
202 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Downloadable Product
Step 6:
Complete the Product Information
Scroll down and complete the information in the following sections as needed: l
l
l
l
Related Products, Up-Sells, and Cross-Sells
l
l
l
l
Step 7:
Publish the Product
1.
If you are ready to publish the product in the catalog, set the Enable Product switch to the
“Yes” position.
2.
Do one of the following:
Method 1: Save and Preview
1.
In the upper-right corner, tap
Save
.
2.
To view the product in your store, choose Customer View on the Admin menu. The store opens in a new browser tab.
Customer View
Method 2: Save and Close
On the Save menu, choose Save & Close.
Magento Community Edition 2.1 User Guide 203
Downloadable Product CHAPTER 12: Creating Products
Save & Close
THINGS TO REMEMBER
Downloadable products can be uploaded to the server, or linked to from another server on the Internet.
You can determine the number of times a customer can download a product.
Customers who purchase a downloadable product can be required to log in before going through checkout.
The delivery of a downloadable product can be made when the order is in either a “Pending” or “Invoiced” state.
204 Magento Community Edition 2.1 User Guide
CHAPTER 12: Creating Products Downloadable Product
Configuring Download Options
The downloadable configuration settings determine the default values and delivery options for downloadable products, and specify if guests can purchase downloads.
To configure download options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Downloadable Product Options section, and do the following:
Downloadable Product Options
a.
To determine the stage in the order workflow when the download becomes available, set
Order Item Status to Enable Downloads
to one of the following: l
Pending l
Invoiced
b.
To set a default limit on the number of downloads that a single customer can make, enter the number in the Default Maximum Number of Downloads field.
c.
Set Shareable to one of the following:
Yes
No
Allows customers to email the download link to others.
Prevents customers from sharing the download link with others by requiring customers to log in to their accounts to access download links.
d.
In the Default Sample Title field, enter the heading that you want to appear above the selection of samples.
Magento Community Edition 2.1 User Guide 205
Downloadable Product CHAPTER 12: Creating Products
Sample Title
e.
In the Default Link Title field, enter the default text that you want to use for download links.
f.
If you want the download link to open in a new browser window, set Opens Links in New
Window
to “Yes.” This setting is used to keep the browser window to your store open.
g.
To determine how downloadable content is delivered, set Use Content Disposition to one of the following:
Attachment
Inline
Delivers the download link by email as an attachment.
Delivers the download link as a link on a web page.
h.
If you want to require that purchasers register for a customer account and log in before purchasing a download, set Disable Guest Checkout if Cart Contains Downloadable
Item
s to “Yes.”
4.
When complete, tap
Save Config
.
206 Magento Community Edition 2.1 User Guide
CHAPTER 13:
Product Settings
The most frequently used product settings and attributes are located at the top of the page, followed by custom attributes. Any other product settings are in expandable sections at the bottom of the page.
Product Settings
Magento Community Edition 2.1 User Guide 207
Advanced Product Settings CHAPTER 13: Product Settings
Advanced Product Settings
To access the advanced pricing and inventory settings, click the link below the Price and
Quantity fields. To learn more, see: l
l
Advanced Links
208 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Other Product Settings
The remaining product settings are located at the bottom of the page. Some settings are available for all products, and others are available for specific product types. A few additional settings might appear when the product is saved for the first time.
To expand or collapse each section:
Tap the section. The button indicates if it is currently expanded or collapsed .
Other Settings
General Settings
SECTION
DESCRIPTION
The Content section is used to enter the main product description that appears on the product page. The short description can be used in most RSS feeds, and might also appear in catalog listings, depending on theme. The product description can be formatted using the
toolbar.
The Product Reviews section lists all reviews that customers have submitted about the product. The section appears only after a new product has been saved.
From the Images and Videos section, you can perform basic image management tasks such as upload multiple images, rearrange the order of images, and control how each image is used. For more control over individual images, you can open each image in “detail view.”
Magento Community Edition 2.1 User Guide 209
Other Product Settings CHAPTER 13: Product Settings
SECTION
DESCRIPTION
The Search Engine Optimization section specifies the
and
fields that are used by search engines to index the product.
Although some search engines ignore meta keywords, others continue to use them. The current best practice is to incorporate highvalue keywords in both the meta title and meta description.
This section is used to set up simple promotional blocks that present a selection of additional products that might be of interest to the customer.
The Product in Websites section shows the current scope of the product within the store hierarchy.
The Design settings give you the ability to apply a different theme to the product page, change the column layout, determine where product options appear, and enter custom XML code
Gives you the ability to apply a different theme to the product page, change the column layout, determine where product options appear, and enter custom XML code
Gift Options can be set at the product level to allow a gift message to be added to the product during checkout.
Product-Specific Settings
SECTION
DESCRIPTION
The Configuration section lists any existing variations of the product, and can also be used to generate variations for use with the
Configurable product type.
The Downloadable Information section is used to generate the links to downloadable products and samples.
Customizable options are based on variations of a single SKU, and can be a good solution if your inventory needs are simple.
The Grouped Products section is used to add items to a Grouped product type, and also to edit the current selection of items.
The Bundle Items section is used to add items to a Bundle product type, and also to edit the current selection of items.
210 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Content
The Content section is used to enter and edit the main product description that appears on the product page. The short description can be used in most RSS feeds, and might also appear in catalog listings, depending on theme. The product description can be formatted using the
toolbar.
Enter only plain ASCII characters into the text box. If pasting text from a word processor, save it first as a plain .TXT file to remove any invisible control characters.
Content
To enter the product description:
1.
Open the product in edit mode. Then, scroll down and expand the Content section.
2.
Enter the main product Description, and use the
to format as needed.
You can drag the lower-right corner to change the height of the text box.
3.
Enter a Short Description of the product, and format as needed.
To learn more, see:
.
Magento Community Edition 2.1 User Guide 211
Other Product Settings CHAPTER 13: Product Settings
Configurations
The Configurations section lists any existing variations of the product, and can also be used to generate variations for use with the Configurable product type. To learn more, see:
Configurations Section
Product Configurations
212 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Product Reviews
The Product Reviews section lists all reviews that customers have submitted about the product.
The section appears with the other product information only after a new product has been saved for the first time. To learn more, see:
.
Product Reviews
Magento Community Edition 2.1 User Guide 213
Other Product Settings CHAPTER 13: Product Settings
Images and Video
From the Images and Video section, you can perform basic image management tasks such as upload multiple images, rearrange the order of images, and control how each image is used.
For additional control over individual images you can open each image in “detail view.” To learn more, see:
To upload an image:
1.
Open the product in edit mode.
2.
Scroll down and expand the Images and Videos section.
Images and Videos
3.
If you're ready to add a product image, do one of the following: l
Drag an image from your desktop, and drop it on the camera tile.
l
Tap the camera tile, and navigate to the image file on your computer. Then, choose the image, and tap
Open
.
A
image appears in the catalog until a product image is available.
214 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Search Engine Optimization
The Search Engine Optimization section specifies the
and
fields that are used by search engines to index the product. Although some search engines ignore meta keywords, others continue to use them. The current
is to incorporate highvalue keywords in both the meta title and meta description.
The default value for each meta data field can be auto-generated based on values specified in the configuration. Each field contains a placeholder that is replaced by an actual value. To learn more, see: Default Field Values .
Search Engine Optimization
To complete the SEO fields:
1.
Open the product in edit mode. Then, scroll down and expand
Optimization
section.
the Search Engine
2.
The default URL Key is based on the product name. You can use the default, or change it as needed. To learn more, see:
3.
The Meta Title is the text that appears at the top of the browser window. You can use the default, which is based on the Product Name, or change it as needed.
4.
The Meta Keywords are used by some search engines more than others. Enter a few high-value key words to help the product gain more visibility.
5.
The Meta Description is the text that appears in search results listings. For best results, enter a description that is between 150-160 characters in length.
Magento Community Edition 2.1 User Guide 215
Other Product Settings
Field Descriptions
FIELD
URL Key
Meta Title
Meta Keywords
Meta Description
CHAPTER 13: Product Settings
DESCRIPTION
Store View Determines the online address of the product.The
URL key is added to the base URL of the store, and appears in the address bar of a browser. Magento initially creates a default, “search engine friendly”
URL, that is based on the product name.
The URL Key should be all lowercase characters, with hyphens instead of spaces. Do not include a suffix such as .html in the URL Key, because it is managed in the configuration.
Store View The title appears in the title bar and tab of your browser, and is also used as the title on a search engine results page (SERP
1
). The meta title should be unique to the page, and less than 70 characters in length.
Auto-generated value: {{name}}
Store View Relevant keywords for the product. Consider using keywords that customers might use to find the product.
Auto-generated value: {{name}}
Store View The meta description provides a brief overview of the page for search results listings. An ideal length is between 150-160 characters in length, with a maximum of 255 characters. Although not visible to the customer, some search engines include the meta description on the search results page.
Auto-generated value: {{name}} {{description}}
216
1Search Engine Results Page
Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Related Products, Up-Sells, and Cross-Sells
This section is used to set up simple promotional blocks that present a selection of additional products that might be of interest to the customer. To learn more, see:
.
Related Products, Up-Sells, and Cross-Sells
Related Products
Related products are meant to be purchased in addition to the item the customer is viewing.
The customer can place the item in the shopping cart by simply clicking the checkbox. The placement of the Related Products block varies according to theme and page layout. In the example below, it appears at the bottom of the Product View page. With a 2 column layout, the
Related Product block often appears in the right sidebar.
Related Products
Magento Community Edition 2.1 User Guide 217
Other Product Settings CHAPTER 13: Product Settings
To set up related products:
1.
Open the product in edit mode.
2.
Scroll down and expand tap
Add Related Products
.
the Related Products, Up-Sells, and Cross-Sells section. Then,
Related Products
3.
Use the
to find the products that you want.
4.
In the list, mark the checkbox of any product you want to feature as a related product.
218
Related Products
5.
When complete, tap
Add Selected Products
.
Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Up-sells
Up-sell products are items that your customer might prefer instead of the product currently considered. An item offered as an up-sell might be of a higher quality, more popular, or have better profit margin. Up-sell products appear on the product page under a heading such as,
“You may also be interested in the following product(s).”
Upsell
To select up-sell products:
1.
Open the product in edit mode.
2.
Scroll down and expand tap
Add Up-Sell Products
.
the Related Products, Up-Sells, and Cross-Sells section. Then,
3.
Use the
to find the products that you want.
Magento Community Edition 2.1 User Guide 219
Other Product Settings CHAPTER 13: Product Settings
4.
In the list, mark the checkbox of any product you want to feature as an up-sell product.
Upsell Products
5.
When complete, tap
Add Selected Products
.
220 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Cross-sells
Cross-sell items are similar to impulse purchases positioned next to the cash register in the checkout line. Products offered as a cross-sell appear on the shopping cart page, just before the customer begins the checkout process.
Cross-sells in Shopping Cart
To select cross-sell products:
1.
Open the product in edit mode.
2.
Scroll down and expand tap
Add Cross-Sell Products
.
the Related Products, Up-Sells, and Cross-Sells section. Then,
3.
Use the
to find the products that you want.
Magento Community Edition 2.1 User Guide 221
Other Product Settings CHAPTER 13: Product Settings
4.
In the list, mark the checkbox of any product you want to feature as a cross-sell product.
Cross-sell Products
5.
When complete, tap
Add Selected Products
.
222 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Customizable Options
Adding customizable options to a product is an easy way to offer customers a selection of options with a variety of text, selection, and date input types. Customizable options are a good solution if your inventory needs are simple. However, because they are based on variations of a single SKU, they cannot be used to manage stock. If you have multiple products with the same options, you can set up one product, and import the options to the other products.
To create customizable options:
1.
Open the product in edit mode.
2.
Scroll down and expand the Customizable Options section. Then, tap
Add Option
.
Customizable Options
3.
In the upper-left corner, tap
New Option
. Then, do the following:
a.
In the Option Title field, enter a name for the option.
b.
Set the Option Type for data entry.
c.
If the option is not required to purchase the product, clear the Required checkbox.
New Option
4.
Tap
Add New Row
. Then, complete the following:
Magento Community Edition 2.1 User Guide 223
Other Product Settings CHAPTER 13: Product Settings
Add Value
a.
In the Title field, enter a name for this option.
b.
In the Price field, enter any markup or markdown from the base product price that applies to this option.
c.
Set Price Type to one of the following:
Fixed
Percentage
The price of the variation differs from the price of the base product by a fixed monetary amount, such as $1.
The price of the variation differs from the price of the base product by a percentage, such as 10%.
d.
Enter a SKU for the option. The option SKU is a suffix that is added to the product SKU.
e.
To change the order of the options, tap the Change Order icon , and drag the option to a new position in the list.
224
Change Order of Options
f.
Repeat this step for each option to be added.
5.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings
To import customizable options:
1.
In the Customizable Options section, tap
Import Options
.
Other Product Settings
Customizable Options
2.
All products with customizable options appear in the grid.
3.
In the list, mark the checkbox of the product with the options that you want to import.
4.
Tap
Import
.
5.
When complete, you can continue to add more custom options, or tap
Save and Close
.
Input Controls
INPUT TYPE DESCRIPTION
TEXT
Field
Area
A single line input field for text.
A multiple-line input box for paragraphs of text. You can use the WYSIWYG
Editor to format the text with HTML tags, or type HTML directly into the text area.
FILE
File A file to be uploaded by the customer.
SELECT
Drop-down
Radio Buttons
Checkbox
Multiple Select
A drop-down list of options. Only one item can be selected at a time.
A set of options that allows only one to be selected at a time.
A checkbox is a variation of a yes/no option. If the product has more than one checkbox, multiple selections can be made at the same time.
A drop-down list of options that accepts multiple selections. To select multiple options, hold down the Ctrl (PC) or Command (Mac) key.
DATE
Magento Community Edition 2.1 User Guide 225
Other Product Settings CHAPTER 13: Product Settings
Input Controls (cont.)
INPUT TYPE DESCRIPTION
Date An input field for a date value. The date can be typed directly into the field, selected from a listm or calendar. The method of input used and format of the date is determined by the Date & Time Custom Options configuration.
Date & Time
Time
An input field for date and time values.
An input field for a time value.
226 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Product in Websites
The Product in Websites section identifies each website where the product is available, according to the
.
Multisite Installation
To copy a product to a different website:
1.
Open the product in edit mode.
2.
Scroll down and expand the Product in Websites section.
Product in Websites
3.
Mark the checkbox of the website where the product is to be copied
For an single website installation, the website checkbox is marked by default.
4.
Choose the Store View where the product is to be copied from.
Magento Community Edition 2.1 User Guide 227
Other Product Settings CHAPTER 13: Product Settings
Product in Websites
5.
When complete, tap
Save
. Then, do the following:
a.
When you return to the product record, set the Store View chooser to the store view to which the product was copied. When prompted to confirm scope switching, tap
OK
.
b.
Enter the Price of the product for this store view.
Because the scope of the base currency is set to "website," it is possible to sell the product for a different price in each website.
6.
When complete, tap
Save
.
228 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Design
The Design settings give you the ability to apply a different theme to the product page, change the column layout, determine where product options appear, and enter custom XML code.
Design
Field Descriptions
FIELD
Layout
DESCRIPTION
Store View To apply a different layout to the product page, select one of the following:
No layout updates This option is preselected by default and does not apply layout changes.
Empty This option lets you define your own layout, such as a 4column page. Requires an understanding of XML.
1 column
2 columns with left bar
2 columns with right bar
3 columns
Applies the 1-column layout.
Applies the 2 column layout.
Applies the 2-columns with right bar layout.
Applies the 3 column layout.
Display product options in Store View Options: Product Info Column / Block after Info
Column
Store View Add XML code to customize the theme.
Magento Community Edition 2.1 User Guide 229
Other Product Settings CHAPTER 13: Product Settings
Scheduled Design Update
The Scheduled Design Update section gives you the ability to make temporary changes to the appearance of the product page. You can schedule design changes for a season, promotion, or just to mix things up. Design changes can be scheduled in advance, so they go into effect, or
“drip” on schedule.
Scheduled Design Update
230 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Gift Options
Gift Options can be set at the product level to allow a gift message to be included during checkout. To override the default configuration setting, clear the Use Config Settings checkbox.
Gift Options
To set gift options for a single product:
1.
Open the product in edit mode.
Scroll down and expand the Gift Options section. Then, do the following:
a.
To override the default setting, clear the Use Config Settings checkbox.
b.
Set Allow Gift Message as needed for the product.
2.
When complete, tap
Save
.
Downloadable Information
The Downloadable Information section is used to generate the links to downloadable products and samples. To learn more, see:
.
Magento Community Edition 2.1 User Guide
Downloadable Information
231
Other Product Settings CHAPTER 13: Product Settings
Grouped Products
The Grouped Products section is used to add individual products to a
product. After the products are added, they appear in the section.
Grouped Product Items
232 Magento Community Edition 2.1 User Guide
CHAPTER 13: Product Settings Other Product Settings
Bundle Items
The Bundle Items section is used to add items to a
product type, and also to edit the current selection of items.
Bundle Items Section
Bundle Items
Magento Community Edition 2.1 User Guide 233
234 Magento Community Edition 2.1 User Guide
CHAPTER 14:
Managing Pricing
Magento supports a number of pricing options that you can use for promotions, or to meet the minimum advertised pricing requirements of the manufacturer. Changes to product pricing can be made on schedule, or by price rule that is applied at the product level or in the shopping cart. Topics in this chapter: l
l
l
l
l
Magento Community Edition 2.1 User Guide 235
Advanced Pricing CHAPTER 14: Managing Pricing
Advanced Pricing
The Advanced Pricing settings define the required conditions for special pricing based on the customer group and website, and also determine quantity discount tier pricing.
Advanced Pricing
To display the Advanced Pricing options:
1.
Open the product in edit mode.
2.
Under the Price field, click Advanced Pricing.
Advanced Pricing
236 Magento Community Edition 2.1 User Guide
CHAPTER 14: Managing Pricing
Field Descriptions
FIELD
Group Price
Add Group Price
Special Price
Cost
Tier Price
Advanced Pricing
DESCRIPTION
Sets up promotional prices for specific customer groups within the selected website. Options include:
Web Site Identifies the website where the group price rule applies. This option appears only if the installation has multiple websites.
Customer Group
Price
Action
(Required) Identifies the customer group that qualifies to receive the group price.
(Required) Specifies the product price for members of the customer group, within the specific website.
Deletes the current Group Price rule.
Inserts an additional row for a new Group Price rule
Offers a discounted price during the time period defined by the
From/To dates.
In the storefront when a special price is available, the retail price is crossed out and the special price appears below in large, bold text.
From Sets the first date the Special Price is available. You can either enter the date or select it from the calendar.
To Sets the last date the Special Price is available. You can either enter the date or select it from the calendar.
The actual cost of the item.
Offers a quantity discount to members of a specific customer group and website. Options include:
Web Site Identifies a specific website where the tier price rule applies.
Customer Group
Quantity
Identifies a specific customer group that qualifies to receive the tier price discount.
(Required) The quantity that must be purchased to receive the tier price.
Magento Community Edition 2.1 User Guide 237
Advanced Pricing CHAPTER 14: Managing Pricing
Field Descriptions (cont.)
FIELD DESCRIPTION
Price (Required) The discounted product price for the quantity purchased.
Deletes the current tier price rule.
Add
Inserts an additional row for a new tier price rule definition.
Manufacturer's Suggested
Retail Price
The manufacturer's suggested retail price (MSRP) for the product.
Display Actual Price Determines where the actual price of the product is visible to the customer. Options:
Use Config Uses the current configuration setting for the price display.
On Gesture
In Cart
Displays the actual product price in a popup, in response to the "Click for price" or What's this?" link.
Displays the actual product price in the shopping cart.
Before Order
Confirmation
Displays the actual product price at the end of the checkout process, just before the order is submitted.
238 Magento Community Edition 2.1 User Guide
CHAPTER 14: Managing Pricing Advanced Pricing
Group Price
A discounted price on any product can be extended to members of a specific customer group, provided they shop while logged in to their accounts. The discounted price appears on the product page with the regular price noted below, and replaces the regular price in the shopping cart.
Customer group prices are a component of tier pricing, and are set up in a similar way. The only difference is that the customer group prices have a quantity of 1.
Group Price Discount
To set up a group price:
1.
Open the product in edit mode.
2.
Below the Price field, click Advanced Pricing.
3.
In the Tier Price section, tap
Add
. Then, do the following:
a.
If your Magento installation includes multiple Websites, choose the one(s) where the group price applies.
b.
Choose the Customer Group that is to receive the discount.
c.
Enter a quantity of 1.
d.
Enter the discounted Price.
Magento Community Edition 2.1 User Guide 239
Advanced Pricing CHAPTER 14: Managing Pricing
Group Price
4.
To add another group price tap
Add
and repeat the previous steps.
5.
When complete, tap
Done
. Then, tap
Save
.
Group Price Applied in Shopping Cart
240 Magento Community Edition 2.1 User Guide
CHAPTER 14: Managing Pricing Advanced Pricing
Special Price
To offer a special price, enter the discounted price and the dates when the special price is in effect. The special price appears instead of the regular price, followed by “was (previous price).”
Special Price
To apply a special price:
1.
Open the product in edit mode.
2.
Below the Price field, click Advanced Pricing.
3.
Enter the amount of the Special Price.
4.
To establish when the special price is in effect, use the Calendar button field to enter the Special Price From and Special Price To dates.
to the right of each
Special Pricing Settings
5.
When complete, tap
Done
. Then, tap
Save
.
Magento Community Edition 2.1 User Guide 241
Advanced Pricing CHAPTER 14: Managing Pricing
Tier Price
Tier pricing lets you offer a quantity discount from the catalog list and product detail pages.
The discount can be applied to a specific store view or customer group.
242
Tier Price on Product Page
The product page calculates the quantity discount and displays a message such as:
Buy 3 for $5.00 each and save 29%
The prices in the storefront take precedence from the highest to the lowest quantity. Therefore, if you have a tier for the quantity 5 and one for the quantity 10, and a customer adds 5, 6, 7, 8 or 9 items to the shopping cart, the customer receives the discounted price that you specified for the quantity 5 tier. As soon as the customer adds the 10th item, the discounted price specified for the quantity 10 tier supersedes the tier for a quantity of 5, and discounted price for
10 applies.
To set up a tier price:
1.
Open the product in edit mode.
2.
Below the Price field, click Advanced Pricing.
3.
In the Tier Price section, tap
Add
. Then, do the following:
Magento Community Edition 2.1 User Guide
CHAPTER 14: Managing Pricing Advanced Pricing
Tier Pricing
a.
If your store has multiple websites, choose the Website where the tier pricing applies.
b.
If applicable, choose the Customer Group to receive the discount.
c.
In the Qty field, enter the quantity that must be ordered to receive the tier price.
d.
In the Item Price field, enter the adjusted price of the item.
To apply the same tier to more than one group, create a separate tier for each group, but with the same Qty and Price information.
4.
To add another group price, tap
Add
and repeat the previous steps.
5.
When complete, tap
Done
. Then, tap
Save
.
Magento Community Edition 2.1 User Guide 243
Advanced Pricing CHAPTER 14: Managing Pricing
Minimum Advertised Price
Merchants are sometimes prohibited from displaying a price that is lower than the manufacturer’s suggested retail price (MSRP). Magento’s Minimum Advertised Price (MAP) gives you the ability to remain in compliance with the manufacturer’s requirements while offering your customers a better price. Because requirements differ from one manufacturer to another, you can configure your store to prevent the display of your actual price on pages where it is not allowed to appear according to the terms of the manufacturer.
MAP Logic
For products with prices that depend on a selected options, (such as custom options, or simple products with their own SKUs and stock management), the following logic is used: l
MAP is applied to the main price. The prices of options, bundle items, and associated products (which add or subtract from the main price) appear normally.
l
If a product does not have a main price, and its price is derived from the associated product prices (such as in a grouped product), the MAP settings of the associated products are applied.
l
If a product in the cart has the Manufacturer’s Suggested Retail Price (MSRP) specified, the price is not crossed-out.
For other price settings, the following MAP logic is used: l
If tier pricing is set, the tier price appears according to the Display Actual Price setting.
l
If a special price is set, it is considered to be the actual price for MAP.
In the order management and customer management tools, as well as in the reports sections of the Admin, only the actual price appears.
244 Magento Community Edition 2.1 User Guide
CHAPTER 14: Managing Pricing Advanced Pricing
Using MAP with Product Types
PRODUCT TYPE
,
DESCRIPTION
The actual price does not automatically appear on catalog list and product pages, but is included only according to the Display Actual
Price setting. Custom option prices appear normally.
(with fixed price)
The prices of associated simple products do not automatically appear on catalog list and product pages, but are included only according to the Display Actual Price setting.
The actual price does not automatically appear on catalog list and product pages, but is included only according to the Display Actual
Price setting. Option prices appear normally.
The actual price does not automatically appear on catalog pages, but is included only according to the Display Actual Price setting. The prices of bundle items appear normally.
MAP is not available for
with dynamic pricing.
The actual price does not automatically appear on catalog list and product pages, but is included only according to the Display Actual
Price setting. The price associated with each download link appears normally.
Using MAP with Price Settings
PRICE SETTING
DESCRIPTION
If tier pricing is set, the tier pricing message is not displayed in the catalog. On the product page a notification is displayed that indicates that the price can be lower when ordering more than a certain quantity, but the discount is displayed in percentages only. For associated products of a grouped product, the discounts are not displayed on the product page.
The tier price is shown according to the Display Actual Price setting.
If the Special price is specified, the special price is displayed according to the Display Actual Price setting.
Magento Community Edition 2.1 User Guide 245
Advanced Pricing CHAPTER 14: Managing Pricing
Configuring MAP
Your store’s MAP settings can be applied to all products in your catalog, or configured for specific products. When Minimum Advertised Price is enabled globally, all product prices in the storefront are hidden from view. There are a variety of configuration options that you can use to remain in compliance with the terms of your agreement with the manufacturer, while still offering your customers a better price.
246
Actual Price Appears “On Gesture”
On the global level, you can enable or disable MAP, apply it to all products, define how the actual price is displayed, and edit the text of the related messages and information tips that appear in the store.
When MAP is enabled, the product-level MAP settings become available. You can apply MAP to an individual product by entering the MSRP, and choosing how you want the actual price to appear in the store. Product-level MAP settings override the global MAP settings.
Magento Community Edition 2.1 User Guide
CHAPTER 14: Managing Pricing Advanced Pricing
Click for Price
To configure MAP:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
If applicable, in the upper-right corner, set Store View to the view where the configuration applies.
3.
In the panel on the left under Sales, choose Sales.
4.
Expand the Minimum Advertised Price section.
5.
If necessary, set Enable MAP to “Yes.” Then, do the following:
Minimum Advertised Price
Magento Community Edition 2.1 User Guide 247
Advanced Pricing CHAPTER 14: Managing Pricing
Method 1:
Configure MAP for All Products:
1.
To determine when and where you want the actual price to be visible to customers, do the following:
a.
To change the default value, clear the Use system value checkbox.
b.
Set Display Actual Price to one of the following: l
In Cart l
Before Order Confirmation l
On Gesture (on click)
2.
Enter the text that you want to appear in the Default Popup Text Message.
3.
Enter any additional explanation that you want to appear in the Default “What’s This”
Text Message
.
4.
When complete, tap
Save Config
.
Method 2:
Configure MAP for a Single Product
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
Open the product in Edit mode.
3.
In the panel on the left under Advanced Settings, choose Advanced Pricing. Then, do the following:
Manufacturer’s Suggested Retail Price
248 Magento Community Edition 2.1 User Guide
CHAPTER 14: Managing Pricing Advanced Pricing
a.
Enter the Manufacturer’s Suggested Retail Price.
In this example, the product price is $54.00, and the MSRP is 59.95.
b.
Set Display Actual Price to one of the following:
Use config
On Gesture
In Cart
Before Order
Confirmation
(Default) Applies the MAP configuration setting.
Displays the actual product price in a popup when the customer clicks the “Click for price” or “What’s this?” link.
Displays the actual product price in the shopping cart.
Displays the actual product price at the end of the checkout process, just before the order is confirmed.
The Manufacturer’s Suggested Retail Price and Display Actual Price fields appear only when
Minimum Advertised Price is enabled in the configuration.
6.
When complete, tap
Done
. Then, tap
Save
.
Magento Community Edition 2.1 User Guide 249
250 Magento Community Edition 2.1 User Guide
CHAPTER 15:
Managing Inventory
Each product in your catalog has both a short and long version of the Advanced Inventory options, depending on whether you want to manage stock for the product. The long form appears when Manage Stock is set to “Yes.” The initial values reflect the default
set in the configuration.
Advanced Inventory (Short Form)
Method 1:
Without Stock Management
1.
Open the product in edit mode.
2.
In the panel on the left under Advanced Settings, choose Advanced Inventory.
3.
Set Manage Stock to “No.” If necessary, clear the Use Config Settings checkbox to make the field available.
4.
Enter the Minimum Qty Allowed in Shopping Cart.
5.
Enter the Maximum Qty Allowed in Shopping Cart.
6.
If you want to sell by quantity increment, do the following:
a.
Set Enable Qty Increments to “Yes.”
b.
In the Qty Increments field, enter the number of products that must be purchased in an incremental step. For example, if you enter 6, the customer must purchase the product in quantities of 6, 12, 18, and so on.
7.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide 251
252
CHAPTER 15: Managing Inventory
Field Descriptions
FIELD
Manage Stock
Qty Increments
Global
Minimum Qty Allowed in
Shopping Cart
Maximum Qty Allowed in
Shopping Cart
Enable Qty Increments
Global
Global
Global
Global
DESCRIPTION
Determines if inventory control is used to manage this product in your catalog. Options: Yes / No
Determines the minimum number of the product that can be purchased in a single order.
Determines the maximum number of the product that can be purchased in a single order.
Determines if the product can be sold in quantity increments. Options: Yes / No
Enter the number of products that must be purchased at the same time. For example, if set to 6, the customer must purchase a quantity of 6, 12, 18, and so on.
When a product is sold in quantity increments, the number appears in the upper-right corner, next to the shopping cart link. If the customer tries to purchase the product in any other quantity, a message appears in the shopping cart,
Method 2:
With Stock Management
1.
Open the product in edit mode.
2.
In the panel on the left under Advanced Settings, choose Advanced Inventory.
3.
Set Manage Stock to “Yes.” If necessary, clear the Use Config Settings checkbox to make the field available. Then, do the following:
a.
Enter the Qty currently in stock.
b.
Enter the Qty for Item’s Status to Become Out of Stock.
c.
Enter the Minimum Qty Allowed in Shopping Cart.
d.
Enter the Maximum Qty Allowed in Shopping Cart.
4.
If the quantity is a decimal value, do the following:
a.
Set Qty Uses Decimals to “Yes.”
b.
If the quantity purchased Can be Divided into Multiple Boxes for Shipping, select “Yes.”
5.
Set Backorders to one of the following:
Magento Community Edition 2.1 User Guide
CHAPTER 15: Managing Inventory l
No Backorders l
Allow Qty Below 0 l
Allow Qty Below 0 and Notify Customer
6.
In the Notify for Quantity Below field, enter the stock level that triggers a Quantity Below notification.
7.
To sell the product in quantity increments, do the following:
a.
Set Enable Qty Increments to “Yes.”
b.
In the Qty Increments field, enter the number of products that must be purchased in an incremental step. For example, if you enter 6, the customer must purchase the product in quantities of 6, 12, 18, and so on.
8.
If the product is currently in stock, set Stock Availability to “In Stock.”
9.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide
Advanced Inventory (Long Form)
253
254
CHAPTER 15: Managing Inventory
Field Descriptions
FIELD
Manage Stock
Qty
Qty for Item’s Status to
Become Out of Stock
Minimum Qty Allowed in
Shopping Cart
Maximum Qty Allowed in
Shopping Cart
Qty Uses Decimals
Global
Global
Global
Global
Global
Can be Divided into
Multiple Boxes for
Shipping
Backorders
Global
Global
DESCRIPTION
Determines if inventory control is used to manage this product in your catalog. Options:
Yes Displays the long form with all stock management options.
No Display the short form without stock management options.
The quantity of the item that is currently in stock.
Determines the stock level at which a product is considered to be out of stock.
Determines the minimum number of the product that can be purchased in a single order.
Determines the maximum number of the product that can be purchased in a single order.
Determines if customers can use a decimal value rather than a whole number when entering the quantity ordered. Options:
Yes Permits values to be entered as decimals, rather than whole numbers, which is suitable for products sold by weight, volume or length.
No Requires quantity values to be entered as whole numbers.
Determines if parts of the product can be shipped separately. Options: Yes / No
Global Determines how backorders are managed.
Backorders do not change the processing status of the order. Funds are still authorized or captured immediately when the order is placed, regardless of whether the product is in stock. Products are shipped as they become available. Options:
Magento Community Edition 2.1 User Guide
CHAPTER 15: Managing Inventory
Field Descriptions (cont.)
FIELD
Notify for Quantity Below Global
Enable Qty Increments
Stock Availability
Global
Global
DESCRIPTION
No
Backorders
Allow Qty
Below 0
Does not accept backorders when product is out of stock.
Accepts backorders when the quantity falls below zero.
Allow Qty
Below 0 and
Notify
Customer
Accepts backorders when the quantity falls below zero, but notifies customers that orders can still be placed.
Determines the stock level at which notification is sent that the inventory has fallen below the threshold.
Determines if the product can be sold in quantity increments. Options: Yes / No
Determines the current availability of the product.
Options:
In Stock Makes the product available for purchase.
Out of Stock Unless Backorders are activated, prevents the product from being available for purchase and removes the listing from the catalog.
Magento Community Edition 2.1 User Guide 255
Stock Options CHAPTER 15: Managing Inventory
Stock Options
Your catalog can be configured to display the availability of each item as “In Stock” or “Out of
Stock,” The configuration setting applies to the catalog as a whole, and the message changes according to the stock status of the product. There are several display variations possible, including how “out of stock” products are managed in the catalog and in product listings.
The out of stock threshold indicates when a product needs to be reordered, and can be set to any number greater than zero. Another way you can use the stock availability threshold is to manage products that are in high demand. If you want to capture new customers, rather than sell to high-quantity buyers, you can set a maximum quantity to prevent a single buyer from taking out your entire inventory.
In Stock, Only 1 Left
256 Magento Community Edition 2.1 User Guide
CHAPTER 15: Managing Inventory Stock Options
To configure stock options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Inventory.
3.
Expand the Stock Options section, and do the following:
a.
To return items to stock if an order is canceled, Set Items’ Status to be in Stock When
Order in Canceled
to “Yes.”
b.
To adjust the quantity on hand when an order is placed, set Decrease Stock When Order
is Placed
to “Yes.”
c.
Set Display Out of Stock Products to “Yes” to continue to display products in the catalog that are no longer in stock.
If
are enabled, customers can sign up to be notified when the product is back in stock.
d.
To display the message, “Only x left,” enter the number in the Display X left Threshold field.
The message begins to appear when the quantity in stock reaches the threshold. For example, if set to 3, the message “Only 3 left” appears when the quantity in stock reaches
3. The message adjusts to reflect the quantity in stock, until the quantity reaches zero.
e.
To display an “In Stock” or “Out of Stock” message on the product page, set Display
Products Availability In Stock on Storefront
to “Yes.”
4.
When complete, tap
Save Config
.
Stock Options
Magento Community Edition 2.1 User Guide 257
Stock Options CHAPTER 15: Managing Inventory
Product Stock Options
The Product Stock Options configuration determines the default product inventory settings at the product level. The configuration applies to individual products, rather than to the contents of the cart as a whole.
To configure the default inventory settings:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Inventory.
3.
Expand the Product Stock Options section, and do the following:
a.
To activate inventory control for your catalog, set Manage Stock to “Yes.”
258
Product Stock Options
Magento Community Edition 2.1 User Guide
CHAPTER 15: Managing Inventory Stock Options
b.
Set Backorders to one of the following:
No Backorders
Allow Qty Below 0
Allow Qty Below 0 and
Notify Customer
To not accept backorders when product is out of stock.
To accept backorders when the quantity falls below zero.
To accept backorders when the quantity falls below zero, and notify the customer that the order can still be placed.
c.
Enter the Maximum Qty Allowed in Shopping Cart.
d.
Enter the Qty for Item's Status to Become Out of Stock.
e.
Enter the Minimum Qty Allowed in Shopping Cart.
f.
In the Notify for Quantity Below field, enter the stock level that triggers notification that the item is out of stock.
g.
To activate quantity increments for the product, set Enable Qty Increments to “Yes.” Then in the Qty Increments field, enter the number of the items that must be purchased to meet the requirement. For example, an item that is sold in increments of 6 can be purchased in quantities of 6, 12, 18, and so on.
h.
When a credit memo is issued for the item, set Automatically Return Credit Memo Item to
Stock
to “Yes” if you want to return the item to inventory by default.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 259
Stock Options CHAPTER 15: Managing Inventory
Stock Message Scenarios
You can use a combination of configuration settings to control stock availability messages on product pages and in listings of products on catalog pages.
Grouped Product with “Out of Stock” Message
Product Page Stock Messages
There are several variations of messaging available for the product page, depending on the combination of Manage Stock and Stock Availability settings.
260 Magento Community Edition 2.1 User Guide
CHAPTER 15: Managing Inventory Stock Options
Example 1:
Show Availability Message
Scenario 1:
This combination of settings causes the availability message to appear on the product page, according to the stock availability of each product.
STOCK OPTIONS
Display product availability in stock in the frontend: Yes
MESSAGE
Product Inventory
Manage Stock Yes
Stock Availability In Stock
Out of Stock
“Availability: In
Stock”
“Availability: Out of
Stock”
Scenario 2:
When stock is not managed for a product, this combination of settings can be used to display the availability message on the product page.
STOCK OPTIONS
Display product availability in stock in the frontend: Yes
MESSAGE
Product Inventory
Manage Stock No “Availability: In
Stock”
Example 2:
Hide Availability Message
Scenario 1:
This combination of configuration and product settings prevents the availability message from appearing on the product page.
STOCK OPTIONS
Display product availability in stock in the frontend: No
MESSAGE
Product Inventory
Manage Stock
Stock Availability
Yes
In Stock
Out of Stock
None
None
Scenario 2:
When stock is not managed for a product, this combination of configuration and product settings prevents the availability message from appearing on the product page.
Magento Community Edition 2.1 User Guide 261
Stock Options
STOCK OPTIONS
Display product availability in stock in the frontend:
Product Inventory
Manage Stock
No
No
CHAPTER 15: Managing Inventory
MESSAGE
None
Catalog Page Stock Messages
The following display options are possible for the category and search results lists, depending on the product availability and configuration settings.
“Out of Stock” Message on Category Page
262 Magento Community Edition 2.1 User Guide
CHAPTER 15: Managing Inventory Stock Options
Example 1:
Show Product with “Out of Stock Message”
This combination of configuration settings includes out of stock products in the category and search results lists, and displays an “out of stock” message.
MESSAGE STOCK OPTIONS
Display Out of Stock Products
Display product availability in stock in the frontend
Display Out of Stock Products
Yes
Yes
Yes
“Out of stock”
Display product availability in stock in the frontend No None
Example 2:
Show Product without “Out of Stock Message”
This combination of configuration settings includes out of stock products in the category and search results lists, but does not display a message.
STOCK OPTIONS
Display Out of Stock Products
Display product availability in stock in the frontend
Yes
No
MESSAGE
None
Example 3:
Hide Product Until Back in Stock
This configuration setting omits out of stock products entirely from the category and search results lists, until they are back in stock.
STOCK OPTIONS
Display Out of Stock Products No
MESSAGE
None
Magento Community Edition 2.1 User Guide 263
Stock Options CHAPTER 15: Managing Inventory
Product Alerts
Customers can subscribe to two types of alerts by email: price change alerts and in-stock alerts.
For each type of alert, you can determine if customers are able to subscribe, select the email template that is used, and identify the sender of the email.
264
Sign Up for Price Alert
When price change alerts are enabled, a “Sign up for price alert” link appears on every product page. Customers can click the link to subscribe to alerts related to the product. Guests are prompted to open an account with your store. Whenever the price changes, or the product goes on special, everyone who has signed up to be notified receives an email alert.
The in-stock alert creates a link called “Sign up to get notified when this product is back in stock” for every product that is out of stock. Customers can click the link to subscribe to the alert. When the product is back in stock, customers receive email notification that the product is available. Products with alerts have a Product Alerts tab in the Product Information panel that lists the customers who have subscribed to an alert.
Magento Community Edition 2.1 User Guide
CHAPTER 15: Managing Inventory Stock Options
To set up product alerts:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Click to expand the Product Alerts section, and do the following:
a.
To offer price change alerts to your customers, set Allow Alert When Product Price
Changes
to “Yes.”
b.
Set Price Alert Email Template to the template that you want to use for the price alert notifications.
c.
To offer alerts when out-of-stock products become available again, set Allow Alert When
Product Comes Back in Stock
to “Yes.”
The “Sign up to get notified when this product is back in stock” message appears only when
Inventory Stock Options - Display Out of Stock Products is set to “Yes.”
d.
Set Stock Alert Email Template to the template that you want to use for product stock alerts.
e.
Set Alert Email Sender to the
that you want to appear as the sender of the email alert.
4.
When complete, tap
Save Config
.
Product Alerts
Magento Community Edition 2.1 User Guide 265
Stock Options CHAPTER 15: Managing Inventory
Product Alert Run Settings
These settings enable you to select how often Magento checks for changes that require alerts to be sent. Additionally, you can select the recipient, sender, and template for emails that are sent if the sending of alerts fails.
266
Product Alert Run Settings
To set up product alerts:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Product Alerts Run Settings section, and do the following:
a.
To determine how often product alerts are sent, set Frequency to one of the following: l
Daily l
Weekly l
Monthly
b.
To determine the time of day product alerts are sent, set Start Time to the hour, minute, and second.
c.
In the Error Email Recipient field, enter the email of the person to be contacted if an error occurs.
d.
In the Error Email Sender field, select the store identity that appears as the sender of the error notification.
e.
Set Error Email Template to the transactional email template to be used for the error notification.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 16:
Images and Video
Using high-quality images of consistent proportion gives your catalog a professional look with commercial appeal. If you have a large catalog with several images per product, you can easily have hundreds, if not thousands of product images to manage. Before you get started, establish a naming convention for your image files, and organize them so you can find the originals if you ever need them.
Product Images
A single product image is rendered in different sizes throughout the catalog. The size of the image container on the page is defined in the style sheet, but how the image is used is determined by the role that is assigned to the image. The main product image, or “base” image, must be large enough to produce the magnification that is needed for zoom. In addition to the main image, a smaller version of the same image might appear in product listings, or as a thumbnail in the shopping cart. You can upload an image in the largest size that is needed, and let Magento render the sizes needed for each use. The same image can be used for all roles, or a different image can be assigned to each role. By default, the first image that is uploaded is assigned to all three roles.
Magento Community Edition 2.1 User Guide 267
Uploading Product Images CHAPTER 16: Images and Video
Uploading Product Images
For each product, you can upload multiple images, rearrange their order mages, and control how each image is used. If you have a large quantity of images to manage, you might prefer to import them as a batch, rather than upload each one individually. To learn more, see:
To manage images:
1.
Open the product in edit mode. Scroll down and expand the Images and Videos section. Then, do any of the following:
Upload an Image
l
Drag an image from your desktop, and drop it on the camera tile in the Images box.
l
In the Images box, tap the camera tile, and navigate to the image file on your computer.
Then, select the image, and tap
Open
.
Upload or Drag and Drop
Rearrange Images
To change the order of images in the gallery, tap the Sort icon at the bottom of the image tile. Then, drag the image to a different position in the Images box.
268
Change Order
Delete an Image
To remove an image from the gallery, tap the Delete icon in the upper-right corner of the image tile. Then, tap
Save
.
Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Uploading Product Images
2.
Tap the image that you want to open in detail view: Then, do any of the following:
Image Detail View
Enter Alt Text
Image Alt text is referenced by screen readers to improve web accessibility, and by search engines when indexing the site. Some browsers display the Alt text on mouseover. Alt text can be several words long, and include carefully selected key words.
In the Alt Text box, enter a brief description of the image.
Assign Roles
By default, all roles are assigned to the first image that is uploaded to the product. To reassign a role to another image, do the following:
1.
Tap an image tile to open the image in detail view.
2.
In the Role box, choose the role that you want to assign to the image.
When you return to the Images and Videos section, the currently assigned roles appear below each image.
Assigned Roles
Magento Community Edition 2.1 User Guide 269
Uploading Product Images CHAPTER 16: Images and Video
Hide Image
To exclude an image from the thumbnail gallery, mark the Hidden checkbox. Then, tap
Save
.
Hidden Images
3.
To close detail view, click the Close box in the upper-right corner.
4.
When complete, tap
Save
Image Roles
IMAGE ROLE
Thumbnail
DESCRIPTION
Thumbnail images appear in the thumbnail gallery, shopping cart, and in some blocks such as Related Items.
Example size: 50 x 50 pixels
Small Image
Base Image
The small image is used for the product images in listings on category and search results pages, and to display the product images needed for sections such as for Up-sells, Cross-sells, and the New
Products List.
Example size: 470 x 470 pixels
The base image is the main image on the product detail page. Image zoom is activated if you upload an image that is larger image than the image container. Example sizes:
470 x 470 pixels (without Zoom)
1100 x 1100 pixels (with Zoom)
A swatch can be used to illustrate the color, pattern, or texture.
Example size: 50 x 50 pixels
270 Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Adding Product Video
Adding Product Video
To add product video, you must first obtain an API Key from your Google account, and enter it in the configuration of your store. Then, you can link to the video from the product.
Step 1:
Get Your YouTube API Key
1.
Log in to your Google account, and visit the Google Developers Console . Then, do the following:
a.
Under Use Google APIs, click Enable and manage APIs.
b.
In the panel on the left choose Credentials. Expand the Add Credentials menu, and choose API key.
c.
When prompted to create a new key, choose Server key. Enter a name for the key, and tap
Create
.
2.
Wait a few moments while the key is generated. Then, copy the key to the clipboard.
In the next step, you will paste the key into your store’s configuration.
Step 2:
Configure Magento
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Product Video section. Then, paste your YouTube API key.
4.
When complete, click
Save Config
.
5.
When prompted, refresh the cache.
Product Video
Magento Community Edition 2.1 User Guide 271
Adding Product Video CHAPTER 16: Images and Video
Step 3:
Link to the Video
1.
Open a product in edit mode. Then in the Images and Video section, tap
Add Video
.
If you haven’t yet entered your YouTube API key, tap
OK
to continue. You won’t be able to link to a YouTube video, but you can go through the process.
Add Video
2.
Enter the URL of the YouTube or Vimeo video.
3.
Enter the Title and Description of the video.
4.
To upload a Preview Image, browse to the image and select the file.
5.
If you prefer to use the video meta data, tap
Get Video Information
.
6.
To determine how the video is used in the store, mark the checkbox of each Role that applies: l
Base Image l
Small Image l
Swatch Image l
Thumbnail l
Hide from Product Page
7.
When complete, tap
Save
.
272 Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Adding Product Video
New Video
Field Descriptions
FIELD
URL
Title
Description
Preview Image
Get Video Information
Role
DESCRIPTION
The URL of the associated video.
The video title.
The video description.
An uploaded image that is used as a preview of the video in your store.
Retrieves the video meta data that is stored on the host server. You can use the original data, or update it as needed.
Determines how the preview image is used in your store. Options:
Base Image
Small Image
Thumbnail
Swatch Image
Hide from Product Page
Magento Community Edition 2.1 User Guide 273
Media Gallery CHAPTER 16: Images and Video
Media Gallery
The media gallery on the product page displays multiple images, video, or swatches related to the product. Each thumbnail can show a different view or variation of the product. Click a thumbnail to browse through the gallery, Although the position of the gallery varies by theme, the default position is just below the main image on the product page.
274
Media Gallery
Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Media Gallery
Image Zoom
Customers can view a magnified portion of the image on mouseover, if the image is large enough to create the zoom effect. When zoom is activated, you can click the main image and move the cursor around to magnify different parts of the image. The magnified selection appears to the right of the image.
Image Zoom
Light Boxes and Sliders
There are many third-party light boxes and sliders that you can use to enhance the presentation of your product images. Look for extensions in
Magento Community Edition 2.1 User Guide 275
Placeholders CHAPTER 16: Images and Video
Placeholders
Magento uses temporary images as placeholders until the permanent product images become available. A different placeholder can be uploaded for each role. The initial placeholder image is the Magento logo, which you can replace with an image of your choice.
Image Placeholder
To upload placeholder images:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, and choose Catalog.
3.
Expand the Product Image Placeholders section.
4.
For each image role, tap
Choose File
. Find the image on your computer and upload the file.
You can use the same image for all three roles, or upload a different placeholder image for each role.
276
5.
When complete, tap
Save
.
Product Image Placeholders
Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Watermarks
Watermarks
If you go to the expense of creating your own original product images, there is not much you can do to prevent unscrupulous competitors from stealing them with the click of a mouse.
However, you can make them a less attractive target by placing a watermark on each image to identify them as your property. A watermark file can be either a .jpg (jpeg), .gif, or .png image.
Both ,gif and .png formats support transparent layers, which can be used to give the watermark a transparent background.
The watermark used for the “small” image in the following example is a black logo with a transparent background, and saved as a .png file with the following settings:
Size:
Opacity:
Position:
50x50
5
Tile
Tiled Watermark
Magento Community Edition 2.1 User Guide 277
Watermarks CHAPTER 16: Images and Video
To add watermarks to product images:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
3.
Under Other Settings, expand the Product Image Watermarks section.
4.
Complete the Base, Thumbnail, Small, and Swatch Image image settings as follows:
a.
Enter the Image Opacity as a percentage. For example: 40
b.
Enter the Image Size, in pixels. For example: 200 x 200
c.
Tap
Upload
, and choose the image file that you want to use.
d.
Set Image Position to determine where the watermark appears.
278
Product Image Watermarks
Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Watermarks
5.
When complete, tap
Save Config
.
6.
When prompted to refresh the cache, tap the Cache Management link in the system message.
Then, refresh the invalid cache.
Refresh Cache
To restore the default value:
Tap Use Default Value ( ).
To delete a watermark:
1.
In the lower-left corner of the image, tap Delete ( ).
Delete Watermark
2.
Tap
Save Config
.
3.
When prompted to refresh the cache, tap the Cache Management link in the system message.
Then, refresh the invalid cache.
If the watermark image persists in the storefront, return to Cache Management and tap
Flush Magento Cache
.
Magento Community Edition 2.1 User Guide 279
Swatches CHAPTER 16: Images and Video
Swatches
Customers have high expectations when it comes to color, and it is crucial that product descriptions accurately represent each available color, pattern, or texture. For example, the capris in the illustration below are not simply available in red, green, and blue. Rather, they are available only in very specific shades of red, green, and blue, which are probably unique to this product.
For
, color can be indicated by a visual swatch, text swatch, or a dropdown input control. Swatches can be used on the product page, in product listings, and in
layered navigation . On the product page, swatches are synchronized to display the
corresponding product image when the swatch is chosen. When chosen, the corresponding value appears in the input field, and the swatch is outlined as the current selection.
280
Swatches on Product Page
Text-Based Swatches
If an image isn’t available for a swatch, the attribute value appears as text. A text-based swatch is like a button with a text label, and behaves in the same way as a swatch with an image. When text-based swatches are used to show the available sizes, any size that is not available is crossed out.
Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Swatches
Text-Based Swatches for Size
Swatches in Layered Navigation
Swatches can also be used in layered navigation, provided that the Use in Layered Navigation property of the color attribute is set to “Yes.” The following example shows both text-based and color image swatches in layered navigation.
Magento Community Edition 2.1 User Guide
Swatches in Layered Navigation
281
Swatches CHAPTER 16: Images and Video
Creating Swatches
Swatches can be defined as a component of the color attribute, or set up locally for a specific product as uploaded
.
In the following examples, the Sylvia Capris are available in specific values of red, green, and blue. Because the swatches were taken from the product image, each is a true representation of the color. The color attribute is used to manage the information for all product colors and swatches.
Step 1:
Create the Swatches
Use either of the following methods to create swatches for your products:
Method 1:
Add a Color Swatch
1.
To capture the true color of a product, open the image in a photo editor and use the eye dropper tool to identify the exact color. Then, take note of the equivalent hexadecimal value.
Hexadecimal Color Values
2.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
3.
In the grid, open the color attribute in edit mode.
4.
Verify that Catalog Input Type for Store Owner is set to “Visual Swatch.”
5.
Under Manage Swatch (values of your attribute), tap
Add Swatch
. Then, do the following:
282 Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Swatches
Manage Swatch Values
a.
In the Swatch column, tap the new swatch to display the menu. Then, select Choose a
color
.
Choose a Color
b.
In the color picker, place your cursor in the # field, and press the Backspace key to delete the current value. Then, enter the six-character hexadecimal value of the new color..
c.
To save the swatch, tap the Color Wheel in the lower-right corner of the color picker.
d.
In the Admin column, enter a label to describe the color to the store administrator. Then if applicable, enter the translation of the color for each each language supported. In the following example, we include the SKU for reference in the Admin label because the colors are used only for a specific product. You can include a space or underscore in the label, but not a hyphen.
Magento Community Edition 2.1 User Guide 283
Swatches CHAPTER 16: Images and Video
e.
In the Is Default column, select the swatch that is to be the default option.
f.
To change the order of the swatches, simply drag each swatch into position.
Swatch Labels
6.
When complete, tap
Save Attribute
. Then when prompted, refresh the cache.
7.
The last step is to open each product in Edit mode, and update the Color attribute with the correct swatch. To update multiple products at the same time, follow the steps below.
Method 2:
Upload a Swatch Image
1.
To capture an image for a swatch, open the product image in a photo editor, and save a square area of the image that depicts the color, pattern, or texture. Then repeat for each variation of the product. The size and dimensions of the swatch is determined by the theme. As a general rule, saving an image as a square helps to preserve the aspect ratio of a pattern.
Swatch Images
2.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
3.
In the grid, open the color attribute in edit mode.
4.
Verify that Catalog Input Type for Store Owner is set to “Visual Swatch.”
5.
Under Manage Swatch (values of your attribute), tap
Add Swatch
. Then, do the following:
284 Magento Community Edition 2.1 User Guide
CHAPTER 16: Images and Video Swatches
a.
In the Swatch column, tap the new swatch to display the menu. Then, choose Upload a
file
.
Upload a File
b.
Navigate to the swatch file that you prepared, and choose the file to upload.
c.
Repeat these steps for each swatch image.
d.
Enter the labels for the Admin and Storefront. In this example, we include the SKU in the admin label for reference because these colors are used only for a specific product. You can include a space or underscore in the label, but not a hyphen.
Enter Labels
6.
When complete, tap
Save Attribute
. Then when prompted, refresh the cache.
7.
The last step is to open each product in Edit mode, and update the Color attribute with the correct swatch. To update multiple products at the same time, follow the steps below.
Step 2:
Update Your Products
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
Filter
the list by Name or SKU to include only the applicable products. The following example filters the list on a partial product name.
Filters
Magento Community Edition 2.1 User Guide 285
Swatches CHAPTER 16: Images and Video
3.
In the grid, mark the checkbox of each product to which the swatch applies. In this example, all blue capris are selected. Then, set the Actions control to “Update Attributes.”
286
Update Attributes
4.
Scroll down to the Colorattribute, and mark the Change checkbox.
Change
5.
Choose the swatch that applies to the selected products, and tap
Save
. Then when prompted, refresh the cache.
Swatch in Storefront
Magento Community Edition 2.1 User Guide
CHAPTER 17:
Categories
Before you add products to your catalog, you need to establish the basic category structure of your catalog. Every product must be assigned to at least one category. Categories are usually created in advance, before products are added to the catalog. However, you can also add categories “on the fly” while creating a product.
Category Tree
Controls
FIELD
Add Root Category
DESCRIPTION
Creates a new root category.
Add Subcategory
Collapse All / Expand All
Delete
Save
Adds a subcategory below the current category or subcategory.
Either collapses or expands the category tree.
Removes the current category or subcategory from the tree.
Saves any changes made to the category.
Magento Community Edition 2.1 User Guide 287
Creating Categories CHAPTER 17: Categories
Creating Categories
The category structure of your catalog is like an upside-down tree, with the root at the top.
Each section of the tree can be expanded and collapsed. Any disabled or hidden categories are grayed out. The first level of categories below the root typically appear as options in the main menu. You can have as many additional subcategories as you need. Categories can be dragged and dropped to other locations in the tree. The category ID number appears in parentheses after the category name at the top of the page.
Category Tree
Process Overview:
Step 1:
Step 2:
Complete the Basic Information
Step 3:
Step 4:
Step 5: Complete the Search Engine Optimization Settings
Step 6:
Choose the Products in Category
Step 7:
288 Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories Creating Categories
Step 1:
Create a Category
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2.
Set Store View to determine where the new category is to be available.
3.
In the category tree, tap the parent category of the new category. The parent is one level above the new category.
If you’re starting from the beginning without any data, there might be only two categories in the list: “Default Category,” which is the root, and an “Example Category.”
4.
Tap
Add Subcategory
.
Step 2:
Complete the Basic Information
1.
If you want the category to be immediately available in the store, set Enable Category to the
“Yes” position.
2.
To include the category in the
, set Include in Menu to the “Yes” position.
3.
Enter the Category Name.
Basic Information
4.
Tap
Save
and continue.
Step 3:
Complete the Category Content
1.
Expand the Content section.
2.
To display a Category Image at the top of the page, tap
Upload
. Then, choose the image that you want to represent the category.
3.
In the Description box, enter the text that you want to appear on the category landing page.
Then, format the text as needed. To learn more, see:
4.
To include a content block on the category landing page, choose the CMS Block that you want to appear.
5.
Tap
Save
and continue.
Magento Community Edition 2.1 User Guide 289
Creating Categories CHAPTER 17: Categories
290
Content
Step 4:
Complete the Display Settings
1.
Expand the Display Settings section.
2.
Set Display Mode to one of the following: l
Products Only l
Static Block Only l
Static Block and Products
3.
If you want the category page to include the “Filter by Attribute” section of layered navigation, set Anchor to the “Yes” position.
4.
To change the Available Product Listing Sort By options, do the following:
a.
Clear the Use All checkbox.
b.
Select one or more of the available values to be available for customers to sort the list. By default, all available values are included. For example, the values might include: l
Position l
Product Name l
Price
5.
To set the default sort order for the category, choose the Default Product Listing Sort By value.
6.
To change the default layered navigation
setting, do the following:
a.
Clear the Use Config Settings checkbox.
b.
Enter the value to be used as an incremental price step for layered navigation.
7.
Tap
Save
and continue.
Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories Creating Categories
Display Settings
Step 5:
Complete the Search Engine Optimization Settings
1.
Expand the Search Engine Optimization Settings section.
2.
Enter a URL Key for the category, or let the system automatically create one that is based on the category name.
3.
Complete the following
for the category: l
Meta Title l
Meta Keywords l
Meta Description
4.
Tap
Save
and continue.
Search Engine Optimization
Magento Community Edition 2.1 User Guide 291
Creating Categories CHAPTER 17: Categories
Step 6:
Choose the Products in Category
1.
Expand the Products in Category section. Then, use one of the following methods to add products to the category.
2.
Use the
as needed to find the products.
To display all records that are not yet included in the category, set the record chooser in the first column to "No." Then, click Search.
3.
In the first column, mark the checkbox of each product to include in the category.
292
Selected Products
4.
Tap
Save
and continue.
Step 7:
Complete the Design Settings
1.
Expand the Design section.
2.
To change the design of the category pages, choose the Theme that you want to apply.
3.
To change the column layout of the cateogry pages, choose the Layout that you want to apply.
4.
To enter custom code, enter valid XML code in the Layout Update XML box.
Design
Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories
5.
To schedule the design update for a specific time period, do the following:
a.
Expand the Schedule Design Update section.
b.
Use the calendar to choose the Schedule Update From and To dates.
Creating Categories
6.
When complete, tap
Save
.
Design
Magento Community Edition 2.1 User Guide 293
Creating Categories CHAPTER 17: Categories
Root Categories
The products in the main menu are determined by the
that is assigned to the store. The root category is basically a container for the main menu. You can create a new catalog with an entirely new set of products, or copy products from an existing catalog. The catalog can be assigned to the current store, or to any other store in the same website.
294
From the Admin, the category structure is like an upside-down tree, with the root on top. The root has a name, but no URL key, and does not appear in the
of the store. All other categories in the menu are nested below the root. Because the root category is the highest level of the catalog, your store can have only one root category active at a time. You can, however, create additional root categories for alternate catalog structures, different stores, and views.
The following example shows how to create a new root category and assign it to a different store.
Process Overview:
Step 1:
Step 2:
Step 3:
Assign the Root Category to the Store
Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories Creating Categories
Step 1:
Create a New Root Category
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2.
In the panel on the left, tap
Add Root Category
.
New Root Category
3.
Assign a Category Name.
The name you choose will initially be assigned to all store views.
4.
If you want to add products to the catalog from the current catalog, do the following:
a.
Expand the Products in Category section.
b.
Use the
to find the products you want. Then, mark the checkbox of each product that you want to copy into the new catalog.
5.
When complete, tap
Save
.
Step 2:
Build Out the Main Menu
1.
In the panel on the left, select the new root category that you created in the previous step.
2.
Tap
Add Subcategory
. Then, follow the instructions to create the
for the main menu.
Magento Community Edition 2.1 User Guide 295
Creating Categories CHAPTER 17: Categories
Step 3:
Assign the Root Category to the Store
1.
On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.
2.
In the Stores column of the grid, click the store that you want to assign the new catalog.
3.
Set Root Category to the new root category that you created.
4.
Make sure that the store has a Default Store View assigned. The store must have at least one
5.
When complete, tap
Save Store
.
6.
To verify that the store has a new catalog, do the following:
a.
On the Admin sidebar, tap Products. Then, choose Catalog.
Any products that were copied to the new catalog appear in the grid.
b.
Visit the storefront to verify that the new catalog and main menu are working correctly.
296 Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories Creating Categories
Hidden Categories
There are many ways to use hidden categories. You might want to create additional category levels for your own internal purposes, but show only the higher-level categories to your customers. Or, you might want to link to a category that is not included in the navigation menu.
To create hidden categories:
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2.
In the category tree, select the category you want to hide. Then, do the following:
a.
Set Is Active to “Yes.”
b.
Set Include in Menu to “No.”
3.
In the Display Settings section, set Anchor to “No.”
The hidden category is active, but does not appear in the top menu, or in layered navigation.
4.
Although the category is hidden, you can still create subcategories beneath it, and make them active. Complete the following settings for each hidden subcategory:
a.
Set Enable Category to “Yes.”
b.
In the Display Settings section, set Anchor to “Yes.”
As active categories, you can now link to them from other places in your store, but they will not appear in the menu.
5.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide 297
Content Settings CHAPTER 17: Categories
Content Settings
The Content settings determines any additional content that is to appear on the category page.
In addition to the list of category products, the page can include an image, text description, and CMS block.
Category Content
Field Descriptions
FIELD
Category Image
Description
Add CMS Block
SCOPE DESCRIPTION
Store View Uploads an image that appears at the top of the category page.
Upload
Uploads an image for the category page.
Store View Enter a description of the category content.
WYSIWYG Editor
Toggles the editor between
WYSIWYG and HTML modes.
Store View Adds an existing
to the category page.
298 Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories Display Settings
Display Settings
The Display Settings determine which content elements appear on a category page and the order in which products appear. You can enable CMS blocks, set the anchor status of the category, and manage sorting options from the Display Settings tab.
Display Settings
Field Descriptions
FIELD
Display Mode
Anchor
Available Product Listing
Sort By
Default Product Listing
Sort By
Layered Navigation Price
Step
DESCRIPTION
Determines the content elements displayed on the category page.
Options:
Products Only
Static Block Only
Static Block and Products
When set to “Yes,” includes the “filter by attribute” section in the layered navigation. Options: Yes / No
(Required) The default values are Position, Name, and Price. To customize the sorting option, clear the Use All Available Attributes checkbox and select the attributes you want to use. You can define and add attributes as needed.
(Required) To define the default “Sort By” option, clear the “Use
Config Settings” checkbox and select an attribute.
By default, Magento displays the price range in increments of 10,
100, and 1000, depending on the products in the list. To change the
Price Step range, clear the “Use Config Settings” checkbox.
Magento Community Edition 2.1 User Guide 299
Search Engine Optimization CHAPTER 17: Categories
Search Engine Optimization
The Search Engine Optimization section specifies the
and
fields that are used by search engines to index the category. Although some search engines ignore meta keywords, others continue to use them. The current
is to incorporate highvalue keywords in both the meta title and meta description.
Search Engine Optimization
Field Descriptions
FIELD
URL Key
Meta Title
Meta Keywords
DESCRIPTION
Store View Determines the online address of the category page.
The URL key is added to the base URL of the store, and appears in the address bar of a browser. In the configuration, you can either include or exclude the category URL key in the product URL.
The URL Key should be all lowercase characters, with hyphens instead of spaces. Do not include a suffix such as .html, because it is managed in the configuration.
Store View The title appears in the title bar and tab of your browser, and is also the title on a search engine results page (SERP
1
). The meta title should be unique to the page, and less than 70 characters in length.
Store View Relevant keywords for the category Consider using keywords that customers might use to find products in the category.
300
1Search Engine Results Page
Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories Products in Category
Field Descriptions (cont.)
FIELD
Meta Description
DESCRIPTION
Store View The meta description provides a brief overview of the page for search results listings. An ideal length is between 150-160 characters in length, with a maximum of 255 characters. Although not visible to the customer, some search engines include the meta description on the search results page.
Products in Category
The Products in Category section lists the products that are currently assigned to the category.
The search filters at the top of each column are used to add and remove products from the category.
Controls
FIELD
Selection
Search Filters
Reset Filter
Search
Magento Community Edition 2.1 User Guide
Category Products
DESCRIPTION
The checkbox in the header of the first column can be used to select or deselect all products.
The control in the first row determines the type of search, and can be set to include any record, or only those that are either assigned or not assigned to the category. The checkbox in the first column of each row identifies products to be added to the category. Options: Yes /
No / Any
The
at the top of each column can be used to enter specific values you want to either include or omit from the list, depending on the Select All setting.
Clears all search filters.
Searches the catalog based on the filter criteria, and displays the result.
301
Design Settings CHAPTER 17: Categories
Design Settings
The Design section gives you control over the look and feel of a category and all assigned product pages, and page layout. You can customize a category page its assigned products for a promotion or to differentiate the category. For example, you might develop distinctive design for a brand or special line of products, or apply an update for a specific period of time.
Custom Design
The Scheduled Update section determines the range of dates when a custom design is applied to category pages.
Scheduled Design Update
302 Magento Community Edition 2.1 User Guide
CHAPTER 17: Categories Design Settings
Field Descriptions
FIELD
Use Parent Category
Settings
Theme
Layout
DESCRIPTION
Allows the current category to inherit the design settings from the parent category. Options: Yes / No
Applies a custom theme to the category.
Applies a different layout to the category page. Options:
No layout updates Preselected by default, and does not apply layout changes to the category page.
Empty
1 column
Use to define your own page layout.
(Requires an understanding of XML.)
Applies a one-column layout to the category page.
2 columns with left bar
Applies a two-column layout with a left sidebar to the category page.
2 columns with right bar
3 columns
Applies a two-column layout with a right sidebar to the category page.
Applies a three-column layout to the category page.
Updates the theme layout with custom XML code.
Apply Design to Products When selected, applies the custom settings to all products in the category.
SCHEDULED DESIGN UPDATE
Schedule Update From/To Determines the range of dates when a custom layout is applied to the category.
Magento Community Edition 2.1 User Guide 303
304 Magento Community Edition 2.1 User Guide
CHAPTER 18:
Using Product Attributes
Attributes are the building blocks of your product catalog, and describe specific characteristics of a product. Attributes determine the type of input control that is used for product options, provide additional information for product pages, and are used as search parameters and criteria for layered navigation, product comparison reports, and promotions. You can create as many attributes as you need to describe the products in your catalog. Other attributes such as price, are built into the core Magento platform and are referred to as “system attributes.”
Creating a New Attribute While Editing a Product
Magento Community Edition 2.1 User Guide 305
Adding an Attribute CHAPTER 18: Using Product Attributes
Adding an Attribute
Although attributes are managed from the Stores menu, you can also add new attributes “on the fly” while working on a product. You can choose from the list of existing attributes, or create a new attribute. The new attribute is added to the
upon which the product is based.
306
Add Attribute
Process Overview:
Step 2: Describe the Basic Properties
Step 3: Describe the Advanced Properties
Step 5: Describe the Frontend Properties
Step 1:
Add a New Attribute
1.
Open the product in edit mode. Then in the upper-right corner, tap
Add Attribute
.
New Attribute
Magento Community Edition 2.1 User Guide
CHAPTER 18: Using Product Attributes Adding an Attribute
2.
To add an existing attribute to the product, use the
to find the attribute in the grid. Then, do the following:
a.
Mark the checkbox in the first column of each attribute to be added.
b.
Tap
Add Selected
.
3.
To define a new attribute, tap
Create New Attribute
, and complete the following steps.
Step 2:
Describe the Basic Properties
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
2.
Tap
Add New Attribute
.
3.
Under Attribute Properties, enter a Default Label to identify the attribute.
4.
Set Catalog Input Type for Store Owner to the type in
to be used for data entry.
If the attribute is used for a
, choose “Dropdown.” Then, set Required to
“Yes.”
5.
For Dropdown and Multiple Select input types, do the following:
a.
Under Values, tap
Add Value
.
b.
Enter the first value that you want to appear in the list. You can enter one value for the
Admin, and a translation of the value for each store view. If you have only one store view, you can enter only the Admin value and it will be used for the storefront as well.
c.
Tap
Add Value
and repeat the previous step for each option that you want to include in the list.
d.
Select Is Default to use the option as the default value.
Magento Community Edition 2.1 User Guide 307
Adding an Attribute CHAPTER 18: Using Product Attributes
Values
6.
If you want to require the customer to choose an option before the product can be purchased, set Required to “Yes.”
Step 3:
Describe the Advanced Properties
(if needed)
1.
Enter a unique Attribute Code in lowercase characters, and without spaces.
308
Advanced Attribute Properties
2.
Set Scope to indicate where in your store hierarchy the attribute can be used.
If the attribute is used for a
configurable product , choose “Global.”
3.
If this attribute applies only to this product, set Unique Value to “Yes.”
4.
To run a validity test of any data entered into a text field, set Input Validation for Store Owner to the type of data that the field should contain. This field is not available for input types with values that are selected. Input validation can be used for any of the following: l
Decimal Number l
Integer Number l
Magento Community Edition 2.1 User Guide
CHAPTER 18: Using Product Attributes l
URL l
Letters l
Letters (a-z, A-Z) or Numbers (0-9)
Adding an Attribute
Input Validation
5.
If you want to be able to include the attribute as a column in the Products grid, set Add to
Column Options
to “Yes.”
6.
If you want to be able to filter the Products grid by this column, set Use in Filter Options to
“Yes.”
Step 4:
Enter the Field Label
1.
Expand the Manage titles section.
2.
Enter a Title to be used as a label for the field. If your store is available in different languages, you can enter a translated title for each view.
Manage Titles
Step 5:
Describe the Storefront Properties
1.
Expand the Storefront Properties section. Then, do the following:
a.
To make the attribute available for search, set Use in Search to “Yes.”
b.
To include the attribute in Product Compare, set Comparable on Storefront to “Yes.”
c.
To include dropdown, multiple select, or price attributes in layered navigation, set Use in
Search Results Layered Navigation
to one of the following:
Magento Community Edition 2.1 User Guide 309
Adding an Attribute CHAPTER 18: Using Product Attributes
Filterable (with results)
Filterable (no 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.
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.
d.
To use in layered navigation on search results pages, set Use in Search Results
Navigation
to “Yes.”
e.
In the Position field, enter a number to indicate the relative position of the attribute in the layered navigation block.
f.
To use the attribute in price rules, set Use for Promo Rule Conditions to “Yes.”
g.
To allow the text to be formatted with HTML, set Allow HTML Tags on Storefront to
“Yes.”
This setting makes the WYSIWYG editor available when editing the field.
h.
To include the attribute on the product page, set Visible on Catalog Pages on Storefront to “Yes.”
2.
Complete the following settings as supported by your theme:
a.
To include the attribute in product listings, set Used in Product Listing to “Yes.”
b.
To use attribute as a sort parameter for product listings, set Used for Sorting in Product
Listing
to “Yes.”
3.
When complete, tap
Save Attribute
.
310 Magento Community Edition 2.1 User Guide
CHAPTER 18: Using Product Attributes Attribute Input Types
Storefront Properties
Attribute Input Types
When viewed from the Admin, attributes are the fields that you complete when you create a product. The input type that is assigned to an attribute determines the type of data that can be entered and the format of the field or input control. From the standpoint of the customer, attributes provide information about the product, and are the options and data entry fields that must be completed to purchase a product.
Attribute Input Types
PROPERTY
Text Field
DESCRIPTION
A single line input field for text.
Text Area
Date
Yes/No
A multiple-line input field for entering paragraphs of text such as a product description. You can use the WYSIWYG Editor to format the text with HTML tags, or type the tags directly into the text.
Date values can be entered by making a selection from a drop-down list, or popup calendar . Depending on your system configuration, dates can be typed directly into a field, or selected from the calendar or list. To format date and time values, see:
.
Displays a drop-down list with pre-defined options of “Yes” and “No.”
Magento Community Edition 2.1 User Guide 311
Attribute Input Types CHAPTER 18: Using Product Attributes
Attribute Input Types (cont.)
PROPERTY DESCRIPTION
Dropdown Displays a drop-down list of values. Only one item can be selected at a time. The Dropdown input type is a key component of
.
Multiple Select
Price
Media Image
Displays a drop-down list of values. To select more than one option, hold the Ctrl key down and click each item.
This input type is used to create price fields that are in addition to the predefined attributes, Price, Special Price, Tier Price and Cost. The currency used is determined by your system configuration.
Associates an additional image with a product, such as a product logo, care instructions, or ingredients from a food label. When you add a media image attribute to the attribute set of a product, it becomes an additional image type, along with Base, Small, and
Thumbnail. The media image attribute can be excluded from the
Lets you define FPT rates based on the requirements of your locale.
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.
A text-based representation of a configurable product option that is frequently used for size. Text swatches can also include hexadecimal color values.
312 Magento Community Edition 2.1 User Guide
CHAPTER 18: Using Product Attributes Attribute Input Types
Date & Time Options
You can customize the format of date and time fields, and select the input control that is used for data entry. Dates values can be selected from a drop-down list, or pop-up calendar.
Pop-up Calendar
Magento Community Edition 2.1 User Guide 313
Attribute Input Types CHAPTER 18: Using Product Attributes
To format date/time fields:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, tap Catalog. Then, choose the Catalog option.
3.
Expand the Date & Time Custom Options section.
4.
To use a popup calendar as the input control for date fields, set Use JavaScript Calendar to
“Yes.”
5.
To establish the Date Fields Order, do the following:
a.
Clear the Use system value checkbox.
b.
Set the order of each part of the date field as needed: l
Month l
Day l
Year
c.
To set your preferred time format, do the following:
d.
Clear the Use system value checkbox.
e.
Set Time Format to one of the following: l
12h AM/PM l
24h
f.
To establish the Year Range for the drop-down values, enter the year in YYYY format to set the from and to dates. If blank, the field defaults to the current year.
314
Date & Time Custom Options
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
MARKETING
315
316
Contents
In this section of the guide, you’ll learn how to leverage your store's built-in shopping tools to create opportunities for customer engagement, and how to set up targeted promotions with price rules. Leverage multiple sales channels by sending your product feeds to shopping sites and marketplaces. Then, use Google tools to analyze traffic, optimize your content, and plan your next campaign.
Recently Viewed / Compared Products
CHAPTER 19:
Marketing Menu
The Marketing menu provides access tools for managing promotions, communications,
SEO, and user-generated content.
Marketing Menu
To display the Marketing menu:
On the Admin sidebar, tap
Marketing
.
Magento Community Edition 2.1 User Guide 317
318
CHAPTER 19: Marketing Menu
Promotions
Create catalog and cart price rules that trigger discounts based on a variety of conditions. Set up promotions that spring into action when the required conditions are met.
Communications
Customize all notifications sent from your store.
Create newsletters and publish RSS feeds.
SEO & Search
Analyze search terms to help customers find products in the store, manage meta data, and create a site map. Use redirects to manage URL changes and avoid broken links.
User Content
Leverage user-generated product reviews to create a sense of community, and increase sales.
Magento Community Edition 2.1 User Guide
CHAPTER 20:
Shopping Tools
Your store includes a set of shopping tools that create opportunities for customers to interact with your store, and share the experience with friends.
Magento Community Edition 2.1 User Guide
Product Page
319
Opportunities to Engage CHAPTER 20: Shopping Tools
Opportunities to Engage
Email a Friend
The Email a Friend link makes it easy for your customers to share links to products with their friends.
Wish List
A wish list is a list of products that a registered customer can share with friends, or save to transfer to the cart at a later date.
Compare Products
The Compare Products block lets your customers quickly compare the features of one product with another.
Product Reviews
Product reviews help build a sense of community, and are considered to be more credible than any advertising money can buy.
320 Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools Email a Friend
Email a Friend
The Email a Friend link makes it easy for your customers to share links to products with their friends. In the Magento demo store, the Email a Friend link appears as an envelope icon. The message template can be customized for your voice and brand. To prevent spamming, you can limit the number of recipients for each email, and the number of products that can be shared over a one-hour period.
Email a Friend
To configure Email a Friend:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Email to a Friend.
3.
Expand the Email Templates section. Then, do the following:
Magento Community Edition 2.1 User Guide 321
Email a Friend CHAPTER 20: Shopping Tools
Email Templates
a.
Set Enabled to “Yes.”
b.
Set Select Email Template to the template you want to use as the basis of the messages.
c.
If you want to require that only registered customers can send email to friends, set Allow
for Guest
s to “No.”
d.
In the Max Recipients field, enter the maximum number of friends who can be on the distribution list for a single message.
e.
In the Max Products Sent in 1 Hour field, enter the maximum number of products that can be shared by a single user with friends over a one-hour time period.
f.
Set Limit Sending By to one of the following methods to identify the sender of emails:
IP Address
Cookie (unsafe)
(Recommended) Identifies the sender by the IP address of the computer that is used to send the emails.
Identifies the sender by browser cookie. This method is less effective because the sender can delete the cookie to bypass the limit.
4.
When complete, tap
Save Config
.
322 Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools Email a Friend
To send email to a friend:
1.
On a catalog page, click the Email a Friend link. Then, do one of the following: l
Log in to your customer account.
l
Sign up for a new account.
2.
Complete the Message and enter the recipient Name and Email Address. To add more recipients, do the following:
a.
Tap
Add Invitee
.
b.
Enter the Name and Email Address of the additional person.
You can send the message to as many additional people as the configuration allows.
3.
When ready to send the message, tap
Send Email
.
Email a Friend Form
Magento Community Edition 2.1 User Guide 323
Wish List CHAPTER 20: Shopping Tools
Wish List
A wish list is a list of products that a registered customer can share with friends, or save to transfer to the cart at a later date. When wish lists are enabled, the Add to Wishlist link appears on the category and product pages of each product in the store. Depending on the theme, it might be a text link or a graphic image.
Shared wish lists are sent from a store email address, but the body of the message contains a personalized note from the customer. You can customize the email template that is used when wish lists are shared, and choose the store contact that appears as the sender.
Wish lists can be updated from the dashboard of the
, Items can be added or transferred between the wish list and cart by the customer or by the store administrator.
324
Wishlist in Customer Account
When a product with multiple options is added to a wish list, any options that have been selected by the customer are included in the wish list item description. For example, if the customer adds the same pair of shoes, but in three different colors, each pair appears as a separate wish list item. On the other hand, if the customer adds the same product to the wish list multiple times, the product appears only once, but with an updated quantity that reflects the number of times the product was added.
Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools Wish List
Configuring the Wish List
The configuration enables wish lists, and determines the email template and sender of email messages that are used when a wish list is shared.
To configure the wish list:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Customers, choose Wish List.
3.
Expand the General Options section. Then, verify that Enabled is set to “Yes.”
4.
Expand
General Options
the Share Options section. Then, do the following:
Share Options
a.
Set Email Sender to the store contact that appears as the sender of the message.
b.
Set Email Template to the template to be used when a customer shares a wish list.
c.
To limit the number of emails a customer can send in a batch, enter the Max Emails
Allowed to be Sent
. The default value is 10, and the maximum allowed is 10,000.
d.
To limit the size of the message, enter the Email Text Length Limit. The default value is
255.
Magento Community Edition 2.1 User Guide 325
Wish List CHAPTER 20: Shopping Tools
5.
Expand following: the My Wish List Link section. Then, set Display Wish List Summary to one of the l
Display number of items in wish list l
Display item quantities
6.
When complete, tap
Save Config
.
My Wish List Link
326 Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools
Sharing a Wish List
Customers can manage their wish lists from the dashboard of their accounts. Store administrators can also help customers manage their wish lists from the Admin.
Wish List
Customer Dashboard with Wish List
To share your wish list:
1.
In the panel on the left of your customer account dashboard, choose My Wish List.
2.
To add a comment to a specific item, hover over the image. Then type your Comment in the box.
3.
To share your wish list, do the following:
a.
Tap
Share My Wish List
.
b.
Enter the email address of each recipient, separated by a comma.
c.
Enter a Message for the body of the email.
4.
When you’re ready to send the message, tap
Share Wish List
.
Magento Community Edition 2.1 User Guide 327
Wish List CHAPTER 20: Shopping Tools
328
Customer Dashboard with Wish List
To transfer an item to your cart:
1.
To add a single item, do the following:
a.
Hover over the item.
b.
Enter the Qty that you want to add to the cart.
c.
Tap Add to Cart.
2.
To transfer all wish list items to the cart, tap
Add All to Cart
.
Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools Product Relationships
Product Relationships
Products in your catalog can be promoted on other pages by defining the nature of the relationship between the products. The options available are: Up-sell products, Related products, and Cross-sell products.
Related Products
Related products are meant to be purchased in addition to the item the customer is viewing. They complement, enhance, or add optional features to the product.
Up-sells
Up-sell products are items that are similar, but are perhaps of a higher-quality, more popular, or have a better profit margin than the item the customer is considering.
Cross-sells
Cross-sell products are offered on the shopping cart page as last-minute purchases before the checkout process begins.
Magento Community Edition 2.1 User Guide 329
Compare Products CHAPTER 20: Shopping Tools
Compare Products
Compare Products generates a detailed, side-by-side comparison of two or more products. You can customize the report to include additional attributes or remove ones that you don’t want to include. Depending on the theme, the Add to Compare link might be represented by an icon or text.
330
Compare Products
To compare products:
1.
From your storefront, find the products that you want to compare, and click the Compare link for each.
2.
Depending on the theme and page layout, there might be a Compare Products block in the sidebar. If so, you can mark the checkbox of the products to include in the report, and tap
Compare
. The Compare Products report opens in a new window.
3.
To print the report, tap
Print This Page
.
4.
After navigating to other pages, you can click the link in the header or sidebar to return to the report.
l
To remove a single product from the report, tap Delete .
l
To remove all products from the report, click the Clear All link.
Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools Compare Products
Magento Community Edition 2.1 User Guide
Compare Products
331
Recently Viewed / Compared Products CHAPTER 20: Shopping Tools
Recently Viewed / Compared Products
The Recently Viewed and Recently Compared blocks usually appear in the right sidebar of a catalog page. The number of products listed in each block can be configured for each website, store, or store view.
To configure Recently Viewed/Compared Products:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Recently Viewed/Compared Products section. Then, do the following:
Recently Viewed/Compared Products
a.
Set Show for Current to the website, store, or store view where the configuration applies.
b.
In the Default Recently Viewed Products Count field, enter the number of recently viewed products to appear in the list.
c.
In the Default Recently Compared Products Count, enter the number of recently compared products to appear in the list.
4.
When complete, tap
Save Config
.
332 Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools Product Reviews
Product Reviews
Product reviews help to build a sense of community, and are considered more credible than any advertising money can buy. In fact, some search engines give sites with product reviews a higher ranking than those without. For those who find your site by searching for a specific product, a product review is essentially the landing page of your store. Product reviews help people find your store, keep them engaged, and often lead to sales.
The configuration determines whether customers must open an account with your store before writing product reviews, or if they can submit reviews as guests. Requiring reviewers to open an account prevents anonymous submissions, and improves the quality of reviews.
Add Your Review
Customers can write reviews for any product in your catalog. Reviews can be written from the product page by clicking the “Add Your Review” link. For products that haven't been reviewed, the link says, “Be the first to review this product.” The Reviews tab lists all current reviews, and the form that is used to submit a review.
The number of stars indicates the satisfaction rating. Visitors can click the link to read the reviews and write their own. As an incentive, customers can receive reward points for submitting a review. When a review is submitted, it is sent to the Admin for moderation. When approved, the review is published in your store.
Magento Community Edition 2.1 User Guide 333
Product Reviews CHAPTER 20: Shopping Tools
334
Reviews Tab
To configure product reviews:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Catalog, select Catalog.
3.
Expand the Product Reviews section.
4.
Set Allow Guests to Write Reviews according to your preference.
5.
When complete, tap
Save Config
.
To moderate reviews:
1.
On the Admin sidebar, tap Marketing. Then under User Content, choose Reviews.
2.
In the list, click a pending review to view the details, and edit if necessary.
3.
To approve a pending review, change the Status from “Pending” to “Approved.” To reject a review, select “Not Approved.”
4.
When complete, tap
Save Review
.
Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools Product Reviews
Product Ratings
When customers review a product, the default ratings are quality, price, and value. In addition to these, you can add your own custom ratings. The five-star ratings that appear on catalog pages are averaged for each product.
Ratings
To create your own ratings:
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Ratings.
2.
In the upper-right corner, tap
Add New Rating
.
Magento Community Edition 2.1 User Guide 335
Product Reviews CHAPTER 20: Shopping Tools
Ratings
3.
In the Rating Title section, enter the Default Value for the new rating. If applicable, enter the translation for each store view.
336
Rating Title
4.
In the Rating Visibility section, set Visibility In to the store view where the rating is to be used.
(Hold down the Ctrl key to select multiple options.)
Ratings are not visible unless assigned to a store view.
5.
In the Sort Order field, enter a number to determine the order of this rating when listed with others.
Magento Community Edition 2.1 User Guide
CHAPTER 20: Shopping Tools
6.
When complete, tap
Save Rating
.
Rating Visibility
Product Reviews
Magento Community Edition 2.1 User Guide 337
338 Magento Community Edition 2.1 User Guide
Promotions
339
340
Contents
In this section of the guide, you will learn how to set up product relationships, and use price rules to trigger discounts based on a variety of conditions. You can use price rules to offer customer incentives, such as to: l
Send your best customers a coupon for a discount on a specific product l
Offer free shipping for purchases over a certain amount l
Schedule a promotion for a period of time
Discount with Minimum Purchase
CHAPTER 21:
Catalog Price Rules
Catalog price rules can be used to selectively offer products at a discounted price, based on a set of conditions. Catalog price rules do not use coupon codes, because they are triggered before a product is placed into the shopping cart.
Catalog Rules
Magento Community Edition 2.1 User Guide 341
Creating a Price Rule
Creating a Price Rule
Process Overview:
Step 1:
Step 2:
Step 3:
Step 4:
CHAPTER 21: Catalog Price Rules
Step 1:
Add a New Rule
1.
On the Admin sidebar, tap Marketing. Then under Promotions, choose Catalog Price Rule.
2.
In the upper-right corner, tap
Add New Rule
.
The form opens to the Rule Information section, with expandable sections below for Conditions and Actions.
342
Rule Information
3.
In the Rule Information section, do the following:
Magento Community Edition 2.1 User Guide
CHAPTER 21: Catalog Price Rules Creating a Price Rule
a.
Complete the Rule Name and Description fields. These fields are for your internal reference only.
b.
Select the Websites where the rule is to be available.
c.
Set the Status of the price rule as needed. By default, the status is "Active."
d.
Select the Customer Groups to which this rule applies.
To choose multiple groups, hold down the Ctrl key, and click each option.
e.
Enter the From and To dates to determine when the price rule is in effect. You can either enter the dates, or choose the dates from the Calendar .
l
If you leave the dates blank, the rule is enabled as soon as the price rule is saved.
f.
Enter a number to establish the Priority of this rule in relation to other rules.
Step 2:
Define the Conditions
Most of the available conditions are based upon existing attribute values. To apply the rule to all products, leave the conditions blank.
1.
Scroll down to Conditions, and expand the section. The first rule begins:
Condition - Line 1
The statement has two bold links, which when tapped, display the options for that part of the statement. If you save the condition without making additional selections, the rule applies to all products.
l
Tap the ALL link, and chose either “ALL” or “ANY.” l
Tap the TRUE link, and choose either “TRUE” or “FALSE.” l
To apply the rule to all products, leave the condition unchanged.
You can create different conditions by changing the combination of these values. For this example, the following condition is used:
If ALL of these conditions are TRUE:
2.
Tap the Add button at the beginning of the next line.
Magento Community Edition 2.1 User Guide 343
Creating a Price Rule CHAPTER 21: Catalog Price Rules
a.
In the list under Product Attribute, choose the attribute that you want to use as the basis of the condition. For this example, the condition is "Attribute Set.”
Condition Line 2, Part 1
For an attribute to appear in the list, it must be configured to be used in promo rule conditions.
To learn more, see:
.
The selected condition appears in the statement, followed by two more bold links. The statement now says:
If ALL of these conditions are TRUE:
Attribute Set is …
b.
Tap the is link, and choose the comparison operator that describes the condition to be met. In this example, the options are “is” and “is not.”
c.
Tap the ... “more” link, and choose the attribute set upon which the condition is based.
344
Condition Line 2, Part 3
The selected item appears in the statement to complete the condition.
If ALL of these conditions are TRUE:
Attribute Set is Default
3.
To add another line to the statement, tap the Add l
Conditions Combination l
Product Attribute button, and choose one of the following:
Then, repeat the process until the condition is complete.
Magento Community Edition 2.1 User Guide
CHAPTER 21: Catalog Price Rules Creating a Price Rule
If at any time you want to delete part of the statement, tap the Delete the line.
button at the end of
Step 3:
Define the Actions
1.
Expand the Actions section, and do the following:
Actions
2.
Under Pricing Structure Rules, set Apply to one of the following:
Apply as percentage of original
Apply as fixed amount
Adjust final price to this percentage
Adjust final price to discount value
Discounts item by subtracting a percentage from the original price. For example:
Enter 10 in Discount Amount for an updated price that is 10% less than the original price.
Discounts item by subtracting a fixed amount from original price. For example:
Enter 10 in Discount Amount for an updated price that is $10 less than the original price.
Discounts item by defining the final price based on percentage. For example:
Enter 10 in Discount Amount for an updated price that is 10% of the original price.
Sets the price to a fixed amount.
Magento Community Edition 2.1 User Guide 345
Creating a Price Rule CHAPTER 21: Catalog Price Rules
3.
Enter the Discount Amount.
4.
To stop processing other rules after this rule is applied, set Discard Subsequent Rules to
“Yes.” This safeguard prevents customers from receiving multiple discounts for the same product.
5.
Tap Save and Continue Edit.
346
Pricing Structure Rules
Step 4:
Test the Rule
When you create a new price rule, it might take an hour or so to become available. Make sure to allow enough time for it to get into the system. Then, test the rule to make sure that it works correctly. Unless otherwise specified, price rules are automatically processed with other system rules each night.As new rules are added, Magento recalculates the prices and the priorities accordingly.
Field Descriptions
FIELD DESCRIPTION
RULE INFORMATION
Rule Name
Description
Websites
Customer Groups
From
(Required) The name of the rule is for internal reference.
A description of the rule should include the purpose of the rule, and explain how it is used.
(Required) Identifies the websites where the rule can be used.
(Required) Identifies the customer groups to which the rule applies.
Specifies the first day the price rule is in effect. If left blank, the price rule goes into effect as soon as it is saved.
Magento Community Edition 2.1 User Guide
CHAPTER 21: Catalog Price Rules Creating a Price Rule
Field Descriptions (cont.)
FIELD
To
DESCRIPTION
Specifies the last day the price rule is in effect. If left blank, the price rule continues indefinitely.
Priority A number that indicates the priority of this rule in relation to others.
The highest priority is number 1.
ACTIONS
Apply Determines the type of calculation that is applied to the purchase.
Options:
Apply as percentage of original
Applies the discount amount as a percentage of the original price.
Apply as fixed amount
Applies the discount amount as a fixed amount less than the original price.
Adjust final price to this percentage
Adjusts the final price by a percentage based on the discount amount.
Adjust final price to discount value
Uses the discount amount as the product price.
Discount Amount (Required) The amount of discount that is offered.
Discard Subsequent Rules Determines if additional rules can be applied to this purchase. To prevent multiple discounts from being applied to the same purchase, select “Yes.” Options: Yes / No
Magento Community Edition 2.1 User Guide 347
Price Rule with Multiple SKUs CHAPTER 21: Catalog Price Rules
Price Rule with Multiple SKUs
A single price rule can be applied to multiple SKUs, which makes it possible to create a variety of promotions based on a product, brand, or category.
Step 1:
Verify Storefront Properties of Attribute
Before you begin, make sure that the Storefront Properties of the SKU attribute are set to "Use in Promo Rules."
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
2.
In the search filter at the top of the Attribute Column, enter "sku." Then, tap
Search
.
3.
Click to open the attribute in edit mode.
4.
In the panel on the left, choose Storefront Properties. Then, make sure that Use for Promo
Rule Conditions
is set to "Yes,"
5.
If you changed the value of the property, tap
Save Attribute
.
Step 2:
Apply a Price Rule to Multiple SKUs
1.
On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.
2.
Do one of the following: l
Follow the instructions to create a
l
Open an existing cart price rule.
3.
Expand the Conditions section, and do the following:
a.
In the first line, set the first parameter to “ANY.”
348
If ANY of these conditions are TRUE
b.
Tap Add choose SKU.
at the beginning of the next line. Then, in the list under Product Attribute,
SKU is …
Magento Community Edition 2.1 User Guide
CHAPTER 21: Catalog Price Rules Price Rule with Multiple SKUs
c.
To complete the condition, click the … “more” link. Then, tap the Chooser button for the list of available products.
Choose Each SKU
d.
In the list, mark the checkbox of each product that is to be included. Then, tap
Save and
Apply
to add the SKUs to the condition.
Multiple SKUs Added to Condition
4.
Complete the rule, including any
to be taken when the conditions are met.
5.
When complete, tap
Save
.
When you create a new price rule, it might take an hour or so to become available. Make sure to allow enough time for it to get into the system. Then, test the rule to make sure that it works correctly. Unless otherwise specified, price rules are automatically processed with other system rules each night.
Magento Community Edition 2.1 User Guide 349
350 Magento Community Edition 2.1 User Guide
CHAPTER 22:
Cart Price Rules
Cart price rules apply discounts to items in the shopping cart, based on a set of conditions. The discount can be applied automatically as soon as the conditions are met, or when the customer enters a valid coupon code. When applied, the discount appears in the cart under the subtotal. A cart price rule can be used as needed for a season or promotion by changing its status and date range.
Apply Coupon in Cart
Magento Community Edition 2.1 User Guide 351
Creating a Cart Price Rule CHAPTER 22: Cart Price Rules
Creating a Cart Price Rule
Complete the following steps to add a new rule, describe the conditions, and define the actions.
Then, complete the labels, and test the rule.
Process Overview:
Step 1:
Step 2:
Step 3:
Step 4:
Step 6:
Step 1:
Add a New Rule
1.
On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.
352
Cart Price Rules
2.
Under Rule Information, complete the Rule Name and Description.
Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Creating a Cart Price Rule
General Information
3.
If you do not want the rule to go into effect immediately, set Active to “No.”
4.
To establish the
of the rule, do the following:
a.
Select the Websites where the promotion is to be available.
b.
Select the Customer Groups to which the promotion applies.
l
For the promotion to be available only to registered customers, do not select the
“NOT LOGGED IN” option.
5.
To associate a
with the price rule, set Coupon to “Specific Coupon.” Then, do the following:
a.
Enter a numeric Coupon Code that the customer must enter to receive the discount.
b.
To set a limit on the number of times the coupon can be used, complete the following:
Magento Community Edition 2.1 User Guide 353
Creating a Cart Price Rule
Uses per Coupon
Uses per Customer
CHAPTER 22: Cart Price Rules
Determines how many times the coupon code can be used.
If there is no limit, leave the field blank.
Determines how many times the coupon code can be used by the same registered customer who belongs to any of the selected customer groups. The setting does not apply to guest shoppers who are members of the NOT LOGGED IN customer group, or to customers who shop without logging in to their accounts. If there is no limit, leave the field blank.
Coupon Settings
6.
Use the Calendar to set the From and To date range for the promotion.
7.
Enter a number to determine the Priority of this price rule in relation to the Action settings of other price rules that might be active at the same time. (Number 1 has the highest priority.)
8.
To apply the rule to published listings in
, set Public In RSS Feed to “Yes.”
354 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Creating a Cart Price Rule
Step 2:
Describe the Conditions
In this step, the conditions are described that must be met for an order to qualify for the promotion. The rule goes into action whenever the set of conditions is met.
Conditions
1.
In the panel on the left, select Conditions. The first rule appears by default, and states:
If ALL of these conditions are TRUE:
The statement has two bold links which when tapped, display the selection of options for that part of the statement. You can create different conditions by changing the combination of these values. Do any of the following: l
Click the ALL link, and select “ALL” or “ANY.” l
Click the TRUE link and select “TRUE” or “FALSE.” l
Leave the condition unchanged to apply the rule to all products.
2.
Click Add at the beginning of the next line. For this example, complete the next part of the condition as follows:
a.
When prompted to Choose the condition to add, choose "Products Subselection."
Products Subselection
b.
When the next part of the condition appears, mouse over the line so you can see where each link with variable values is located.
Magento Community Edition 2.1 User Guide 355
Creating a Cart Price Rule CHAPTER 22: Cart Price Rules
If ALL of thes conditions are TRUE
c.
Click the "more" (...) link, and enter ">100." This condition requires the total quantity of the cart to be greater than 100.
Total Quantity Value
3.
Click Add
Category
.
at the beginning of the next line. Then add a condition that is based on
Category
a.
In the next part of the condition, click the "more" (...) link to display the input field.
Then, open the Chooser to display the category tree.
b.
Mark the checkbox of the category that you want to use as a condition for the price rule.
The condition can be based on any category that is a child of the store’s
.
356 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Creating a Cart Price Rule
Choosing a Category for a Condition
4.
To add more conditions, click Add and define another condition.
You can repeat the process as many times as needed to describe the conditions that must be met for the price rule . Here are some examples:
Example 1:
Regional Price Rule
To create a regional price rule, use one of the following cart attributes: l
Shipping Postcode l
Shipping Region l
Shipping State/Province l
Shipping Country
Example 2:
Shopping Cart Totals
To base the condition on shopping cart totals, use one of the following cart attributes: l
Subtotal l
Total Items Quantity l
Total Weight
Step 3:
Define the Actions
The shopping cart price rule actions describe how prices are updated when the conditions are met.
Magento Community Edition 2.1 User Guide 357
Creating a Cart Price Rule CHAPTER 22: Cart Price Rules
1.
Scroll down to Actions, and expand the section. Then, do the following:
358
Cart Price Rule Actions
a.
Set Apply to one of the following discount options:
Percent of product price discount
Fixed amount discount
Fixed amount discount for whole cart
Buy X get Y free
Discounts item by subtracting a percentage from the original price. The discount applies to each qualifying item in the cart. For example: Enter 10 in Discount Amount for an updated price that is 10% less than the original price.
Discounts item by subtracting a fixed amount from original price. The discount applies to each qualifying item in the cart. For example: Enter 10 in Discount Amount for an updated price that is $10 less than the original price.
Discounts the entire cart by subtracting a percentage from the cart total. For example: Enter 10 in Discount Amount to subtract 10% from the cart total.
Defines a quantity that the customer must purchase to receive a quantity for free. (The Discount Amount is Y.)
b.
Enter the Discount Amount as a number, without symbols. For example, depending on the discount option selected, the number 10 might indicate a percentage, a fixed amount, or a quantity of items.
c.
For a "Buy X get Y Free" discount, enter the quantity in the Discount Qty Step (Buy X) field that the customer must purchase to receive the discount.
d.
In the Maximum Qty Discount is Applied To field, enter the maximum quantity of the same product that can qualify for the discount in the same purchase.
e.
Set Apply to Shipping Amount as follows:
Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Creating a Cart Price Rule
Yes
No
Applies the discount amount to the subtotal and shopping amounts separately.
Applies the discount amount only to the subtotal.
f.
To stop processing other rules after this rule is applied, set Discard Subsequent Rules to “Yes.” This safeguard prevents customers from receiving multiple discounts for the same product.
g.
To extend free shipping for orders that meet the conditions, set Free Shipping to one of the following:
No Free shipping is not available.
For matching items only Free shipping is available only for items that match the conditions of the rule.
For shipment with matching items
Free shipping is available for any shipment that includes matching item(s).
2.
Define as many additional conditions as needed for the action.
3.
When complete, tap
Save and Contnue Edit
.
Step 4:
Complete the Labels
The label appears on the order below the subtotal to identify the discount. You can enter a default label for all store views, or enter a different label for each view.
1.
Scroll down to Labels, and expand the section.
2.
Enter the text that you want used as the Default Rule Label for All Store Views.
Default Label
3.
If your store has multiple views, or multiple websites with multiple views, enter the appropriate label text for each. For example, if each store view is in a different language, enter the translation of the label for each view.
Magento Community Edition 2.1 User Guide 359
Creating a Cart Price Rule CHAPTER 22: Cart Price Rules
Step 5:
Save and Test the Rule
1.
When complete, tap
Save Rule
.
2.
Test the rule to make sure that it works correctly.
When you create a new price rule, it might take an hour or so to become available. Make sure to allow enough time for it to get into the system. Then, test the rule to make sure that it works correctly. Unless otherwise specified, price rules are automatically processed with other system rules each night.As new rules are added, Magento recalculates the prices and the priorities accordingly.
360
Cart Price Rule Saved
Field Descriptions
FIELD
RULE INFORMATION
Rule Name
Description
Status
Websites
DESCRIPTION
(Required) The name of the rule is for internal reference.
A description of the rule should include the purpose of the rule, and explain how it is used.
(Required) Determines if the rule is currently active in the store.
Options: Active / Inactive
(Required) Identifies the websites where the rule can be used.
Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Creating a Cart Price Rule
Field Descriptions (cont.)
FIELD
Customer Groups
DESCRIPTION
(Required) Identifies the customer groups to which the rule applies.
Coupon (Required) Indicates if a coupon is associated with the rule. Options:
No Coupon No coupon is associated with the rule.
Specific Coupon A specific coupon is associated with the rule.
Coupon Code When prompted, enter the Coupon Code that the customer must enter to take advantage of the promotion.
Use Auto
Generation
Select the checkbox to automatically generate multiple coupon codes that can be used with the promotion.
Auto Displays the Coupons Information section to define the format of the coupon codes to be generated.
Uses per Coupon
Uses per Customer
From
To
Priority
Public in RSS Feed
The number of times the coupon code can be used.
Determines how many times the coupon code can be used by the same registered customer who belongs to any selected customer group. Does not apply to guest shoppers who are members of the
NOT LOGGED IN customer group, or to customers who shop without logging in to their accounts. For no limit, leave blank.
The first date the coupon can be used.
The last date the coupon can be used.
A number that indicates the priority of this rule in relation to others.
The highest priority is number 1.
Determines if the promotion is included in your store’s public RSS feed. Options: Yes / No.
ACTIONS
Apply Determines the type of calculation that is applied to the purchase.
Options:
Magento Community Edition 2.1 User Guide 361
Creating a Cart Price Rule CHAPTER 22: Cart Price Rules
Field Descriptions (cont.)
FIELD DESCRIPTION
Percent of product price discount
Fixed amount discount
Fixed amount discount for whole cart
Discounts item by subtracting a percentage from the original price.
For example: Enter 10 in Discount Amount for an updated price that is 10% less than the original price.
Discounts item by subtracting a fixed amount from original price.
For example: Enter 10 in Discount Amount for an updated price that is $10 less than the original price.
Discounts the entire cart by subtracting a fixed amount from the cart total.
For example: Enter 10 in Discount Amount to subtract $10 from the cart total.
Buy X Get Y Free
(discount amount is
Y)
Defines a quantity that the customer must purchase to receive a quantity for free. (The
Discount Amount is Y.)
Discount Amount (Required) The amount of discount that is offered.
Maximum Qty Discount is
Applied To
Sets the maximum number of products that the discount can be applied to in the same purchase.
Discount Qty Step (Buy X) Sets the number of products represented by “X” in a “Buy X Get Y
Free” promotion.
Apply to Shipping Amount Determines if the discount can be applied to the cost of shipping.
Options: Yes / No.
Discard Subsequent
Rules
Determines if additional rules can be applied to this purchase. To prevent multiple discounts from being applied to the same purchase, select “Yes.” Options: Yes / No
Free Shipping Determines if free shipping is included in the promotion, and if so, for which items. Options:
No Free shipping is not available when a coupon that is based on the rule is used.
For matching items only
Free shipping is available only for specific items in the cart that match the rule.
362 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Creating a Cart Price Rule
Field Descriptions (cont.)
FIELD DESCRIPTION
For shipment with matching items
Free shipping is available for the entire cart when a coupon that is based on the rule is used.
LABELS
Default Rule Label for All
Store Views
A default label that identifies the discount and can be used for all store views.
Store View Specific Labels If applicable, a different label that identifies the discount for each store view.
Magento Community Edition 2.1 User Guide 363
Coupon Codes CHAPTER 22: Cart Price Rules
Coupon Codes
Coupons codes are used with
to apply a discount when a set of conditions is met. For example, a coupon code can be created for a specific customer group, or for anyone who makes a purchase over a certain amount. To apply the coupon to a purchase, the customer can enter the coupon code in the cart, or possibly at the cash register of your “brick and mortar” store. Here are a few ways that you can use coupons in your store: l
Email coupons to customers l
Produce printed coupons l
Create in-store coupons for mobile users
Coupon codes can be sent by email, or included in newsletters, catalogs, and advertisements.
The list of coupon codes can be exported and sent to a commercial printer. You can also create in-store coupons with a quick response code that shoppers can scan with their smart phones.
The QR code can link to a page on your site with more information about the promotion.
Method 1:
Create a Specific Coupon
1.
Follow the instructions to create a
2.
On the General Information page, set Coupon to “Specific Coupon.”
a.
Enter a Coupon Code to be used with the promotion.
The format of the code as numeric, alphanumeric or alphabetical is determined by the
.
b.
To limit the number of times the coupon can be used, complete the following: l
Uses per Coupon l
Uses per Customer
For unlimited use, leave these fields blank.
364
Coupon Information
c.
To make the coupon valid for a limited period of time, complete the From and To dates.
To select the date, tap the Calendar range empty, the rule will never expire.
button next to each field. If you leave the date
Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Coupon Codes
3.
Complete the
as needed.
Method 2:
Generate a Batch of Coupons
1.
Follow the instructions to create a
.
2.
Under Coupon Code, mark the Use Auto Generation checkbox.
3.
To limit the number of times each customer can use the coupon, enter the number of Uses per
Customer
.
Generate Auto-numbered Coupons
4.
Scroll down and expand the Manage Coupon Codes section. Then, do the following:
a.
In the Coupons Qty field, enter the number of coupons that you want to generate.
b.
Enter the Code Length, not including the prefix, suffix, or separators.
c.
Set the Code Format to one of the following: l
Alphanumeric l
Alphabetical l
Numeric
d.
(Optional) Enter a Code Prefix to be added to the beginning of the code.
e.
(Optional) Enter a Code Suffix to be added to the end of the code.
f.
(Optional) In the Dash Every X Characters field, enter the number of characters.between
each dash. For example, if the code is twelve characters long, and there is a dash every four characters, it will look like this: xxxx-xxxx-xxxx. Dashes make codes easier to read and enter.
5.
When complete, tap
Generate
. The list of generated codes appears below.
Generated Codes
Magento Community Edition 2.1 User Guide 365
Coupon Codes CHAPTER 22: Cart Price Rules
Configuring Coupon Codes
The length and format of automatically generated coupon codes is controlled by the configuration. The characters can be set to all numbers, all letters, or a combination. You can insert a dash at set intervals to make it easy to read, and add a .prefix and suffix to associate the code iith a specific campaign or initiative.
366
Auto Generated Specific Coupon Codes
To format coupon codes:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Customers, choose Promotions.
3.
In the Auto Generated Specific Coupon Codes section, do the following:
a.
Enter the Code Length, including prefix, sufix, and separators.
b.
Set the Code Format to one of the following: l
Alphanumeric l
Alphabetical l
Numeric
c.
To add a Code Prefix, enter the value that you want to appear at the beginning of all coupon codes.
d.
To add a Code Suffix, enter the value that you want to appear at the end of all coupon codes.
e.
To insert a Dash Every X Characters, enter the number of characters between each dash.
Coupon codes with different dash patterns are considered to be different codes, even if the numbers are the same.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Coupon Codes
Coupons Report
The Coupons Report can be filtered for a specific store view, time period, order status, and price rule.
Coupon Report Filters
To run the report:
1.
On the Admin sidebar, tap Reports. Then under Sales choose Coupons.
2.
If you have multiple store views, set Store View in the upper-left corner to establish the scope of the report.
3.
To refresh the sales
for the day, click the message at the top of the workspace.
4.
To filter the data, do the following:
a.
Set Date Used to one of the following: l
Order Created l
Order Updated
The Order Updated report is created in real-time, and does not require a refresh.
b.
To define the period of time covered by the report, set Period to one of the following: l
Day l
Month l
Year
Magento Community Edition 2.1 User Guide 367
Free Shipping Promotion CHAPTER 22: Cart Price Rules
c.
Enter the From and To dates in M/D/YY format to define the date range of the report.
d.
To print a report for a specific
, set Order Status to “Specified,” Then, choose the order status from the list.
e.
Set omit rows without data from the report, set Empty Rows to “No.”
f.
Do one of the following: l
To include all coupon activity from all price rules, set Cart Price Rule to “Any.” l
To include only activity that is related to a specific price rule, set Cart Price Rule to
“Specified,” Then, select the specific cart price rule in the list.
5.
When ready to run the report, tap
Show Report
. The report appears at the bottom of the page.
Free Shipping Promotion
Free shipping can be offered as a promotion, either with, or without a
. A free shipping coupon, or voucher, can also be applied to customer pick-up orders, so the order can be invoiced and “shipped” to complete the
Some shipping carrier configurations give you the ability of offer free shipping based on a minimum order. To expand upon this basic capability, you can use shopping cart price rules to create complex conditions based on multiple product attributes, cart contents, and customer groups.
Process Overview:
Step 1:
Step 2:
Step 3:
Step 4:
Step 1:
Enable Free Shipping
1.
Enable
in your store’s configuration.
2.
Complete the free shipping settings for any
that you want to use for free shipping.
368 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Free Shipping Promotion
Step 2:
Create a Cart Price Rule
1.
On the Admin sidebar, tap Marketing. Then under Promotions, choose Cart Price Rules.
2.
Follow the steps below to set up the type of free shipping promotion that you want to offer.
Example 1:
Free Shipping for Any Order
1.
Complete the Rule Information as follows:
a.
Enter a Rule Name for internal reference.
b.
Enter a brief Description to describe the rule.
c.
Set Active to “Yes.”
d.
In the Websites box, select each site where the free shipping coupon is to be available.
e.
Select the Customer Groups to which the rule applies.
f.
Set Coupon to one of the following: l
To offer a free shipping promotion without a coupon, accept the default, “No Coupon” setting.
l
To use a coupon with the price rule, select “Specific Coupon.” If necessary, complete the instructions to set up a
2.
Scroll down and expand the Actions section. Then, do the following:
a.
Set Apply to “Percent of product price discount.”
b.
Set Apply to Shipping Amount to “Yes.”
c.
Set Free Shipping to “For shipment with matching items.”
Price Rule Action
Example 2:
Free Shipping for Orders Over $Amount
1.
Complete the General Information settings as described in the previous example.
2.
Scroll down and expand the Conditions section.
Magento Community Edition 2.1 User Guide 369
Free Shipping Promotion CHAPTER 22: Cart Price Rules
3.
Tap Add to insert a condition. Then, do the following:
a.
In the list under Cart Attribute, choose Subtotal.
b.
Click the is link, and choose “equals or greater than.”
c.
Click the … “more” link, and enter a threshold value for the Subtotal, such as 100, to complete the condition.
4.
If necessary, expand
Condition
the Actions. section. Then do the following:
a.
Set Apply to “Percent of product price discount.”
b.
Set Apply to Shipping Amount to “Yes.”
c.
Set Free Shipping to “For shipment with matching items.”
Actions
370 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Free Shipping Promotion
Step 3:
Complete the Labels
Complete
of the cart price rule instructions to enter any labels that appear during checkout.
Step 4:
Save and Test the Rule
1.
When complete, tap
Save Rule
.
2.
Test the rule to make sure that it works correctly.
When you create a new price rule, it might take an hour or so to become available. Make sure to allow enough time for it to get into the system. Then, test the rule to make sure that it works correctly. Unless otherwise specified, price rules are automatically processed with other system rules each night.
Magento Community Edition 2.1 User Guide 371
Buy X Get Y Free CHAPTER 22: Cart Price Rules
Buy X Get Y Free
This example shows how to set up a
for a “Buy X, Get Y Free” promotion. The format of the discount is as follows:
Buy X quantity of product, get Y quantity for free.
Process Overview:
Step 1:
Step 2:
Step 3:
Step 4:
Step 5:
Step 1:
Create a Cart Price Rule
Complete
of the cart price rule instructions to complete the rule information.
Step 2:
Define the Conditions
Complete
of the cart instructions to define the conditions for the price rule. The conditions can be triggered by purchasing a specific product, making a purchase of a certain amount, or any other scenario.
Step 3:
Define the Actions
1.
Expand the Actions section, and do the following:
a.
Set Apply to “Buy X get Y free (discount amount is Y).”
b.
Set Discount Amount to 1. This is the quantity the customer will receive for free.
c.
To limit the number of discounts that can be applied when the condition is met, enter the number in the Maximum Qty Discount is Applied To field. For example, enter “1” to discount only one item.
d.
In the Discount Qty Step (Buy X) field, enter the quantity that the customer must purchase to qualify for the discount. In this example, the customer must purchase two.
e.
To prevent other discounts from being applied to the purchase, set Discard subsequent
rules
to "Yes."
372 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Buy X Get Y Free
Buy X Get Y Free
2.
Tap
Save and Continue Edit
. Then, complete the rest of the rule as needed.
Step 4:
Complete the Label
Complete
of the cart price rule instructions to enter the label that appears during checkout.
Step 5:
Save and Test the Rule
1.
When complete, tap
Save Rule
.
2.
Test the rule to make sure that it works correctly.
When you create a new price rule, it might take an hour or so to become available. Make sure to allow enough time for it to get into the system. Then, test the rule to make sure that it works correctly. Unless otherwise specified, price rules are automatically processed with other system rules each night.
Magento Community Edition 2.1 User Guide 373
Discount with Minimum Purchase CHAPTER 22: Cart Price Rules
Discount with Minimum Purchase
Cart price rules can be used to offer a percentage discount based on a minimum purchase. In the following example, a 25% discount is applied to all purchases over $200.00 in a specific category. The format of the discount is as follows:
X% off all Y (category) over $Z dollars
Process Overview:
Step 1:
Step 2:
Step 3:
Step 4:
Step 5:
Step 1:
Create a Shopping Cart Rule
Follow the basic
to create a cart rule.
Step 2:
Define the Conditions
1.
Scroll down and expand the Conditions section.
2.
Tap Add , and choose Product Attribute Combination.
Product Attribute Combination
3.
Tap Add
Category
.
at the beginning of the next line. Then in the list under Product Attribute, choose
374 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Discount with Minimum Purchase
Category
a.
Click the … “more” link to display additional options.
Category IS
b.
Tap the Chooser button to see the available categories. In the category tree, mark the checkbox of each category that you want to include. Then, press Enter to add the categories to the condition.
Category IS
4.
Tap Add at the beginning of the next line, and do the following:
a.
In the list under Cart Item Attribute, choose Price in cart.
Category IS
a.
Click the is link, and choose “equals or greater than.”
b.
Click the ... “more” link and enter the amount that the Price in Cart must be to meet the condition. For example, enter 200.
Magento Community Edition 2.1 User Guide 375
Discount with Minimum Purchase CHAPTER 22: Cart Price Rules
Enter the Price to Complete the Condition
5.
Tap
Save and Continue Edit
.
Step 3:
Define the Actions
1.
Expand the Actions section, and do the following:
Actions
a.
Set Apply to “Percent of product price discount.”
b.
Enter the Discount Amount. For example, enter 25 for a twenty-five percent discount.
c.
To prevent additional promotions from being applied to the purchase, set Discard
subsequent rules
to “Yes.”
2.
Tap
Save and Continue Edit
. Then, complete the rule as needed.
376 Magento Community Edition 2.1 User Guide
CHAPTER 22: Cart Price Rules Discount with Minimum Purchase
Step 4:
Complete the Labels
Complete
of the cart price rule instructions to enter any labels that appear during checkout.
Step 5:
Save and Test the Rule
1.
When complete, tap
Save Rule
.
2.
Test the rule to make sure that it works correctly.
When you create a new price rule, it might take an hour or so to become available. Make sure to allow enough time for it to get into the system. Then, test the rule to make sure that it works correctly. Unless otherwise specified, price rules are automatically processed with other system rules each night.
Magento Community Edition 2.1 User Guide 377
378 Magento Community Edition 2.1 User Guide
Communications
379
380
Contents
In this section of the guide, you will learn how to customize email and newsletter templates, as well as PDF invoices and packing slips. You will also learn how to personalize the content with variables and markup tags.
Adding Reference IDs to Header
CHAPTER 23:
Email templates define the layout, content, and formatting of automated messages sent from your store. They are called transactional emails
1 because each one is associated with a specific type of transaction, or event.
Magento includes a set of responsive email templates that are triggered by a variety of events that take place during the operation of your store. Each template is optimized for any screen size, and can be viewed from the desktop, as well as on tablets and mobile devices. You will find a variety of prepared email templates related to customer activities, sales, product alerts, admin actions, and system messages that you can customize to reflect your brand.
1An automated email message that is sent in response to a specific event or transaction.
Magento Community Edition 2.1 User Guide 381
Supported Email Clients CHAPTER 23: Email
Supported Email Clients
A wide range of technologies is supported by the various email clients and services available today. Although there is some variation in the way email messages are rendered, we have found the following services to be compatible with Magento Community Edition 2.1.
Desktop Clients
OPERATING SYSTEM CLIENTS SUPPORTED
OS X 10.8
Apple Mail 6
OS X 10.7
Windows 8
Windows 7
Outlook 2011
Outlook 2013
Outlook 2010
Outlook 2007
Outlook 2003
Mobile Clients
OPERATING SYSTEM CLIENTS SUPPORTED
Android 4.2, “Jelly Bean” Native email app
Android 2.3, “Gingerbread” Native email app
Gmail App (Android 4.2) Native email app
Blackberry 5 OS
IOS 8
Native email app iPhone 6 iPhone 6 Plus
IOS 7
IOS 6 iPad (Retina) iPad Mini iPhone 5s
Mail on these devices:
iPhone 5 iPhone 4s
382 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Supported Email Clients
Web Clients
EMAIL APPLICATION
AOL Mail
Gmail
Yahoo! Mail
Outlook.com
BROWSERS SUPPORTED*
Chrome
Internet Explorer
Firefox
Chrome
Internet Explorer
Firefox
Chrome
Internet Explorer
Firefox
Chrome
Internet Explorer
* The latest version of each browser was used for testing.
Magento Community Edition 2.1 User Guide 383
Preparing Your Email Logo CHAPTER 23: Email
Preparing Your Email Logo
Logos can be saved as any of the following file types. Logos with transparent backgrounds can be saved as either .GIF or .PNG files.
l
JPG/JPEG l
GIF l
PNG
To ensure that your logo renders well on high-resolution devices, the uploaded image should be three times the size of the dimensions that are specified in the header template. Typically, original logo artwork is created as a vector image, so it can be scaled up without losing resolution. The image can then be saved in one of the supported bitmap image formats.
Logo Three Times Display Size
To take advantage of the limited vertical space in the header, make sure to crop the image to eliminate any wasted space at the top or bottom. When editing the image, be careful to preserve the aspect ratio
1 of the logo, so the height and width resize proportionally.
As a general rule, you can make an image smaller than the original, but not larger without losing resolution. Taking a small image and scaling it up in a photo editor lowers the resolution of the image. For example, if the display dimensions of the logo are 168 pixels wide by 48 pixels high in the header template, the uploaded image should be 504 pixels wide by 144 pixels high.
LOGO DIMENSIONS
Width:
1 X (DISPLAY SIZE)
168 px
3 X (IMAGE SIZE)
504 px
Height: 48 px 144 px
384
1The proportional relationship between the width and height of an image.
Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Configuring Email Templates
Configuring Email Templates
The configuration determines the logo, as well as the header and footer templates that are used for all transactional email messages that are sent from your store.
Transactional Emails
Process Overview:
Step 1:
Step 2:
Select the Header and Footer Templates
Magento Community Edition 2.1 User Guide 385
Configuring Email Templates CHAPTER 23: Email
Step 1:
Upload Your Logo
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
3.
Under Other Settings, expand the Transactional Emails section. Then, do the following:
a.
To upload your prepared Logo Image, tap
Upload
. Find the file on your computer, and select the file.
b.
In the Logo Image Alt field, enter alternate text to identify the image.
c.
Enter the Logo Width and Logo Height in pixels. Enter each value as a number, without the “px” abbreviation. These values refer to the display dimensions of the logo in the header, and not to the actual size of the image.
Step 2:
Choose the Header and Footer Templates
If you have custom header and footer templates for your store, or for different stores, you can specify which templates are used for each, according to the
of the configuration.
1.
Choose the Header Template to be used for all transactional email messages.
2.
Choose the Footer Template to be used for all transactional email messages.
3.
When complete, tap
Save Config
.
386 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Configuring Email Templates
Configuring Sales Email
A number of email messages are triggered by the events related to an order, and the configuration is similar. You must identify the store contact that appears as the sender of the message, the email template to be used, and anyone else who is to receive a copy of the message. Sales emails can be sent when triggered by an event, or by predetermined interval.
Sales Emails
Step 1:
Update the Email Templates
Make sure that you have updated each
to reflect your brand. For a complete list of templates, see:
.
Step 2:
Choose the Type of Transmission
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Sales Emails.
3.
Expand following: the General Settings section. Then, set Asynchronous Sending to one of the
Disable
Enable
Sends sales email when triggered by an event.
Sends sales email at predetermined, regular intervals.
Magento Community Edition 2.1 User Guide 387
Configuring Email Templates
General Settings
Step 3:
Complete the Details for Each Sales Email Message
4.
Expand the Order section. Then, do the following:
CHAPTER 23: Email
388
Order
a.
Verify that Enabled is set to “Yes.”
b.
Set New Order Confirmation Email to the store contact that appears as the sender of the message.
c.
Set New Order Confirmation Template to the template that is used for the email that is sent to registered customers.
d.
Set New Order Confirmation Template for Guest to the template that is used for the email that is sent to guests who do not have an account with your store.
e.
In the Send Order Email Copy To field, enter the email address of anyone who is to receive a copy of the new order email. If sending a copy to multiple recipients, separate each address with a comma.
f.
Set Send Order Email Copy Method to one of the following:
Bcc
Separate Email
Sends a “blind courtesy copy” by including the recipient in the header of the same email that is sent to the customer. The BCC recipient is not visible to the customer.
Sends the copy as a separate email.
Magento Community Edition 2.1 User Guide
CHAPTER 23: Email
5.
Expand the Order Comments section, and repeat these steps.
Configuring Email Templates
Order Comments
6.
Complete the configuration for the remaining sales emails: l
Invoice l
Shipment l
Credit Memo
7.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 389
Configuring Email Templates CHAPTER 23: Email
Payment Failed Email
A notification is sent to the customer if the payment method that is chosen during checkout fails to complete the transaction.
390
Payment Failed Emails
Step 1:
Update the Email Templates
Make sure that you have updated each
to reflect your brand. For a complete list of templates, see:
Step 2:
Configure the Payment Failed Emails
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Payment Failed Emails section. Then, do the following:
a.
Set Payment Failed Email Sender to the store contact that appears as the sender of the message.
b.
Set Payment Failed Email Receiver to the store contact that is to receive notification of failed email transmissions.
c.
Set Payment Failed Template to the template that is used for the email that is sent when the payment method fails during checkout.
d.
In the Send Payment Failed Email Copy To field, enter the email address of anyone who is to receive a copy of the payment failed notification. If sending a copy to multiple recipients, separate each address with a comma.
e.
Send Payment Failed Copy Method to one of the following:
Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Configuring Email Templates
Bcc Sends a “blind courtesy copy” by including the recipient in the header of the same email that is sent to the customer. The BCC recipient is not visible to the customer.
Sends the copy as a separate email.
Separate Email
4.
When complete, tap
Save Config
.
Configuring Admin User Email
The Admin email template configuration determines the email templates that are sent when users forget and reset their passwords, the store contact that appears as the sender of the message, and how long the password recovery link remains valid.
Admin User Emails
To configure the Admin email templates:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Admin.
3.
Expand the Admin User Emails section. Then, do the following:
a.
Set Forgot Password Email Template to the template that is sent when Admin users forget their passwords.
b.
Set Forgot and Reset Email Sender to the store contact that appears as the sender of the message.
c.
Set User Notification Template to the email template that is used as the default for admin notifications.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 391
Customizing Email Templates CHAPTER 23: Email
Customizing Email Templates
Magento includes a default email template for the body section of each message that is sent by the system. The template for the body content is combined with the header and footer templates to create the complete message. The content is formatted with HTML and CSS, and can be easily edited, and customized by adding
and
frontend apps . Email templates
can be customized for each website, store, or store view. Make sure to update the system configuration after creating a customized template, so the custom template is used instead of the default.
The default templates include your logo and store information, and can be used without further customization. However as a best practice, you should view each template, and make any necessary changes before they are sent to customers.
392
Preview of Welcome Template
Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Customizing Email Templates
Header Template
The email header template includes your logo that is linked to your store. In addition, you can easily insert variables to add store contact information to the header.
Email Templates
Process Overview:
Step 1:
Step 2:
Customize and Preview the Template
Step 3:
Step 1:
Load the Default Template
1.
On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
2.
Tap
Add New Template
. Then, do the following:
Magento Community Edition 2.1 User Guide 393
Customizing Email Templates CHAPTER 23: Email
a.
Under Load default template, in the Template list under Magento_Email, choose
“Header.”
Default Header Template
b.
Tap
Load Template
.
The HTML code and variables from the template appear in the form.
Step 2:
Customize the Template
1.
Under Template Information, do the following:
a.
Enter the Template Name for your custom header.
b.
Enter a Template Subject to help organize the templates. In the grid, the list of templates can be sorted and filtered by the Subject column.
394
Header Template Information
c.
In the Template Content box, modify the HTML as needed.
Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Customizing Email Templates
When working in the template code, be careful not to overwrite anything that is enclosed in double braces.
d.
To insert a variable, position the cursor in the code where you want the variable to appear, and tap
Insert Variable
. Then, choose the variable that you want to insert.
When a variable is selected, a
for the variable is inserted in the code.
Insert Variable
Although the Store Contact variables are the ones most often included in the header, you can enter the code for any system or
directly into the template.
e.
If you need to make any CSS declarations, enter the styles in the Template Styles box.
2.
When you are ready to review your work, tap
Preview Template
. Then, make adjustments to the template as needed.
3.
When complete, tap
Save Template
.
Your custom header now appears in the list of available Email templates.
Step 3:
Update the Configuration
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
In the grid, find the store view that you want to configure. Then in the Action column, click
Edit
.
3.
Scroll down and expand the Transactional Emails section.
4.
Choose the Header Template that is used as the default for email notifications.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 395
Customizing Email Templates CHAPTER 23: Email
Transactional Emails
Field Descriptions
FIELD DESCRIPTION
LOAD DEFAULT TEMPLATE
Template Lists the selection of available templates, and identifies the template to be customized.
TEMPLATE INFORMATION
Template Name The name of your custom template.
Insert Variable
Template Subject
Template Content
Template Styles
Inserts a Store Contact Information variable into the template at the cursor location.
The Template Subject appears in the Subject column, and can be used to sort and filter the templates in the list.
The content of the template in HTML.
Any CSS style declarations that are needed to format the template header can be entered in the Template Styles box.
396 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Customizing Email Templates
Footer Template
The email template footer contains the closing and signature line of the email message. You can change the closing to fit your style, and add additional information, such as the company name and address below your name.
Email Templates
Process Overview:
Step 1: Load the Default Template
Step 2: Customize and Preview the Template
Step 3: Update the Configuration
Step 1:
Load the Default Template
1.
On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
2.
Tap
Add New Template
. Then, do the following:
a.
Under Load default template, in the Template list under Magento_Email, choose “Footer.”
b.
Tap
Load Template
.
Default Footer Template
Magento Community Edition 2.1 User Guide 397
Customizing Email Templates CHAPTER 23: Email
Step 2:
Customize and Preview the Template
1.
Enter the Template Name for your custom footer.
2.
Enter a Template Subject to help organize the templates. In the grid, the templates can be sorted and filtered by the Subject column.
398
Footer Template Information
3.
In the Template Content box, modify the HTML as needed.
When working in the template code, be careful not to overwrite anything that is enclosed in double braces.
4.
To insert a variable, position the cursor in the code where you want the variable to appear, and tap
Insert Variable
. Then, choose the variable that you want to insert.
When a variable is selected, a
for the variable is inserted in the code.
Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Customizing Email Templates
Insert Variable
Although the Store Contact variables are the ones most often included in the footer, you can enter the code for any system or
directly into the template.
5.
If you need to make any CSS declarations, enter the styles in the Template Styles box.
Step 3:
Update the Configuration
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
In the grid, find the store view that you want to configure. Then in the Action column, click
Edit
.
3.
Scroll down and expand the Transactional Emails section.
4.
Choose the Footer Template that is used as the default for email notifications.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
Transactional Emails
399
Customizing Email Templates CHAPTER 23: Email
Field Descriptions
FIELD DESCRIPTION
LOAD DEFAULT TEMPLATE
Template Lists the selection of available templates, and identifies the template to be customized.
TEMPLATE INFORMATION
Template Name The name of your custom template.
Insert Variable
Template Subject
Template Content
Template Styles
Inserts a Store Contact Information variable into the template at the cursor location.
The Template Subject appears in the Subject column, and can be used to sort and filter the templates in the list.
The content of the template in HTML.
Any CSS style declarations that are needed to format the template footer can be entered in the Template Styles box.
400 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Customizing Email Templates
Message Template
The process of customizing the body of each message is the same as the customizing the header or footer. The only difference is that there is a different message template for each activity or event that triggers a notification. You can use the templates as they are, or customize them to match your voice and brand. In addition to the template text, there's a wide selection of
that can be incorporated into the template.
Process Overview:
Step 1:
Step 2:
Step 4:
Step 5:
Step 1:
Load the Default Template
1.
On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
2.
Tap
Add New Template
. Then, do the following:
a.
Under Load default template, in the Template list, choose the template that you want to customize.
b.
Tap
Load Template
.
Default Message Template
Step 2:
Customize the Template
1.
In the Template Name field, enter a name for your custom template.
2.
By default, the Template Subject contains the first line of the message, which is the salutation. You can leave it as is, or enter something more descriptive.
3.
Take note of the Currently Used For path to the template configuration. You will later follow this path to update the configuration.
Magento Community Edition 2.1 User Guide 401
Customizing Email Templates CHAPTER 23: Email
Message Template Information
4.
In the Template Content box, modify the HTML as needed. The content consists of a combination of HTML tags, CSS directives, variables, and text.
When working in the template code, be careful not to accidentally type over the code that is enclosed in double braces.
Template Message Content
5.
To insert a variable, position the cursor in the code where you want the variable to appear, and tap
Insert Variable
. Then, choose the variable that you want to insert.
When a variable is selected, a
for the variable is inserted in the code.
402
Insert Variable
In addition to the Store Contact variables, the list includes the Customer Account URL,
Customer Email, and Customer Name. However, you are not limited to the variables in this list. You can enter the code for any system or
directly into the template.
6.
If you need to make any CSS declarations, enter the styles in the Template Styles box.
Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Customizing Email Templates
Step 3:
Update the Configuration
1.
In the breadcrumb trail at the top of the Template Information section, find the following information, as it relates to your template. In this example the template configuration is located on the Customer Configuration page, in the Create New Account Options section, and in the Default Welcome Email field.
Page
Section
Field
Customer Configuration
Create New Account Options
Default Welcome Email
2.
Tap the link to open the template configuration page.
3.
Expand the section. Then, find the field for the email template that you customized, and specify the new template as the default.
Welcome Email Configuration
Step 4:
Preview and Save the Template
1.
When you are ready to review your work, tap
Preview Template
. Then, make adjustments to the template as needed.
2.
When complete, tap
Save Template
.
Your custom template is now available in the list of Email templates.
Magento Community Edition 2.1 User Guide 403
Customizing Email Templates CHAPTER 23: Email
Field Descriptions
FIELD DESCRIPTION
LOAD DEFAULT TEMPLATE
Template Lists the selection of available templates, and identifies the template to be customized.
TEMPLATE INFORMATION
Template Name The name of your custom template.
Insert Variable
Inserts a variable into the template at the cursor location.
Template Subject
Template Content
Template Styles
The Template Subject appears in the Subject column, and can be used to sort and filter the templates in the list.
The content of the template in HTML.
Any CSS style declarations that are needed to format the template can be entered in the Template Styles box.
404 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Email Template List
Email Template List
The list of email templates is organized alphabetically by Magento module.
Email Templates
TEMPLATE
Magento_Checkout
CONFIGURATION PATH
Payment Failed
Page:
Section:
Field:
Sales > Checkout
Payment Failed Emails
Payment Failed Template
Magento_Contact
Contact Form
Page:
Section:
Field:
General > Contacts
Email Options
Email Template
Magento_Customer
Change Email
Change Email and
Password
Forgot Password n/a n/a
Page:
Section:
Field:
Customers > Customer Configuration
Password Options
Forgot Email Template
New Account
Page:
Section:
Field:
Customers > Customer Configuration
Create New Account Options
Default Welcome Email
New Account
(Magento/luma)
Page:
Section:
Field:
Customers > Customer Configuration
Create New Account Options
Default Welcome Email
Magento Community Edition 2.1 User Guide 405
Email Template List CHAPTER 23: Email
Email Templates (cont.)
TEMPLATE
New Account
Confirmation Key
CONFIGURATION PATH
Page: Customers > Customer Configuration
Section: Create New Account Options
Field: Confirmation Link Email
New Account Confirmed
Page:
Section:
Field:
New Account Without
Password
Page:
Section:
Field:
Remind Password
Page:
Section:
Field:
Reset Password
Page:
Section:
Field:
Magento_Directory
Currency Update
Warnings
Page:
Section:
Field:
Magento_Email
Footer
Footer (Magento/luma)
Header n/a n/a n/a
Customers > Customer Configuration
Create New Account Options
Welcome Email
Customers > Customer Configuration
Create New Account Options
Default Welcome Email Without Password
Customers > Customer Configuration
Password Options
Remind Email Template
Customers > Customer Configuration
Password Options
Reset Password Template
General > Currency Setup
Scheduled Import Settings
Error Email Template
406 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Email Template List
Email Templates (cont.)
TEMPLATE
Magento_Newsletter
CONFIGURATION PATH
Subscription Confirmation
Page:
Section:
Field:
Customers > Newsletter
Subscription Options
Confirmation Email Template
Subscription Success
Page:
Section:
Field:
Customers > Newsletter
Subscription Options
Success Email Template
Unsubscription Success
Page:
Section:
Field:
Customers > Newsletter
Subscription Options
Unsubscription Email Template
Magento_ProductAlert
Cron Error Warning
Page:
Section:
Field:
Catalog > Catalog
Product Alerts Run Settings
Error Email Template
Price Alert
Page:
Section:
Field:
Catalog > Catalog
Product Alerts
Price Alert Email Template
Stock Alert
Page:
Section:
Field:
Catalog > Catalog
Product Alerts
Stock Alert Email Template
Magento_Sales
Credit Memo Update
Page:
Section:
Field:
Sales > Sales Emails
Credit Memo Contents
Credit Memo Comment Email Template
Magento Community Edition 2.1 User Guide 407
Email Template List CHAPTER 23: Email
Email Templates (cont.)
TEMPLATE
Credit Memo Update
(Magento/luma)
CONFIGURATION PATH
Page: Sales > Sales Emails
Section: Credit Memo Comments
Field: Credit Memo Comment Email Template
Credit Memo Update for
Guest
Page:
Section:
Field:
Sales > Sales Emails
Credit Memo Comments
Credit Memo Comment Email Template for
Guest
Credit Memo Update for
Guest (Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Credit Memo Comments
Credit Memo Comment Email Template for
Guest
Invoice Update
Page:
Section:
Field:
Invoice Update
(Magento/luma)
Page:
Section:
Field:
Invoice Update for Guest
Page:
Section:
Field:
New Credit Memo
Page:
Section:
Field:
Sales > Sales Emails
Invoice Comments
Invoice Comment Email Template
Sales > Sales Emails
Invoice Comments
Invoice Comment Email Template
Sales > Sales Emails
Invoice Comments
Invoice Comment Email Template for Guest
Sales > Sales Emails
Credit Memo
Credit Memo Email Template
408 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Email Template List
Email Templates (cont.)
TEMPLATE
New Credit Memo
(Magento/luma)
CONFIGURATION PATH
Page: Sales > Sales Emails
Section: Credit Memo
Field: Credit Memo Email Template
New Credit Memo for
Guest
Page:
Section:
Field:
Sales > Sales Emails
Credit Memo
Credit Memo Email Template for Guest
New Credit Memo for
Guest (Magento/luma)
New Invoice
New Invoice
(Magento/luma)
New Invoice for Guest
New Invoice for Guest
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Credit Memo
Credit Memo Email Template for Guest
Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template (Default Config)
Page: Sales > Sales Emails
Section:
Field:
Invoice
Invoice Email Template
Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template (Default Config)
Page: Sales > Sales Emails
Section:
Field:
Invoice
Invoice Email Template
Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template for Guest (Default Config)
Page: Sales > Sales Emails
Section:
Field:
Invoice
Invoice Email Template for Guest
Stores -> Configuration -> Sales Emails -> Invoice -> Invoice Email
Template for Guest (Default Config)
Magento Community Edition 2.1 User Guide 409
Email Template List CHAPTER 23: Email
Email Templates (cont.)
TEMPLATE CONFIGURATION PATH
Page:
Section:
Field:
Sales > Sales Emails
Invoice
Invoice Email Template for Guest
New Order
Page:
Section:
Field:
Sales > Sales Emails
Order
New Order Confirmation Template
New Order
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Order
New Order Confirmation Template
New Order for Guest
Page:
Section:
Field:
Sales > Sales Emails
Order
New Order Confirmation Template for Guest
New Order for Guest
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Order
New Order Confirmation Template for Guest
New Shipment
Page:
Section:
Field:
Sales > Sales Emails
Shipment
Shipment Email Template
New Shipment
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Shipment
Shipment Email Template
New Shipment for Guest
Page:
Section:
Sales > Sales Emails
Shipment
410 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Email Template List
Email Templates (cont.)
TEMPLATE CONFIGURATION PATH
Field: Shipment Email Template for Guest
New Shipment for Guest
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Shipment
Shipment Email Template for Guest
Order Update
Page:
Section:
Field:
Sales > Sales Emails
Order Comments
Order Comment Email Template
Order Update
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Order Comments
Order Comment Email Template
Order Update for Guest
Page:
Section:
Field:
Sales > Sales Emails
Order Comments
Order Comment Email Template for Guest
Order Update for Guest
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Order Comments
Order Comment Email Template for Guest
Shipment Update
Page:
Section:
Field:
Sales > Sales Emails
Shipment Comments
Shipment Comment Email Template
Shipment Update
(Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Shipment Comments
Shipment Comment Email Template
Magento Community Edition 2.1 User Guide 411
Email Template List CHAPTER 23: Email
Email Templates (cont.)
TEMPLATE
Shipment Update for
Guest
CONFIGURATION PATH
Page: Sales > Sales Emails
Section: Shipment Comments
Field: Shipment Comment Email Template for
Guest
Shipment Update for
Guest (Magento/luma)
Page:
Section:
Field:
Sales > Sales Emails
Shipment Comments
Shipment Comment Email Template for
Guest
Magento_SendFriend
Send Product Link to
Friend
Page:
Section:
Field:
Catalog > Email to a Friend
Email Templates
Select Email Template
Magento_Sitemap
Sitemap Generation
Settings
Page:
Section:
Field:
Catalog > XML Sitemap
Generation Settings
Error Email Template
Magento_User
Forgot Admin Password
User Notification
Page:
Section:
Field:
Advanced > Admin
Admin User Emails
Forgot Password Email Template
Stores -> Configuration -> Admin -> Admin User Emails -> User
Notification Template (Default Config)
Page: Advanced > Admin
Section:
Field:
Admin User Emails
User Notification Template
412 Magento Community Edition 2.1 User Guide
CHAPTER 23: Email Configuring Email Communications
Email Templates (cont.)
TEMPLATE
Magento_Wishlist
CONFIGURATION PATH
Magento Wish List Sharing
Page:
Section:
Field:
Customers > Wish List
Share Options
Email Template
Configuring Email Communications
The Mail Sending Settings give you the ability to route returned email or replies to email to a specific address. Also, if your store is running on a Windows server, you can verify the host and port settings.
Security Notice! We recommend that all merchants immediately set their mail sending configuration to protect against a recently identified potential remote code execution exploit. Until this issue is resolved, we highly recommend that you avoid using Sendmail for email communications. In the Mail Sending Settings, make sure that Set Return Path is set to "No." To learn more, see the
Magento Security Center posting
.
Mail Sending Settings
To configure email communications:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose System.
3.
Expand the Mail Sending Settings section. Then, do the following:
a.
If necessary, set Disable Email Communications to “No.”
b.
If running on a Windows server, verify the following settings:
Magento Community Edition 2.1 User Guide 413
Configuring Email Communications CHAPTER 23: Email
Host
Port (25) localhost
25
c.
Until the current security issue is resolved, we highly recommend that you set Set Return
Path
to "No."
No
Yes
Specified
( Recommended Security Measure ) Routes returned email to the default store email address.
Routes returned email to the default store email address.
Routes returned email to the email address specified in the Return
Path Email
field.
4.
When complete, tap
Save Config
.
414 Magento Community Edition 2.1 User Guide
CHAPTER 24:
Sales Documents
In addition to the email messages related to a sale, your store generates invoices, packing slips, and credit memos in both HTML and PDF formats. Before your store goes live, make sure to update these documents with your logo and store address. You can customize the address format, and also include additional information for reference.
l
Invoices l
Packing Slips l
Credit Memos
Magento Community Edition 2.1 User Guide 415
Preparing Your Invoice Logo CHAPTER 24: Sales Documents
Preparing Your Invoice Logo
Unlike the logo images used in HTML, the logo for PDF invoices and other sales documents can be a high-resolution, 300 dpi image. However, the image must be rendered to fit a space that is
200 pixels wide by 50 pixels high. Be careful to preserve the aspect ratio when you resize the logo. Resize the logo to fit the height, and don’t worry about any unused space to the right.
200 x 50 pixels
One way to resize your logo to fit the required size is to create a new, blank image with the correct dimensions. Then, paste your logo image and resize it to fit the height. With most image editing programs, you can either scale it by a percentage to preserve the aspect ratio, or hold down the shift key and manually resize the image.
To configure invoices and packing slips:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Sales.
3.
Expand the Invoice and Packing Slip Design section. Then, do the following:
416
Invoice and Packing Slip Design
a.
To upload the Logo for PDF Print-outs, tap
Choose File
. Find the logo that you have prepared, and tap
Open
.
b.
To upload the Logo for HTML Print View,tap
Choose File
. Find the logo that you have prepared, and tap
Open
.
Magento Community Edition 2.1 User Guide
CHAPTER 24: Sales Documents Preparing Your Invoice Logo
4.
Enter your address as you want it to appear on invoices and packing slips.
5.
When complete, tap
Save Config
.
For reference, a thumbnail of the uploaded image appears before each field. Don’t worry if the thumbnail appears distorted. The proportion of the logo will be correct on the invoice.
To replace an image:
1.
Tap Choose File and choose a different logo file.
2.
Mark the Delete Image checkbox for the image you want to replace.
3.
Tap
Save Config
.
Image Formats
FORMAT REQUIREMENTS
File Format
Image Size
Resolution
JPG (JPEG), PNG, TIF (TIFF)
200 pixels wide x 50 pixels high
300 dpi recommended
HTML
File Format
Image Size
Resolution
JPG (JPEG), PNG, GIF
Determined by theme.
72 or 96 dpi
Magento Community Edition 2.1 User Guide 417
Adding Reference IDs to Header CHAPTER 24: Sales Documents
Adding Reference IDs to Header
The Order ID and customer IP address can be included in the header of sales documents that accompany an order. By default, both the Order ID and customer IP address appear in the header of invoices, shipment packing slips, and credit memos.
418
PDF Print-outs
To change the Order ID settting:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose PDF Print-outs.
3.
Expand the Invoice section.
Invoice
4.
Set Display Order ID in Header according to your preference.
5.
Repeat for the Shipment and Credit Memo sections.
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 24: Sales Documents Adding Reference IDs to Header
To change the customer IP address setting:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Sales.
3.
Expand the General section.
4.
Set Hide Customer IP to your preference.
5.
When complete, tap
Save Config
.
General
Magento Community Edition 2.1 User Guide 419
Customer Address Templates CHAPTER 24: Sales Documents
Customer Address Templates
You can modify the template that determines the format of customer billing and shipping addresses that appear on printed invoices, shipments, and refunds, as well as in the address book of the customer account.
Example 1: Text Templates
For Text, Text One Line, HTML and PDF Address Templates
{{depend address attribute code}} a space, a character, or UI label
{{/depend}};
{{if address attribute code}}{{var address attribute code}} a space, a character, or UI label
{{/if}}
Example 2: JavaScript Template
For JavaScript Address Template
#{address attribute code} or User Interface label #{address attribute code}
420
Address Templates
Magento Community Edition 2.1 User Guide
CHAPTER 24: Sales Documents Customer Address Templates
To change the order of address fields:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Customers, choose Customer Configuration.
3.
Expand the Address Templates section. The section includes a separate set of formatting instructions for each of the following: l
Text l
Text One Line l
HTML l
4.
Edit each template as needed, using the examples for reference.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 421
422 Magento Community Edition 2.1 User Guide
CHAPTER 25:
Newsletters
Publishing a regular newsletter is considered to be one of the most powerful and affordable marketing tools available. Magento Community Edition 2.1 gives you the ability to publish and distribute newsletters to customers who have subscribed, plus tools to produce your newsletter, build and manage your list of subscribers, develop content, and drive traffic to your store. You can also use
to create an archive of past issues.
You can add capabilities by integrating your Magento installation with a third-party newsletter service provider and by adding extensions. To learn more, see
Magento Community Edition 2.1 User Guide 423
Configuring Newsletters CHAPTER 25: Newsletters
Configuring Newsletters
The first step in creating newsletters is to configure the newsletter settings for your site. You can require customers to click a confirmation link that is sent by email to confirm the subscription. This double opt-in
1
, method requires customers to confirm twice that they want to receive your newsletter, and reduces the possibility that it might be considered to be spam.
To configure subscription options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Customers, choose Newsletter.
3.
If necessary, expand the Subscription Options section. Then, do the following:
Subscription Options
424
1The process for subscribing email recipients by requiring them to take a secondary step to confirm that they want to receive emails.
Magento Community Edition 2.1 User Guide
CHAPTER 25: Newsletters Configuring Newsletters
a.
Confirm the email template and sender of the each of the following email messages that are sent to subscribers: l
Success email l
Confirmation email l
Unsubscribe email
b.
To use the double opt-in process to confirm subscriptions, set Need to Confirm to “Yes.”
c.
To allow people who do not have an account with your store to subscribe to the newsletter, set Allow Guest Subscription to “Yes.”
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 425
Newsletter Templates CHAPTER 25: Newsletters
Newsletter Templates
You can create as many newsletter templates as you need for different purposes. You might send a weekly product update, a monthly newsletter, or annual holiday newsletter. Newsletter templates can be prepared with HTML markup, or as plain text. Unlike HTML, plain text newsletters contain no images, rich text, or formatted links. In the grid, the Template Type column indicates whether a template is HTML or text.
Newsletter Templates
To create a newsletter template:
1.
On the Admin sidebar, tap Marketing. Then under Communications, choose Newsletter
Template
.
2.
To add a new template, click the Add New Template button. Then, do the following:
a.
In the Template Name enter name for internal reference.
b.
In the Template Subject field, describe the purpose of the newsletter.
c.
In the Sender Name field , enter the name of the person who is to appear as the sender of the newsletter.
d.
In the Sender Email field, enter the email address of the newsletter sender.
426 Magento Community Edition 2.1 User Guide
CHAPTER 25: Newsletters Newsletter Templates
e.
At the Template Content field, tap
Show / HIde Editor
to display the WYSIWYG editor.
Then, update the content as needed. To learn more, see:
.
Do not remove the unsubscribe link at the bottom of the template content. In some jurisdictions, the link is required by law.
f.
In the Template Styles field, enter the CSS declarations needed to format the content.
Template Information
3.
Tap Preview Template to see how it looks. Then, make any changes that are needed.
4.
When complete, tap
Save Template
.
After you save a template, a
Save As
button appears the next time you edit the template. It can be used to save variations of the template without overwriting the original.
To convert the template to plain text:
1.
At the top of the page, tap
Convert to Plain Text
. When prompted to confirm, tap
OK
.
2.
To preview the plain text version of the template, tap
Preview Template
. The preview opens in a new browser tab.
3.
To save the plain text version, tap
Save Template
.
To restore the HTML:
1.
At the top of the page, tap
Return HTML Version
.
2.
To preview the HTML version of the template, tap
Preview Template
. The preview opens in a new browser tab.
3.
To save the HTML version, tap
Save Template
.
Magento Community Edition 2.1 User Guide 427
Sending Newsletters CHAPTER 25: Newsletters
Sending Newsletters
To manage the load on the server, newsletters with many subscribers are sent in a queue of multiple batches. You can check the newsletter queue periodically to check the status, and see how many have been processed. Any problems that occur during transmission appear on the
Newsletter Problem Report.
To send a newsletter:
1.
On the Admin menu, tap Marketing. Then under Newsletters, choose Newsletter Templates.
2.
In the grid, find the template for the newsletter that is to be sent. Then, set the Action column to “Queue Newsletter.”
428
Add to Newsletter Queue
3.
In the Queue Date Start field, select the date that the transmission is to begin from the calendar ( ).
4.
In the Subscribers From list select each store view that is to be included in the email blast.
5.
Complete the email header information as follows:
a.
Enter a brief description of the newsletter for the Subject line of the email header.
b.
Enter the Sender Name.
c.
In the Sender Email field, enter the email address of the sender.
The default name and email address of the sender is specified in the configuration.
Magento Community Edition 2.1 User Guide
CHAPTER 25: Newsletters Sending Newsletters
6.
If applicable, enter a note in the Message box above the instructions to unsubscribe. Do not remove the instructions, which are required by law in many jurisdictions.
7.
When complete, tap
Save and Resume
.
The newsletter appears in the queue waiting to be processed.
Newsletter Queue
To check for problems:
1.
On the Admin menu, tap Reports.
2.
Under Marketing, choose Newsletter Problem Reports.
Magento Community Edition 2.1 User Guide 429
Managing Subscribers CHAPTER 25: Newsletters
Managing Subscribers
As a best practice you should manage your subscription list on a regular basis, and make sure to process any requests to unsubscribe. In some jurisdictions, it is required by law that requests to unsubscribe are processed within a specific period of time.
If you want to use a third-party service to send newsletters, you can export your subscription list as a CSV or XML file.
To cancel a subscription:
1.
On the Admin sidebar, tap Marketing. Then under Communications, choose Newsletter
Subscribers
.
2.
Find the subscriber in the grid. Then, mark the checkbox in the first column.
3.
Set the Action control to “Unsubscribe.” Then, tap
Submit
.
The status of the record changes to “Unsubscribed.”
Unsubscribe
430 Magento Community Edition 2.1 User Guide
CHAPTER 25: Newsletters Managing Subscribers
To export the list of subscribers:
1.
From the Newsletter Subscribers list, use the filter controls to include only records with a
Status
of “Subscribed,” and for the appropriate website, store, or store view.
2.
Set the Export to control to one of the following: l
CSV l
XML
3.
Tap
Export
. Then, look for the prompt at the bottom of the screen, and save the file.
Export Newsletter Subscribers
Magento Community Edition 2.1 User Guide 431
432 Magento Community Edition 2.1 User Guide
CHAPTER 26:
RSS Feeds
RSS (Really Simple Syndication) is an XML-based data format that is used to distribute information online. Your customers can subscribe to your RSS feeds to learn of new products and promotions. RSS Feeds can also be used to publish your product information to shopping aggregation sites, and can be included in newsletters.
When RSS feeds are enabled, any additions to products, specials, categories, and coupons are automatically sent to the subscribers of each feed. A link to all RSS feeds that you publish is in the footer of your store.
The orange RSS symbol is typically used to identify an RSS feed.
The software that is required to read an RSS feed is called a feed reader
1
, and allows people to subscribe to headlines, blogs, podcasts, and much more. Google Reader is one of the many feed readers that are available online for free.
RSS Feeds
1Software that is used to read syndicated content from RSS feeds.
Magento Community Edition 2.1 User Guide 433
434
CHAPTER 26: RSS Feeds
To set up RSS feeds for your store:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the upper-right corner, set Store View to the view(s) where the feeds are to be available. If prompted to confirm, tap OK.
3.
In the panel on the left, under Catalog, choose RSS Feeds.
4.
Expand the Rss Config section. Then, set Enable RSS to “Enable.”
If necessary, clear the Use Website checkbox to change the default value.
RSS Feeds
5.
Expand the Wish List section. Then, set Enable RSS to “Enable.”
6.
Expand the Catalog section and set other feeds to “Enable” as needed.
l
New Products l
Special Products l
Coupons/Discounts l
Top Level Category
Catalog
7.
Expand the Order section. Then, set Customer Order Status Notification to “Enable.”
8.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 26: RSS Feeds
Types of RSS Feeds
RSS FEED
Wish List
New Products
Special Products
Coupons / Discounts
Top Level Category
Customer Order Status
DESCRIPTION
When enabled, an RSS feed link appears at the top of customer wish list pages. Additionally, the wish list sharing page includes a checkbox that lets you include a link to the feed from shared wish lists.
Publishes notification of new products added to the catalog.
Publishes notification of any products with special pricing.
Publishes notification of any special coupons or discounts that are available in the store.
Publishes notification of any change to the top-level category structure of your catalog, which is reflected in the main menu.
Gives customers the ability to track their order status by RSS feed.
When enabled, an RSS feed link appears on the order.
Magento Community Edition 2.1 User Guide 435
436 Magento Community Edition 2.1 User Guide
CHAPTER 27:
Using Variables
Variables are pieces of information that can be created once and used in multiple places, such as email templates, blocks, and content pages. Your store includes a large number of predefined variables that can be used to personalize communications. In addition, you can create your own custom variables.
l
Predefined Variables l
Custom Variables
Magento Community Edition 2.1 User Guide 437
Adding Predefined Variables CHAPTER 27: Using Variables
Adding Predefined Variables
Predefined variables are easy to add to content email templates and content pages to personalize communications. The selection of available variables depends on the template.
438
Variables for Contact Form Template
To add a variable to an email template:
1.
On the Admin sidebar, tap Marketing. Then under Communications, choose Email Templates.
2.
Do one of the following: l
Load an existing template.
l
Add a new template.
3.
In the Template Content box, position the insertion point where you want the variable to appear. Then, tap
Insert Variable
.
4.
In the list of available variables, choose the one you want to insert into the template.
5.
To preview the template in a new browser window, tap
Preview
. Then, return to the main window.
6.
When complete, tap
Save Template
.
Magento Community Edition 2.1 User Guide
CHAPTER 27: Using Variables Adding Custom Variables
Adding Custom Variables
If you know a little basic HTML, you can create custom variables and use a
to incorporate them into pages, blocks, banners, and email templates.
{{CustomVar code= "my_custom_variable"}}
Custom Variables
To create a custom variable:
1.
On the Admin sidebar, tap System. Then under Other Settings, choose Custom Variables.
2.
Tap
Add New Variable
.
3.
Enter an identifier in the Variable Code field. Use all lowercase characters, without spaces.
4.
Enter a Variable Name, which is used for internal reference. Then, do one of the following: l
In the Variable HTML Value text field, enter any content you want to include, using basic
HTML tags. This option allows you to format the value.
l
In the Variable Plain Value field, enter the variable value as plain text.
You can drag the lower-right corner to make the boxes bigger.
Magento Community Edition 2.1 User Guide 439
Adding Custom Variables
5.
When complete, tap
Save
.
New Custom Variable
CHAPTER 27: Using Variables
440 Magento Community Edition 2.1 User Guide
CHAPTER 27: Using Variables Markup Tags
Markup Tags
A markup tag is a snippet of code that contains a relative reference to an object in your store, such as a variable, URL, image, or block. Markup tags can be incorporated into the HTML of content pages, blocks, email templates, newsletters, and so on.
Markup tags are enclosed in double, curly braces, and can either be generated by the Widget tool, or typed directly into HTML content. For example, rather than hard-coding the full path to a page, you can use a markup tag to represent the store URL. The markup tags featured in the following examples include:
Custom Variable
The Variable markup tag can be used to insert a
into an email templates, blocks, newsletters, and content pages,
{{CustomVar code= "my_custom_variable"}}
Store URL
The Store URL markup tag represents the base URL of your website, and is used as a substitute for the first part of a full URL, including the domain name. There are two versions of this markup tag: One that goes directly to your store, and the other with a forward slash at the end that is used when a path is added.
{{store url='apparel/shoes/womens'}}
Media URL
The dynamic media URL markup tag represents the location and file name of an image that is stored on a content delivery network (CDN). The tag can be used to place an image on a page, block, banner, or email template.
{{media url='shoe-sale.jpg'}}
Magento Community Edition 2.1 User Guide 441
Markup Tags CHAPTER 27: Using Variables
Block ID
The Block ID markup tag is one of the easiest to use, and can be used to place a block directly on a CMS page, or even nested inside another block. You can use this technique to modify a block for different promotions or languages. The Block ID markup tag references a block by its identifier.
{{block id='block-id'}}
Template Tag
A template tag references a PHTML template file, and can be used to display the block on a
CMS page or static block. The code in the following example can be added to a page or block to display the Contact Us form.
“Contact Us” Template Tag
{{block type="core/template" name="contactForm" template="contacts/form.phtml"}}
The code in the next example can be added to a page or block to display the a list of products in a specific category, by category ID.
“Category Product List” Template Tag
{{block type="catalog/product_list" category_id="22" template="catalog/product/list.phtml"}}
442 Magento Community Edition 2.1 User Guide
CHAPTER 27: Using Variables Markup Tags
Widget Code
The Widget tool can be used to display lists of products, or to insert complex links, such as one that goes to a specific product page, based on product ID. The code that is generated includes the block reference, location of the code module, and corresponding PHTML template. After the code is generated, you can copy and paste it from one place to another.
The code in the following example can be added to a page or block to display the list of new products.
“New Products Grid” Code
{{widget type="catalog/product_widget_new" display_type="new_products" products_count="10" template="catalog/product/widget/new/content/new_grid.phtml"}}
The code in the next example can be added to a page or block to display a link to a specific product, by product ID.
“Link to Product” Code
{{widget type="catalog/product_widget_link" anchor_text="My Product Link" title="My Product Link" template="catalog/product/widget/link/link_ block.phtml" id_path="product/31"}}
Magento Community Edition 2.1 User Guide 443
Markup Tags CHAPTER 27: Using Variables
Using Markup Tags in Links
You can use markup tags with HTML anchor tags, and link directly to any page in your store.
The link can be incorporated into content pages, blocks, banners, or email and newsletter templates. You can also use this technique to link an image to a specific page.
Process Overview:
Step 1: Identify the Destination URL
Step 2: Add the Markup to the URL
Step 3: Complete the Anchor Tag
Step 1:
Identify the Destination URL
If possible, navigate to the page that you want to link to, and copy the full URL from the address bar of your browser. The part of the URL that you need comes after the “dot com forward slash.” Otherwise, copy the URL Key from the CMS page that you want to use as the link destination.
Full URL to Category Page
http://mystore.com/apparel/shoes/womens http://mystore.com/apparel/shoes/womens.html
Full URL to Product Page
http://mystore.com/apparel/shoes/womens/nine-west-pump http://mystore.com/apparel/shoes/womens/nine-west-pump.html
Full URL to CMS Page
http://mystore.com/about-us
444 Magento Community Edition 2.1 User Guide
CHAPTER 27: Using Variables Markup Tags
Step 2:
Add the Markup to the URL
The Store URL tag represents the base URL of your website, and is used as a substitute for the
“http address” part of the store URL, including the domain name and “dot com.” There are two versions of the tag, which you can use, depending on the results you want to achieve.
store direct_url store url
Links directly to a page.
Places a forward slash at the end, so additional references can be appended as a path.
In the following examples, the URL Key is enclosed in single quotes, and the entire markup tag is enclosed in double curly braces. When used with an anchor tag, the markup tag is placed inside the double quotes of the anchor. To avoid confusion, you can alternate using single-and double quotes for each nested set of quotes.
1.
If you are starting with a full URL, delete the “http address” part of the URL, up through and including the “dot.com forward slash.” In its place, type the Store URL markup tag, up through the opening single quote.
Store URL Markup Tag
http://mystore.com/apparel/shoes/womens
{{store url='apparel/shoes/womens'}}
Otherwise, type the first part of the Store URL markup tag, and paste the URL key or path that you copied earlier.
Store URL Markup Tag with URL Key
{{store url='
{{store url='apparel/shoes/womens'}}
2.
To complete the markup tag, type the closing double quotes and double braces.
Magento Community Edition 2.1 User Guide 445
Markup Tags CHAPTER 27: Using Variables
Step 3:
Complete the Anchor Tag
1.
Wrap the completed markup tag inside an anchor tag, using the markup tag instead of the target URL. Then, add the link text, and closing anchor tag.
Markup in Anchor Tag
<a href="{{markup tag goes here}}">Link Text</a>
2.
Paste the completed anchor tag into the code of any CMS page, block, banner, or email template, where you want the link to appear.
Complete Link with Markup
<a href="{{store url='apparel/shoes'}}">Shoe Sale</a>
446 Magento Community Edition 2.1 User Guide
CHAPTER 27: Using Variables Variable Reference
Variable Reference
Most email templates have a section of additional variables that are specific to the template.
The following are examples of some frequently used templates.
Email Template Variables
VARIABLE
Email Footer Template
MARKUP TAG
{{template config_path="design/email/footer_template"}}
Email Header Template
{{template config_path="design/email/header_template"}}
Email Logo Image Alt
{{var logo_alt}}
Email Logo Image URL
{{var logo_url}}
Email Logo Image Height
{{var logo_height}}
Email Logo Image Width
{{var logo_width}}
Template CSS
{{var template_styles|raw}}
Store Contact Information Variables
VARIABLE
Base Unsecure URL
MARKUP TAG
{{config path="web/unsecure/base_url"}}
Base Secure URL
{{config path="web/secure/base_url"}}
General Contact Name
{{config path="trans_email/ident_general/name"}}
General Contact Email
Sales Representative
Contact Name
Sales Representative
Contact Email
Custom1 Contact Name
{{config path="trans_email/ident_general/email"}}
{{config path="trans_email/ident_sales/name"}}
{{config path="trans_email/ident_sales/email"}}
Custom1 Contact Email
{{config path="trans_email/ident_custom1/name"}}
{{config path="trans_email/ident_custom1/email"}}
Magento Community Edition 2.1 User Guide 447
Variable Reference CHAPTER 27: Using Variables
Store Contact Information Variables (cont.)
VARIABLE
Custom2 Contact Name
MARKUP TAG
{{config path="trans_email/ident_custom2/name"}}
Custom2 Contact Email
{{config path="trans_email/ident_custom2/email"}}
Store Name
{{config path="general/store_information/name"}}
Store Phone Telephone
{{config path="general/store_information/phone"}}
Store Hours
{{config path="general/store_information/hours"}}
Country
Region/State
{{config path="general/store_information/country_id"}}
{{config path="general/store_information/region_id"}}
Zip/Postal Code
{{config path="general/store_information/postcode"}}
City
Street Address 1
{{config path="general/store_information/city"}}
{{config path="general/store_information/street_line1"}}
Street Address 2
{{config path="general/store_information/street_line2"}}
Store Contact Address
{{config path="general/store_information/address"}}
448 Magento Community Edition 2.1 User Guide
CHAPTER 27: Using Variables Variable Reference
New Account Template Variables
VARIABLE
Customer Account URL
MARKUP TAG
{{var this.getUrl($store, 'customer/account/')}}
Customer Email
{{var customer.email}}
Customer Name
{{var customer.name}}
New Order Template Variables
VARIABLE
Billing Address
MARKUP TAG
{{var formattedBillingAddress|raw}}
Email Order Note
Order ID
{{var order.getEmailCustomerNote()}}
{{var order.increment_id}}
Order Items Grid
{{layout handle="sales_email_order_items" order=$order area="frontend"}}
Payment Details
{{var payment_html|raw}}
Shipping Address
Shipping Description
{{var formattedShippingAddress|raw}}
{{var order.getShippingDescription()}}
Magento Community Edition 2.1 User Guide 449
450 Magento Community Edition 2.1 User Guide
SEO & Search
451
452
Contents
In this section of the guide, we'll take a look at the search capabilities of your store, what you can learn from customer search terms, and how to make your products easy to find. Finally, you’ll learn best practices and techniques that you can use to bring more traffic to your store.
Configuring Layered Navigation
CHAPTER 28:
Catalog Navigation
The term navigation
1 refers to the methods shoppers use to move from page to page throughout your store. The main menu, or top navigation of your store is actually a list of category links, and provides easy access to the products in your catalog. You will also find categories in the breadcrumb trail that runs across the top of most pages, and in the layered navigation that appears on the left side of some two- or three-column pages.
For a product to be visible in your store, it must be assigned to at least one category. Each category can have a dedicated landing page with an image, static block, a description, and a list of products in the category. You can also create special designs for category pages that are active only for a specific period of time such as for a holiday or promotion.
1The primary group of web page links that a customer uses to navigate around the website; the navigation links to the most important categories or pages on an online store.
Magento Community Edition 2.1 User Guide 453
Top Navigation CHAPTER 28: Catalog Navigation
Top Navigation
The main menu of your store is like a directory to the different departments in your store. Each option represents a different category of products. The position and presentation of the top navigation might vary by theme, but the way it works is essentially the same.
454
Top Navigation
The category structure of your catalog can influence how well your site is indexed by search engines. The more deeply nested a category, the less likely it is to be thoroughly indexed. As a general rule, anywhere between one and three visible levels is considered to be the most effective. The
counts as the first level, although it doesn't appear in the menu.
The maximum number of levels that are available in the top navigation is determined by the configuration. In addition, there might be a limit to the number of menu levels that are supported by your store theme. For example, the sample Luma theme supports up to five levels, including the root.
Counting Menu Levels
Level 1
Level 2
The first level is the
root category , which in the sample data is named
“Default Category.” The root is a container for the menu, and its name does not appear as an option in the menu.
On a desktop display, the top navigation is the main menu that appears across the top of the page. On a mobile device, the main menu typically appears as a fly-out menu of options. The secondlevel options in the Luma store are “What's New,” “Women,” “Men,”
“Gear,” “Training,” and “Sale.”
Level 3
Level 4
The third-level appears below each main menu option. For example, under “Women,” the third-level options are “Tops” and “Bottoms.”
The fourth-level options are subcategories that fly out from a thirdlevel option. For example, under “Tops,” the fourth level menu options are “Jackets,” “Hoodies & Sweatshirts,” “Tees,” and “Bras & Tanks.”
Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation Top Navigation
To set the depth of the top navigation:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, expand Catalog. Then, choose Catalog.
3.
Expand the Category Top Navigation section.
Because the depth of the top navigation has a global
configuration scope , the setting applies to
all websites, stores, and store views in the Magento installation. The Category Top Navigation configuration section is available only when Store View in the upper-left corner is set to
“Default Config.”
Default Config
4.
To limit the number of subcategories that appear in the top navigation, enter the number in the
Maximal Depth
field.
The default Maximal Depth value is zero, which does not place a limit on the number of subcategory levels.
5.
When complete, tap
Save Config
.
Category Top Navigation
Magento Community Edition 2.1 User Guide 455
Breadcrumb Trail CHAPTER 28: Catalog Navigation
Breadcrumb Trail
A breadcrumb trail is a set of links that shows where you are in relation to other pages in the store. You can click any link in the breadcrumb trail to return to the previous page.
The breadcrumb trail can be configured to appear on content pages, as well as catalog pages.
The format and position of the breadcrumb trail varies by theme, but it is usually located just below the header. By default, the breadcrumb trail appears on CMS pages.
Breadcrumb Trail
456 Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation
To remove the breadcrumbs from CMS pages:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Web. Then, do the following:
a.
Expand the Default Pages section.
b.
Clear the Use system value checkbox.
c.
Set Show Breadcrumbs for CMS Pages to "No."
3.
When complete, tap
Save Config
.
Breadcrumb Trail
Show Breadcrumbs for CMS Pages
Magento Community Edition 2.1 User Guide 457
Product Listings CHAPTER 28: Catalog Navigation
Product Listings
Product listings can be set to appear by default as either a list or grid. You can also determine how many products appear per page, and which attribute is used to sort the list. Each catalog page with a product list has a set of controls that can be used to sort the products, change the format of the list, sort by attribute, and advance from one page to the next.
458
Products Displayed as a Grid
Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation
To configure product listings:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
Scroll down and in the panel on the left, tap Catalog. Then choose Catalog.
3.
Expand the Storefront section, and do the following:
Product Listings
Storefront
a.
Set the default List Mode to one of the following: l
Grid Only l
List Only l
Grid (default) / List l
List (default / Grid
b.
In the Products per Page on Grid Allowed Values field, enter the number of products that you want to appear per page when shown in grid format. To enter a selection of values, separate each number by a comma.
c.
In the Products per Page on Grid Default Value field, enter the default number of products to appear in the grid per page.
Magento Community Edition 2.1 User Guide 459
Product Listings CHAPTER 28: Catalog Navigation
d.
In the Products per Page on List Allowed Values field, enter the number of products that you want to appear per page when shown in list format. To enter a selection of values, separate each number by a comma.
e.
In the Products per page on List Default Value field, enter the default number of products that appear in the list, per page.
f.
To give customers the option to list all products, set Allow All Products on Page to “Yes.”
g.
Set Product Listing Sorted by to the default attribute that is initially used to sort the list.
4.
If using a
flat catalog , do the following:
a.
To display a flat category listing of products, set Use Flat Catalog Category to “Yes.”
b.
To display a flat product listing, set Use Flat Catalog Product to “Yes.”
5.
If you want to allow dynamic references for media assets in category and product URLs, set
Allow Dynamic Media URLs in Products and Categories
to “Yes.”
6.
When complete, tap
Save Config
.
Page Controls
CONTROL
View As
DESCRIPTION
Displays the products in either a grid or list format.
Sort By
Show Per Page
Pagination Links
Changes the sort order of the list.
Determines how many products appear per page.
Navigation links to other pages.
460 Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation Pagination Controls
Pagination Controls
The Pagination settings appear at the top and bottom of the list, and control the format of the pagination links for product listings. You can set the number of links that appear in the control, and configure the Next and Previous links. For the pagination links to appear, there must be more products in the list than are allowed per page in the product list configuration.
Pagination Controls
Pagination Controls
View As
Displays the list in either a Grid or List format.
Sort By
Changes the sort order of the list.
Show Per Page
Determines how many products appear per page.
Pagination Links
Navigation links to other pages.
Magento Community Edition 2.1 User Guide 461
Pagination Controls CHAPTER 28: Catalog Navigation
To configure the pagination controls:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
3.
Under Other Settings, expand the Pagination section.
Pagination
a.
In the Pagination Frame field, enter the number of links that you want to appear in the pagination control.
b.
In the Pagination Frame Skip field, enter the number of links that you want to skip ahead before displaying the next set of links in the pagination control.
For example, if the pagination frame has five links, and you want to jump to the next five links, how many links do you want to skip ahead? If you set this to four, then the last link from the previous set will be the first link in the next set.
c.
In the Anchor Text for Previous field, enter the text that you want to appear for the
Previous link. Leave blank to use the default arrow.
d.
In the Anchor Text for Next field, enter the text that you want to appear for the Next link.
Leave blank to use the default arrow.
4.
When complete, tap
Save Config
.
462 Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation Layered Navigation
Layered Navigation
Layered navigation makes it easy to find products based on category, price range, or any other available attribute. Layered navigation usually appears in the left column of search results and category pages and sometimes on the home page. The standard navigation includes a “Shop
By” list of categories and price range. You can configure the display of layered navigation, including product count and price range.
Layered Navigation by Category and Price
Magento Community Edition 2.1 User Guide 463
Layered Navigation CHAPTER 28: Catalog Navigation
Layered Navigation with Filterable Attributes
Layered navigation can be used to search for products by category or by attribute. For example, when a shopper chooses the Mens/Shorts category from the top navigation, the initial results include all products in the category. The list can be filtered further by choosing a specific style, climate, color, material, pattern, or price—or a combination of values. Filterable attributes appear in an expanding section that lists each attribute value. As an option, the list of products with matching results can be configured to include products with, or without, a match.
The attribute properties, combined with the product input type determines which attributes
can be used for layered navigation. Layered navigation is available only for “ anchor
” categories, but can also be added to search results pages. The Catalog Input Type for Store Owner property of each attribute must be set to “Dropdown,” “Multiple Select,” or “Price.” To make the attributes filterable, the Use in Layered Navigation property of each must be set to either
“Filterable (with results)” or “Filterable (no results).”
464
Filterable Attributes In Layered Navigation
Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation Layered Navigation
The following instructions show how to set up basic layered navigation with filterable attributes. For advanced layered navigation with price steps, see:
.
Process Overview:
Step 1:
Set Up the Attribute Properties
Step 2:
Step 3:
Step 1:
Set Up the Attribute Properties
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
2.
Find the attribute in the list, and open in edit mode. Then, do the following:
Filtered Search on Attribute Code
a.
In the panel on the left, choose Storefront Properties. Then, set Use In Layered
Navigation
to one of the following:
Filterable (with results)
Filterable (no results)
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.
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.
Magento Community Edition 2.1 User Guide 465
Layered Navigation CHAPTER 28: Catalog Navigation
Filterable Swatch Value with No Results
b.
Set Use In Search Results Layered Navigation to “Yes.”
466
Storefront Properties
3.
Repeat these steps for each attribute that you want to include in layered navigation.
Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation Layered Navigation
Step 2:
Make the Category an Anchor
1.
On the Admin sidebar, tap Products. Then under Inventory choose Categories.
2.
In the categories tree on the left, select the category where you want to use layered navigation.
3.
Expand the Display Settings section. Then, set Anchorto “Yes.”
4.
Tap
Save
.
Category Display Settings
Step 3:
Test the Results
To test the setting, go to your store and navigate to the category from the main menu. The selection of filterable attributes appears in the layered navigation of the category page.
Magento Community Edition 2.1 User Guide 467
Layered Navigation CHAPTER 28: Catalog Navigation
Price Navigation
Price navigation can be used to distribute products by price range in layered navigation. You can also split each range in intervals. There are ways to calculate price navigation: l
Automatic (Equalize Price Ranges) l
Automatic (Equalize Product Counts) l
Manual
With the first two methods, the navigation steps are calculated automatically. The manual method lets you specify a division limit for price intervals. The following example shows the difference between price navigation steps of 10 and 100.
Iterative splitting provides the best distribution of products among price ranges. With iterative splitting, after choosing the $0.00-$99 range, the customer can drill-down through several sub-ranges of prices. Price-range splitting stops when the number of products reaches the threshold set by the Interval Division Limit.
Example: Price Navigation Steps
PRICE STEP BY 10
$20.00 - $29.99 (1)
$30.00 - $39.99 (2)
$70.00 - $79.99 (1)
$100.00 - $109.99 (1)
$120.00 - $129.99 (2)
$150.00 - $159.99 (1)
$180.00 - $189.99 (1)
$420.00 - $429.99 (1)
$440.00 - $449.99 (1)
$710.00 and above (1)
PRICE STEP BY 100
$0.00 - $99.99 (4)
$100 - $199.99 (5)
$400.00 - $499.99 (2)
$700.00 and above (1)
468 Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation Layered Navigation
To configure price navigation:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Layered Navigation section. Then, do the following:
a.
By default, Display Product Count is set to “Yes.” The change the setting, first clear the
Use system value
checkbox.
b.
Set Price Navigation Steps Calculation to one of the following methods:
Layered Navigation
Method 1:
Automatic (equalize price ranges)
Leave Price Navigation Steps Calculation set to the default, “Automatic (Equalize Price
Ranges.)” This setting uses the standard algorithm for price navigation.
Method 2:
Automatic (equalize product counts)
To change the value of any of the following fields, first clear the Use system value checkbox.
1.
Set Price Navigation Steps Calculation to “Automatic (equalize product counts).”
2.
To display a single price when multiple products with the same price, set Display Price
Interval as One Price
to “Yes.”
3.
In the Interval Division Limit field, enter the threshold for a number of products within a price range. The range cannot be further split beyond this limit., The default value is 9.
Magento Community Edition 2.1 User Guide
Automatic (equalize product counts)
469
Layered Navigation CHAPTER 28: Catalog Navigation
Method 3:
Manual
To change the value of any of the following fields, first clear the Use system value checkbox.
1.
Set Price Navigation Steps Calculation to “Manual.”
2.
Enter a value to determine the Default Price Navigation Step.
3.
Enter the Maximum Number of Price Intervals allowed, up to 100.
4.
When complete, tap
Save Config
.
Manual
470 Magento Community Edition 2.1 User Guide
CHAPTER 28: Catalog Navigation Layered Navigation
Configuring Layered Navigation
The layered navigation configuration determines if a product count appears in parentheses after each atribute, and the size of the step calculation that is used in price navigation.
To configure layered navigation:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, expand the Catalog section. Then choose Catalog.
3.
Expand the Layered Navigation section, and do the following:
Layered Navigation
a.
To display the number of products found for each attribute, set Display Product Count to
“Yes.” If necessary, first clear the Use system value checkbox.
b.
Set Price Navigation Step Calculation to “Automatic (equalize price ranges).” If necessary, first clear the Use system value checkbox.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 471
472 Magento Community Edition 2.1 User Guide
CHAPTER 29:
Catalog Search
Research shows that people who use search are more likely to make a purchase than those who rely on navigation alone. In fact, according to some studies, people who use search are nearly twice as likely to make a purchase. In this section of the guide, we will explore how customers search for products in your catalog, and how you can configure catalog search.
l
l
l
l
l
Magento Community Edition 2.1 User Guide 473
Quick Search CHAPTER 29: Catalog Search
Quick Search
The Search box in the header of the store helps visitors find products in your catalog. The search text can be the full or partial product name, or any other word or phrase that describes the product. The search terms that people use to find products can be managed from the
Admin.
To do a quick search:
1.
In the Search box, enter the first few letters of what you want to find.
Any matches in the catalog appear below, with the number of results found.
2.
Either press the Enter key or tap a result in the list of matching products.
Search
474 Magento Community Edition 2.1 User Guide
CHAPTER 29: Catalog Search Advanced Search
Advanced Search
Advanced Search lets shoppers search the catalog based on values entered into a form. Because the form contains multiple fields, a single search can include several parameters. The result is a list of all products in the catalog that match the criteria. A link to Advanced Search is in the footer of your store.
Advanced Search
Each field in the form corresponds to an attribute from your product catalog. To add a field, set the frontend properties of the attribute to “Include in Advanced Search.” As a best practice, include only the fields that customers are most likely to use to find a product, because having too many will slow down the search.
Magento Community Edition 2.1 User Guide 475
Advanced Search CHAPTER 29: Catalog Search
To use advanced search:
1.
In the footer of the store, click Advanced Search.
2.
In the Advanced Search form, full or partial values in as many fields as necessary.
3.
Tap
Search
to display the results.
Search Results
4.
If you don’t see what you are looking for in the search results, tap Modify your search and try another combination of criteria.
476 Magento Community Edition 2.1 User Guide
CHAPTER 29: Catalog Search Search Results
Search Results
The Search Results list includes all products that match the search criteria entered in the Quick
Search box or the Advanced Search form. Every product list in the catalog has essentially the same controls. The only difference is that one is the result of a search query, and the other is the result of
The results can be formatted as either a grid or list, and sorted by a selection of attributes.
controls appear if there are more products than fit on the page, and are used to move from one page to the next. The number of records per page is determined by the Catalog
Frontend configuration. To learn more, see:
Magento Community Edition 2.1 User Guide
Search Results with Pagination Controls
477
Search Results CHAPTER 29: Catalog Search
Weighted Search
Product attributes that are enabled for catalog search can be assigned a weight to give them a higher value in search results. Attributes with a greater weight are returned before those with a lower weight. For example, if there are two attributes in the system, “color” with a search weight of 3 and “description” with a search weight of 1. A search for the word “red,” returns a list of products with a color attribute value of “red,” but does not return products with descriptions that contain the word “red.” In this example, the color attribute has a greater weight than the description attribute.
Search Weight
To set the search weight properties of an attribute:
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
2.
Find the attribute in the list, and open in edit mode.
3.
In the panel on the left, choose Storefront Properties. Then, do the following:
a.
To include the attribute in search queries, set Use in Search to “Yes.”
b.
To establish the search value of the attribute, set Search Weight to a number from 1 to 10, where 10 has the highest priority. If no value is entered, all attributes have a search weight of 1.
4.
When complete, tap
Save Attribute
button.
478 Magento Community Edition 2.1 User Guide
CHAPTER 29: Catalog Search Search Results
Configuring Catalog Search
Magento uses a fulltext MySQL search. By adjusting the Catalog Search configuration, you can control the size of valid query text.
Catalog Search
To configure catalog search:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Catalog Search section, and do the following:
4.
To limit the length and word count of search query text, do the following:
a.
Set Minimal Query Length to the minimum number of characters that can be submitted in a query.
b.
Set Maximum Query Length to the maximum number of characters that can be submitted in a query.
5.
Accept the default, Search Engine, “MySQL.”
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 479
480 Magento Community Edition 2.1 User Guide
CHAPTER 30:
Search Terms
You can learn what your customers are looking for by examining the search terms they use to find products in your store. If enough people look for a product that you don’t carry, perhaps it’s time to add it to your catalog. Meanwhile, rather than have them leave them empty handed, why not redirect them to another product in your catalog? Here are a few ways you can leverage customer search terms:
Landing Page
The landing page for a search term can be a content page, a category page, a product detail page, or even a page on a different site.
Synonyms
One way to improve the effectiveness of catalog search is to include different terms that people may use to describe the same item. You don’t want to lose a sale just because someone is looking for a “sofa,” and your product is listed as a “couch.” You can capture a broader range of search terms by entering the words, “sofa” “davenport,” and “loveseat” as synonyms for “couch,” and direct them to the same landing page.
Misspelled Words
Use search terms to capture common misspellings and redirect them to the appropriate page.
For example, if you sell wrought iron patio furniture, you know that many people misspell the term as “rod iron,” or even “rot iron.” You can enter each misspelled word as a search term, and make them synonyms for “wrought iron.” Even though the word is misspelled, the search will be directed to the page for “wrought iron.”
Magento Community Edition 2.1 User Guide 481
Popular Search Terms CHAPTER 30: Search Terms
Popular Search Terms
The Search Terms link in the footer of your store displays the search terms used by visitors to your store, ranked by popularity. Search terms appear in a “tag cloud” format, where the size of the text indicates the popularity of the term.
By default, Popular Search Terms is enabled as a search engine optimization tool, but has no direct connection to the catalog search process. Because the Search Terms page is indexed by search engines, any terms on the page can help improve your search engine ranking and the visibility of your store.
Popular Search Terms
482 Magento Community Edition 2.1 User Guide
CHAPTER 30: Search Terms Popular Search Terms
To configure Popular Search Terms:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Search Engine Optimization section.
4.
Clear the Use system value checkbox. Then, set Popular Search Terms as needed.
5.
When complete, tap
Save Config
.
Search Engine Optimization
Magento Community Edition 2.1 User Guide 483
Adding Search Terms CHAPTER 30: Search Terms
Adding Search Terms
As you learn new words that people use to search for products in your catalog, you can add them to your search terms list to direct people to the most closely matching products in your catalog.
Search Terms
To add a new search term:
1.
On the Admin sidebar, tap Marketing. Then under SEO & Search, choose Search Terms.
2.
Tap
Add New Search Term
. Then, do the following:
484 Magento Community Edition 2.1 User Guide
CHAPTER 30: Search Terms Adding Search Terms
General Information
a.
Under General Information in the Search Query box, type the word or phrase that you want to add as a new search term.
b.
If your store is available in multiple languages, choose the applicable Store view.
c.
To redirect the search results to another page in your store, or to another website, enter the full URL of the target page in the Redirect URL field.
d.
If you want this term to be available for use as a suggestion whenever a search returns no results, set Display in Suggested Terms to “Yes.”
3.
When complete, tap
Save Search
.
To edit a search term:
1.
In the Search Terms grid, click the row of any record to open the search term in edit mode.
2.
Make the necessary changes.
3.
When complete, tap
Save Search
.
To delete a search term:
1.
In the list, mark the checkbox of the term to be deleted.
2.
In the upper-left corner of the list, set Actions to “Delete.”
3.
When complete, tap
Submit
.
Magento Community Edition 2.1 User Guide 485
Search Terms Report CHAPTER 30: Search Terms
Search Terms Report
The Search Terms report shows the number of results for each term, and the number of times
(hits) the term was used. The report data can be filtered by term, store, results, and hits, and exported for further analysis.
To view the search terms report:
1.
On the Admin sidebar, tap Reports. Then under Marketing, choose Search Terms.
2.
Use the controls to filter the report as needed.
Search Terms Report
486 Magento Community Edition 2.1 User Guide
CHAPTER 31:
SEO Best Practices
Search engine optimization is the practice of fine-tuning the content and presentation of a site to improve the way the pages are indexed by search engines. Magento Community 2.1
includes a number of features to support your ongoing SEO effort.
Commerce Resources
See the latest Magento eBooks to gain access to expert insight and online business resources to help develop and improve your store.
Magento Community Edition 2.1 User Guide 487
Meta Data CHAPTER 31: SEO Best Practices
Meta Data
Your store is loaded with places where you can enter keyword-rich meta data to improve the way search engines index your site. While setting up your store, you might enter preliminary meta data, with the intention of finishing it later. Over time, you can fine-tune the meta data to target the buying patterns and preferences of your customers.
Meta Tags
Meta Title
The meta title appears in the title bar and tab of your browser, and search results listings. The meta title should be unique to the page, and less than seventy characters in length.
Meta Keywords
Although some search engines ignore meta keywords, others continue to use them. The current best practice is to incorporate high-value keywords in the meta title and meta description.
Meta Description
Meta descriptions provide a brief overview of the page for search results listings. Ideally, a meta description should be between 150-160 characters in length, although the field will accept up to 255 characters.
488 Magento Community Edition 2.1 User Guide
CHAPTER 31: SEO Best Practices Meta Data
Canonical Meta Tag
The canonical meta tag tells search engines which page to index when multiple URLs have identical or very similar content.
Structured Data Markup
Rich Snippets
Rich snippets provide detailed information for search results listings and other applications. By default, structured data markup that is based on the schema.org
standard is added to your store’s product template. As a result, more information is available for search engines to include as “rich snippets” in product listings.
Magento Community Edition 2.1 User Guide 489
Example 1: Category Path Creates Duplicate URLs CHAPTER 31: SEO Best Practices
Canonical Meta Tag
Some search engines penalize websites that have multiple URLs that point to the same content.
The canonical meta tag tells search engines which page to index when multiple URLs have identical or very similar content. Using the canonical meta tag can improve your site ranking and aggregate pageviews. The canonical meta tag is placed in the <head> block of a product or category page. It provides a link to your preferred URL, so search engines will give it greater weight.
Example 1:
Category Path Creates Duplicate URLs
For example, if your catalog is configured to include the category path in product URLs, your store will generate multiple URLs that point to the same product page.
http://mystore.com/gear/bags/driven-backpack.html
http://mystore.com/driven-backpack.html
Example 2:
Category Page Full URL
When canonical meta tags for categories are enabled, the category page of your store includes a canonical URL to the full category URL: http://mystore.com/gear/bags/driven-backpack.html
Example 3
: Product Page Full URL
When canonical meta tags for products are enabled, the product page includes a canonical
URL to the domain-name/product-url-key because product URL keys are globally unique.
http://mystore.com/driven-backpack.html
If you also include the category path in product URLs, the canonical URL remains domainname/product-url-key. However, the product can also be accessed using its full URL, which includes the category. For example, if the product URL key is driven-backpack, and is assigned to the Gear > Bags category, the product can be accessed using either URL.
You can avoid being penalized by search engines by omitting the category from the URL, or by using the canonical meta tag to direct search engines to index either by product or category. As a best practice, it is recommended that you enable canonical meta tags for both categories and products.
490 Magento Community Edition 2.1 User Guide
CHAPTER 31: SEO Best Practices Example 1: Category Path Creates Duplicate URLs
To enable the canonical meta tag:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose elect Configuration.
2.
In the panel on the left under Catalog, choose Catalog.
3.
Expand the Search Engine Optimization section.
To change any field values, you must first clear the Use system value checkbox after each field.
Search Engine Optimization
4.
If want search engines to index only pages that have a full category path, do the following:
a.
Set Use Canonical Link Meta Tag for Categories to “Yes.”
b.
Set Use Canonical Link Meta Tag for Products to “No.”
5.
If you want search engines to index only product pages, do the following:
a.
Set Use Canonical Link Meta Tag for Products to “Yes.”
b.
Set Use Canonical Link Meta Tag for Categories to “No.”
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 491
Using a Sitemap CHAPTER 31: SEO Best Practices
Using a Sitemap
A sitemap improves the way your store is indexed by search engines, and is specifically designed to find pages that might be overlooked by web crawlers. A sitemap can be configured to index all pages and images.
When enabled, Magento creates a file called sitemap.xml that is saved to the root directory of your installation. The configuration gives you the ability to set the frequency of the updates, and the priority for each type of content. Your sitemap should be updated as frequently as the content on your site changes, which might be daily, weekly, or monthly.
While your site is in development, you might include instructions in the robots.txt file for webcrawlers to avoid indexing the site. Then before the launch, you can change the instructions to allow the site to be indexed.
Process Overview:
Step 1: Configure and Enable the Sitemap
Step 2: Configure and Enable robots.txt (Optional)
Step 3: Submit Your Sitemap to Search Engines
Step 4: Restore the Previous Robot Instructions (Optional)
Step 1:
Configure and Enable the Sitemap
Complete the
to determine what is included, and how frequently the sitemap is updated.
Step 2:
Configure and Enable robots.txt
(Optional)
Complete the
configuration with instructions that direct search engines to crawl the parts of your site that you want to be indexed.
Step 3:
Submit Your Sitemap to Search Engines
You can submit your sitemap to different search engines by providing them a link to the sitemap.xml file in the root of your Magento installation. For more information, see the instructions for the specific search engine. Here are links to instructions for two top search engines: l
Google l
Microsoft Bing
Step 4:
Restore Previous Robot Instructions
(Optional)
You can now restore either the original, or default restrictions.
492 Magento Community Edition 2.1 User Guide
CHAPTER 31: SEO Best Practices Sitemap Configuration
Sitemap Configuration
Your sitemap should be updated as frequently as the content on your site changes, which could be on a daily, weekly, or monthly basis. The configuration lets you set the frequency and priority for each type of content.
Step 1:
Set the Frequency and Priority of Content Updates
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, choose XML Sitemap.
3.
Expand the Categories Options section. Then, do the following:
a.
Set Frequency to one of the following: l
Always l
Hourly l
Daily l
Weekly l
Monthly l
Yearly l
Never
b.
In the Priority field, enter a value between 0.0 and 1.0. Zero has the lowest priority.
Categories Options
4.
Click to expand the Products Options section. Then, complete the Frequency and Priority settings as needed.
5.
To determine the extent that images are included in the sitemap, set Add Images into Sitemap to one of the following: l
None l
Base Only l
All
Magento Community Edition 2.1 User Guide 493
Sitemap Configuration CHAPTER 31: SEO Best Practices
Products Options
6.
Click to expand the CMS Pages Options section. Then, complete the Frequency and Priority settings as needed.
CMS Pages Options
7.
When complete, tap
Save Config
.
Step 2:
Complete the Generation Settings
1.
Expand the Generation Settings section.
494
Generation Settings
2.
To generate a sitemap, set Enabled to “Yes.” Then, do the following:
a.
Set Start Time to the hour, minute and second that you want the sitemap to be updated.
b.
Set Frequency to one of the following: l
Daily l
Weekly l
Monthly
Magento Community Edition 2.1 User Guide
CHAPTER 31: SEO Best Practices Sitemap Configuration
c.
In the Error Email Recipient field, enter the email address of the person who is to receive notification if an error occurs during a sitemap update.
d.
Set Error Email Sender to the store contact who appears as the sender of the error notification.
e.
Set Error Email Template to the template used for the error notification.
Step 3:
Set the Sitemap File Limits
1.
Expand the Sitemap File Limits section. Then, do the following:
a.
In the Maximum No of URLs per File field, enter the maximum number of URLs that can be included in the sitemap. By default, the limit is 50,000.
b.
In the Maximum File Size field, enter the largest size in bytes that is allocated for the sitemap. The default size is 10,485,760 bytes.
Sitemap File Limits
Step 4:
Set the Search Engine Submission Settings
1.
Expand the Search Engine Submission Settings section.
2.
If using a robots.txt file to provide instructions to search engines that crawl your site, set
Enable Submission to Robots.txt
to “Yes.”
Search Engine Submission Settings
3.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 495
Search Engine Robots CHAPTER 31: SEO Best Practices
Search Engine Robots
The Magento configuration includes settings to generate and manage instructions for web crawlers and bots that index your site. The instructions are saved in a file called “robots.txt” that resides in the root of your Magento installation. The instructions are directives that are recognized and followed by most search engines.
By default, the robots.txt file that is generated by Magento contains instructions for web crawler to avoid indexing certain parts of the site that contain files that are used internally by the system. You can use the default settings, or define your own custom instructions for all, or for specific search engines. There are many articles online that explore the subject in detail.
Example:
Custom Instructions
Allows Full Access
User-agent:*
Disallow:
Disallows Access to All Folders
User-agent:*
Disallow: /
Default Instructions
Disallow: /lib/
Disallow: /*.php$
Disallow: /pkginfo/
Disallow: /report/
Disallow: /var/
Disallow: /catalog/
Disallow: /customer/
Disallow: /sendfriend/
Disallow: /review/
Disallow: /*SID=
496 Magento Community Edition 2.1 User Guide
CHAPTER 31: SEO Best Practices Search Engine Robots
Search Engine Robots
To configure robots.txt:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Design.
3.
Expand the Search Engine Robots section. Then, do the following:
a.
Set Default Robots to one of the following:
INDEX, FOLLOW
NOINDEX, FOLLOW
INDEX, NOFOLLOW
NOINDEX, NOFOLLOW
Instructs web crawlers to index the site and to check back later for changes.
Instructs web crawlers to avoid indexing the site, but to check back later or changes.
Instructs web crawlers to index the site once, but to not check back later for changes.
Instructs web crawlers to avoid indexing the site, and to not check back later for changes.
b.
If needed, enter custom instructions into the Edit Custom instruction of robots.txt file box: For example, while a site is in development, you might want to disallow access to all folders.
c.
To restore the default instructions, tap
Reset to Default
.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 497
498 Magento Community Edition 2.1 User Guide
CHAPTER 32:
URL Rewrites
The URL Rewrite tool lets you change any URL that is associated with a product, category, or CMS page. When the rewrite goes into effect, any links that point to the previous URL are redirected to the new address.
The terms rewrite and redirect are often used interchangeably, but refer to slightly different processes. A URL rewrite changes the way a URL appears in the browser. A URL redirect, on the other hand, updates the URL that is stored on the server. A URL redirect can be either temporary or permanent. Your store uses URL rewrites and redirects to make it easy for you to change the URL key of a product, category, or page and preserve existing links.
By default,
are enabled for your store. The "Create Permanent
Redirect for old URL" checkbox is marked under the URL key field of each product.
Create Permanent Redirect for Old URL
Magento Community Edition 2.1 User Guide 499
URL Rewrite Configuration CHAPTER 32: URL Rewrites
URL Rewrite Configuration
URL rewrites make it possible to make existing URLs more “search engine friendly” and also easier for humans to read. Enabling Web Server Apache Rewrites is part of the initial Magento setup. Magento routinely uses URL rewrites to remove the file name “index.php” that normally appears in the URL just after the root folder. When Web Server Rewrites are enabled, the system rewrites each URL to omit “index.php.” The rewrite removes words that convey nothing of value to search engines or customers, and has no impact on performance or site rank.
URL without Web Server Rewrite
http://www.yourdomain.com/magento/index.php/storeview/url-identifier
URL with Web Server Rewrite
http://www.yourdomain.com/magento/storeview/url-identifier
To configure URL rewrites:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Web.
3.
Expand the Search Engine Optimization section.
Search Engine Optimization
4.
Set Use Web Server Rewrites to your preference.
5.
When complete, tap
Save Config
.
500 Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Automatic Redirects
Automatic Redirects
Your store can be configured to automatically generate a permanent redirect whenever the URL key of a product or category changes. In the Search Engine Optimization section, the checkbox below the URL key indicates if permanent redirects are enabled. If your store is already configured to automatically redirect catalog URLs, making a redirect is as easy as updating the
URL key. The process to create an automatic redirect is the same for both products and categories.
Create Permanent Redirect for Old URL
To set up automatic redirects:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Catalog, select Catalog.
3.
Expand the Search Engine Optimization section.
4.
Set Create Permanent Redirect for URLs if URL Key Changed to “Yes.”
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
Search Engine Optimization
501
Automatic Redirects CHAPTER 32: URL Rewrites
To automatically redirect product URLs:
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
Find the product in the list, and click to open the record.
3.
Expand following: the Search Engine Optimization section. Then in the URL Key field, do the
a.
Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not, follow the instructions to
b.
Update the URL Key as needed, using all lowercase characters and hyphens instead of spaces.
4.
When complete, tap
Save
.
5.
When prompted to refresh the cache, follow the links in the message at the top of the workspace. The permanent redirect is now in effect for the product and any associated category
URLs.
To automatically redirect category URLs:
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2.
Find the category in the tree, and click to open the record.
3.
Expand following: the Search Engine Optimization section. Then in the URL Key field, do the
a.
Make sure that the Create Permanent Redirect for old URL checkbox is selected. If not, follow the instructions to
b.
Update the URL Key as needed, using all lowercase characters and hyphens instead of spaces.
4.
When complete, tap
Save
.
5.
When prompted to refresh the cache, follow the links in the message at the top of the workspace. The permanent redirect is now in effect for the category and any associated product
URLs.
502 Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Creating URL Rewrites
Creating URL Rewrites
The URL Rewrite tool can be used to create product and category rewrites, and custom rewrites for any page in your store. When the rewrite goes into effect, any existing links that point to the previous URL are seamlessly redirected to the new address.
URL rewrites can be used to add high-value keywords to improve the way the product is indexed by search engines. You can also use rewrites to create additional URLs for a temporary seasonal change, or permanent change. Rewrites can be created for any valid path, including
CMS content pages. Internally, the system always references products and categories by their
ID. No matter how often the URL changes, the ID remains the same. Here are some ways you can use URL rewrites:
System URL
http://www.example.com/catalog/category/id/6
Original URL
http://www.example.com/peripherals/keyboard.html
Redirected Product URL
http://www.example.com/ergonomic-keyboard.html
Additional Category URLs
http://www.example.com/all-on-sale.html
http://www.example.com/save-now/spring-sale
Magento Community Edition 2.1 User Guide
URL Rewrites
503
Creating URL Rewrites CHAPTER 32: URL Rewrites
Product Rewrites
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although people might still navigate to the former page from search engines or outdated links, the redirect causes your store to switch to the new target.
If
are enabled for your store, there is no need to create a rewrite when a product
is changed.
504
Add URL Rewrite for Product
Process Overview:
Step 1.
Step 2:
Step 3.
Step 1:
Plan the Rewrite
1.
To avoid mistakes, write down the "redirect to" path and "redirect from" path. The path includes the URL Key and suffix, if applicable.
If you're not sure, open each product page in your store, and copy the path from the address bar of your browser. When creating a product redirect, you can either include or exclude the
. For this example, we create a product redirect without a category path.
Product with Category Path
Redirect to: gear/bags/impulse-duffle.html
Redirect from: gear/bags/overnight-duffle.html
Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites
Product without Category Path
Redirect to: impulse-duffle.html
Redirect from: overnight-duffle.html
Creating URL Rewrites
Step 2:
Create the Rewrite
1.
On the Admin sidebar, tap Marketing. Then under Search & SEO, choose URL Rewrites.
2.
Before you proceed, do the following to verify that the "request path" is available.
a.
In the search filter at the top of the Request Path column, enter the URL key of the page that is to be redirected. Then, tap
Search
.
b.
If there are multiple redirect records for the page, find the one that matches the applicable store view. Then, open the redirect record in edit mode.
c.
In the upper-right corner, tap
Delete
. When prompted, tap
OK
to confirm.
3.
In the upper-right corner of the URL Rewrites page, tap
Add URL Rewrite
.
4.
When you return to the URL Rewrites page, tap
Add URL Rewrite
.
5.
Set Create URL Rewrite to “For product.”
6.
In the grid, find the product that is the target—or destination—of the redirect. Then, click the row.
Add URL Rewrite for a Product
7.
Below the category tree, tap
Skip Category Selection
. For this example, the redirect does not include a category.
Magento Community Edition 2.1 User Guide 505
Creating URL Rewrites CHAPTER 32: URL Rewrites
506
Skip Category Selection
The Add URL Rewrite for a Product page displays a link to the target in the upper-left corner, and the Target Path field displays the system version of the path, which cannot be changed.
Initially, the Redirect Path field also displays the target path.
a.
If you have multiple store views, set Store to the view where the rewrite applies Otherwise, a rewrite will be created for each view.
b.
In the Request Path field, type over the default entry, and enter the URL key and suffix—if applicable—of the original product request. This is the "Redirect from" product that you identified in the planning step.
The Request Path must be unique for the specified store. If there is already a redirect that uses the same Request Path, you will receive an error when you try to save the redirect. The previous redirect must be deleted before you can create a new one.
c.
Set Redirect Type to one of the following: l
Temporary (302) l
Permanent (301)
d.
For your own reference, enter a brief Description of the rewrite.
Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Creating URL Rewrites
URL Rewrite Information
8.
Before saving the redirect, review the following: l
The link in the upper-left corner displays the name of the target product.
l
The Request Path contains the path for the original "redirect from" product.
9.
When complete, tap
Save
.
The new product rewrite now appears at the top of the URL Rewrites grid.
URL Rewrite Saved
Step 3:
Test the Result
1.
Go to the home page of your store.
2.
Do one of the following: l
Navigate to the original "redirect from" product request page.
l
In the address bar of the browser, enter the path to the original "redirect from" product immediately after the store URL. Then, press Enter.
Magento Community Edition 2.1 User Guide 507
Creating URL Rewrites CHAPTER 32: URL Rewrites
The new target product appears instead of the original product request.
Field Descriptions
FIELD
Create URL Rewrite
DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the rewrite is created. Options:
Custom
For category
For product
For CMS page
Request Path
Target Path
Redirect
The product that is to be redirected. Depending on your configuration, the Request Path might include the .html or .htm suffix, and category.
The Request Path must be unique, and cannot be in use by another redirect. If you receive an error that the Request Path already exists, delete the existing redirect, and try again.
The internal path that is used by the system to point to the destination of the redirect. The target path is grayed out and cannot be edited.
Determines the type of redirect. Options :
No No redirect is specified.
Many operations create redirect requests of this type. For example, every time you add products to a category, a redirect of the "No" type is created each store view.
Temporary (302)
Permanent (301)
Indicates to search engines that the rewrite is for a limited time. Search engines generally do not retain page rank information for temporary rewrites.
Indicates to search engines that the rewrite is permanent. Search engines generally retain page rank information for permanent rewrites.
Description Describes the purpose of the rewrite for internal reference.
508 Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Creating URL Rewrites
Category Rewrites
If a category is removed from your catalog, you can use a category rewrite to redirect links to the URL of another category in your store. Think in terms of "target" and "original request," or
"redirect to" and "redirect from." Although people might still navigate to the former page from search engines or outdated links, the redirect causes your store to switch to the new target.
If
are enabled for your store, there is no need to create a rewrite when a category
is changed.
URL Rewrite for Category
Process Overview:
Step 1:
Step 2:
Step 3:
Step 1:
Plan the Rewrite
1.
To avoid mistakes, write down the "redirect to" path and "redirect from" path. The paths should include the URL Key and suffix, if applicable.
If you're not sure, open each category page in your store, and copy the path from the address bar of your browser.
Category Path
Redirect to: gear/backpacks-and-bags.html
Redirect from: gear/bags.html
Magento Community Edition 2.1 User Guide 509
Creating URL Rewrites CHAPTER 32: URL Rewrites
Step 2:
Create the Rewrite
1.
On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.
2.
Before you proceed, do the following to verify that the "request path" is available,
a.
In the search filter at the top of the Request Path column, enter the URL key of the category that is to be redirected. Then, tap
Search
.
b.
If there are multiple redirect records for the page, find the one that matches the applicable store view. Then, open the redirect record in edit mode.
c.
In the upper-right corner, tap
Delete
. When prompted, tap
OK
to confirm.
3.
When you return to the URL Rewrites page, tap
Add URL Rewrite
.
4.
Set Create URL Rewrite to “For category.” Then in the category tree, choose the target category that is the destination of the redirect.
510
Category Tree
5.
In the URL Rewrite section, do the following:
a.
If you have multiple stores, select the Store where the rewrite applies.
b.
In the Request Path field, enter the URL key of the category that the customer requests.
This is the "redirect from" category.
The Request Path must be unique for the specified store. If there is already a redirect that uses the same Request Path, you will receive an error when you try to save the redirect. The previous redirect must be deleted before you can create a new one.
Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites
c.
Set Redirectto one of the following: l
Temporary (302) l
Permanent (301)
d.
For your reference, enter a brief description of the rewrite.
Creating URL Rewrites
Category Rewrite Information
6.
Before saving the redirect, review the following: l
The link in the upper-left corner displays the name of the target category.
l
The Request Path contains the path for the original "redirect from" category.
7.
When complete, tap
Save
button.
The new category rewrite appears at the top of the URL Rewrites grid.
Magento Community Edition 2.1 User Guide
New Category Rewrite
511
Creating URL Rewrites CHAPTER 32: URL Rewrites
Step 3:
Test the Result
1.
Go to the home page of your store.
2.
Do one of the following: l
Navigate to the original "redirect from" category.
l
In the address bar of the browser, enter the path to the original "redirect from" category immediately after the store URL. Then, press Enter.
The new target category appears instead of the original category request.
Field Descriptions
FIELD
Create URL Rewrite
DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the rewrite is created. Options:
Custom
For category
For product
For CMS page
Request Path The category that is to be redirected. Depending on your configuration, the Request Path might include the .html or .htm
suffix, and parent category.
The Request Path must be unique, and cannot be in use by another redirect. If you receive an error that the Request Path already exists, delete the existing redirect, and try again.
Target Path
Redirect
The internal path that is used by the system to point to the destination of the redirect. The target path is grayed out and cannot be edited.
Determines the type of redirect. Options :
No No redirect is specified.
Many operations create redirect requests of this type. For example, every time you add products to a category, a redirect of the "No" type is created each store view.
512 Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Creating URL Rewrites
Field Descriptions (cont.)
FIELD DESCRIPTION
Temporary (302)
Description
Permanent (301)
Indicates to search engines that the rewrite is for a limited time. Search engines generally do not retain page rank information for temporary rewrites.
Indicates to search engines that the rewrite is permanent. Search engines generally retain page rank information for permanent rewrites.
Describes the purpose of the rewrite for internal reference.
Magento Community Edition 2.1 User Guide 513
Creating URL Rewrites CHAPTER 32: URL Rewrites
CMS Page Rewrites
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "source," or "redirect to" and "redirect from." Although people might still navigate to the former page from search engines or outdated links, the redirect causes your store to switch to the new target.
514
Add URL Rewrite
Process Overview:
Step 1:
Step 2:
Step 3:
Step 1:
Plan the Rewrite
1.
To avoid mistakes, write down the URL key of the "redirect to" page and "redirect from" page.
If you're not sure, open each page in your store, and copy the path from the address bar of your browser.
CMS Page Path
Redirect to: new-page
Redirect from: old-page
Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Creating URL Rewrites
Step 2:
Create the Rewrite
1.
On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.
2.
Before you proceed, do the following to verify that the "request path" is available.
a.
In the search filter at the top of the Request Path column, enter the URL key of the page that is to be redirected. Then, tap
Search
.
b.
If there are multiple redirect records for the page, find the one that matches the applicable store view. Then, open the redirect record in edit mode.
c.
In the upper-right corner, tap
Delete
. When prompted, tap
OK
to confirm.
3.
When you return to the URL Rewrites page, tap
Add URL Rewrite
.
4.
Set Create URL Rewrite to “for CMS page.”
5.
Find your new target page in the grid, and open in edit mode.
Custom URL Rewrite
6.
Under URL Rewrite Information, do the following:
a.
If you have multiple store views, select the Store where the rewrite applies.
b.
In the Request Path field, enter the URL key of the original page that the customer requests. This is the "redirect from" page.
The Request Path must be unique for the specified store. If there is already a redirect that uses the same Request Path, you will receive an error when you try to save the redirect. The previous redirect must be deleted before you can create a new one.
c.
Set Redirectto one of the following:
Magento Community Edition 2.1 User Guide 515
Creating URL Rewrites l
Temporary (302) l
Permanent (301)
d.
For your reference, enter a brief description of the rewrite.
CHAPTER 32: URL Rewrites
516
Custom URL Rewrite
7.
Before saving the redirect, review the following: l
The link in the upper-left corner displays the name of the target page.
l
The Request Path contains the path for the original "redirect from" page.
8.
When complete, tap
Save
.
The new rewrite appears in the grid at the top of the list.
Saved URL Rewrite
Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Creating URL Rewrites
Step 3:
Test the Result
1.
Go to the home page of your store.
2.
Do one of the following: l
Navigate to the original "redirect from" page.
l
In the address bar of the browser, enter the name of the original "redirect from" page immediately after the store URL. Then, press Enter.
The new target page appears instead of the original page request.
Field Descriptions
FIELD
Create URL Rewrite
DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the rewrite is created. Options:
Custom
For category
For product
For CMS page
Request Path
Target Path
The CMS page that is to be redirected.
The Request Path must be unique, and cannot be in use by another redirect. If you receive an error message that the Request Path already exists, delete the existing redirect, and try again.
The internal path that is used by the system to point to the destination. The target path is grayed out and cannot be edited.
Redirect Determines the type of redirect. Options :
No No redirect is specified.
Temporary (302) Indicates to search engines that the rewrite is for a limited time. Search engines generally do not retain page rank information for temporary rewrites.
Permanent (301) Indicates to search engines that the rewrite is permanent. Search engines generally retain page rank information for permanent rewrites.
Description Describes the purpose of the rewrite for internal reference.
Magento Community Edition 2.1 User Guide 517
Creating URL Rewrites CHAPTER 32: URL Rewrites
Custom Rewrites
A custom rewrite can be used to manage miscellaneous redirects, such as redirecting a page from your store to an external website. For example, you might have two Magento websites, each with their own domain. You can use a custom redirect to reroute requests for a product, category, or page to the other website. Unlike other redirect types, the target of a custom redirect is not chosen from a list of existing pages in your store.
Before you begin, make sure that you understand exactly what the redirect is to accomplish.
Think in terms of "target" and "original request," or "redirect to" and "redirect from." Although people might still navigate to the former page from search engines or outdated links, the redirect causes your store to switch to the new target.
518
Add URL Rewrite
Process Overview:
Step 1:
Step 2:
Step 3:
Step 1:
Plan the Rewrite
1.
To avoid mistakes, write down the URL of the "redirect to" page, and the URL key of the
"redirect from" page.
If you're not sure, open each page, and copy the URL from the address bar of your browser.
Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites
Custom Path
Redirect to:
Redirect from: http://www.different-website.com/page.html
cms-page category.html
category/subcategory.html
product.html
category/product.html
Creating URL Rewrites
Step 2:
Create the Rewrite
1.
On the Admin sidebar, tap Marketing. Then under SEO & Search, choose URL Rewrites.
2.
Before you proceed, do the following to verify that the "request path" is available:
a.
In the search filter at the top of the Request Path column, enter the URL key of the page that is to be redirected. Then, tap
Search
.
b.
If there are multiple redirect records for the page, find the one that matches the applicable store view. Then, open the redirect record in edit mode.
c.
In the upper-right corner, tap
Delete
. When prompted, tap
OK
to confirm.
3.
When you return to the URL Rewrites page, tap
Add URL Rewrite
.
4.
Set Create URL Rewrite to “Custom.”
5.
Under URL Rewrite Information, do the following:
a.
If you have multiple store views, select the Store where the rewrite applies.
b.
In the Request Path field, enter the URL key and path—if applicable—of the product, category, or CMS page that is to be redirected.
The Request Path must be unique for the specified store. If there is already a redirect that uses the same Request Path, you will receive an error when you try to save the redirect. The previous redirect must be deleted before you can create a new one.
c.
In the Target Path field, enter the URL of the destination. If the target is located on another website, enter the fully qualified URL.
d.
Set Redirectto one of the following: l
Temporary (302) l
Permanent (301)
e.
For your reference, enter a brief description of the rewrite.
Magento Community Edition 2.1 User Guide 519
Creating URL Rewrites CHAPTER 32: URL Rewrites
Custom URL Rewrite
6.
Before saving the redirect, review the following: l
The Request Path contains the URL key or path of the original "redirect from" page.
l
The Target Path contains the URL of the "redirect to" page.
7.
When complete, tap
Save
.
The new rewrite appears in the grid at the top of the list.
520
Saved URL Rewrite
Step 3:
Test the Result
1.
Go to the home page of your store.
2.
Do one of the following: l
Navigate to the original "redirect from" page.
l
In the address bar of the browser, enter the name of the original "redirect from" page immediately after the store URL. Then, press Enter.
Magento Community Edition 2.1 User Guide
CHAPTER 32: URL Rewrites Creating URL Rewrites
The new target page appears instead of the original page request.
Field Descriptions
FIELD
Create URL Rewrite
DESCRIPTION
Indicates the type of rewrite. The type cannot be changed after the rewrite is created. Options:
Custom
For category
For product
For CMS page
Request Path
Target Path
Redirect
The path to the product, category, or CMS page that is to be redirected. Depending on your configuration, the Request Path might include the .html or .htm suffix.
The Request Path must be unique, and cannot be in use by another redirect. If you receive an error that the Request Path already exists, delete the existing redirect, and try again.
The path or URL that is the destination of the redirect.
Determines the type of redirect. Options :
No No redirect is specified.
Many operations create redirect requests of this type. For example, every time you add products to a category, a redirect of the "No" type is created each store view.
Temporary (302) Indicates to search engines that the rewrite is for a limited time. Search engines generally do not retain page rank information for temporary rewrites.
Permanent (301) Indicates to search engines that the rewrite is permanent. Search engines generally retain page rank information for permanent rewrites.
Description Describes the purpose of the rewrite for internal reference.
Magento Community Edition 2.1 User Guide 521
522 Magento Community Edition 2.1 User Guide
CHAPTER 33:
Google Tools
Your store configuration is integrated with the following Google tools to help optimize your content, analyze your traffic, and connect your catalog to shopping aggregators and marketplaces.
l
l
Magento Community Edition 2.1 User Guide 523
Google Analytics CHAPTER 33: Google Tools
Google Analytics
Google Universal Analytics gives you the ability to define additional custom dimensions and metrics for tracking, with support for offline and mobile app interactions, and access to ongoing updates.
Google Analytics
Process Overview:
Step 1: Sign Up for Google Universal Analytics
Step 2: Complete the Magento Configuration
Step 1:
Sign Up for Google Universal Analytics
Visit the Google website, and sign up for a Google Universal Analytics account.
Step 2:
Complete the Magento Configuration
1.
Return to your store, and log in to the Admin. On the Admin sidebar, tap Stores. Then under
Settings
, choose Configuration.
2.
In the panel on the left, under Sales, choose Google API.
3.
Expand the Google Analytics section. Then, do the following:
a.
Set Enable to “Yes.”
b.
Enter your Google Analytics Account Number.
c.
If you want to conduct A/B testing and other performance tests on your content, set
Content Experiments
to “Yes.”
4.
When complete, tap
Save Config
.
524 Magento Community Edition 2.1 User Guide
CHAPTER 33: Google Tools Google AdWords
Google AdWords
Google AdWords is a service that you can use to place ads in Google Search results and on the pages of companies in the Google Display Network. The AdWords dashboard includes tools to manage your campaigns, track response, and measure results.
Conversion tracking shows how many ad clicks lead to a sale or other valuable action. The
"Success" page that appears to your customer after an order has been submitted is used to track conversions because it appears only after a sale. After completing the Google AdWords configuration for your store, there is no need to copy the conversion tracking script to the
"Success" page, because Magento already has the necessary information. To learn more, see
Google AdWorlds Help .
Magento Ad in Google Search Results
Step 1:
Create a Google AdWords Campaign
1.
Visit Google AdWords , and sign up for an account.
2.
Follow the instructions to create a campaign.
3.
To set up conversion tracking for your campaign, do the following:
a.
On the Tools tab of your AdWords dashboard, choose Conversions. Then, tap
Conversion
.
b.
When prompted for the conversion source, choose Website
c.
Enter a name for the conversion action that you want to track. Then, tap
Done
.
d.
Click Value. Then if applicable, assign a value to the conversion. For example, l
If you make $5 on each sale, choose "Each time it happens," and assign a value of $5.
l
If the value of each sale varies, leave the value blank.
Then, tap
Done
.
e.
Tap
Conversion windows
, and complete the settings to determine how long the conversions are to be tracked, the reporting category, and attribution model.
Magento Community Edition 2.1 User Guide 525
Google AdWords CHAPTER 33: Google Tools
4.
When complete, tap
Save and Continue
.
Step 2:
Get Your Conversion Tag
1.
Under Install your tag, choose to count conversions on Page load.
2.
As an option, you can add the Google Site Stats notification to the conversion page. The notification appears in the lower corner with a link to Google's security standards and cookie usage.
3.
To choose how you want to manage the your AdWords tag, do one of the following: l
If you plan to add the script to your store yourself, choose Save instructions and tag.
l
If you plan to have someone else add the script to your store , choose Email instructions
and tag
.
4.
When complete, tap
Done
.
Step 3:
Configure Your Store
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
If configuring Google AdWords tor a specific store view, do the following:
a.
In the upper-left corner, choose the Store View that is to be configured.
b.
When prompted to confirm scope switching, tap
OK
.
3.
In the panel on the left, under Sales, choose Google API. Then, expand
AdWords
section and do the following: the Google
a.
If necessary, clear the Use Website checkbox for each setting to be changed.
b.
Set Enable to “Yes.”:
c.
Enter the Conversion ID from your Google AdWords script.
526 Magento Community Edition 2.1 User Guide
CHAPTER 33: Google Tools Google AdWords
Google AdWords
4.
To format the Google Sites Stat notification, do the following:
a.
Set Conversion Language to the language that is identified in your Google AdWords script.
b.
Enter the Conversion Format to be used for the Google Sites Stat notification on the conversion page.
1
2
3
Displays a one-line notification with a link to more information about Google tracking.
Displays a two-line notification with a link to more information about Google tracking.
Displays no customer notification.
c.
Enter the hexadecimal code for the Conversion Color that you want to use for the Google
Site Stats notification label.
d.
Enter the encrypted text for the Conversion Label that appears on the Google Sites Stat notification.
For example: MlEYCOKBnGoQz6CZoAM
Sample Google AdWords Tag Code
<!-- Google Code for Back to School Sale Conversion Page -->
<script type="text/javascript">
/* <![CDATA[ */ var google_conversion_id = 999999999; var google_conversion_language = "en"; var google_conversion_format = "3";
Magento Community Edition 2.1 User Guide 527
Google AdWords CHAPTER 33: Google Tools var google_conversion_color = "ffffff"; var google_conversion_label = "MlEYCOKBnGoQz6CZoAM"; var google_remarketing_only = false;
/* ]]> */
</script>
<script type="text/javascript" src="//www.googleadservices.com/pagead/conversion.js">
</script>
<noscript>
<div style="display:inline;">
<img height="1" width="1" style="border-style:none;" alt="" src="//www.googleadservices.com/pagead/conversion/872829007/?label=MlEYCOK
BnGoQz6CZoAM&guid=ON&script=0"/>
</div>
</noscript>
5.
Set Conversion Value Type to one of the following:
Dynamic
Constant
Determines that a conversion has occurred based on the dynamic Order
Amount value.
Determines that a conversion has occurred based on a specific value entered.
For a Constant conversion value type, enter a specific Value for the Order Amount to qualify as a conversion.
6.
When complete, tap
Save Config
.
Step 4:
Verify the Configuration
Within a few hours, the tracking status in your Google AdWords dashboard changes from
"Unverified" to "No recent conversions" or "Recording conversions." When someone clicks your ad and makes a purchase, the conversion appears on the Conversion Actions page of your dashboard and campaign report.
528 Magento Community Edition 2.1 User Guide
CONTENT
529
530
Content Elements
In this section of the guide, you’ll learn how to create and manage content pages and blocks, and use variables and widgets to add dynamic content.
CHAPTER 34:
Content Menu
The term content marketing
1 refers to the art of promoting your products or services by providing valuable information to your customers at no charge. The quality of your content helps distinguish your store from others, increases your visibility to search engines, and provides support to your customers. This soft-sell approach is often more effective than advertising, builds credibility and trust, and can turn your store into a destination.
Content is still king.
Your content should reflect the branding of your store, and be delivered with your distinctive visual presentation and voice to convey your message. Use pictures to tell a story. Educate, inspire, and entertain. Keep in mind that with quality content, sometimes less is more.
To display the Content menu:
On the Admin sidebar, tap
Content
.
Content Menu
1The art of promoting products or services by providing valuable information at no charge.
Magento Community Edition 2.1 User Guide 531
532
Menu Options
CHAPTER 34: Content Menu
Pages
Create pages with text, images, blocks, variables, and widgets, that can be incorporated into the navigation of your store, and linked to other pages..
Blocks
Create blocks of content without writing any code.
Blocks can contain text, images, and even video, and can be assigned to any part of the page layout.
Widgets
Display dynamic data and add blocks, links, and interactive elements most anywhere in your store.
Magento Community Edition 2.1 User Guide
CHAPTER 35:
Pages
All content can be viewed in terms of its shelf life, just as any product in a store. Did you know that the shelf life of social media content is less than twenty-four hours? The potential shelf life of the content you create can help you decide where to invest your resources.
Content with a long shelf life is sometimes referred to as evergreen content
1
. Examples of evergreen content include customer success stories, "how to" instructions, and
Frequently Asked Questions (FAQ.) In contrast, content is perishable by nature includes events, industry news, and press releases.
1Content that has a long shelf life.
Magento Community Edition 2.1 User Guide 533
Core Content CHAPTER 35: Pages
Core Content
The Magento demo store has examples of core content pages to help you get started. Take a look at the following pages in your store, to make sure that the content conveys your message, voice, and brand.
Content Pages
Home
The demo “Home” page includes a banner, an image carousel, several static blocks with links, and a list of new products.
About Us
The “About Us” page is linked from the footer of your store. You can include images, video, links to press releases and announcements. The sample page has an image on the right, and one of a decorative sort to indicate the end of the page.
534 Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Core Content
Customer Service
The “Customer Service” page is another node in the page hierarchy. The two headers on the page have content that only becomes visible when the header is clicked.
Privacy Policy
Your store’s “Privacy Policy” page should be updated with your own information. As a best practice, your privacy policy should explain to your customers the type of information that your company collects and how it is used.
404 Not Found
The “404 Page Not Found” page is named for the response code that is returned when a page cannot be found. URL redirects reduce the number of times that this page appears. However, for those times when it is necessary, you might as well take advantage of the opportunity to offer some links to products that the customer might find interesting.
Magento Community Edition 2.1 User Guide 535
Core Content CHAPTER 35: Pages
Enable Cookies
The “Enable Cookies” page appears when visitors to your site do not have cookies enabled in their browsers. The page provides step-by-step, illustrated instructions to enable cookies for the most popular browsers.
Service Unavailable
The “503 Service Unavailable" page is named for the response code that is returned when the server is unavailable.
536 Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Core Content
Default Pages
The Default Pages configuration determines the landing page that is associated with the
URL , and the corresponding home page. It also determines which page appears when a “Page
Not Found” error occurs, and if a
appears at the top of each page.
To configure the default pages:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Web.
3.
Expand the Default Pages section. Then, do the following:
Default Pages
a.
In the Default Web URL field, enter the relative path to the folder in the Magento installation that contains the landing page. The default value is “cms.”
For a specific store view, clear the
Use Default checkbox next to the Default Web URL field, and any other default fields to be changed.
b.
Set CMS Home Page to the CMS page to be used as the home page.
c.
In the Default No-route URL field, enter the relative path to the folder in the Magento installation where the page is redirected when a “404 Page Not Found” error occurs. The default value is “cms/index/noRoute.”
d.
Set CMS No Route Page to the CMS page that appears when a “404 Page Not Found” error occurs.
e.
Set CMS No Cookies Page to the CMS page that appears when cookies are disabled in the browser.
f.
If you want a breadcrumb trail to appear at the top of all CMS pages, set Show
Breadcrumbs for CMS Pages
to “Yes.”
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 537
Workspace Controls CHAPTER 35: Pages
Workspace Controls
The page workspace includes tools to help you quickly find the pages you need, and commands to perform routine maintenance on individual or multiple pages. You can also quickly update page properties from the grid.
538
Pages Grid
To quickly update page properties:
1.
Click any row in the grid. To select multiple records, mark the checkbox of each row that you want to update.
Update Page Properties
2.
Update any of the following properties: l
Title l
URL Key l
Status l
Layout
3.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Workspace Controls
Workspace Controls
CONTROL
Add New Page
DESCRIPTION
Adds a new page.
Search
Actions
Select
Save Edits
Initiates a catalog search based on the current filters.
Lists all actions that can be applied to selected items in the list. To apply an action to a page, or to multiple pages, mark the checkbox in the first column of each record that is subject to the action. Options:
Delete
Disable
Enable
Edit
The control in the header of the first column can be used to select multiple records as the target of action. Mark the checkbox in the first column of each record that you want to select. Options: Select All /
Deselect All
Applies the current action to selected records.
Edit Opens the record in edit mode. You can accomplish the same thing by clicking anywhere on the row.
Magento Community Edition 2.1 User Guide 539
Workspace Controls
Columns
COLUMN
Select
ID
Title
URL Key
Layout
Store View
Status
Created
Modified
Action
CHAPTER 35: Pages
DESCRIPTION
The checkbox in the first column is used to select multiple records:
Options:
Select All
Deselect All
The ID is an incrementing number that is assigned to each page.
The page title appears at the top of each page.
The URL key is similar to a file name, and identifies the page in the
URL.
Determines if the page appears with sidebars to the right or left of the main content area. Options:
1 column
2 columns with left bar
2 columns with right bar
3 columns
Empty
Can be used to associate the page with a specific store view.
Indicates if the page is currently online or offline. Options: Enabled /
Disabled
The date the page was created.
The data the page was last modified.
The actions that can be applied to an individual record include:
Edit Opens the page in edit mode.
Delete
View
Deletes the page.
Displays the page in preview mode.
540 Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Workspace Controls
Page Search
The Search box in the upper-left of the page grid can be used to find specific pages by keyword.
For a more advanced search, you can
the search by multiple parameters.
Keyword Search Results
To search by keyword:
1.
Enter a search term into the page search box.
2.
Tap Search to display the results. The results include all pages that contain the keyword.
Magento Community Edition 2.1 User Guide 541
Workspace Controls CHAPTER 35: Pages
To filter search:
1.
If necessary, click Clear All to clear the previous search criteria.
2.
Tap the Filters tab to display the selection of search filters.
3.
Complete as many of the filters as necessary to describe the page(s) that you want to find.
4.
Tap
Apply Filters
to display the results.
Filtered Search
542 Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages
Search Filters
FILTER
ID
Title
URL Key
Created
Modified
Store View
Layout
Workspace Controls
Status
Apply Filters
Cancel
Clear All
DESCRIPTION
Filter the search by page record ID.
Filter the search based on the page title.
Filter the search by the URL Key.
Filter the search by the date the page was created.
Filter the search based on the date the page was last modified.
Filter the search based on store view. Options: (All available Store
Views)
Filter the search based on page layout. Options:
1 column
2 columns with left bar
2 columns with right bar
3 columns
Empty
Filter the search on the page status. Options: Disables / Published
Applies all filters to the search.
Cancels the current search.
Clears all search filters.
Magento Community Edition 2.1 User Guide 543
Workspace Controls CHAPTER 35: Pages
Page Actions
Pages can be edited, disabled, enabled, and deleted. To apply an action to an individual page, mark the checkbox in the first column. To select or deselect all pages, use the mass actions control at the top of the column.
Page Actions
To apply an action:
The Action column on the far right can be used to apply any of the following actions to the individual page: l
Edit l
Delete l
View
544
Single Page Actions
Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Workspace Controls
Page Grid Layout
The selection of columns and their order in the grid can be changed according to your preference. To keep the new column arrangement, you can save it as a view.
Moving a Column
To change the selection of columns:
In the upper-right corner, tap the Columns ( ) control. Then, do the following: l
Mark the checkbox of any column you want to add to the grid.
l
Clear the checkbox of any column you want to remove from the grid.
To move a column:
1.
Tap the header of the column, and hold.
2.
Drag the column to the new position, and release.
Magento Community Edition 2.1 User Guide 545
Workspace Controls
To save a view:
1.
Tap the View ( ) control. Then, tap Save Current View.
CHAPTER 35: Pages
546
Save Current View
2.
Enter a name for the view. Then, click the arrow ( ) to save all changes. The name of the view now appears as the current view.
To change the view:
Tap the View ( ) control. Then, do one of the following: l
Choose the view that you want to use.
l
To change the name of a view, tap the Edit ( ) icon. Then, update the name.
Choose a View
Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Adding a New Page
Adding a New Page
The process of adding a new content page to your store is essentially the same for any type of page you might want to create. You can include text, images, blocks of content, variables, and widgets. Most content pages are designed to be read by search engines first, and by people second. Keep the needs of each of these two very different audiences in mind when choosing the page title, and URL, and when composing the meta data, and content.
The following instructions walk you through each step to create a basic page. Some advanced features are skipped over, but are covered in other topics.
Pages
Process Overview:
Step 1:
Step 2:
Step 3:
Step 4:
(Optional)
Step 7:
Step 1:
Add a New Page
1.
On the Admin sidebar, tap Content. Then under Elements, choose Pages.
2.
Tap
Add New Page
.
Magento Community Edition 2.1 User Guide 547
Adding a New Page CHAPTER 35: Pages
548
New Page
3.
On the new page, do the following:
a.
By default, a new page is published when the record is saved. If you do not want to publish the page immediately, set Enable Page to "No."
4.
b.
Enter the Page Title. The Page Title is the name that appears in the
navigation.
To schedule design changes, expand following: the Custom Design Update section. Then, do the
a.
Use the calendar effect.
to choose the From and To dates when the design change is to be in
b.
If applicable, set New Theme to a different theme that is to be used for the page.
c.
If applicable, set New Layout to one of the following: l
1 column l
2 columns with left bar l
2 columns with right bar l
3 columns l
Empty
Custom Design Update
Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages
Step 2:
Complete the Content
1.
Expand the Content section.
Adding a New Page
Content
2.
In the Content Heading box, type the heading that you want to appear at the top of the page.
3.
By default, the editor opens in WYSIWYG mode with the toolbar at the top.
l
If you prefer to work directly with the HTML code, tap
Show / Hide Editor
.
4.
Complete the content and format the text as needed. You can add
, and
as needed. To learn more, see:
.
5.
Tap
Save and Continue Edit
.
Step 3:
Complete the SEO Information
1.
Expand the Search Engine Optimization section. Then, do the following:
a.
When the page was saved, a default URL key was created that is based on the Content
Heading. You can accept the default, or enter another URL Key that consists of all lowercase characters, with hyphens instead of spaces.
b.
Enter a Meta Title for the page. The Meta Title should be less than seventy characters in length, and appears in the browser title bar and tab.
c.
Enter your choice of high-value Meta Keywords that search engines can use to index the page. Separate multiple words with a comma. Meta keywords are ignored by some search engines, but used by others.
d.
In the Meta Description field, enter a brief description of the page for search results listings. Ideally, the description should be from 150-160 characters in length, with a maximum limit of 255.
Magento Community Edition 2.1 User Guide 549
Adding a New Page CHAPTER 35: Pages
Search Engine Optimization
2.
Tap
Save and Continue Edit
.
Step 4:
Define the Scope of the Page
1.
Expand the Page in Websites section.
2.
In the Store View list, select each view where the page is to be available. If the installation has multiple websites, select each website and store view where the page is to be available.
Pages in Websites
Step 5:
Enter Any Design Changes
(Optional)
1.
Expand the
Design
section. Then, do the following:
Design
550 Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Adding a New Page
a.
To change the
page layout , set Layout to one of the following:
l
1 column l
2 columns with left bar l
2 columns with right bar l
3 columns l
Empty
b.
To include additional
layout instructions , enter valid XML code in the Layout Update
XML
box.
Step 6:
Preview the Page
1.
To return to the Pages grid, tap Save Page.
2.
Fnd the page in the grid. Then in the Action column, select View.
3.
To return to the grid, tap
Back
in the upper-left corner of the browser window.
Step 7:
Publish the Page
1.
In the Action column of the grid, select Edit.
2.
Set Enable Page to "Yes."
3.
Tap
Save Page
.
Now that your page is complete, it can be added to your store navigation, linked to other pages, or added as a link in the footer of your store. You can also use it as your new
.
Magento Community Edition 2.1 User Guide 551
Adding a New Page CHAPTER 35: Pages
Switching Home Pages
You can maintain a selection of different home pages, and activate the page that you want to use as the default home page.
To Change the Home Page:
1.
Complete the steps to add a new
.
2.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3.
In the panel on the left under General, choose Web.
4.
Expand the Default Pages section. Then, do the following:
Default Pages
a.
Set CMS Home Page to the new page.
b.
Tap
Save Config
.
5.
In the message at the top of the workspace, tap the Cache Management link, and refresh any invalid caches.
552 Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Media Storage
Media Storage
Media storage helps you organize and gain access to media files that are stored on the server.
The path to the location of the files is determined by the
configuration. Files in media storage can be accessed from the editor while working on pages and static blocks. Media storage is usually located in the file system on the same server as the Magento program files.
Alternatively, media files can be managed in a
, or located on a separate server or
content delivery network . The editor can be configured to use either static or
for catalog content in category or product descriptions.
Media Storage
To insert an image from media storage:
Open the page or block to be edited. Then, use one of the following methods to insert an image from media storage:
Method 1: From WYSIWYG Mode
1.
On the toolbar of the WYSIWYG
).
2.
After the Image URL field, click Browse ( ).
Magento Community Edition 2.1 User Guide 553
Media Storage CHAPTER 35: Pages
Insert Image (WYSIWYG Mode)
3.
In the directory tree on the left, navigate to the folder where the image is stored.
4.
Select the tile of the image. Then, tap
Insert File
.
Insert File
Method 2: From HTML Mode
1.
Position the cursor in the code where the <img> tag is to be inserted.
2.
Tap
Insert Image
.
Insert Image (HTML Mode)
554 Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Media Storage
To upload files to media storage:
The first two steps are the same as if you are inserting an image.
1.
On the toolbar of the WYSIWYG
).
2.
After the Image URL field, click Browse ( ).
3.
In the directory tree on the left, do one of the following: l
Navigate to the folder where you want to save the uploaded image.
l
Navigate to the place where you want to create a new folder, and tap
Create Folder
. Then, enter the folder name, and tap OK.
4.
To upload file(s) to media storage, tap
Choose Files
. Then, do the following:
a.
In the directory of your local computer, navigate to the location of the images.
b.
Select each image that is to be uploaded.
c.
Tap
Open
.
The images are uploaded to the current media storage folder on the server.
Media Storage
Magento Community Edition 2.1 User Guide 555
Using the Editor CHAPTER 35: Pages
Using the Editor
The WYSIWYG editor gives you the ability to enter and format while working in a “What You
See Is What You Get” view of the content. If you prefer to work directly with the underlying
HTML code, you can easily change modes. The editor can be used to create content for pages, blocks, and product descriptions. When working in the product catalog, the editor is accessed by clicking the WYSIWYG Editor button.
For a complete list of toolbar buttons, see: Using the Editor .in the online guide.
Editor Toolbar
Inserting a Link
An easy way to insert a link is to use the Link button in the editor toolbar. It doesn’t require any knowledge of HTML, and the result is the same.
To insert a link:
1.
Highlight the text where you want to create the link. Then, in the editor toolbar, tap the Link button.
556
Insert Link Button
2.
In the Link URL field, enter one of the following: l
The URL Key of a page in your store.
l
The full URL of an external page to be linked.
3.
Set Target to one of the following: l
Open link in the same window l
Open in a new window
4.
In the Title field, enter the tooltip text to appear when someone hovers over the link.
Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Using the Editor
5.
Tap
Insert
to create the link.
Inserting an Image
From the editor, you can insert an image that has been uploaded to
, or link to an image that resides on another server.
Media Storage
Method 1:
Insert an Image from Media Storage
1.
If necessary, tap
Show / Hide Editor
to work directly with the code.
2.
Position the cursor where you want the code for the image to be inserted. Then, tap
Insert
Image
.
3.
Choose the image that you want to use, and tap
Insert File
.
4.
To view the image in WYSIWYG mode, tap
Show / Hide Editor
again.
Method 2
: Insert an Image from Another Server
Use this method to insert an image that is available online, but resides on another server. You must have the full URL of the image to complete the process.
1.
If necessary, tap
Show / Hide Editor
to work in WYSIWYG mode.
2.
Position your cursor where you want the image to appear.
3.
On the Editor toolbar, tap the
Insert Image
button. Then, do the following:
Magento Community Edition 2.1 User Guide 557
Using the Editor CHAPTER 35: Pages
558
Insert Image Button
a.
In the Image URL field, paste the full URL to the image on the other server.
b.
In the Image Description field, enter a brief description of the image.
c.
In the Title field, enter a relevant title for the image.
4.
Tap
Insert
to complete the process.
Inserting a Widget
The
tool can be used to add a variety of content elements to the page, including links to any content page or node, product, or category. Links can be positioned on the page in a block format, or incorporated directly into the content. You can use the Widget tool to create links to the following types of content: l
l
l
By default, links inherit their style from the style sheet of the theme.
To insert a widget:
1.
Open the content page to be edited.
2.
In the panel on the left, choose Content. Then, use either of the following methods:
Method 1:
WYSIWYG Mode
1.
Tap
Show / Hide Editor
to work in WYSIWYG mode.
2.
Position the cursor in the text where you want the widget to appear.
3.
On the editor toolbar, tap
Insert Widget
.
Method 2:
HTML Mode
From the HTML editor, tap
Insert Widget
.
3.
When prompted, choose the Widget Type. This example shows how to insert a link to a product.
Magento Community Edition 2.1 User Guide
CHAPTER 35: Pages Using the Editor
4.
To use the product name, leave the Anchor Custom Text field empty.
5.
Enter a Anchor Custom Title for best SEO practice. (The title isn't visible on the page.)
6.
Set Template to one of the following: l
To incorporate the link into text, select “Product Link Inline Template.” l
To place the link on a separate line, select “Product Link Block Template.”
7.
Tap
Select Product
, and do the following:
a.
In the tree, navigate to the category you want.
b.
In the list, choose the linked product.
c.
Click
Insert Widget
to place the link on the page. In the HTML, a
for the link appears at the top of the page, enclosed in double curly braces.
d.
If needed, use Cut (Ctrl + x) and Paste (Ctrl + v) to position the markup tag in the code where you want the link to appear.
8.
Tap
Show / Hide Editor
to see the link in WYSIWYG mode.
You can continue editing the page, and incorporate other links into the content.
Inserting a Variable
Your store includes many predefined variables that can be incorporated into content pages and other communications.
To insert a variable on a page:
1.
Do one of the following: l
Open an existing page.
l
Create a new page.
2.
In the panel on the left, choose Content. Then from the editor, do one of the following: l
Position the cursor where you want the variable to appear, and tap
Insert Variable
.
l
If you prefer to work with the code, click
Show / Hide Editor
. Position the insertion point in the text where you want the variable to appear. Then, tap
Insert Variable
.
3.
In the list of available variables, choose the one you want to insert into the page.
4.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide 559
Using the Editor CHAPTER 35: Pages
Configuring the Editor
The WYSIWYG editor is enabled by default, and can be used to edit content on CMS pages and blocks, and in products and categories. From the configuration you can activate or deactivate the editor, and elect to use static—rather than
—
for media content in product and category descriptions.
WYSIWYG Options
To configure the editor:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Content Management.
3.
Expand the WYSIWYG Options section, and do the following:
a.
Set Enable WYSIWYG Editor to your preference. The editor is enabled by default.
b.
Set Static URLs for Media Content in WYSIWYG for Catalog to your preference for
that is included in category and product field descriptions.
4.
When complete, tap
Save Config
.
560 Magento Community Edition 2.1 User Guide
CHAPTER 36:
Content Blocks
A block is a modular unit of content that can be positioned most anywhere on the page.
Content blocks are sometimes referred to as static blocks, or CMS blocks, and can be used to display fixed information such as text, images, and embedded video, as well as dynamic information from a widget or that originates in a database or other source. Most elements on the home page are blocks that can be easily managed.
You can create custom blocks of content without writing any code, and assign them to appear in a specific place in the page layout. Blocks can also be defined and positioned by making a
in XML code.
Magento Community Edition 2.1 User Guide
Blocks on Home Page
561
Adding New Blocks CHAPTER 36: Content Blocks
Adding New Blocks
Custom blocks of content can be added to any page, group of pages, or even to another block.
You can place code for a carousel image slider in a block, and then position the block on the home page.
The Blocks workspace uses the same
as the Pages workspace to help you find blocks and perform routine maintenance operations.
Blocks Workspace
562 Magento Community Edition 2.1 User Guide
CHAPTER 36: Content Blocks
To create a block:
1.
On the Admin sidebar, tap Content. Then under Elements, choose Blocks.
2.
In the upper-right corner, tap
Add New Block
. Then, do the following:
Adding New Blocks
New Block
a.
By default the status of the new block is enabled. If you want to change the status, set
Enable Block
to “No.”
b.
Assign a Block Title for internal reference.
c.
Assign a unique Identifier for the block. Use all lowercase characters, with underscores instead of spaces.
d.
Select each Store View where the block is to be available.
e.
Complete the block Content as needed.
l
Use the
to format text, create links and tables, images, video, and audio.
l
If you prefer to work with the HTML code, tap
Show / Hide Editor
.
3.
When complete, tap
Save Block
.
The new block appears at the bottom of the list in the Blocks grid.
Magento Community Edition 2.1 User Guide 563
Adding New Blocks CHAPTER 36: Content Blocks
Adding Social Plugins
Social networking sites have a numerous oplugins that can easily be added to your store. In addition, there are many extensions on Magento Connect that can be used to integrate your store with social media. The following example shows how to add a Facebook “Like” button to your store.
564
Facebook Plugins
Step 1:
Get the Button Code
1.
On the Facebook website, go to the button setup page.
2.
In the URL to Like field, enter the URL of the page in your store that you want people to Like.
For example, you might enter the URL of your store’s home page. Then, do the following:
a.
Choose the Layout for the button.
b.
Enter the Width in pixels that is available on your site for the button and any associated text message.
c.
Set Action Type to one of the following: l
Like l
Recommend
3.
Tap
Get Code
to copy the generated code to the clipboard.
Magento Community Edition 2.1 User Guide
CHAPTER 36: Content Blocks Adding New Blocks
Like Button Setup
Step 2:
Create a Content Block
1.
Return to your store. On the Admin sidebar, tap Content. Then under Elements, choose
Blocks
.
2.
In the upper-right corner, click tap Add New Block. Then, do the following:
a.
Enter a descriptive Block Title for internal reference. For example: Facebook Like Button.
b.
Assign a unique Identifier to the block, using all lowercase characters, and underscores instead of spaces. For example: facebook_like_button.
c.
If your Magento installation has multiple store views, choose each Store View where the block is to be available.
d.
Paste the snippet of code that you copied from the Facebook site into the Content box.
e.
If the block is not ready to “go live,” set Enable Block to “No.”
3.
When complete, tap
Save Block
.
Step 3:
Place the Block
1.
On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
2.
In the upper-right corner, tap Add Widget. Then, do the following:
a.
In the Settings section, set Type to “CMS Static Block.” Then, tap
Continue
.
b.
Verify that Design Theme is set to the current theme.
c.
Tap
Continue
.
3.
In the Storefront Properties section, do the following:
Magento Community Edition 2.1 User Guide 565
Adding New Blocks CHAPTER 36: Content Blocks
a.
In the Widget Title field, enter a title for internal reference.
b.
Set Assign to Store Views to “All Store Views,” or to the view where the app will be available. To select more than one, hold the Ctrl key down and select each option.
c.
Enter a number in the Sort Order field to determine the order of the block if it assigned to appear in the same location on the page as other content elements. The top position is zero.
4.
In the Layout Updates section, tap
Add Layout Update
. Then, set Display On to the category, product, or page where you want the block to appear.
For example, if you choose “All Pages,” and position the block in either the header or footer, the block will appear in the same place on every page of the store.
To place the block on a specific page, do the following:
a.
Set Display On to “Specified Page.” Then, select the Page where you want the block to appear.
b.
Choose the Block Reference to identify the place on the page where the block is to be placed.
c.
Accept the default setting for Template, which is set to "CMS Static Block Default
Template."
d.
Tap
Save and Continue Edit
.
5.
In the panel on the left, choose Widget Options.
6.
Tap
Select Block…
. Then in the list, choose the block that you want to place.
7.
When complete, tap
Save
.
8.
When prompted, follow the instructions at the top of the workspace to update the index and page cache.
The widget now appears in the Widgets grid.
Step 4:
Verify the Location in Your Store
Return to your storefront to verify that the block is in the correct location. To move the block, you can reopen the widget try a different page or block reference.
566 Magento Community Edition 2.1 User Guide
CHAPTER 36: Content Blocks Adding New Blocks
Adding a Lightbox or Slider
There is a wide assortment of jQuery-based image lightboxes, sliders, and carousels available on Magento Marketplace , and some are free. A recent search on the term “slider” returned thirythree results.
Slider Extensions
To add a lightbox or slider to your store, download the extension from Magento Markeplace, and follow the instructions from the developer.
Magento Community Edition 2.1 User Guide 567
Positioning Blocks CHAPTER 36: Content Blocks
Positioning Blocks
The code that controls the page layout and placement of blocks is written in XML
make it easy to position a block at a specific place on the page, and even for a specific product or category without writing any code. You can choose each option from a list, rather than trying to remember all of the possible combinations.
The following list shows the locations by page type where blocks are typically placed. To learn more about how areas on the page are defined, see:
Category and CMS Pages
BLOCK REFERENCE
Breadcrumbs
Left Column
Main Content Area
My Cart Extra Actions
Navigation Bar
Page Bottom
Page Footer
Page Header
Page Top
Right Column
Store Language
POSITION
The navigation aid at the top of many pages that shows your current location as a link. Any additional content placed in the Breadcrumbs reference floats to the right of the breadcrumbs, if displayed.
Content is added to the left column.
Content is added to the main content area.
Content appears below the Cart Subtotal in the My Cart popup located within the top link.
Content appears below the main navigation bar.
Content appears at the bottom of the page.
Content appears above the footer of the page.
Content appears below the header of the page.
Content appears at the top of the page.
Content appears in the right column.
Content appears in the upper-left corner of the header.
568 Magento Community Edition 2.1 User Guide
CHAPTER 36: Content Blocks Positioning Blocks
Product Page
BLOCK REFERENCE
Alert URLs
POSITION
Content appears below the title of the product on the product detail page.
Bottom Block Options
Wrapper
Breadcrumbs
Info Column Options
Wrapper
Left Column
Main Content Area
My Cart Extra Actions
If custom options are added, content appears below the Add to Cart button.
Content appears to the right of breadcrumbs—the navigation aid that provides links as a path—that’s showcased below the navigation bar.
If a custom options are added, content appears to the right. The same location applies to configurable options.
Content appears below the left column blocks.
Content appears below the main content area.
Content appears below the Cart Subtotal in the My Cart popup located within the top link.
Navigation Bar
Page Bottom
Page Footer
Page Header
Content appears below the main navigation bar.
Content appears at the bottom of the page.
Content appears above the footer of the page.
Content appears below the header of the page.
Page Top Content appears at the top of the page.
PayPal Express Checkout
(Payflow Edition) Shortcut
Wrapper
If the PayPal payment method is enabled, content appears below the
PayPal buy button.
PayPal Express Checkout
Shortcut Wrapper
If the PayPal payment method is enabled, content appears below the
PayPal buy button.
Product Tags List
Product View Extra Hint
Right Column
Store Language
Tags List Before
Content appears below the products tag bar.
Content appears below the main top price of the product.
Content appears below the right column blocks.
Content appears to the right of the language chooser.
Content appears above the Add Your Tags field.
Magento Community Edition 2.1 User Guide 569
Positioning Blocks CHAPTER 36: Content Blocks
Using a Widget
The CMS Static Block widget gives you the ability to place an existing
most anywhere in your store.
570
Process Overview:
Step 2: Complete the Layout Updates
Step 1:
Choose the Type
1.
On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
2.
In the upper-right corner, tap
Add Widget
. Then do the following:
a.
In the Settings section, set Type to “CMS Static Block.” Then, tap
Continue
.
b.
Verify that Design Theme is set to the current theme.
c.
Tap
Continue
.
Magento Community Edition 2.1 User Guide
CHAPTER 36: Content Blocks Positioning Blocks
Settings
3.
In the Storefront Properties section, do the following:
a.
In the Widget Title field, enter a descriptive title for internal reference.
b.
Set Assign to Store Views to “All Store Views,” or to the view where the app will be available. To select more than one, hold the Ctrl key down and select each option.
c.
Enter a number in the Sort Order field to determine the order of the block if it assigned to appear in the same location on the page as other content elements. The top position is zero.
Magento Community Edition 2.1 User Guide
Storefront Properties
571
Positioning Blocks CHAPTER 36: Content Blocks
Step 2:
Complete the Layout Updates
1.
In the Layout Updates section, tap
Add Layout Update
. Then, do the following:
2.
Set Display On to the category, product, or page where you want the block to appear. To place the block on a specific page, do the following:
a.
Choose the Page where you want the block to appear.
b.
Choose the Block Reference that identifies the place on the page where the block is to be placed.
c.
Accept the default setting for Template, which is set to "CMS Static Block Default
Template."
Layout Updates
Step 3:
Place the Block
1.
In the panel on the left, select Widget Options.
2.
Tap
Select Block…
. Then in the list, choose the block that you want to place.
3.
When complete, tap
Save
.
The app now appears in the list.
4.
When prompted, follow the instructions at the top of the workspace to update the index and page cache.
5.
Return to your storefront to verify that the block appears in the correct location. To move the block, you can reopen the frontend app try a different page or block reference.
572 Magento Community Edition 2.1 User Guide
CHAPTER 36: Content Blocks Positioning Blocks
Using a Layout Update
Blocks can be placed in the left or right sidebar of a specific page by making a
to the XML code. With a few simple changes to the code, you can position the block in either sidebar, and control its position in relation to other blocks.
The term callout
1 is sometimes used to refer to a block that is defined as a layout update with
XML code. The term sidebar
2 refers to the left or right columns of the page layout. When entering layout update code, make sure to follow the syntax exactly as shown in the example.
To place a block in the sidebar, the page must have a two-or three-column layout. To learn more, see:
.
To place a block in the sidebar of a page:
1.
On the Admin sidebar, tap Content. Then under Elements, choose Blocks.
2.
In the grid, find the block you want to place, and take note of its Identifier. Make sure that you have the correct spelling.
3.
On the Admin sidebar, tap Content. Then under Elements, choose Pages.
4.
Find the page where you want to place the block, and open the page in edit mode.
5.
In the panel on the left, choose Design. Then, do the following:
a.
In the Layout Update XML box, enter the code for the right or left sidebar.
Code for CMS Block in Sidebar
<reference name="right">
<block type="cms/block" name="right.permanent.callout">
<action method="setBlockId"><block_id>your-block-id</block_id></action>
</block>
</reference>
b.
Change the reference name to identify either the “right” or “left” column, according to the layout of the page.
c.
Change the block_id to the identifier of the block that is being placed.
6.
When complete, tap
Save Page
.
1A term that is sometimes used to describe a block that is defined as a layout update using XML code.
2The right or left column of a two-column page layout.
Magento Community Edition 2.1 User Guide 573
574 Magento Community Edition 2.1 User Guide
CHAPTER 37:
Widgets
A widget is a snippet of code that makes it possible to display a wide range of content and place it at specific block references in your store. Many display real-time, dynamic data and create opportunities for your customers to interact with your store. The Widget tool makes it easy to place existing content such as blocks with images and text, and interactive elements most anywhere in your store.
You can use widgets to create landing pages for marketing campaigns, display promotional content at specific locations throughout the store. Widgets can also be used to add interactive elements and action blocks for external review systems, video chats, voting, and subscription forms, or to provide navigation elements for tag clouds and image sliders.
Magento Community Edition 2.1 User Guide 575
Widget Types CHAPTER 37: Widgets
Widget Types
Widgets
TYPE
CMS Page Link
DESCRIPTION
Displays a link to a selected page. Allows you to specify custom text and title. When the link is complete, it can be used in content pages and blocks.
CMS Static Block
Catalog Category Link
Displays a block of content at a specific location on a page.
Displays either an inline or block-style link to a selected catalog category. When the link is complete, it can be used in content pages and blocks.
Catalog New Products List Displays a block of products which have been designated as new, for the duration of time specified in the product record.
Catalog Product Link Displays either an inline or block-style link to a selected catalog product. When the link is complete, it can be used in content pages and blocks.
Catalog Products List Displays a list of products from the catalog.
Orders and Returns
Recently Compared
Products
Gives customers the ability to submit their own requests for returned merchandise authorization.
Displays the block of recently compared products. You can specify the number of products included, and format them as a list or product grid.
Recently Viewed Products Displays the block of recently viewed products. You can specify the number of products included, and format them as a list or product grid.
576 Magento Community Edition 2.1 User Guide
CHAPTER 37: Widgets Creating a Widget
Creating a Widget
The process of creating a widget is nearly the same for each type. You can follow the first part of the instructions, and then complete the last part for the specific type of widget.
Process Overview:
Widgets
Magento Community Edition 2.1 User Guide 577
Creating a Widget CHAPTER 37: Widgets
Step 1:
Choose the Type
1.
On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
2.
Tap
Add Widget
. Then, do the following;
a.
In the Settings section, set Type to the type of widget that you want to create. ”Then, tap
Continue
.
b.
Verify that Design Theme is set to the current theme.
3.
Tap
Continue
.
Widget Settings
578 Magento Community Edition 2.1 User Guide
CHAPTER 37: Widgets Creating a Widget
4.
Under Storefront Properties, do the following:
a.
In the Widget Title field, enter a descriptive title for internal reference only.
b.
Set Assign to Store Views to “All Store Views,” or to the view where the app will be available. To select more than one, hold the Ctrl key down and select each option.
c.
Enter a number in the Sort Order field to determine the order of the block if it appears in the same location as other content elements. The top position is zero.
Storefront Properties
Magento Community Edition 2.1 User Guide 579
Creating a Widget CHAPTER 37: Widgets
Step 2:
Specify Where It Goes
1.
In the Layout Updates section, tap
Add Layout Update
.
2.
Set Display On to the type of page where it is to appear.
3.
In the Block Reference list, choose the area of the page layout where it is to be placed.
580
Layout Updates
4.
If the widget is a link, set Template to one of the following:
Block Template
Inline Template
Formats the content so it can be placed as standalone unit on the page.
Formats the content so it can be placed inside other content. For example, a link that goes inside a paragraph of text.
Step 3:
Complete the Options
The options for each widget type vary slightly, but the process is essentially the same. The following example displays the product list for a specific category, with pagination controls.
1.
In the panel on the left, choose Widget Options.
2.
Tap
Select Block
.
3.
Enter a Title to appear above the list. For example, “Featured Products.”
4.
For pagination controls, set Display Page Control to “Yes.” Then, do the following:
a.
Enter the Number of Products per Page.
b.
Enter the total Number of Products to Display.
c.
Set Condition to the category of products to be featured. The process is the same as setting a condition for a
.
Magento Community Edition 2.1 User Guide
CHAPTER 37: Widgets Creating a Widget
Widget Options
5.
When complete, tap
Save
.
6.
When prompted, follow the instructions at the top of the workspace to update the cache, as needed.
Step 4:
Check It Out!
Return to your storefront to verify that the widget is working correctly. To move it to a different location, you can reopen the widget and try a different page or block reference.
Magento Community Edition 2.1 User Guide 581
Creating a Widget CHAPTER 37: Widgets
New Products List
The list of new products is an example of dynamic content, and consists of live data that is pulled from your product catalog. By default, the “New Products” list includes the first eight of the most recently added products. However, it can also be configured to include only products within a specified date range.
582
New Products List on Home Page
Process Overview:
Step 1: Set the Date Range for Each Product
Step 1:
Set the Date Range for Each Product
To make a product appear in the list by date range, the “New From” dates must be entered in the product. The product then appears in the New Products list during the date range specified.
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
Find each product that you want to feature, and open in edit mode. Then, do the following:
a.
In the Set Product as New From field, tap the calendar . Then, choose the first date that you want the product to be featured.
b.
In the To field, tap the calendar . Then, choose the last date that you want the product to be featured.
Magento Community Edition 2.1 User Guide
CHAPTER 37: Widgets Creating a Widget
"Set Product As New " Date Range
3.
When complete, tap
Save
.
4.
When you are prompted to reindex and refresh the page cache, click the links at the top of the workspace, and follow the instructions.
The list of products now appears on the Home Page for the specified date range.
Step 2
: Create the Widget
The code that determines the content of the New Products list and its placement in your store is generated by the Widget tool.
1.
On the Admin sidebar, tap Content. Then under Elements, choose Widgets.
2.
In the upper-right corner, tap
Add Widget
.
3.
In the Settings section, do the following:
a.
Set Type to “Catalog New Products List.”
b.
Choose the Design Theme that is used by the store.
4.
Tap
Continue
.
Widget Type
5.
In the Storefront Properties section, complete the following fields:
Magento Community Edition 2.1 User Guide 583
Creating a Widget CHAPTER 37: Widgets
Widget Title
Assign to Store Views
Sort Order
Enter a descriptive title for your widget. This title is visible only from the Admin.
Select the store views where the widget will be visible. You can select a specific store view, or "All Store Views."
(Optional) Enter a number to determine the order this items appears with others in the same part of the page. (0 = first, 1 = second, 3= third, and so on.)
584
Storefront Properties
Step 3:
Choose the Location
1.
In the Layout Updates section, tap
Add Layout Update
. Then, do the following:
a.
Set Display On to “Specified Page.”
b.
Set Page to “CMS Home Page.”
c.
Set Block Reference to “Main Content Area.”
d.
Set Template to one of the following: l
New Product List Template l
New Products Grid Template
Magento Community Edition 2.1 User Guide
CHAPTER 37: Widgets Creating a Widget
Layout Updates
2.
Tap
Save and Continue Edit
.
For now, you can ignore the message to refresh the cache.
Step 4:
Configure the List
1.
In the panel on the left, choose Widget Options. Then, do the following:
2.
Set Display Products to one of the following:
All Products
New Products
Lists products in sequence, starting with those most recently added.
Lists only the products which are identified as “New.” A product is considered to be new during the date range that is specified in the “Set Product As New From/To” fields. The list will be empty if the date range expires without any new products defined.
3.
Complete the remaining information as follows:
a.
To provide navigation control for lists with multiple pages, set Display Page Control to
“Yes.” Then, in the Number of Products per Page field, enter the number of products you want to appear on each page.
b.
Set Number of Products to Display to the number of new products that you want to include in the list. The default setting is 10.
c.
In the Cache Lifetime (Seconds) field, choose how often you want to refresh the list of new products. By default, the cache is set to 86400 seconds, or 24 hours.
Magento Community Edition 2.1 User Guide 585
Creating a Widget CHAPTER 37: Widgets
Widget Options
4.
When complete, tap
Save
.
5.
When prompted to refresh the cache, click the link in the message at the top of the workspace, and follow the instructions.
Step 5:
Preview Your Work
1.
On the Admin sidebar, tap Content. Then under Elements, choose Pages.
2.
Find the page in the grid where the New Products list is to appear. Then, in the Action column, click the Preview link.
586 Magento Community Edition 2.1 User Guide
Design & Theme
587
588
Contents
Your store's theme is like a window dressing that can be changed for a season or promotion.
In this section, you will learn about page layouts, how to make simple HTML changes, and apply a new theme to your store.
CHAPTER 38:
Design Menu
Magento provides a variety of easy-to-use design options that you can use to make simple changes to your store. In addition, you will find many professionally designed themes available on Magento Connect. Like the window dressing of your store, you can change the theme for the season or for a promotion.
More advanced users will appreciate the flexibility of working with Magento’s objectoriented environment that assembles pages from separate components. After you understand the basics, you’ll appreciate working in such a flexible and fluid environment.
To learn more, see the Frontend Developer Guide .
Design Menu
Magento Community Edition 2.1 User Guide 589
Menu Options
CHAPTER 38: Design Menu
Themes
The theme determines the visual presentation of your store, and consists of a collection of layout files, template files, translation files, and skins.
Schedule
Themes can be activated for a period of time, according to a schedule. Use the schedule to plan theme changes in advance for a season or promotion.
590 Magento Community Edition 2.1 User Guide
CHAPTER 38: Design Menu Design Configuration
Design Configuration
The Design Configuration makes it easy to edit design-related rules and configuration settings by displaying the settings on a single page.
Design Configuration
To edit the design configuration:
1.
On the Admin menu, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
The page displays the current design settings for the store view.
3.
To change the Default Theme, set Applied Theme to the theme that you want to apply to the view.
If no theme is specified, the system default theme is used. Some third-party extensions modify the system default theme.
4.
If the theme is to be used for only a specific device, do the following:
a.
Under Design Rules, tap
Add New User Agent Rule
.
b.
In the Search String column, enter the browser ID for the specific device.
c.
A search string can be either a normal expression or Perl Compatible Regular Expression
(PCRE). To learn more, see: User Agent . The following search string identifies Firefox:
/^mozilla/i
d.
In the Theme Name column, choose the theme that is to be used for the specified device.
Magento Community Edition 2.1 User Guide 591
Design Configuration CHAPTER 38: Design Menu
User-Agent Rules
e.
Repeat the process to enter additional devices. Search strings are matched in the order they are entered.
5.
Under Other Settings, expand each section and edit the settings as needed.
592
Edit Design Configuration
l
l
l
l
l
l
6.
When complete, tap
Save Configuration
.
Magento Community Edition 2.1 User Guide
CHAPTER 39:
Page Setup
The main sections of the page are controlled, in part, by a set of standard HTML tags.
Some of these tags can be used determine the selection of fonts, color, size, background colors, and images that are used in each section of the page. Other settings control page elements such as the logo in the header, and the copyright notice in the footer. The Page
Setup sections correspond to the underlying structure of the HTML page, and many of the basic properties can be set from the Admin.
HTML Page Sections
Magento Community Edition 2.1 User Guide 593
HTML Head CHAPTER 39: Page Setup
HTML Head
The settings in the HTML Head section correspond to the <head> tag of an HTML page, and can be configured for each store view. In addition to meta data for the page title, description, and keywords, the section includes a link to the favicon, and miscellaneous scripts.
Instructions for search engine robots and the display of the store demo notice are also configured in this section.
To configure the HTML Head:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
3.
Under Other Settings, expand the HTML Head section.
4.
Update the fields as needed. (See the
for a description of each field,)
5.
When complete, tap
Save Config
.
594
HTML Head
Magento Community Edition 2.1 User Guide
CHAPTER 39: Page Setup Header
Header
The Header section identifies the path to your store logo, and specifies the logo alt text and welcome message.
Header
To configure the header:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
3.
Under Other Settings, expand the Header section.
4.
Make any changes necessary to the
and
settings.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 595
Footer CHAPTER 39: Page Setup
Footer
The Footer configuration section is where you can update the
that appears at the bottom of the page, and enter miscellaneous scripts that must be positioned before the closing <body> tag..
Footer
To configure the footer:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
3.
Under Other Settings, expand the Footer section.
4.
Make any changes necessary to the Copyright and Miscellaneous HTML settings.
5.
When complete, tap
Save Config
.
596 Magento Community Edition 2.1 User Guide
CHAPTER 40:
Page Layout
The layout of each page in your store consists of distinct sections, or containers, that define the header, footer, and content areas of the page. Depending on the layout, each page might have one, two, three columns, or more. You can think of the layout as the
“floor plan” of the page.
Content blocks float to fill the available space, according to the section of the
where they are assigned to appear. You will discover that if you change the layout from a three-column to a two-column layout, the content of the main area expands to fill the available space, and any blocks that are associated with the unused side bar seem to disappear. However, if you restore the three-column layout, the blocks reappear. This fluid approach, or liquid layout, makes it possible to change the page layout without having to rework the content. If you are used to working with individual HTML pages, you will discover that this modular, “building block” approach requires a different way of thinking.
Magento Community Edition 2.1 User Guide 597
Standard Page Layouts CHAPTER 40: Page Layout
Standard Page Layouts
1 Column
The “1 Column” layout can be used to create a dramatic home page with a large image or focal point.
It’s also a good choice for a landing page, or any other page that has a combination of text, images, and video.
2 Columns with Left Bar
The “2 Columns with Left Bar” layout is often used for pages with navigation on the left, such as a catalog or search results pages with layered navigation. It is also an excellent choice for home pages that need additional navigation or blocks of supporting content on the left.
2 Columns with Right Bar
With a “2 Columns with Right Bar” layout, the main content area is large enough for an eye-catching image or banner. This layout is also often used for
Product pages with blocks of supporting content on the right.
598 Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Standard Page Layouts
3 Columns
The “3 Column” layout has a center column that is wide enough for the main text of the page, with room on each side for additional navigation and blocks of supporting content.
Empty
The “Empty” layout can be used to define custom page layouts. To learn more, see the Magento
Designer’s Guide .
Magento Community Edition 2.1 User Guide 599
Storefront Examples CHAPTER 40: Page Layout
Storefront Examples
The column dimensions are determined by style sheet of the theme. Some themes apply a fixed pixel width to the page layout, while others use percentages to make the page respond to the width of the window or device.
Most desktop themes have a fixed width for the main column, and all activity takes place within this enclosed area. Depending on your screen resolution, there is empty space on each side of the main column.
1 Column Layout
The content area of a “1 Column” layout spans the full-width of the main column. This layout is often used for a home page with a large banner or slider, or pages that require no navigation, such as a login page, splash page, video, or full-page advertisement.
600
1 Column Layout
Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Storefront Examples
2 Columns with Left Bar
The content area of this layout is divided into two columns. The main content column floats to the right, and the side bar floats to the left.
2 Columns Left Bar
2 Columns with Right Bar
This layout is a mirror image of the other two-column layout. This time, the side bar floats to the right, and the main content column floats to the left.
Magento Community Edition 2.1 User Guide
2 Columns Right Bar
601
Storefront Examples CHAPTER 40: Page Layout
3 Columns
A 3-column layout has a main content area with two side columns. The left side bar and main content column are wrapped together, and float as a unit to the left. The other side bar floats to the right.
3 Columns
602 Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Layout Updates
Layout Updates
Before you begin working with custom layout updates, it is important to understand how the pages of your store are constructed, and the difference between the terms layout and layout update. The term layout
1 refers to the visual and structural composition of the page. However, the term layout update
2 refers to a specific set of XML instructions that determines how the page is constructed.
The XML layout of your Magento Community Edition 2.1 store is a hierarchical structure of blocks. Some elements appear on every page, and others appear only on specific pages. You can see how these structural blocks are referenced by examining the layout update code for your home page. To do so, simply open your home page in edit mode, and choose the Design tab to view the Page Layout section. Depending on the theme, it might contain instructions to remove blocks, unset blocks, and add blocks by referencing specific areas of the page layout.
In many cases, the same result can be achieved with the Frontend App tool. To place a block of content as a frontend app, you must identify the page, and the location on the page where you want the block to appear. You can use the Frontend App tool to place a block on most any page in your store, including the home page and all content pages. However, to place a block in the sidebar of a specific page, you must make the change by entering code as a layout update.
1The visual and structural composition of a page.
2A specific set of XML instructions that determines how the page is constructed.
Magento Community Edition 2.1 User Guide 603
Layout Updates CHAPTER 40: Page Layout
Standard Block Layout
In the following diagram, the block names that can be used to refer to a block in the layout are black, and the block types, or block class paths, are blue.
604
Standard Block Layout
Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Layout Updates
Block Descriptions
BLOCK TYPE
page/html
DESCRIPTION
There can be only one block of this type per page. The block name is
"root," and, it is one of the few root blocks in the layout. You can also create your own block and name it "root," which is the standard name for blocks of this type.
page/html_head page/html_notices page/html_header
There can be only one block of this type per page. The block name is
"head," and it is a child of the root block. This block must not be removed from layout.
There can be only one block of this type per page. The block name is
"global_notices," and it is a child of the root block. If this block is removed from the layout, the global notices will not appear on the page.
There can be only one block of that type per page. The block name is
"header," and it is a child of the root block. This block corresponds to the visual header at the top of the page, and contains several standard blocks. This block must not be removed.
page/html_wrapper
Although included in the default layout, this block is deprecated, and only is included to ensure backward compatibility. Do not use blocks of this type.
page/html_breadcrumbs
There can be only one block of this type per page. The name of this block is "breadcrumbs," and it is a child of the header block. This block displays breadcrumbs for the current page.
page/html_footer page/template_links page/switch core/messages
There can be only one block of this type per page. The block name is
"footer," and it is a child of the root block. The footer block corresponds to the visual footer at the bottom of the page, and contains several standard blocks. This block must not be removed.
There are two blocks of this type in the standard layout. The
"top.links" block is a child of the header block, and corresponds to the top navigation menu. The "footer_links" block is a child of the footer block, and corresponds to the bottom navigation menu. It is possible to manipulate the template links, as shown in the examples.
There are two blocks of this type in a standard layout. The "store_ language" block is a child of the header block, and corresponds to the top language switcher. The "store_switcher" block is a child of the footer block, and corresponds to the bottom store switcher.
There are two blocks of this type in a standard layout. The "global_ messages" block displays global messages. The "messages" block is used to display all other messages. If you remove these blocks, the customer won't be able to see any messages.
Magento Community Edition 2.1 User Guide 605
Layout Updates CHAPTER 40: Page Layout
Block Descriptions (cont.)
BLOCK TYPE DESCRIPTION
core/text_list
This type of block is widely used throughout Magento, and is used as a placeholder for rendering children blocks.
core/profiler
There is only one instance of this type of block per page. It is used for the internal Magento profiler, and should not be used for any other purpose.
606 Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Layout Updates
Layout Update Examples
The following blocks types can be manipulated with custom layout instructions. Each action must be specified using the full syntax of the instruction. In the following examples, a simplified notation is used to refer to each action, which corresponds to the full syntax of the instruction.
Full Syntax
?
<!-- Action can be specified inside either a <block> or <reference> instruction. -->
<action method="someActionName">
<arg1>Value 1</arg1>
<arg2>Value 2</arg2>
<!--->
<argN>Value N</argN>
</action>
<!--->
Simplified Syntax
?
someActionName($arg1, $arg2, ..., $argN)
Magento Community Edition 2.1 User Guide 607
Layout Updates CHAPTER 40: Page Layout
page/template_links
Syntax
ACTION DESCRIPTION
addLink($label, $url, $title, $prepare
Adds another link to the end of the list of existing links. Just specify the $label (link caption), $url (link URL) and $title
(link tooltip), and you'll see a new link in the corresponding place. The $prepare parameter must be "true" if you want the
URL to be prepared, or converted to the full URL from the shortened URL. For example, the new page becomes BASE_
URL/newpage if prepared.
removeLinkByUrl($url) Removes a link from the block by its URL. Note that the URL must be properly specified and exactly match corresponding
URL of the link you want to remove.
cms/block
Syntax
ACTION
setBlockId($blockId)
DESCRIPTION
Specifies the ID of a CMS block, so its content can be fetched and displayed when the page is rendered.
?
<!--...-->
<reference name="content">
<block type="cms/block" name="additional.info" as="additionalInfo">
<action method="setBlockId"><id>additional_info</id></action>
</block>
</reference>
<!--->
608 Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Layout Updates
core/text
A core/text block can be used to enter free form text directly into the template.
Syntax
ACTION
addText($textContent)
DESCRIPTION
Specifies text to be rendered as the block's content. After the text is specified, the layout update instructions must continue to be a valid XML statement. If you use HTML tags as part of the text, it is recommended to use:
<![CDATA[...]]>
?
<!--...-->
<reference name="content">
<block type="core/text" name="test.block">
<action method="addText">
<txt><![CDATA[<h2>ATTENTION!</h2><p>Check your options carefully before you submit.</p>]]></txt>
</action>
</block>
</reference>
<!--->
page/html_welcome
This block can be used to duplicate the “Welcome, <USERNAME>!” message that appears in the header block. When the user is not logged in, the welcome message specified in the configuration appears.
Magento Community Edition 2.1 User Guide 609
Layout Updates CHAPTER 40: Page Layout
Layout Update Syntax
Custom layout updates can be applied to product category pages, product pages, and content page to achieve a variety of results, such as:
<block>
<reference>
<action>
<remove>
Create new block.
Update existing content.
Assign actions to blocks.
Remove blocks.
Any change made to the layout is applied when the associated entity—which can be either a product, category, or CMS page—becomes active in the frontend of the store.
Custom layout update instructions consist of well-formed XML tags, without the <?xml ...> declaration and root tag. As with normal XML, every tag must either be empty or properly closed, as shown in the following examples:
<tag attribute="value" />
<tag attribute="value"> ... </tag>
610 Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Layout Updates
<block>
Creates a new block within the current context. Layout block nesting defines the ordering of block initialization location of the blocks on the page.
Syntax
NAME
type
VALUE
*
block class path
An identifier of the block class path that corresponds to the class of the block. See the list of the available block types below.
name before
*
block name identifier
A name that can be used to address the block in which this attribute is assigned. If you create a new block with the name that is the same as one of the existing blocks, your newly created block substitutes the previously existing block. See the list of names of existing blocks below.
block name | '-'
Is used to position the block before a block with the name specified in the value. If "-" value used the block is positioned before all other sibling blocks.
after template as block name | '-'
Is used to position the block after a block with the name specified in the value. If "-" value used the block is positioned after all other sibling blocks.
template filename
A template filename used for the specific block type. As you have no way to see the list of template files, use whatever template value is demanded for every block type listed below.
block alias
An alias name by which a template calls the block in which this attribute is assigned. Sometimes it's necessary to specify the alias for a specific block type.
Magento Community Edition 2.1 User Guide 611
Layout Updates CHAPTER 40: Page Layout
<reference>
Changes the context for all included instructions to a previously defined block. An empty
<reference> tag if of no use, because it affects only the instructions which are children.
Syntax
NAME
name
VALUE
*
block name
A name of a block to reference.
<action>
Used to access block API, in other words, call block's public methods. It is used to set up the execution of a certain method of the block during the block generation. Action child tags are translated into block method arguments. The list of all available methods depends on the block implementation (e.g. public method of the block class).
Syntax
NAME
method
VALUE
*
block method name
A name of the public method of the block class this instruction is located in that is called during the block generation.
<remove>
Removes an existing block from the layout.
Syntax
NAME
name
VALUE
*
block name
The name of the block to be removed.
<extend>
This instruction performs final modifications to blocks which are already part of the layout.
Every attribute in the <block> instruction—except for the block name—is subject for change. In addition, the special attribute parent can be used to change the parent of the block. Simply put the name of the new parent block into the <extend> instruction, and the parent of the block that is referenced will be changed in the layout.
612 Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout
Syntax
NAME
name
* parent
Layout Updates
VALUE
*
block name
The name of any block to be extended.
any other
Any other attribute specific for the <block> instruction.
block name
The name of the block that should become a new parent for the referenced block.
*
Indicates a required value
Magento Community Edition 2.1 User Guide 613
Layout Updates CHAPTER 40: Page Layout
Controlling Block Order
Sometimes more than one content element is assigned to the same structural block. For example, there might be several block that appear in a sidebar. You can control the order of blocks by including a “before” or “after” positioning property in the code. To place a block either before, or after a specific block, replace the hyphen with the block identifier, as shown in the following examples: before="-" after="-"
Places the block at the top of the sidebar, before other blocks.
Places the block at the bottom of the sidebar, after other blocks.
Code to Position Content Blocks
<block type="cms/block" before="-" name="left.permanent.callout">
<block type="cms/block" before="some-other-block" name="left.permanent.callout">
<block type="cms/block" after="-" name="left.permanent.callout">
<block type="cms/block" after="some-other-block" name="left.permanent.callout">
614 Magento Community Edition 2.1 User Guide
CHAPTER 40: Page Layout Layout Updates
XML Load Sequence
For developers, it is important to understand that blocks and layout updates must be loaded in the correct order, in keeping with the rules of precedence and load sequence
1 which determine how the page is rendered. Magento supports the following page layout scenarios:
Scenario 1:
Default Layout
The default layout consists of the visual elements that are visible from every page of the store.
Whether it is a menu item, or a shopping cart block, each item has a handle
2 in the default section of the layout definition.
Scenario 2:
Changes to Specific Pages
The second case allows you to create a different layout for a specific page. The XML layout for specific pages is constructed in the same sequence that Magento loads modules, and is determined by the system configuration.
In addition to the instructions in the layout update files which are specific to each module, you can make a custom layout update that applies to a special case in the backend, and is merged each time the special case occurs.
1The order in which scripts are loaded into memory. To work correctly, some scripts must be loaded before others.
2In programming, a name used to reference an object.
Magento Community Edition 2.1 User Guide 615
616 Magento Community Edition 2.1 User Guide
CHAPTER 41:
Themes
A theme is a collection of files that determines the visual presentation of your store. When you first install Magento Community Edition 2.1, the design elements of the store are based on the “Default” Theme. In addition to the initial default theme that comes with your Magento installation, there is a wide variety of themes that are available “off the shelf” on Magento Connect.
Magento themes include layout files, template files, translation files, and skins. A skin is a collection of supporting CSS, images, and JavaScript files that together, create the visual presentation and interactions that your customers experience when they visit your store.
Themes and skins can be modified and customized by a developer or designer who has knowledge of Magento theme design and access to your server. To learn more, see the
Frontend Developer Guide .
Luma Theme
Magento Community Edition 2.1 User Guide 617
Using the Default Theme CHAPTER 41: Themes
Using the Default Theme
Magento’s default responsive theme renders the display of your storefront for different devices, and incorporates best practices for desktop, table, and mobile devices. Some themes are designed to be used only with specific devices. When Magento detects a specific browser ID, or user agent, it uses the theme that is configured to be used for the specific browser. The search string can also include Perl-Compatible Regular Expressions (PCRE). To learn more, see: User
Agent .
618
Themes
To view the current theme settings:
1.
On the Admin sidebar, tap Content. Then under Design, choose Themes.
2.
In the list of installed themes, find the theme that you want to examine, and click the row to display the settings.
3.
To view a sample page, tap the Theme Preview Image.
Preview Theme
Magento Community Edition 2.1 User Guide
CHAPTER 41: Themes Using the Default Theme
To apply a theme:
1.
On the Admin sidebar, tap Content. Then under Design, choose Configuration.
2.
Find the store view that you want to configure. Then in the Action column, click Edit.
3.
Under Default Theme, set Applied Theme to the one that you want to use for the current view.
Applied Theme
To add a user agent rule:
1.
Under Design Rule, tap
Add New User Agent Rule
. Then, do the following:
Design Rule
a.
In the Search String field, enter the browser ID for the specific device. For example:
Search strings are matched in the order they are entered. For example, for Firefox enter:
/^mozilla/i
b.
Repeat the process to enter additional devices.
2.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 619
Installing a New Theme CHAPTER 41: Themes
Installing a New Theme
When you first install Magento, the design elements of the store are based on the “Default” theme. The Luma theme is also available if you installed the sample data. You can modify a theme, add themes created by others, or create new ones.
contains a growing selection of themes that you can install to change the appearance of your store. To learn how to create or modify a theme, see the Frontend Developer Guide .
620
Magento Marketplace
To install a new theme:
1.
Before you begin, make sure that you have a valid set of Magento 2 Access Keys .
2.
Follow the steps outlined in the Marketplace Quick Tour , to: l
Find a Theme l
Evaluate the Product l
Make a Purchase l
Download the Software l
Install the Theme
3.
To apply the theme to your store, see:
,
Magento Community Edition 2.1 User Guide
CHAPTER 41: Themes Theme Assets
Theme Assets
The term static files
1 refers to the collection of assets, such as CSS, fonts, images, and
JavaScript, that is used by a theme. The location of static files is specified in the
configuration.
A digital signature can be added to the URL of each static file to make it possible for browsers to detect when a newer version is available. The newer version of the file is used if the signature differs from what is stored in the browser's cache.
For a standard installation, the assets associated with a theme are organized in the web folder at the following location below the Magento root.
[magento_root]/app/design/frontend/Magento/[theme_name]/web
Theme Assets
1The collection of assets, such as CSS, fonts, images, and JavaScript that is used by a theme.
Magento Community Edition 2.1 User Guide 621
Theme Assets CHAPTER 41: Themes
To sign static files:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
Expand the Static Files Settings section.
Static Files Settings
4.
Set Sign Static Files to "Yes."
5.
When complete, tap
Save Config
.
FILE TYPE
CSS
DESCRIPTION
Directory that contains the CSS files that control the visual styling that is associated with the skin. Example location on server:
[magento]/app/design/frontend/Magento/[theme]/web/css
Fonts
Images
JS
Directory that contains the fonts that are available to be used by the theme.
Location on server:
[magento]/app/design/frontend/Magento/[theme]/web/fonts
Directory that contains all images used by the theme, including buttons, background textures, and so on. Example location on server:
[magento]/app/design/frontend/Magento/[theme]/web/images
Directory that contains theme-specific JavaScript routines and callable functions.
Example location on server:
[magento]/app/design/frontend/Magento/[theme]/web/js
622 Magento Community Edition 2.1 User Guide
CHAPTER 41: Themes Theme Assets
Merging CSS Files
As part of an effort to optimize your site and reduce page load time, you can reduce the number of separate CSS files by merging them into a single condensed file. If you open a merged
CSS file, you’ll find one continuous stream of text, with line breaks removed. Because you can’t edit the merged file, it’s best to wait until you are out of the development mode, and no longer making frequent changes to the CSS.
To merge CSS files:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
Expand the CSS Settings section.
4.
Set Merge CSS Files to “Yes.”
5.
When complete, tap
Save Config
.
CSS Settings
Magento Community Edition 2.1 User Guide 623
Theme Assets CHAPTER 41: Themes
Merging JavaScript Files
Multiple JavaScript files can be merged into a single, condensed file to reduce page load time. If you open a merged JavaScript file, you’ll find one continuous stream of text, with line breaks removed. If you are finished with the development process, and the code contains no errors, you might consider merging the files.
To merge JavaScript files:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
Expand the JavaScript Settings section.
624
4.
Set Merge JavaScript Files to “Yes.”
5.
When complete, tap
Save Config
.
JavaScript Settings
Magento Community Edition 2.1 User Guide
CHAPTER 41: Themes Scheduling Design Changes
Scheduling Design Changes
Design changes can be scheduled in advance, so they go into effect on schedule. You can use scheduled design changes for seasonal changes, promotions, or just to add variation.
Store Design Schedule
To schedule a design change:
1.
On the Admin sidebar, tap Content. Then under Design, choose Schedule.
2.
Tap
Add Design Change
. Then under General Settings, do the following:
New Design Change
a.
Set Store to the view where the change applies.
b.
Set Custom Design to the theme, or variation of a theme, that is to be used.
to choose the values
c.
To define the period when the change is in effect, use the calendar for the Date From and Date To fields.
3.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide 625
626 Magento Community Edition 2.1 User Guide
CUSTOMERS
627
628
Contents
In this section of the guide, you will become familiar with the customer account dashboard, and learn to configure customer accounts according to your preference. You will also learn how to create customer groups that can be referenced in promotions and tax classes.
CHAPTER 42:
Customers Menu
The Customers menu provides access to customer account management tools, and gives you the ability to see who is currently online in your store.
Customers Menu
To display the Customers menu:
On the Admin sidebar, tap
Customers
.
Magento Community Edition 2.1 User Guide 629
Menu Options
CHAPTER 42: Customers Menu
All Customers
Lists all customers who have registered for an account with your store, or were added by the administrator.
Now Online
Lists all customers and visitors who are currently online in your store.
630 Magento Community Edition 2.1 User Guide
CHAPTER 42: Customers Menu All Customers
All Customers
The Customers page lists all customers who have registered for an account with your store, or were added by the administrator.
All Customers
To view customer information:
1.
On the Admin sidebar, tap Customers. Then, choose All Customers.
2.
Open any customer record in edit mode.
3.
In the panel on the left, choose the information you need to edit. Then, make the necessary changes.
4.
When complete, tap
Save Customer
.
Magento Community Edition 2.1 User Guide 631
Now Online CHAPTER 42: Customers Menu
Now Online
The Now Online option on the Customers menu lists all customers and visitors who are currently online in your store. The length of the
is set in the configuration, and determines how long the customer’s activity is visible from the Admin. By default, a customer’s online session lasts fifteen minutes.
Online Customers
To see all customers who are online now:
1.
On the Admin sidebar, tap Customers. Then, choose Online Now.
2.
In the list, open any record to view the customer’s information and activity.
632 Magento Community Edition 2.1 User Guide
CHAPTER 42: Customers Menu Now Online
Column Descriptions
COLUMN
ID
DESCRIPTION
The customer ID of a registered customer.
First Name
Last Name
IP Address
Session Start Time
Last Activity
Type
Last URL
The first name of a registered customer.
The last name of a registered customer.
The email address of a registered customer.
The IP address of the computer that customers and guests are using to access your store.
The starting date and time of the current session.
The date and time of the customer’s last activity in yur store.
Options include: Customer / Visitor
The last URL the customer visited.
Magento Community Edition 2.1 User Guide 633
634 Magento Community Edition 2.1 User Guide
CHAPTER 43:
Customer Accounts
The header of every page in your store extends an invitation for shoppers to “Log in or register” for an account with your store. Customers who open an account with your store enjoy a range of benefits, including:
Faster checkout. Registered customers move through checkout faster because much of the information is already in their accounts.
Self service. Registered customers can update their information, check the status of orders, and even reorder from their account dashboard.
Customers can access their account dashboard by clicking the “My Account” link in the header of the store. They can use their account dashboard to view and modify their information, including past and current addresses, billing and shipping preferences, newsletter subscriptions, wishlist, and more.
Account Dashboard
Magento Community Edition 2.1 User Guide 635
Customer Sign In CHAPTER 43: Customer Accounts
Customer Sign In
Customer have easy access to their accounts from every page in your store. Depending on the configuration, customers can be redirected to their account dashboard, or continue shopping after they log in to their accounts. When customers forget their passwords, a reset link is sent to the email address that is associated with the account.
Sign In
To sign in to your customer account:
1.
In the header of the store, tap Sign in.
2.
When prompted, enter the Email Address that is associated with your account, and your
Password
. Then,tap
Login
.
636 Magento Community Edition 2.1 User Guide
CHAPTER 43: Customer Accounts Customer Sign In
Customer Login
To reset your password:
1.
On the Login page, tap Forgot Your Password?.
2.
When prompted, enter the Email Address that is associated with your account, and tap
Submit
.
If the email address you entered matches the one that is associated with the account, you will receive a "Password Reset Confirmation" email with a link to reset your password.
3.
Tap the link in the email, and when prompted, enter your New Password. Enter it again to confirm, and tap
Reset Password
.
Your new password must be six or more characters in length, without spaces.
When you receive confirmation that the password is updated, you can use the new password to log in to your account.
Magento Community Edition 2.1 User Guide 637
Account Dashboard CHAPTER 43: Customer Accounts
Account Dashboard
My Dashboard
The customer’s account dashboard gives them the ability to track orders, manage shipping addresses, and manage other store activities.
Account Information
Customers can update their account information and change their password as needed. The store Admin can also update customer accounts and access the information to offer shopping assistance.
Address Book
The customer address book includes the default billing and shipping address, and additional address entries.
Downloadable Products
Lists all downloadable products the customer has purchased, with a link to each.
638 Magento Community Edition 2.1 User Guide
CHAPTER 43: Customer Accounts Account Dashboard
Orders
Displays a list of all customer orders, with a link to each. If enabled in the configuration, any order can be reordered by simply clicking the Reorder link.
Billing Agreements
Displays a list of any customer billing agreements.
Newsletter Subscriptions
Lists all available newsletters. Those to which the customer is currently subscribed have a checkmark.
My Product Reviews
Displays a list of all product reviews submitted by the customer, with a link to each.
Magento Community Edition 2.1 User Guide 639
Configuring Customer Accounts CHAPTER 43: Customer Accounts
My Wish List
This section is a placeholder for API applications that link the customer account to other applications or extensions.
Configuring Customer Accounts
The customer account settings determine the information that is collected during customer registration, and the experience that customers have during the process. Customer configuration settings include: l
l
l
l
l
l
640 Magento Community Edition 2.1 User Guide
CHAPTER 43: Customer Accounts Configuring Customer Accounts
Online Session Length
The length of each customer session is set by default to fifteen minutes. If there is no keyboard activity during that time, the current session ends, and customers must log back into their accounts to continue shopping. If
is enabled, the contents of their carts are saved for the next time they sign in to their accounts.
Online Customers Options
To configure the online session length:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Online Now.
2.
In the panel on the left under Customers, choose Customer Configuration.
3.
Expand the Online Customers Options section.
4.
In the Online Minutes Interval field, enter the number of minutes before the customer session.
Leave the field empty to accept the default interval of fifteen minutes.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 641
Configuring Customer Accounts CHAPTER 43: Customer Accounts
Login Landing Page
You can configure your store to redirect customers to their account dashboard after they log in, or let them continue shopping.
To set the login landing page:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Customers, choose Customer Configuration.
3.
Expand the Login Options section.
Login Options
4.
Set Redirect Customer to Account Dashboard after Logging in to one of the following:
Yes
No
The account dashboard appears when customers log in to their accounts.
Customers can continue shopping after logging in to their accounts.
5.
When complete, tap
Save Config
.
642 Magento Community Edition 2.1 User Guide
CHAPTER 43: Customer Accounts Configuring Customer Accounts
New Account Options
In the Create New Account Options section of the configuration, the basic account options are combined with more advanced options that relate to VAT ID Validation and custom integrations. The following instructions cover only the most frequently used options. To learn about automatic customer group assignments, see:
Magento Community Edition 2.1 User Guide
Create New Account Options
643
Configuring Customer Accounts CHAPTER 43: Customer Accounts
To set up the basic customer account options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Customers, choose Customer Configuration.
3.
Expand the Create New Account Options section. Then, do the following:
a.
Set Default Group to the customer group that is assigned to new customers when an account is created.
a.
If you have a Value Added Tax number, and want it to be visible to customers, set Show
VAT Number on Storefront
to “Yes.”
b.
Enter the Default Email Domain for the store. For example: mystore.com
c.
Set Default Welcome Email to the template that is used for the Welcome email sent to new customers.
d.
Set Default Welcome Email without Password to the template that is used when a customer account is created that does not yet have a password. For example, a customer account created from the Admin does not yet have a password assigned.
e.
Set Email Sender to the store contact that appears as the sender of the Welcome email.
f.
To require that customers confirm their request to open an account with your store, set
Require Emails Confirmation
to “Yes.” Then, set Confirmation Link Email to the template that is used for the confirmation email.
g.
Set Welcome Email to the template that is used for the Welcome message that is sent after the account is confirmed.
4.
When complete, tap
Save Config
.
644 Magento Community Edition 2.1 User Guide
CHAPTER 43: Customer Accounts Configuring Customer Accounts
Name and Address Options
The Name and Address Options determine the values in the drop-down lists for the prefix and suffix part of the customer name.
To configure the customer name and address:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Customers, choose Customer Configuration.
3.
Expand the Name and Address Options section.
Magento Community Edition 2.1 User Guide
Name and Address Options
645
Configuring Customer Accounts CHAPTER 43: Customer Accounts
1.
Enter the Number of Lines in a Street Address. If left blank, the street address defaults to 2.
2.
To include a prefix before the name, do the following:
a.
Set Show Prefix to one of the following: l
Optional l
Required
b.
In the Prefix Dropdown Options field, enter each prefix that you want to appear in the list, separated by a semicolon. Place a semicolon before the first value to display an empty value at the top of the list.
3.
To include a suffix after the name, do the following:
a.
Set Show Suffix to one of the following: l
Optional l
Required
b.
In the Suffix Dropdown Options field, enter each prefix that you want to appear in the list, separated by a semicolon. Place a semicolon before the first value to display an empty value at the top of the list.
4.
To include additional fields, do the following:
a.
Set Show Date of Birth to “Yes.”
b.
Set Show Tax/VAT Number to “Yes.”
c.
Set Show Gender to “Yes.”
5.
When complete, tap
Save Config
.
646 Magento Community Edition 2.1 User Guide
CHAPTER 43: Customer Accounts Configuring Customer Accounts
Password Options
The customer password options control the level of security that is used for password reset requests, and determines the email templates that are used for customer notification, and the lifetime of the password recovery link. You can allow customers to change their own passwords, or require that only store administrators can do so
To configure customer password options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Customers, choose Customer Configuration. Then, expand the Password Options section.
Password Options
3.
Set Password Reset Protection Type to the method you want to use for managing password reset requests:
By IP and Email
By IP
The password can be reset online after a response is received from a reset notification sent to the email address associated with the Admin account.
The password can be reset online without additional confirmation.
Magento Community Edition 2.1 User Guide 647
Configuring Customer Accounts CHAPTER 43: Customer Accounts
By Email
None
The password can be reset only by responding to an email notification that is sent to the email address associated with the Admin account.
The password can be reset only by the store administrator.
4.
To limit the number of password reset requests sent per hour, do the following:
a.
In the Max Number of Password Reset Requests field, enter the maximum number of password reset requests that can be sent per hour.
b.
In the Min Time Between Password Reset Requests field, enter the minimum number of minutes that must elapse between requests.
5.
To configure the password reset email notification, do the following:
a.
Set Forgot Email Template to the template that is used for the email sent to customers who have forgotten their passwords.
b.
Set Remind Email Template to the template that is used when a password hint is sent to customers.
c.
Set Reset Password Template to the template that is used when customers change their passwords.
d.
Set Password Template Email Sender to the store contact that appears as the sender of password-related notifications.
6.
Complete the following password reset security options:
a.
In the Recovery Link Expiration Period (hours) field, enter the number of hours before the password recovery link expires.
b.
In the Number of Required Character Classes field, enter the number of different character types that must be included in a password, based on the following character classes: l
Lowercase l
Uppercase l
Numeric l
Special Characters
c.
In the Maximum Login Failures to Lockout Account field, enter the number of failed login attempts until the Admin account is locked. For unlimited attempts, enter zero (0).
d.
In the Minimum Password Length field, enter the minimum number of characters that can be used in a password. The number must be greater than zero.
e.
In the Lockout Time (minutes) field, enter the number of minutes an Admin account is locked after too many failed attempts to log in.
7.
When complete, tap
Save Config
.
648 Magento Community Edition 2.1 User Guide
CHAPTER 44:
Customer Groups
Customer groups determine which discounts are available, and the tax class that is associated with the group. The default customer groups are General, Not Logged In, and
Wholesale.
Customer Groups
To create a customer group:
1.
On the Admin sidebar, tap Stores. Then under Other Settings, choose Customer Groups.
2.
Tap
Add New Customer Group
. Then, do the following:
a.
Enter a unique Group Name less than 32 characters to identify the group.
b.
Select the Tax Class that applies to the group.
Magento Community Edition 2.1 User Guide 649
CHAPTER 44: Customer Groups
Group Information
3.
When complete, tap
Save Customer Group
.
To edit a customer group:
1.
On the Admin sidebar, tap Stores. Then under Other Settings, choose Customer Groups.
2.
Open the record in edit mode.
3.
Make the necessary changes.
4.
When complete, tap
Save Customer Group
.
650 Magento Community Edition 2.1 User Guide
CHAPTER 44: Customer Groups
To assign a customer to a different group:
1.
On the Admin sidebar, tap Customers. Then, choose All Customers.
2.
Find the customer in the list, and mark the checkbox in the first column. Then, do the following:
a.
Set the Actions control to “Assign a Customer Group.”
b.
Set the Group control to the new group.
c.
When prompted to confirm, tap
OK
.
Assign a Customer Group
Magento Community Edition 2.1 User Guide 651
652 Magento Community Edition 2.1 User Guide
SALES
653
654
Contents
In this section of the guide, you’ll learn how to manage all apsects of the order process, including point of purchase support, order processing, payments, and fulfillment.
CHAPTER 45:
Sales Menu
The Sales menu lists transactions according to where they are in the order workflow. You might think of each of option as a different stage in the lifetime of an order.
To display the Sales menu:
On the Admin sidebar, tap
Sales
.
Sales Menu
Magento Community Edition 2.1 User Guide 655
656
Menu Options
CHAPTER 45: Sales Menu
Orders
When an order is placed, a sales order is created as a temporary record of the transaction. Payment has not been processed, and the order can still be canceled.
Invoices
An invoice is a record of the receipt of payment for an order. Multiple invoices can be created for a single order, each with as many, or as few of the purchased products that you specify. Depending on the payment action, payment can be automatically captured when the invoice is generated.
Shipments
A shipment is a record of the products in an order that have been shipped. As with invoices, multiple shipments can be associated with a single order, until all of the products in the order are shipped.
Billing Agreements
A billing agreement is similar to a purchase order, except that it isn’t limited to a single purchase. During checkout, the customer chooses Billing Agreement as the payment method. A billing agreement streamlines the checkout process because the customer doesn’t have to enter payment information for each purchase.
Transactions
The Transactions page lists all payment activity that has taken place between your store and all payment systems, and provides access to more detailed information.
Magento Community Edition 2.1 User Guide
Point of Purchase
657
658
Contents
In this section of the guide, you’ll learn how to configure the cart and checkout options, and offer assistance to your customers.
Creating Customer Accounts
CHAPTER 46:
Shopping Cart
The cart is positioned at the end of the path to purchase, at the intersection of “Buy” and
“Abandon,” and is perhaps, the most important page in the store. The cart is where the order total is calculated, along with discount coupons and estimated shipping and tax. It’s a great place to show your trust badges and seals, and an ideal opportunity to offer one last item. You can choose the items to be offered as a cross-sell impulse purchase whenever a specific item appears in the cart.
Magento Community Edition 2.1 User Guide
Shopping Cart
659
Cart Configuration CHAPTER 46: Shopping Cart
Cart Configuration
The cart configuration determines the when the customer is redirected to the cart page, and which images are used for product thumbnails. You can require an order to reach a minimum amount before the checkout process begins, specify the number of days quoted prices remain valid, and specify the order of items in the Totals section.
l
l
l
l
l
l
See also:
660 Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart Cart Configuration
My Cart Link
The cart link in the upper-right corner of the header gives a quick summary of the contents of the cart. The link can be configured to display the number of different products (or SKUs) in the cart, or the total quantity of all items. If the
is enabled, you can click the link to display more detail.
Cart Link
To configure the cart link:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the My Cart Link section.
4.
Set Display Cart Summary to one of the following: l
Display item quantities l
Display number of items (different products) in cart.
5.
When complete, tap
Save Config
.
My Cart Link
Magento Community Edition 2.1 User Guide 661
Cart Configuration CHAPTER 46: Shopping Cart
Cart Sidebar
The Cart Sidebar is often called the “mini cart,” and displays a summary of the items in the cart. It is enabled by default, and appears when you click the number of items in the Cart Link.
Shopping Cart Sidebar
To configure the mini cart:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Shopping Cart Sidebar section. Then, do the following:
662
Shopping Cart Sidebar
a.
Set Display Shopping Cart Sidebar to your preference.
b.
In the Maximum Display Recently Added Item(s) field, enter the maximum number of recently added items that you want to appear in the mini cart.
4.
When complete, tap
Save Config.
Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart Cart Configuration
Redirect to Cart
The shopping cart page can be configured to appear whenever an item is added to the cart, or only when customers choose to go to the page. The basic information about the items currently in the cart is always available in the
mini cart , The decision is a matter of balancing the
benefits letting customers continue shopping, with the benefit of encouraging customers to proceed to checkout. If might be simply a matter of personal preference. However, if you want back it up with numbers, you can run an A/B test to see which approach produces a higher conversion rate.
To configure when the cart appears:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Shopping Cart section.
4.
Set After Adding a Product Redirect to Shopping Cart to your preference.
5.
Tap
Save Config
.
Redirect to Cart
Magento Community Edition 2.1 User Guide 663
Cart Configuration CHAPTER 46: Shopping Cart
Quote Lifetime
You can determine how long a price is valid by setting the cart quote lifetime in the configuration. For example, if a shopper leaves a cart unattended after several days, the quotes price for some items might no longer be the same. By default, the quote lifetime is set to thirty days.
To configure the quote lifetime:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Shopping Cart section.
4.
In the Quote Lifetime (days) field, enter the number of days that a quoted price remains valid.
5.
When complete, tap
Save Config
.
Shopping Cart
664 Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart Cart Configuration
Minimum Order
The configuration allows you to specify a minimum amount, after discounts are applied, that order subtotals are required to meet. Orders shipped to multiple address can be required to meet the minimum order amount per address. The Checkout button becomes available only after the minimum order amount is reached.
Minimum Order Message in Cart
To configure a minimum order amount:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Sales.
3.
Expand the Minimum Order Amount section. Then, do the following:
Magento Community Edition 2.1 User Guide 665
Cart Configuration CHAPTER 46: Shopping Cart
666
Minimum Order Amount
a.
To require a minimum order amount, set Enable to “Yes.”
b.
Enter the Minimum Amount that is required for the subtotal, after discounts are applied.
c.
Set Include Tax to Amount to one of the following:
Yes
No
Requires the subtotal to meet the minimum amount with tax included.
Requires the subtotal to meet the minimum amount without tax.
d.
To change the default message that appears at the top of the cart when the subtotal doesn’t meet the minimum amount, enter the text in the Description Message box. Leave the box blank to use the default message.
e.
To change the default error message, enter the text in the Error to Show in Shopping Cart box.
Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart Cart Configuration
f.
To require that each address in a multi-address order meet the minimum order amount, set Validate Each Address Separately in Multi-address Checkout to “Yes.”
g.
To change the default message at the top of the cart for orders that are to be shipped to multiple addresses, but do not meet the minimum, enter the text in the Multi-address
Description Message
box.
h.
To change the default error message for orders that are to be shipped to multiple addresses, but do not meet the minimum, enter the text in the Multi-address Error to
Show in Shopping Cart
box.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 667
Cart Configuration CHAPTER 46: Shopping Cart
Cart Thumbnails
The thumbnail images in the cart give customers a quick overview of the items they are about to purchase. However, for products with multiple options, the image might not match the variation of the product that is in the cart. If the customer purchases an item in a specific color, ideally, the thumbnail in the cart should match.
The thumbnail image for both grouped and configurable products can be set to display the image from either the “parent” product or from the product variation. The setting applies to all grouped or configurable products in the current store view.
668
Thumbnail Images in Cart
Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart
To configure cart thumbnails:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Shopping Cart section. Then, do the following:
Cart Configuration
Shopping Cart
a.
Set Grouped Product Image to one of the following: l
Product Thumbnail Itself l
Parent Product Thumbnail
b.
Set Configurable Product Image to one of the following: l
Product Thumbnail Itself l
Parent Product Thumbnail
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 669
Persistent Shopping Cart CHAPTER 46: Shopping Cart
Persistent Shopping Cart
A persistent shopping cart keeps track of unpurchased items which are left in the cart, and saves the information for the customer’s next visit. Customers who are “remembered” can have the contents of their shopping carts restored the next time they visit your store.
Using a persistent shopping cart can help reduce the number of abandoned shopping carts and increase sales. It is important to understand that the persistent shopping cart does not expose sensitive account information at any time. While the persistent shopping cart is use, both registered customers and guest shoppers are required to either log in to an existing account, or create a new account before going through checkout. For guest shoppers, a persistent shopping cart is the only way to retrieve information from a previous session.
To use the persistent shopping cart, the customer’s browser must be set to allow cookies.
During operation, the following cookies are used:
Session Cookie
A short-term session cookie exists for the duration of a single visit to your site, and expires when the customer leaves, or after a set period of time.
Persistent Cookie
A long-term persistent cookie continues in existence after the end of the session, and saves a record of the customers’ shopping contents for future reference.
670 Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart Persistent Shopping Cart
Persistent Cart Workflow
When Persistent Shopping Cart is enabled, the workflow depends on the values of the “Enable
Remember Me” and “Clear Persistence on Log Out” settings, the customer’s decision to select or clear the “Remember Me” checkbox, and when the persistent cookie is cleared.
When a persistent cookie is applied, a Not %Jane Smith%? link appears in the page header, to give the customer the ability to terminate the persistent session and start working as a guest, or log in as a different customer. The system retains a record of the shopping cart contents, even if the customer later uses different devices to shop in your store. For example, a customer can add an item to the shopping cart from a laptop, edit the cart contents from a desktop computer, add more items from a mobile device, and complete the checkout process from a tablet.
There is a separate independent persistent cookie for each browser. If the customer uses multiple browsers while visiting your store during a single, persistent session, any changes made in one browser will be reflected in any other browser when the page is refreshed. While the persistent shopping cart is enabled, your store creates and maintains a separate persistent cookie for each browser that is used by a customer to log in or create an account.
An Open Session on a Shared Computer
Jane is finishing up her holiday shopping with a persistent session, and adds a present for John to her cart, as well as something for her mother. Then she goes to the kitchen for some milk and cookies.
John sits down at the computer to do some quick shopping while Jane’s in the kitchen. Without noticing the “Not %Jane%” link at the top of the page, he finds a nice present for Jane and adds it to the cart. When he goes to checkout and logs in as himself, both the items in Jane’s cart are added to his cart. John’s in such a hurry that he doesn’t notice the additional item during Order
Review, and submits the order. Jane’s cart is now empty, and John bought presents for both
Jane and her mother.
Jane brings John some milk and cookies, and asks, “What’s up?” He says, “Oh, nothing.”
Magento Community Edition 2.1 User Guide 671
Persistent Shopping Cart CHAPTER 46: Shopping Cart
Remember Me
Customers can click the “Remember Me” checkbox on the Login page to save the contents of the their shopping carts.
Yes
A persistent cookie is created, and the contents of the shopping cart is saved for the customer’s next logged-in session.
No
If “Remember Me” is not selected or is cleared, a persistent cookie is not created, and the cart information is not saved for the customer’s next logged-in session.
Continue Persistence on Logout (No)
No
When the customer logs in, the persistent cookie is invoked, in addition to the session cookie which is already in use.
No
When the customer logs out, the session cookie is deleted, but the persistent cookie remains in effect. The next time the customer logs in, the cart items are restored, or added to any new items that have been placed in the cart.
No
If the customer does not log out, but the session cookie expires, the persistent cookie remains in effect.
Clear Persistence on Logout (Yes)
Yes
When the customer logs in, the persistent cookie is invoked, in addition to the session cookie which is already in use.
Yes
When the customer logs out, both cookies are deleted.
Yes
If the customer does not log out, but the session cookie expires, the persistent cookie remains in effect.
672 Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart Persistent Shopping Cart
Persistent Cart Settings and Effects
SETTINGS
Enable Remember Me = “No”
Clear Persistence on Log Out = any value
EFFECT
The Remember Me checkbox is not available on the login and registration page. The persistent cookie is not used.
The session cookie is applied as usual; the persistent cookie is not used.
Enable Remember Me = “Yes”
Clear Persistence on Log Out = any value
Remember Me (not selected)
Enable Remember Me = “Yes”
Clear Persistence on Log Out = “Yes”
Remember Me = “Yes”
Enable Remember Me = “Yes”
Clear Persistence on Log Out = “No”
Remember Me = “Yes”
When a customer logs in, both cookies are applied. When a customer logs out, both cookies are deleted. If a customer does not log in, but the session cookie expires, the persistent cookie is still used. Apart from logging out, the persistent cookie is deleted when its lifetime runs out or when the customer clicks the Not %Jane Smith% link.
When a customer logs in, both cookies are applied. When a customer logs out, the session cookie is deleted, the persistent session continues. The persistent cookie is deleted when its lifetime runs out or when the customer clicks the Not %Jane Smith% link.
Magento Community Edition 2.1 User Guide 673
Persistent Shopping Cart CHAPTER 46: Shopping Cart
Configuring a Persistent Cart
During the setup of a persistent shopping cart, you can specify the lifetime of the cookies, and which options you want to make available for various customer activities.
If the session cookie expires while the customer is logged in, the persistent cookie remains active.
To configure a persistent cart:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Customers, choose Persistent Shopping Cart.
3.
If necessary, expand the General Options section.
4.
To enable the persistent shopping cart and display additional options, set Enable Persistence to “Yes.” Then, do the following:
674
General Options
a.
In the Persistence Lifetime (seconds) field, enter the length of time, in seconds, that you want the persistent cookie to last. The default value of 31,536,000 seconds is equal to one year, and is the maximum time allowed.
b.
Set Enable “Remember Me” to one of the following:
Yes
No
Displays the “Remember Me” checkbox on the Login page of your store, so customers can choose to save their shopping cart information.
Persistence can still be enabled, but customers are not given the option to choose if they want to save their information.
c.
To preselect the “Remember Me” checkbox, set Remember Me Default Value to “Yes.”
d.
Set Clear Persistence on Log Out to one of the following:
Magento Community Edition 2.1 User Guide
CHAPTER 46: Shopping Cart Persistent Shopping Cart
Yes
No
The shopping cart is cleared when a registered customer logs out.
The shopping cart is saved when a registered customer logs out.
If the session cookie expires while the customer is still logged in, the persistent cookie remains in use.
e.
Set Persist Shopping Cart to one of the following:
Yes
No
If the session cookie expires, the persistent cookie is preserved. If a guest shopper later logs in or creates a new account, the shopping cart is restored.
The shopping cart is not preserved for guests after the session cookie expires.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 675
676 Magento Community Edition 2.1 User Guide
CHAPTER 47:
Checkout
When the checkout process begins, the transaction shifts to a secure, encrypted channel. A padlock symbol appears in the address bar of the browser, and the URL changes from
“http” to “https”.
From this point on, the goal is to gather the information necessary to complete the transaction. The Checkout page leads the customer through each step of the process.
Customers who are logged into their accounts can complete checkout quickly, because much of the information is already in their accounts.
Checkout Steps
Step 1: Shipping
The first step of the checkout process is for the customer to complete the shipping address information, and to choose the shipping method.
Step 2: Review & Payments
During the second step of the checkout process, the customer chooses the payment method, and applies any coupons with promotional codes to the purchase.
The
appears after the order is placed.
For registered customers, the page includes the order number with a link to the customer’s account, and a link to generate a receipt.
Magento Community Edition 2.1 User Guide 677
Checkout Step 1: Shipping CHAPTER 47: Checkout
Checkout Step 1:
Shipping
The first step of the checkout process is for the customer to complete the shipping address information, and to choose the shipping method. If the customer has an account, the shipping address is entered automatically, but can be changed if needed. The progress bar at the top of the page follows each step of the checkout process, and the Order Summary shows the information entered so far.
Checkout Step 1: Shipping
678 Magento Community Edition 2.1 User Guide
CHAPTER 47: Checkout Checkout Step 2: Review & Payments
Checkout Step 2:
Review & Payments
During the second step of the checkout process, the customer chooses the payment method, and applies any coupons with promotional codes to the purchase. All information can be reviewed, and edited if needed. If enabled, the customer must to agree to the terms and conditions of the sale before placing the order.
Magento Community Edition 2.1 User Guide
Review & Payments
679
Order Confirmation CHAPTER 47: Checkout
Order Confirmation
The order confirmation appears after the order is placed. For registered customers, the page includes the order number with a link to the customer’s account, and a link to generate a receipt. Registered customers are told that they will receive order confirmation and tracking info by email. Guests are encouraged to create an account to track the order. Registered customers can generate a receipt by clicking a link
The order confirmation page is also called the “Success” page, and is used by analytics programs to track conversions.
Order Confirmation
680 Magento Community Edition 2.1 User Guide
CHAPTER 47: Checkout Checkout Configuration
Checkout Configuration
The checkout configuration determines the format of the page, the requirements to make a purchase, and the options that are presented during the checkout process.
l
l
l
l
Magento Community Edition 2.1 User Guide 681
Checkout Configuration CHAPTER 47: Checkout
Checkout Options
The checkout configuration determines the layout of the checkout page, and if shoppers must register for an account and agree to the terms and conditions of the sale before making a purchase.
To change the checkout options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Checkout Options section.
4.
Set the following to your preference: l
Enable
l
Allow
l
Enable
5.
When complete, tap
Save Config
.
Checkout Options
682 Magento Community Edition 2.1 User Guide
CHAPTER 47: Checkout Checkout Configuration
Guest Checkout
Your store can be configured to require that shoppers open an account before making a purchase, or to allow unregistered guests to go through the checkout process. The default setting allows guests to make purchases, with an option to register for an account after they complete the checkout process.
Checkout as Guest
To change the guest checkout setting:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Checkout Options section.
4.
If necessary, clear the Use system value checkbox. Then, do the following:
a.
If the setting is for a specific store view, choose the store view where the configuration applies.
b.
When prompted, tap OK to continue.
5.
Set Allow Guest Checkout to your preference:
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
Checkout Options
683
Checkout Configuration CHAPTER 47: Checkout
Terms and Conditions
When Terms and Conditions is enabled, customers are required to agree to the terms and conditions of the sale before the purchase is finalized. The Terms and Conditions of the sale typically includes disclosure information that might be required by law for B2C or B2B sites, and outlines the rights of the buyer and seller. The Terms and Conditions message appears after the payment information, just before the Place Order button.
Terms and Conditions at Checkout
Step 1:
Enable Terms and Conditions
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
3.
Expand the Checkout Options section. Then, do the following:
a.
Verify that Enable Onepage Checkout is set to “Yes.”
b.
Set Enable Terms and Conditions to “Yes.”
684
4.
When complete, tap
Save Config
.
Checkout Options
Magento Community Edition 2.1 User Guide
CHAPTER 47: Checkout Checkout Configuration
Step 2:
Add Your Terms and Conditions
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Terms and Conditions.
2.
In the upper-right corner, tap
Add New Condition
.
Terms and Conditions Information
3.
In the Terms and Conditions Information section, complete the following:
New Condition
a.
Enter the Condition Name for internal reference.
b.
Set Status to “Enabled.”
c.
Set Show Content as to one of the following:
Magento Community Edition 2.1 User Guide 685
Checkout Configuration CHAPTER 47: Checkout
Text
HTML
Displays the terms and conditions content as unformatted text.
Displays the content as HTML which can be formatted..
4.
Select each Store View where the Terms and Conditions is to be used.
5.
Enter the Checkbox Text to be used as the text for the Terms and Conditions link. For example, “I understand and accept the terms and conditions of the sale.
6.
In the Content box, enter the full text of the terms and conditions of the sale.
7.
(Optional) Enter the Content Height (css) in pixels, to determine the height of the text box where the terms and conditions statement appears during checkout. For example, to make the text box one inch high on a 96 dpi display, enter 96. A scroll bar appears if the content extends beyond the height of the box.
8.
When complete, tap
Save Condition
.
686 Magento Community Edition 2.1 User Guide
CHAPTER 47: Checkout Checkout Configuration
One Page Checkout
The purpose of OnePage Checkout is to gather the information that is needed, and complete the sale as quickly as possible. When Onepage Checkout is enabled, the entire checkout process takes place on a single page. Each section of the checkout information is expanded as needed.
Magento’s Onepage Checkout is enabled by default. If you are implementing a custom integration or checkout extension, it might be necessary to disable Onepage Checkout.
To disable Onepage Checkout:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Checkout.
Checkout Options
3.
Expand the Checkout Options section.
4.
If necessary, clear the Use system value checkbox. Then, do the following:
a.
If the setting is for a specific store view, choose the store view where the configuration applies.
b.
When prompted, tap OK to continue.
5.
Set Enable Onepage Checkout to “No.”
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 687
Gift Options CHAPTER 47: Checkout
Gift Options
The selection of available gift options appears during the Shipping Method step of the checkout process. The Gift Options configuration determines if customers have the option to add a gift message to the complete order, and for individual items. The
of the Gift Options configuration applies to the entire website, but can be overridden at the product level. .
Gift Options
To enable gift options:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Sales.
3.
Expand the Gift Options section.
4.
If necessary, clear the Use system value checkbox. Then, do the following:
a.
If the setting is for a specific store view, choose the store view where the configuration applies.
b.
When prompted, tap OK to continue.
5.
Set the Gift Message options according to your preference: l
Allow Gift Messages on Order Level l
Allow Gift Messages for Order Items
6.
When complete, tap
Save Config
.
688 Magento Community Edition 2.1 User Guide
CHAPTER 47: Checkout Gift Options
Checkout Totals Sort Order
During Order Review, the total appears at the bottom of the order, with any adjustments for discounts, shipping charges, store credit, and tax. The order of each item determines the sequence of the calculations, and is set in the configuration by a number that is assigned to each item. For example, the Subtotal is the first item in the section, and is assigned a value of
10. The Grand Total appears last, and is assigned a value of 100. All of the other items in the totals section are assigned a value between those values.
Checkout Totals
To configure the checkout totals:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Sales.
3.
Expand the Checkout Totals Sort Order section.
Checkout Totals Sort Order
4.
If necessary, clear the Use system value checkbox. Then, do the following:
Magento Community Edition 2.1 User Guide 689
Gift Options CHAPTER 47: Checkout
a.
If the setting is for a specific store view, choose the store view where the configuration applies.
b.
When prompted, tap OK to continue.
5.
Change the number assigned to each item to determine its order in the Totals section..
6.
When complete, tap
Save Config
.
690 Magento Community Edition 2.1 User Guide
CHAPTER 48:
Shopping Assistance
Customers sometimes need assistance to complete a purchase. Some customers like to shop online, but would rather the order by phone. You can offer immediate assistance both guests and customers who have registered for an account with your store.
l
l
Magento Community Edition 2.1 User Guide 691
Creating Customer Accounts CHAPTER 48: Shopping Assistance
Creating Customer Accounts
Customers usually create their own accounts from your store. However, you can also create customer accounts directly from the Admin, which is useful when customers order by phone.
692
New Customer Account Information
Step 1:
Create a New Customer Account
1.
On the Admin sidebar, tap Customers. Then, choose All Customers.
2.
Tap
Add New Customer
.
3.
In the Account Information section, do the following:
Magento Community Edition 2.1 User Guide
CHAPTER 48: Shopping Assistance Creating Customer Accounts
Customer Information
a.
To associate the customer with a specific store view, set Associate to Website to the view.
b.
Assign the customer to a Customer Group.
c.
If using VAT ID Validation, and want to Disable Automatic Group Change Based on
VAT ID
, mark the checkbox.
4.
Complete the following required fields: l
First Name l
Last Name l
5.
Complete the optional fields as needed: l
Prefix l
Middle Name/Initial l
Suffix l
Date Of Birth l
Tax/VAT Number l
Gender
6.
Set Send Welcome Email From to the customer identity to appear as the sender of the
Welcome email.
7.
Tap
Save and Continue Edit
.
When the customer account is saved, the full set of options appears in the panel on the left and in the menu at the top of the page. The Customer View tab displays a summary of account activity.
Magento Community Edition 2.1 User Guide 693
Creating Customer Accounts CHAPTER 48: Shopping Assistance
Customer Account Saved
Step 2:
Complete the Customer Address and Contact Information
1.
In the panel on the left, choose Addresses. Then, do the following:
a.
To add a new address, tap
Add New Addresses
.
694
Add Address to New Customer Account
b.
To define the type of address, mark one of the following checkboxes: l
Default Billing Address l
Default Shipping Address
c.
If the name of another person is associated with the address, complete the name information as needed. If the name fields are left blank, the customer name will be used for the address.
d.
Complete the following address fields as needed:
Magento Community Edition 2.1 User Guide
CHAPTER 48: Shopping Assistance Creating Customer Accounts l
Company l
Street Address l
City l
Country l
State/Province l
Zip/Postal Code
e.
Complete the following information if available: l
Phone Number l
Fax l
VAT Number
2.
When complete, tap
Save Customer
.
Field Descriptions
FIELD DESCRIPTION
ACCOUNT INFORMATION
Associate to Website Identifies the website associated with the customer account.
Group
Prefix
Identifies the customer group to which the customer belongs. Select the checkbox to disable automatic group change based on VAT.
If used, the prefix that is associated with the customers name. For example: Mr, Mrs. or Dr. Depending on the configuration, the input control might be a text field or a drop-down list of options.
First Name
Middle Name / Initial
Last Name
Suffix
The customer's first name.
The customer's middle name or middle initial.
The customer's last name.
If used, the suffix that is associated with the customer's name. For example: Jr.,Sr., or III. Depending on the configuration, the input control might be a text field or a drop-down list of options.
Date Of Birth
Tax / VAT Number
Gender
The customer's email address.
The customer's date of birth.
The customer's Tax or Value Added Tax number, if applicable.
Identifies the customer's gender as Male or Female.
Magento Community Edition 2.1 User Guide 695
Creating Customer Accounts CHAPTER 48: Shopping Assistance
Field Descriptions (cont.)
FIELD
Send Welcome Email
From
DESCRIPTION
If you have multiple stores, select the store from which the welcome message will be sent.
ADDRESSES
New Addressees
Add New Addresses
Company
Street Address
City
Country
State/Province
Zip/Postal Code
Phone Number
Fax
VAT Number
Identifies the type of new address. Options:
Default Billing Address
Default Shipping Address
Displays another New Address section to identify the type of the address to be entered.
The company name, if applicable for this address.
The street address of the customer. The second line of the street address can be used if needed.
The city where the customer resides at this address.
The country where the customer resides at this address.
The state or province of the customer at this address.
The ZIP or postal code of the customer at this address.
The phone number where the customer can be reached at this address.
The fax number where the customer can be reached at this address.
If applicable, the value added tax number that applies to the customer at this address.
696 Magento Community Edition 2.1 User Guide
CHAPTER 48: Shopping Assistance Creating Customer Accounts
Updating Customer Accounts
The panel on the left of the Customer Information page includes information about customer activity, such as when the customer last signed in or out of their account, addresses, order statistics, recent orders, shopping cart contents, product reviews, newsletter subscriptions, and so on.
Customer Account
To update customer information:
1.
On the Admin sidebar, tap Customers. Then, choose All Customers.
2.
Find the customer in the grid. Then in the Action column, click Edit.
3.
In the panel on the left, choose the type of information you need to edit. Then, make any necessary changes to the customer account.
4.
When complete, tap
Save Customer
.
Magento Community Edition 2.1 User Guide 697
Creating Customer Accounts CHAPTER 48: Shopping Assistance
Account Options
OPTION
Reset
Reset Password
Force Sign-In
Save and Continue Edit
Save Customer
DESCRIPTION
Resets any unsaved changes in the customer form to their previous values.
Creates a new order that is associated with the customer account.
Resets the customer’s password.
Clears the tokens associated with the customer’s password, and provides the administrator access to the account,
Saves any changes to the customer account, and keeps the customer record open.
Saves any changes tot he customer account, and closes the customer record.
698 Magento Community Edition 2.1 User Guide
CHAPTER 48: Shopping Assistance Creating a Customer Order
Creating a Customer Order
For registered customers who need assistance, you can create an entire order directly from the
Admin. The Create New Order form includes all the information that is needed to complete the normal checkout process, with activity summaries from the customer’s account dashboard.
Create New Order
To create a new order:
1.
On the Admin sidebar, tap Customers.
2.
Find the customer in the grid. Then in the Action column, click Edit.
3.
In the workspace header, tap Create Order.
4.
If your store has multiple views, choose the store view where the order is to be placed. .
5.
To add products from the Customer’s Activities, mark the checkbox of each product in the panel on the left. Then, scroll down and tap
Update Changes
. The item appears in the order form.
Magento Community Edition 2.1 User Guide 699
Creating a Customer Order CHAPTER 48: Shopping Assistance
Add to Cart
6.
To add products from the catalog, tap
Add Products
. Then, do the following:
Add Products
a.
In the grid, mark the checkbox of each product to be added to the cart, and enter the Qty to be purchased.
700
Select Products
Magento Community Edition 2.1 User Guide
CHAPTER 48: Shopping Assistance Creating a Customer Order
b.
If the product has multiple options, tap
Configure
. Complete the options as needed, and tap
OK
. Then, click the Add Selected Product(s) to Order link to update the cart.
c.
To override the price of an item, mark the Custom Price checkbox. Then, enter the new price in the box below. To update the cart totals, tap
Update Items and Quantities
.
Custom Price
d.
Complete the following sections as needed for the order: l
Apply Coupon Codes l
Payment Method l
Shipping Method l
Order Comments
7.
When complete, tap
Submit Order
. A confirmation is sent to the customer, and the customer can view the order details from their account.
Order Created
Magento Community Edition 2.1 User Guide 701
Creating a Customer Order CHAPTER 48: Shopping Assistance
Updating an Order
After a customer places an order, it is sometimes necessary to edit the order, place it on hold, or cancel it entirely. When you change an order, the original order is canceled and a new order is generated. You can, however, change the billing or shipping address without generating a new order.
702
Edit Order
To edit an order:
1.
On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
2.
Find the order to be edited. Then in the Action column, click the View link.
3.
Tap
Edit
. When prompted to confirm, tap
OK
to continue.
4.
Make the necessary changes to the order.
5.
When complete, do one of the following: l
To save changes made to the billing or shipping address, tap
Save
.
l
To save changes made to line items, and reprocess the order, tap
Submit Order
.
Magento Community Edition 2.1 User Guide
CHAPTER 48: Shopping Assistance Creating a Customer Order
To place an order on hold:
If the customer’s preferred method of payment is not available, or if the item is temporarily out of stock, you can put the order on hold.
1.
In the Orders grid, find the pending order that you want to place on hold.
2.
In the Action column, click the View link.
3.
Tap
Hold
to place the order on hold.
Hold Order
4.
When you are ready to return the order to an active state, repeat the process and tap
Unhold
.
To cancel an order:
Canceling an order changes its status from “Pending” to “Canceled.”
1.
In the Orders grid, find the pending order to be canceled.
2.
In the Action column, click the View link.
3.
Tap
Cancel
.
Magento Community Edition 2.1 User Guide 703
Creating a Customer Order
Cancel Order
The status of the order is now “Canceled.”
CHAPTER 48: Shopping Assistance
704 Magento Community Edition 2.1 User Guide
Order Management
705
706
Contents
In this section of the guide, you will learn about each stage of the order workflow, and how to process orders, create invoices, and shipments.
You will also learn how to issue credit memos and manage returns.
Pending Payment Order Lifetime
CHAPTER 49:
Orders
The Orders workspace lists all current orders. Each row in the grid represents an order, and each column represents an attribute, or data field. Use the standard
to sort and filter the list, find orders, and apply
to selected orders. You can view existing orders, and create new orders. The tabs above the pagination controls can be used to filter the list, change the default view, change and rearrange columns, and export data.
Orders
Magento Community Edition 2.1 User Guide 707
708
CHAPTER 49: Orders
Workspace Controls
CONTROL
Search
Create New Order
DESCRIPTION
Initiates a search for orders based on keywords entered in the search box, and current filters.
Creates a new order.
Displays the list of archived orders.
Go to Archive
Search
Reset Filter
Actions
Mass Actions
Submit
Initiates a search for orders based on the current filters.
Restores all filters to a blank state.
Lists all actions that can be applied to selected orders. To apply an action to an order, or group of orders, mark the checkbox in the first column of each order. Order actions:
Cancel
Hold
Unhold
Print Invoices
Print Packing Slips
Print Credit Memos
Print All
Move to Archive
Can be used to select multiple records as the target of action. Mark the checkbox in the first column of each record that is subject to the action. Options: Select All, Unselect All, Select Visible, and
Unselect Visible
Applies the current action to the selected order records.
Edit Opens the order in edit mode.
Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders
Columns
COLUMN
Selection State
DESCRIPTION
Filters the list of orders based on checkbox status. Options:
Any Lists all records, regardless of checkbox status.
Yes
No
Lists only records with the checkbox marked.
Lists only records without the checkbox marked.
ID
Purchase Point
Purchase Date
Bill-to Name
Ship-to Name
Grand Total (Base)
Grand Total (Purchased)
Status
Action
A unique, sequential number that is assigned when a new order is saved for the first time.
Identifies the store view where the order was placed.
The date the order was placed.
The name of the person who is responsible to pay for the order.
The name of the person to whom the order is to be shipped.
The grand total of the order.
The grand total of products purchased in the order.
The current order status.
The View link opens the order.
Magento Community Edition 2.1 User Guide 709
Order Workspace CHAPTER 49: Orders
Order Workspace
The Order workspace lists all current orders. Each row in the grid represents a customer order, and each column represents an attribute, or data field . Use the standard
to sort and filter the list, find orders, and apply
to selected orders. From the grid, you can view existing orders, and create new orders. The tabs above the pagination controls are used to filter the list, change the default view, change and rearrange columns, and export data.
Orders
710 Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Order Workspace
Workspace Controls
CONTROL
Search
Create New Order
DESCRIPTION
Initiates a search for orders based on keywords entered in the search box, and current filters.
Creates a new order.
Displays the list of archived orders.
Go to Archive
Search
Reset Filter
Actions
Mass Actions
Submit
Initiates a search for orders based on the current filters.
Restores all filters to a blank state.
Lists all actions that can be applied to selected orders. To apply an action to an order, or group of orders, mark the checkbox in the first column of each order. Order actions:
Cancel
Hold
Unhold
Print Invoices
Print Packing Slips
Print Credit Memos
Print All
Move to Archive
Can be used to select multiple records as the target of action. Mark the checkbox in the first column of each record that is subject to the action. Options: Select All, Unselect All, Select Visible, and
Unselect Visible
Applies the current action to the selected order records.
Edit Opens the order in edit mode.
Magento Community Edition 2.1 User Guide 711
Order Workspace CHAPTER 49: Orders
Columns
COLUMN
Selection State
DESCRIPTION
Filters the list of orders based on checkbox status. Options:
Any Lists all records, regardless of checkbox status.
Yes
No
Lists only records with the checkbox marked.
Lists only records without the checkbox marked.
ID
Purchase Point
Purchase Date
Bill-to Name
Ship-to Name
Grand Total (Base)
Grand Total (Purchased)
Status
Action
A unique, sequential number that is assigned when a new order is saved for the first time.
Identifies the store view where the order was placed.
The date the order was placed.
The name of the person who is responsible to pay for the order.
The name of the person to whom the order is to be shipped.
The grand total of the order.
The grand total of products purchased in the order.
The current order status. Options:
The View link opens the order.
Order Actions
To apply an action to specific orders, mark the checkbox in the first column of each order. To select or deselect all orders, use the control at the top of the column.
712
Order Actions
Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Order Workspace
Order Search
The Search box in the upper-left of the Orders grid can be used to find specific orders by keyword, or by filtering the order records in the grid.
Search Results
To search for a match:
1.
Enter a search term into the page search box.
2.
Tap Search ( ) to display the results.
To filter the search:
1.
Tap the Filters ( ) tab to display the selection of search filters.
2.
Complete as many of the filters as needed to describe the order(s) that you want to find.
3.
Tap
Apply Filters
to display the results.
Magento Community Edition 2.1 User Guide 713
Order Workspace CHAPTER 49: Orders
714
Search Filters
FILTER
ID
Bill-to Name
Ship-to Name
Purchase Point
Status
Purchase Date
Order Filters
DESCRIPTION
Filters the search based on order ID.
Filters the search by the name of the person who is responsible to pay for the order.
Filters the search by the name of the person to whom each order is shipped .
Filters the search by website, store, or store view where the order was placed.
Filters the search based on order status. Options:
Canceled
Closed
Complete
Suspected Fraud
On Hold
Payment Review
PayPal Canceled Reversal
Pending
Pending Payment
Processing
Filters the search based on the date purchased. To find orders within a range of dates, enter both the From and To dates.
Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Order Workspace
Search Filters (cont.)
FILTER
Grand Total (Base)
Grand Total (Purchased)
Apply Filters
DESCRIPTION
Filters the search based on the Grand Total of each order.
Filters the search based on Grand Total of items purchased in each order.
Applies all filters to the search.
Cancel
Clear All
Cancels the current search.
Clears all search filters.
Order Grid Layout
The selection of columns and their order in the grid can be changed according to your preference. The new layout can be saved as a grid “view.” By default, only nine of twenty available columns are included in the grid.
Order Grid Columns
To change the column selection:
In the upper-right corner, tap the Columns ( ) control. Then, do the following: l
Mark the checkbox of any column you want to add to the grid.
l
Clear the checkbox of any column you want to remove from the grid.
Make sure to scroll down to see all available columns.
Magento Community Edition 2.1 User Guide 715
Order Workspace CHAPTER 49: Orders
To move a column:
1.
Tap the header of the column, and hold.
2.
Drag the column to the new position, and release.
To save a grid view:
1.
Tap the View control. Then, tap Save Current View.
2.
Enter a name for the view. Then, click the arrow ( ) to save all changes.
The name of the view now appears as the current view.
To change the view:
Tap the View control. Then, do one of the following: l
To use a different view, tap the name of the view.
l
To change the name of a view, tap the Edit ( ) icon. Then, update the name.
716 Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Order Workflow
Order Workflow
When a customer places an order, a sales order is created as a temporary record of the transaction. In the Orders grid, sales orders initially have a status of "Pending," and can be canceled at any time until the payment is processed. After payment is confirmed, the order can be invoiced and shipped.
Place Order. The checkout process begins when the shopper clicks the Go to Checkout button on the shopping cart page or
directly from their customer account.
Order Pending. In the Orders grid, the status of the sales order is initially “Pending.”
Payment has not been processed, and the order can still be canceled.
Receive Payment. The status of the order changes to “Processing.” when payment is received or authorized. Depending on the payment method, you might receive notification when the transaction is authorized or processed.
Invoice Order. An order is typically invoiced after payment is received. Some payment methods generate an invoice automatically when payment is authorized and captured.
The payment method determines which invoicing options are needed for the order. After the invoice is generated and submitted, a copy is sent to the customer.
Ship Order. The shipment is submitted, and the packing slip and shipping label are printed. The customer receives notification, and the package is shipped. If tracking numbers are used, the shipment can be tracked from the customer’s account.
Magento Community Edition 2.1 User Guide 717
Order Workflow CHAPTER 49: Orders
Processing Orders
When a customer places an order, a sales order is created as a temporary record of the transaction. The sales order has a status of “Pending” until payment is received. Sales orders can be canceled until an invoice is generated. An easy way to think of it is this: Orders become invoices, and invoices become shipments. The Orders grid lists all orders, regardless of where they are in the workflow.
Orders
718 Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Order Workflow
To view an order:
1.
On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
2.
Find the order in the grid, and in the Action column, click View.
l
A pending order can be modified, put on hold, canceled, or invoiced and shipped.
l
A completed order can be reordered.
View Order
Magento Community Edition 2.1 User Guide 719
Order Workflow CHAPTER 49: Orders
Allow Reorders
When enabled, reorders can be made directly from the customer account or from the original order in the Admin. Reorders are enabled by default.
720
Customer Reorder Link in Admin
To configure customer reorders:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Sales.
3.
Expand the Reorder section.
4.
Set Allow Reorder to your preference.
Reorder
Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Order Status
Order Status
All orders have an order status that is associated with a stage in the order processing
The status of each order is shown in the Status column of the Orders grid. Your store has a set of predefined order status and order state settings. The order state describes the position of an order in the workflow.
Order Status
Predefined Order Status
ORDER STATUS STATUS CODE
Processing processing
Suspected Fraud
Pending Payment
Payment Review
Pending
On Hold
Complete fraud pending_payment payment_review pending holded complete
Closed
Canceled closed canceled
PayPal Canceled Reversal paypay_canceled_reversal
Pending PayPal pending_paypal
PayPal Reversed paypal_reversed
Magento Community Edition 2.1 User Guide 721
Order Status
Order State
ORDER STATE
New
Pending Payment
Processing
Complete
Closed
Canceled
On Hold
Payment Review
CHAPTER 49: Orders
When the state of new orders is set to “Processing,” the option to
“Automatically Invoice All Items” becomes available in the configuration.
722 Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders
Order Status Workflow
Order Status
Magento Community Edition 2.1 User Guide 723
Order Status CHAPTER 49: Orders
Custom Order Status
In addition to the preset order status settings, you can create custom order status settings of your own, assign them to order states, and set a default order status for order states. For example, you might need a custom order status for orders such as “packaging” or
“backordered,” or for a status that is specific to your needs. You can create a descriptive name for the custom status, and assign it to the associated order state in the workflow.
Only default custom order status values are used in the order workflow. Custom status values that are not set as default can be used only in the comments section of the order.
Order Status Settings
724 Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders
To create a custom order status:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Order Status.
2.
In the upper-right corner, tap
Create New Status
.
Order Status
Create New Order Status
3.
Under Order Status Information section, do the following:
a.
Enter a Status Code for internal reference. The first character must be a letter (a-z), and the rest can be any combination of letters and numbers (0-9). Use the underscore character instead of a space.
b.
Enter a Status Label to identify the status setting in both the Admin and storefront.
4.
In the Store View Specific Labels section, enter any labels that are needed for different store views.
5.
When complete, tap
Save Status
.
Magento Community Edition 2.1 User Guide 725
Order Status
To assign an order status to a state:
1.
On the Order Status page, tap
Assign Status to State
.
CHAPTER 49: Orders
726
Assign Status
2.
In the Assignment Information section, do the following:
a.
Choose the Order Status that you want to assign. They are listed by status label.
b.
Set Order State to the place in the workflow where the order status belongs.
c.
To make this status the default for the order state, mark the Use Order Status as Default checkbox.
d.
To make this status visible from the storefront, mark the Visible On Storefront checkbox.
Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Order Status
Assign Status to State
3.
When complete, tap
Save Status Assignment
.
To edit an existing order status:
1.
In the Order Status grid, open the status record in edit mode.
2.
Update the status settings as needed.
3.
When complete, tap
Save Status
.
To remove an order status from an assigned state:
A status setting cannot be unassigned from a state if the status is currently in use.
1.
In the Order Status grid, find the order status record to be unassigned.
2.
In the Action column on the far right of the row, tap the Unassign link.
A message appears at the top of the workspace that the order status has been unassigned.
Although the order status label still appears in the list, it is no longer assigned to a state.
Order status settings cannot be deleted.
Magento Community Edition 2.1 User Guide 727
Scheduled Order Operations CHAPTER 49: Orders
Scheduled Order Operations
Magento
jobs can be used to schedule the following order management tasks: l
Pending Payment Order Lifetime
l
728
Orders Grid with Pending Orders
Pending Payment Order Lifetime
The lifetime of orders with pending payments is determined by the Orders Cron Settings configuration. The default value is set to 480 minutes, which is eight hours.
To set the lifetime of orders with pending payments:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Sales.
3.
Expand the Orders Cron Settings section.
Orders Cron Settings
4.
In the Pending Payment Order Lifetime (minutes) field, enter the number of minutes before a pending payment expires.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 49: Orders Scheduled Order Operations
Scheduled Grid Updates
The Grid Settings configuration schedules updates to the following order management grids, and reindexes the data as scheduled by
l
l
l
l
The benefits of scheduling these tasks is to avoid the locks that occur when data is saved, and to reduce processing time. When enabled, any updates take place only during the scheduled cron job. For best results, Cron should be configured to run once every minute.
To enable scheduled grid updates and reindexing:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
Expand the Grid Settings section.
4.
Set Asynchronous Indexing to “Enable.”
5.
When complete, tap
Save Config
.
Grid Settings
Magento Community Edition 2.1 User Guide 729
730 Magento Community Edition 2.1 User Guide
CHAPTER 50:
Invoices
An invoice is a record of the record of payment for an order. Multiple invoices can be created for a single order, and each can include as many or as few of the purchased products that you specify. You can upload a high-resolution logo for a print-ready
PDF invoice, and include the
in the header. To customize the invoice template with your logo, see:
.
Magento Community Edition 2.1 User Guide
PDF Invoice
731
Creating an Invoice CHAPTER 50: Invoices
Creating an Invoice
Creating an invoice for an order converts the temporary sales order into a permanent record of the order that cannot be canceled. A new invoice page looks similar to a completed order, with some additional fields. Every activity that is related to an order is noted in the Comments section of the invoice.
Normally, orders are invoiced and shipped after payment is received. However, if the method of payment is a purchase order, the order can be invoiced and shipped before payment is received.
You can generate an invoice with a packing slip, and also print shipping labels from your carrier account. A single order can be divided into partial shipments which are invoiced separately, if necessary.
When the state of new orders is set to “Processing,” the option to “Automatically Invoice All
Items” becomes available in the configuration. To learn more, see: .
Some credit card payment methods complete the invoicing step as part of the process when
Payment Action is set to “Authorize and Capture.” In such a case, the Invoice button does not appear, and the order is ready to ship.
Before an invoice can be printed, it must first be generated for the order. To view or print the
PDF, first download and install a PDF reader such as Adobe Acrobat Reader .
Invoices
732 Magento Community Edition 2.1 User Guide
CHAPTER 50: Invoices Creating an Invoice
To invoice an order:
1.
On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
2.
Find the order in the grid, and do the following:
a.
In the Action column, click the View link.
b.
In the upper-right corner, tap
Invoice
. The new invoice page looks similar to a completed order page, with additional fields that can be edited.
The Invoice button does not appear for orders placed with the “Authorize and Capture” payment action.
3.
If the items are ready to ship, you can generate a packing slip for the shipment at the same time you create the invoice. To create a packing slip, do the following:
a.
In the Shipping Information section, mark the Create Shipment checkbox. A shipment record will be created at the same time the invoice is generated.
Create Shipment
b.
To include a tracking number, tap
Add Tracking Number
. Then, enter the following: l
Carrier l
Title l
Number
c.
If you need to generate a partial invoice, do the following:
In the Items to Invoice section, update the Qty to Invoice column to include only specific items on the invoice. Then, tap
Update Qty’s
.
Magento Community Edition 2.1 User Guide 733
Creating an Invoice CHAPTER 50: Invoices
Items to Invoice
4.
If an online payment method was used for the order, set Amount to the appropriate option.
5.
To notify customers by email when the invoice is generated, do the following:
a.
Mark the Email Copy of Invoice checkbox.
b.
Enter any Invoice Comments. To include the comments in the notification email, mark the Append Comments checkbox.
6.
When complete, tap
Submit Invoice
at the bottom of the page. The status of the order changes from "Pending" to "Complete."
Submit Invoice
734 Magento Community Edition 2.1 User Guide
CHAPTER 50: Invoices Creating an Invoice
Magento Community Edition 2.1 User Guide
Completed Invoice
735
Creating an Invoice
To print the invoice:
1.
At the top of the workspace, tap
to generate a PDF of the invoice
2.
Do one of the following: l
Send the PDF invoice to a printer.
l
Save the PDF file.
To customize the default invoice, see:
CHAPTER 50: Invoices
736
Default PDF Invoice
Magento Community Edition 2.1 User Guide
CHAPTER 50: Invoices
Payment Actions
PAYMENT ACTION
Capture Online
Capture Offline
Not Capture
Creating an Invoice
DESCRIPTION
Upon invoice submission, the system captures the payment from the third-party payment gateway. You have the ability to create a credit memo and void the invoice.
Upon invoice submission, the system does not capture the payment.
It is assumed that the payment is captured directly through the gateway, and you no longer have the option to capture this payment through Magento. You have the ability to create a credit memo, but you do not have the option to void the invoice. (Even though the order used an online payment, the invoice is essentially an offline invoice.)
When the invoice is submitted, the system does not capture the payment. It is assumed that you will capture the payment through
Magento at a later date. There is a Capture button in the completed invoice. Before capturing, you are able to cancel the invoice. After capturing you are able to create a credit memo and void the invoice.
Do not select Not Capture unless you are certain that you are going to capture the payment through Magento at a later date. You will not be able to create a credit memo until the payment has been captured using the Capture button.
Magento Community Edition 2.1 User Guide 737
Creating an Invoice CHAPTER 50: Invoices
Printing Multiple Invoices
Invoices can be printed individually or as a batch. However, before an invoice can be printed, it must first be generated for the order. To add your logo and address to the invoice, see:
.
To view or print the PDF, you must have a PDF reader. You can download
Adobe Reader at no charge.
To print multiple invoices:
1.
On the Admin sidebar, tap Sales. Then under Operations, choose Invoices.
2.
In the Invoices grid, mark the checkbox of each invoice to be printed.
3.
Set the Actions control to “PDF Invoices.”
Print Invoices
The invoices are saved in a single PDF file that can be sent to a printer, or saved.
738 Magento Community Edition 2.1 User Guide
CHAPTER 51:
Billing Agreements
The Billing Agreements grid lists all
between your store and its customers. The store administrator can filter the records by the customer or billing agreement information including billing agreement reference ID, status, and creation date.
Each record includes general information about the billing agreement, and all sales orders that have used it as a payment method. The store administrator can view, cancel, or delete customer’s billing agreements. A canceled billing agreement can be deleted only by the store administrator.
Billing Agreements
Magento Community Edition 2.1 User Guide 739
740 Magento Community Edition 2.1 User Guide
CHAPTER 52:
Shipments
The Shipments grid lists the shipment record of all invoices that have been prepared for shipping. A shipment record can be generated when an order is
.
Shipments
Magento Community Edition 2.1 User Guide 741
742 Magento Community Edition 2.1 User Guide
CHAPTER 53:
Transactions
The Transactions grid lists all payment activity that has taken place between your store and a payment system, and provides access to more detailed information.
To view transactions:
On the Admin sidebar, tap Sales. Then under Operations, choose Transactions.
Transactions
Magento Community Edition 2.1 User Guide 743
744 Magento Community Edition 2.1 User Guide
CHAPTER 54:
Credit Memos
A credit memo is a document that shows the amount that is owed to the customer. The amount can be applied toward a purchase, or refunded to the customer. You can print a credit memo for a single order, or for multiple orders as a batch. Before a credit memo can be printed, it must first be generated for the order. The credit memo grid lists the credit memos that have been issued. to customers.
Credit Memos
Magento Community Edition 2.1 User Guide 745
CHAPTER 54: Credit Memos
To create a credit memo:
1.
On the Admin sidebar tap Sales. Then under Operations, choose Orders.
2.
Find the completed order in the grid. Then in the Action column, click the View link to open the order.
3.
In the upper right corner, tap
Credit Memo
. (The button appears only after an order is invoiced.)
Create Credit Memo
The New Credit Memo page looks similar to the completed order page, with an Items to Refund section that lists each item from the invoice.
746
Items to Refund
If an online payment method was used, you will not be able to edit these fields.
4.
Do one of the following: l
If the product is to be returned to inventory, mark the Return to Stock checkbox.
l
If the product will not be returned to inventory, leave the checkbox blank.
Magento Community Edition 2.1 User Guide
CHAPTER 54: Credit Memos
The Return to Stock checkbox appears only if inventory Stock Options are set to “Decrease Stock
When Order Is Placed.”
5.
Complete the following:
a.
In the Qty to Refund box, enter the number of items to be returned. Then, press the Enter key to record the change. The Update Qty’s button becomes active.
b.
Enter 0 for the Qty to Refund of any items that are not to be refunded.
c.
Tap
Update Qty’s
to recalculate the total. (The amount to be credited cannot exceed the maximum amount that is available for refund.)
6.
In the Refund Totals section, do the following, as applicable:
a.
In the Refund Shipping field, enter any amount that is to be refunded from the shipping fee. This field initially displays the total shipping amount from the order that is available for refund. It is equal to the full shipping amount from the order, less any shipping amount that has already been refunded. Like the quantity, the amount can be reduced, but not increased.
b.
In the Adjustment Refund field, enter a value to be added to the total amount refunded as an additional refund that does not apply to any particular part of the order (shipping, items, or tax). The amount entered cannot raise the total refund higher than the paid amount.
c.
In the Adjustment Fee field, enter a value to be subtracted from the total amount refunded. This amount is not subtracted from a specific section of the order such as shipping, items, or tax.
d.
If the purchase was paid with store credit, mark the Refund to Store Credit checkbox. The amount will be credited to the customer’s account balance.
e.
To add a comment, enter the text in the Credit Memo Comments box.
f.
To send an email notification to the customer, mark the Email Copy of Credit Memo checkbox.
g.
To include the comments you have entered in the email, mark the Append Comments checkbox.
The status of a credit memo notification appears in the completed credit memo next to the credit memo number.
7.
To complete the process and generate the credit memo, choose one of the following refund option buttons, according to the payment type: l
Refund Offline l
Refund Online
8.
To add a comment to the completed credit memo, scroll down to the Comments History section, and enter the comment in the box. A history of all activity related to the order is listed below.
Magento Community Edition 2.1 User Guide 747
CHAPTER 54: Credit Memos l
To send the comment to the customer by email, mark the Notify Customer by Email checkbox.
l
To post the comment in the customer’s account, mark the Visible on Frontend checkbox.
Then, tap
Submit Comment
.
9.
In the panel on the left, choose Credit Memos. Any credit memos that are associated with this order appear in the list.
Completed Credit Memo
748 Magento Community Edition 2.1 User Guide
CHAPTER 54: Credit Memos Printing Credit Memos
Printing Credit Memos
To print or view the completed credit memo, you must have a PDF reader installed on your computer. You can download Adobe Reader at no charge.
Credit Memos
To print a credit memo:
1.
On the Admin sidebar, tap Sales. Then under Operations, choose Credit Memos.
2.
Use one of the following methods to print the credit memo:
Magento Community Edition 2.1 User Guide 749
Printing Credit Memos
Method 1:
Print current credit memo
1.
In the grid, open the credit memo.
2.
Tap
.
CHAPTER 54: Credit Memos
Print Credit Memo
Method 2:
Print multiple credit memos
1.
In the list, mark the checkbox of each credit memo that you want to print.
2.
Set the Actions control to “PDF Credit Memos. Then, tap
Submit
.
3.
When prompted, do one of the following: l
To save the document, tap
Save
. Then, follow the prompts to save the file to your computer. When the download is complete, open the PDF in Adobe Reader, and print the document.
l
To view the document, tap
Open
. The printed-ready PDF credit memo opens in Adobe
Reader. From here, you can either print the credit memo or save it to your computer.
750 Magento Community Edition 2.1 User Guide
CHAPTER 54: Credit Memos
Product Return Workflow
Product Return Workflow
Magento Community Edition 2.1 User Guide
Product Return Workflow
751
752 Magento Community Edition 2.1 User Guide
Payments
753
754
Contents
In this section of the guide, you will learn about the payment methods, services, and gateways that you can make available to your customers, and how to configure them.
PayPal Fraud Management Filter
CHAPTER 55:
Recommended Solutions
The following payment solutions provide an easy way for merchants who are just starting out to accept online payments. As your business grows, you can combine these with additional PayPal payment solutions.
PayPal Express Checkout
Use PayPal Express Checkout as a standalone option, or combine it with another PayPal payment solution.
Braintree
Braintree allows you to accept credit/debit cards and
PayPal without any setup or monthly fees. Your customers never leave your store to complete the purchase.
Magento Community Edition 2.1 User Guide 755
PayPal Express Checkout CHAPTER 55: Recommended Solutions
PayPal Express Checkout
PayPal Express Checkout helps boost sales by giving your customers the ability to pay by credit card or from the security of their personal PayPal accounts. During checkout, the customer is redirected to the secure PayPal site to complete the payment information. The customer is then returned to your store to complete the remainder of the checkout process. Choosing Express
Checkout adds the familiar PayPal button to your store, which has been reported to increase sales.*
Customers with current PayPal accounts can make a purchase in a single step by clicking the
“Check out with PayPal” button. Express Checkout can be used as a standalone, or in combination with one of PayPal’s All-In-One solutions. If you already accept credit cards online, you can offer Express Checkout as an additional option to attract new customers who prefer to pay with PayPal.
Requirements
Merchant: Personal PayPal Account
Customer: Personal PayPal Account
756 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
Checkout Workflow
Unlike other payment methods, PayPal Express Checkout allows the customer to check out at the beginning of the usual checkout workflow from the product page, the mini shopping cart, and shopping cart.
Customer Places Order. The customer taps the “Check out with PayPal” button. .
Customer Is Redirected to PayPal Site. The customer is redirected to the PayPal site to complete the transaction. / The customer taps the “Check out with PayPal” button.
and is redirected to the PayPal site to complete the transaction.
Customer Logs into their PayPal Account. The customer must log in to their PayPal account to complete the transaction. The payment system uses the customer’s billing and shipping information from their PayPal account.
Customer Returns to the Checkout Page. The customer is redirected back to the checkout page in your store to review the order.
Customer Places Order. The customer places the order, and the order information is submitted to PayPal.
PayPal Settles the Transaction. PayPal receives the order and settles the transaction.
PayPal Express Checkout does not support orders with multiple-addresses.
Magento Community Edition 2.1 User Guide 757
PayPal Express Checkout CHAPTER 55: Recommended Solutions
Setting Up PayPal Express Checkout
You can have two PayPal solutions active at the same time: Express Checkout, plus an All-In-
One solution. If you enable a different solution, the one used previously is automatically deactivated.
Process Overview:
Step 1:
Step 2:
Complete the Required Settings
Step 3:
Step 4:
Complete the Advanced Settings
758 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
Step 1:
Configure Your PayPal Account
1.
Before you begin, you must configure your PayPal merchant account on the PayPal website.
a.
Log in to your PayPal Advanced account at manager.paypal.com
.
b.
Go to Service Settings > Hosted Checkout Pages > Set Up, and make the following settings:
AVS No
CSC No
Enable Secure Token Yes
c.
Save
the settings.
2.
PayPal recommends that you set up an additional user on your account. To set up an additional user, do the following:
a.
Go to manager.paypal.com
and log in to your account.
b.
Follow the instructions to set up an additional user.
c.
Save
the changes.
3.
Expand the Required PayPal Settings section, and do the following:
a.
Enter the Email Address that is associated with your PayPal merchant account.
Important! Email addresses are case sensitive. To receive payment, the email address you enter must match the email address specified in your PayPal merchant account.
b.
Set API Authentication Methods to one of the following: l
API Signature l
API Certificate
c.
If necessary, click the Get Credentials from PayPal button. Then, complete the following: l
API Username l
API Password l
API Signature
d.
If you are using credentials from your sandbox account, set Sandbox Mode to “Yes.”
If necessary, click the Sandbox Credentials button and follow the instructions to set up your testing environment.
When testing the configuration in a sandbox, use only credit card numbers that are recommended by PayPal. When you are ready to “go live,” return to the configuration and set Sandbox Mode to “No.”
Magento Community Edition 2.1 User Guide 759
PayPal Express Checkout CHAPTER 55: Recommended Solutions
e.
If your system uses a proxy server to establish the connection between Magento and the
PayPal payment system, set API Uses Proxy to “Yes.” Then,, complete the following: l
Proxy Host l
Proxy Port
4.
When these sections are complete, set Enable this Solution to “Yes.”
5.
To enable P ayPal In-Context Checkout , do the following:
a.
Set Enable In-Context Checkout Experience to “Yes.”
b.
Enter your PayPal Merchant Account ID.
Your Merchant Account ID is in your PayPal business account profile.
6.
To offer financing through PayPal to your customers, see PayPal Credit to learn more.
You have now completed the Required PayPal Settings. At this point, you can either continue with the Basic and Advanced Settings, or click the Save Config button. You can return later fine-tune the configuration.
Step 2:
Begin the Configuration
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Payment Methods.
3.
If your Magento installation has multiple websites, stores or views, in the upper-left corner, choose the Store View where the configuration applies.
4.
In the Merchant Location section, select the Merchant Country where your business is located.
5.
Under Recommended Solutions in the PayPal Express Checkout section, tap
Configure
.
Step 3:
Complete the Required Settings
a.
Enter the Email Address that is associated with your PayPal merchant account.
Important! Email addresses are case sensitive. To receive payment, the email address you enter must match the email address specified in your PayPal merchant account.
b.
Set API Authentication Methods to one of the following: l
API Signature l
API Certificate
c.
If necessary, tap
Get Credentials from PayPal
. Then, complete the following:
760 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout l
API Username l
API Password l
API Signature
d.
If you are using credentials from your sandbox account, set Sandbox Mode to “Yes.”
If necessary, click the Sandbox Credentials button and follow the instructions to set up your testing environment.
e.
If your system uses a proxy server to establish the connection between Magento and the
PayPal payment system, set API Uses Proxy to “Yes.” Then,, complete the following: l
Proxy Host l
Proxy Port
6.
Set Enable This Solution to “Yes.”
7.
If you want to offer PayPal Credit to your customers, set Enable PayPal Credit to “Yes.”
You have now completed the required settings. You can either continue with the remaining settings, or save and return later fine-tune the configuration.
Magento Community Edition 2.1 User Guide
Required Settings
761
PayPal Express Checkout CHAPTER 55: Recommended Solutions
Step 4:
Complete the Basic Settings
1.
Expand the Basic Settings - PayPal Express Checkout section.
2.
Enter a Title to identify this payment method during checkout. It is recommended to set the title to “PayPal” for each store view.
3.
If you offer multiple payment methods, enter a number in the Sort Order field to determine the sequence in which PayPal Payments Standard is listed with the other methods. Payment methods appear in ascending order based on the Sort Order value.
4.
Set Payment Action to one of the following:
Authorization
Sale
Order
Approves the purchase, but puts a hold on the funds. The amount is not withdrawn until it is “captured” by the merchant.
The amount of the purchase is authorized and immediately withdrawn from the customer’s account.
The amount of the order is neither captured nor authorized in the customer’s balance, bank account, or credit card at PayPal. The Order payment action represents an agreement between the PayPal payment system and the merchant, which enables the merchant to capture one or more amounts up to the “ordered” total from the customer’s buyer account, over a period of up to 29 days. After the funds are “ordered,” the merchant can capture them at any time during the following 29 day period. Capturing of the order amount can be done only from the
Magento Admin by creating one or more invoices.
5.
To display the “Check out with PayPal” button on the product page, set Display on Product
Details Page
to “Yes.”
6.
If Payment Action is set to “Order,” complete the following fields:
Authorization
Honor Period
(days)
Determines how long the primary authorization remains valid. The value should be equal to the corresponding value in your PayPal merchant account. The default value in your PayPal merchant account is
3. To increase this number you need to contact PayPal. The authorization becomes invalid at 11:49 p.m., U.S. Pacific Time, of the last day.
Order Valid Period
(days)
Determines how long the order remains valid. When the order becomes invalid, you can no longer create invoices for it. Specify the value equal to the Order Valid Period value in your PayPal merchant account. The default value in your PayPal merchant account is 29. To change this number, you must contact PayPal.
762 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
Number of Child
Authorizations
Specifies the maximum number of authorizations for a single order, which determines the maximum number of online partial invoices that you can create for an order. The number in this field should be equal to the corresponding setting in your PayPal merchant account. The default number of child authorizations in your PayPal account is 1. To increase this number, you must contact PayPal.
Basic Settings
Step 5:
Complete the Advanced Settings
1.
Expand the Advanced Settings section. Then, complete the following:
a.
Set Display on Shopping Cart to “Yes.”
b.
Set Payment Applicable From to one of the following:
All Allowed
Countries
Accepts payment from the countries already specified in your configuration.
Specific Countries Accepts payments from only the countries you specify. Hold the
Ctrl key down and in the Payment Applicable From list, click each country where you accept payment.
c.
Set Debug Mode to “Yes” to write communications with the payment system into the log file. The log file for PayPal Payments Advanced is payments_payflow_advanced.log.
In accordance with PCI Data Security Standards, credit card information is not recorded in the log file.
d.
To enable host authenticity verification, set Enable SSL Verification to “Yes.”
e.
To display a full summary of the customer’s order by line item from the PayPal site, set
Transfer Cart Line Items
to “Yes.”
To include up to ten shipping options in the summary, set Transfer Shipping Options to
“Yes.” (This option appears only if line items are set to transfer.)
f.
To determine the type of image used for the PayPal acceptance button, set Shortcut
Buttons Flavor
to one of the following:
Magento Community Edition 2.1 User Guide 763
PayPal Express Checkout CHAPTER 55: Recommended Solutions
Dynamic
Static
(Recommended) Displays an image that can be dynamically changed from the PayPal server.
Displays a specific image that cannot be dynamically changed.
g.
To allow customers without PayPal accounts to make a purchases with this method, set
Enable PayPal Guest Checkout
to “Yes.”
h.
Set Require Customer’s Billing Address to one of the following:
Yes Requires the customer’s billing address for all purchases.
No Does not require the customer’s billing address for any purchases.
For Virtual Quotes
Only
Requires the customer’s billing address for virtual quotes only.
i.
To specify whether the customer can sign a
with your store in the PayPal payment system when there are no active billing agreements available in the customer account, set Billing Agreement Signup to one of the following:
Auto
Ask Customer
Never
The customer can either sign a billing agreement during the
Express Checkout flow or use another method of payment.
The customer can decide whether to sign a billing agreement during the Express Checkout flow.
The customer cannot sign a billing agreement during the Express
Checkout flow.
Merchants must ask PayPal Merchant Technical Support to enable billing agreements in their accounts. The Billing Agreement Signup parameter is enabled only after PayPal confirms that billing agreements are enabled for your merchant account.
j.
To allow the customer to complete the transaction from the PayPal site without returning to your Magento store for Order Review, set Skip Order Review Step to “Yes.”
764 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
Advanced Settings
2.
Complete the following sections as needed for your store:
PayPal Billing Agreement Settings
A
is a sales agreement between the merchant and customer that has been authorized by PayPal for use with multiple orders. During the checkout process, the Billing
Agreement payment option appears only for customers who have already entered into a billing agreement with your company. After PayPal authorizes the agreement, the payment system issues a unique reference ID to identify each order that is associated with the agreement.
Similar to a purchase order, there is no limit to the number of billing agreements a customer can set up with your company.
1.
Expand the PayPal Billing Agreement Settings section.
2.
Set Enabled to “Yes.” Then, do the following:
a.
Enter a Title to identify the PayPal Billing Agreement method during checkout.
b.
If you offer multiple payment methods, enter a number in the Sort Order field to determine the sequence in which Billing Agreement appears when listed with other payment methods during checkout.
c.
Set Payment Action to one of the following:
Magento Community Edition 2.1 User Guide 765
PayPal Express Checkout CHAPTER 55: Recommended Solutions
Authorization
Sale
Approves the purchase, but puts a hold on the funds. The amount is not withdrawn until it is “captured” by the merchant.
The amount of the purchase is authorized and immediately withdrawn from the customer’s account.
d.
Set Payment Applicable From to one of the following:
All Allowed
Countries
Accepts payment from the countries already specified in your configuration.
Specific Countries Accepts payments from only the countries you specify. Hold the Ctrl key down and in the Payment Applicable From list, click each country where you accept payment.
e.
To record communications with the payment system in the log file, set Debug Mode to “Yes.”
The log file is stored on the server and is accessible only to developers. In accordance with PCI Data Security Standards, credit card information is not recorded in the log file.
f.
To enable SSL verification, set Enable SSL verification to “Yes.”
g.
To display a summary of each line item in the customer’s order on your PayPal payments page, set Transfer Cart Line Items to “Yes.”
h.
To allow customers to initiate a billing agreement from the dashboard of their customer account, set Allow in Billing Agreement Wizard to “Yes.”
766
Billing Agreement Settings
Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
Settlement Report Settings
1.
Click to expand the Settlement Report Settings section.
2.
If you have signed up for PayPal’s Secure FTP Server, enter the following SFTP login credentials: l
Login l
Password
3.
To run test reports before “going live” with Express Checkout on your site, set Sandbox
Mode
to “Yes.”
4.
Enter the Custom Endpoint Hostname or IP Address. By default, the value is: reports.paypal.com
5.
Enter the Custom Path where reports are saved. By default, the value is:
/ppreports/outgoing
6.
To generate reports according to a schedule, under Scheduled Fetching, make the following settings:
a.
Set Enable Automatic Fetching to “Yes.”
b.
Set Schedule to one of the following: l
Daily l
Every 3 Days l
Every 7 Days l
Every 10 Days l
Every 14 Days l
Every 30 Days l
Every 40 Days
PayPal retains each report for forty-five days.
c.
Set Time of Day to the hour, minute, and second when you want the reports to be generated.
Magento Community Edition 2.1 User Guide 767
PayPal Express Checkout CHAPTER 55: Recommended Solutions
768
Settlement Report Settings
Frontend Experience Settings
The frontend experience settings give you the opportunity to choose which PayPal logos appear on your site, and to customize the appearance of your PayPal merchant pages.
1.
Click to expand the Frontend Experience Settings section.
2.
Select the PayPal Product Logo that you want to appear in the PayPal block in your store. The PayPal logos are available in four styles and two sizes. Options include: l
No Logo l
We Prefer PayPal (150 x 60 or 150 x 40) l
Now Accepting PayPal (150 x 60 or 150 x 40) l
Payments by PayPal (150 x 60 or 150 x 40) l
Shop Now Using PayPal (150 x 60 or 150 x 40)
3.
To customize the appearance of your PayPal merchant pages, do the following:
a.
Enter the name of the Page Style that you want to apply to your PayPal merchant pages. Options include:
Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout paypal primary your_custom_ value
Uses the PayPal page style.
Uses the page style that you identified as the “primary” style in your account profile.
Uses a custom payment page style, which is specified in your account profile.
b.
In the Header Image URL field, enter the URL of the image that you want to appear in the upper-left corner of the payment page. The maximum file size is 750 pixels wide by 90 pixels high.
PayPal recommends that the image be located on a secure (https) server. Otherwise, the customer’s browser may warn that “the page contains both secure and nonsecure items.”
c.
Enter the six-character hexadecimal code, without the “#” symbol, for each of the following:
Header
Background Color
Header Border
Color
Page Background
Color
Background color for the checkout page header.
2-pixel border around the header.
Background color for the checkout page and around the header and payment form.
3.
When complete, tap
Save Config
.
Frontend Experience Settings
Magento Community Edition 2.1 User Guide 769
PayPal Express Checkout CHAPTER 55: Recommended Solutions
PayPal In-Context Checkout
PayPal’s In-Context Checkout makes it easier than ever to pay online. Customers never lose sight of your store during this simplified one- or two-click seamless checkout. In-Context
Checkout works equally well on Macs and PCs, and offers a consistent experience on desktop computers, tablets, and mobile devices. To learn more, see: In-Context Checkout in Express
Checkout .
PayPal In-Context Checkout Demo
770 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
To configure In-Context Checkout:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Payment Methods.
3.
In the PayPal Express Checkout section, tap
Configure
. Then, do the following:
a.
In the Required PayPal Settings section, set Enable In-Context Checkout Experience to
“Yes.”
b.
Enter your PayPal Merchant Account ID.
Your Merchant Account ID is in your PayPal
profile.
Enable PayPal In-Context Checkout
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 771
PayPal Express Checkout CHAPTER 55: Recommended Solutions
PayPal Billing Agreements
To simplify the checkout process, customers can enter into a billing agreement with PayPal, as the payment service provider. During checkout, the customer chooses the billing agreement as the payment method. The payment system verifies the billing agreement by its unique number, and charges the customer's account. With a billing agreement in place, it is no longer necessary for the customer to enter payment information for each purchase. Customers can manage their billing agreements from the dashboard of their customer account, where the status of each is shown as “Active” or “Canceled.” When a billing agreement is canceled, it cannot be reactivated.
The Billing Agreements grid lists all billing agreements between your store and its customers.
The store administrator can filter the records by the customer or billing agreement information including billing agreement reference ID, status, and creation date. Each record includes general information about the billing agreement, and all sales orders that have used it as a payment method. The store administrator can view, cancel, or delete customer’s billing agreements. A canceled billing agreement can be deleted only by the store administrator.
Billing Agreements
772 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
Billing Agreement Workflow
Customer signs up for a billing agreement. After a billing agreement is in place, additional billing agreements can be added only from the customer account. There is no limit to the number of billing agreements a customer can create. Customers can use any of the following methods to sign up for billing agreements: l
Sign up in customer account. Customers can sign up for a billing agreement from their customer accounts.
l
Sign up at checkout. Customers who pay for a purchase with PayPal Express
Checkout can mark a checkbox to create a billing agreement. Although the billing agreement is not used for the current order, it becomes available as a payment method option the next time the customer places an order.
l
Sign up by store administrator. On a customer’s request, the store administrator can create a sales order using the customer’s billing agreement.
PayPal Verifies and Records Agreement. When the customer places the order with payment by billing agreement, the billing agreement reference ID and sales order payment details are transferred to PayPal, and recorded in the customer account, along with reference information. If the payment is authorized, an order is created in
Magento.The billing agreement reference ID is sent to the customer and to the store.
Magento Community Edition 2.1 User Guide 773
PayPal Express Checkout CHAPTER 55: Recommended Solutions
PayPal Settlement Reports
The PayPal Settlement report provides the store administrator with the information about each transaction that affects the settlement of funds.
Before generating settlement reports, the store administrator must request PayPal Merchant
Technical Services to create an SFTP user account, enable settlement reports generation, and enable SFTP in their PayPal business account.
After configuring and enabling settlement reports in the PayPal merchant account, Magento will start generating reports during the following twenty-four hours. The list of available settlement reports can be viewed from the Admin.
774
To view settlement reports:
1.
On the Admin sidebar, tap Reports. Then under
Sales
, choose select PayPal Settlement.
2.
For the most recent updates, tap Fetch Updates in the upper-right corner.
The system connects to the PayPal SFTP server to fetch the reports. When the process is complete, a message appears with the number of reports fetched. The report includes the following information for each transaction:
Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Express Checkout
Field Descriptions
FIELD DESCRIPTION
PayPal Reference ID Type One of the following reference codes:
Order ID
Transaction ID
Subscription ID
Preapproved Payment ID Options include:
Custom The text entered by the merchant on the transaction in PayPal.
Transaction Debit or Credit The direction of money movement of gross amount.
Fee Debit or Credit The direction of money movement for fee.
Magento Community Edition 2.1 User Guide 775
Braintree CHAPTER 55: Recommended Solutions
Braintree
Braintree offers a fully customizable checkout experience with fraud detection and PayPal integration. Braintree reduces the PCI compliance burden for merchants because the transaction takes place on the Braintree systerm.
776
Configure Braintree
Setting Up Braintree
Process Overview:
Step 1:
Get Your Braintree Credentials
Step 2:
Step 3:
Complete the Advanced Settings
Step 4:
Complete the Country-Specific Settings
Step 5:
Complete the PayPal through Braintree Settings
Step 6:
Complete the 3D Verification Settings
Step 1:
Get Your Braintree Credentials
Visit Braintree Payments and sign up for an account.
Step 2:
Complete the Basic Settings
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Payment Methods.
l
If your Magento installation has multiple websites, stores or views, in the upper-left corner, choose the Store View where the configuration applies.
l
In the Merchant Location section, verify that Merchant Country is set to the location of your business.
3.
Under Recommended Solutions, in the Braintree section, tap
Configure
. Then, do the following:
Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Braintree
a.
Enter a Title to identify Braintree as a payment option during checkout.
b.
Set the current operating Environment for Braintree transactions to one of the following: l
Sandbox l
Production
When testing the configuration in a sandbox, use only credit card numbers that are recommended by Braintree. When you are ready to go live with Braintree, set Environment to “Production.”
c.
Set Payment Action to one of the following:
Authorize Only
Authorize and
Capture
Approves the purchase and puts a hold on the funds. The amount is not withdrawn from the customer’s bank account until the sale is
“captured” by the merchant.
The amount of the purchase is authorized and immediately withdrawn from the customer’s account.
d.
In the Merchant ID field, enter the email address that is associated with your Braintree account.
e.
Enter the following credentials from your Braintree account: l
Public Key l
Private Key
Basic Settings
4.
Set Enable this Solution to “Yes.”
5.
To include PayPal as a payment option with Braintree, set Enable PayPal through Braintree to “Yes.”
Magento Community Edition 2.1 User Guide 777
Braintree CHAPTER 55: Recommended Solutions
6.
If you want the ability to store customer information securely, so customers don't have to reenter it each time they make a purchase, set Vault Enabled to “Yes.”
Basic Settings
Step 3:
Complete the Advanced Settings
1.
Expand the Advanced Braintree Settings section.
2.
In the Vault Title field, enter a descriptive title for your reference that identifies the vault where your customer card information is stored.
3.
Enter the Merchant ID that is to be associated with Braintree transactions. If left blank, the default merchant account from your Braintree account is used.
4.
To use Braintree fraud protection for all transactions, set Advanced Fraud Protection to “Yes.”
Make sure that Advanced Fraud Protection is enabled in the Settings/Protection section of your account.
5.
If you want the system to save a log file of interactions between your store and Braintree, set
Debug
to “Yes.”
6.
To require customers to provide the three-digit security code from the back of a credit card, set
CVV Verification
to “Yes.”
If using CVV verification, make sure to enable AVS and/or CVV in the Settings/Processing section of your Braintree account.
7.
In the Credit Card Types box, hold down the Ctrl key and select each credit card that is accepted by your store as payment through Braintree.
8.
In the Sort Order field, enter a number to determine the sequence in which Braintree appears when listed with other payment methods during checkout.
778 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Braintree
Advanced Settings
Step 4:
Complete the Country Specific Settings
1.
Set Payment from Applicable Countries to one of the following: l
All Allowed Countries l
Specific Countries
For Payment from Specific Countries, hold down the Ctrl key and select each country from which you accept payment.
Magento Community Edition 2.1 User Guide 779
Braintree CHAPTER 55: Recommended Solutions
780
Country-Specific Settings
2.
To set up Country Specific Credit Card Types, do the following:
a.
Tap
Add
.
b.
Set the Country, and choose each Allowed Credit Card Type.
c.
Repeat to identify the credit cards that are accepted from each country.
Step 5:
Complete the PayPal through Braintree Settings
1.
Do the following to identify your PayPal through Braintree configuration:
a.
Enter a Title to identify Braintree’s payment by PayPal option during checkout.
b.
In the Vault Title field, enter a descriptive title to identify the vault where your customer card information is to be stored.
c.
In the Sort Order field, enter a number to determine the sequence in which Braintree’s
PayPal payment option appears when listed with other payment options during checkout.
d.
To display your
differently than what is defined in your store configuration, enter the name as you want it to appear in the Override Merchant Name field.
2.
Set Payment Action to one of the following:
Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Braintree
Authorize
Authorize and
Capture
Approves the purchase and puts a hold on the funds. The amount is not withdrawn from the customer’s bank account until the sale is “captured” by the merchant.
The amount of the purchase is authorized and immediately withdrawn from the customer’s account.
3.
Set Payment from Applicable Countries to one of the following for Braintree transactions processed by PayPal: l
All Allowed Countries l
Specific Countries
For Payment from Specific Countries, hold down the Ctrl key and select each country from which you accept payment.
4.
To require that customers provide a billing address, set Require Customer’s Billing Address to “Yes.”
This feature must first be enabled for your account by PayPal Technical Support.
5.
If you want customers to be able to edit the shipping address while completing a PayPal transaction, set Allow to Edit Shipping Address Entered During Checkout on PayPal Side to
“Yes.”
6.
To save a log file of interactions between your store and PayPal through Braintree, set Debug to “Yes.”
7.
If you want to bypass the Order Review step before the order is submitted, set Skip Order
Review
to “Yes.”
By default, Order Review is the last stage of the checkout process.
8.
To display the PayPal button on both the mini shopping cart and shopping cart page, set
Display on Shopping Cart
to “Yes.”
Magento Community Edition 2.1 User Guide 781
Braintree CHAPTER 55: Recommended Solutions
782
PayPal through Braintree Settings
Step 6:
Complete the 3D Verification Settings
1.
If you want to add a verification step for customers using credit cards that are enrolled in a verification program such as “Verified by VISA,” set 3d Secure Verification to “Yes.”
During the process, the transaction amount that is submitted for verification is checked against the amount that is sent for authorization,
2.
In the Threshold Amount field, enter the maximum amount that is allowed to be processed by
Braintree for a single order.
The Threshold Amount defines the maximum amount that is allowed for an authorized sale.
Authorization is declined if the order amount exceeds the Threshold Amount.
3.
Set Verify for Applicable Countries to one of the following: l
All Allowed Countries l
Specific Countries
Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Braintree
To Verify for Specific Countries, hold down the Ctrl key and select each country from which payments are to be verified.
3D Verification Settings
Step 7:
Dynamic Descriptors
The following descriptors are used to identify purchases on customer credit card statements.
You can reduce the number of chargebacks by clearly identifying the company that is associated with each purchase. If Dynamic Descriptors are not enabled for your account, contact Braintree support .
1.
Enter the Dynamic Descriptor for the Name, Phone, and URL according to these guidelines:
Name There are two parts to the Name descriptor, which are separated by an asterisk (*). For example: company*myproduct
The first part of the descriptor identifies the company or DBA, and the second part identifies the product. The length of the Company and Product parts of the descriptor can be allocated in the following ways, for a combined length of up to twenty-two characters.
Characters in Name Descriptor
Company Product
Option 1
Option 2
Option 3
Must be 3 characters
Must be 7 characters
Must be 12 characters
Up to 18 characters
Up to 14 characters
Up to 9 characters
Phone The Phone descriptor must be ten to fourteen characters in length, and can include only numbers, dashes, parentheses, and periods. For example:
Magento Community Edition 2.1 User Guide 783
Braintree CHAPTER 55: Recommended Solutions
URL
9999999999
(999) 999-9999
999.999.9999
The URL descriptor represents your domain name, and can be up to thirteen characters long. For example: company.com
2.
When your Braintree configuration is complete, tap
Save Config
.
784 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
Other PayPal Solutions
PayPal is a global leader in online payments and a fast and secure way for your customers to pay online. With PayPal and Magento Community Edition 2.1, you can accept payments from all major debit and credit cards. PayPal offers additional convenience without extra effort, because even your customers who don’t have a PayPal account can pay for their purchases with
PayPal. In this guide, PayPal payments solutions are organized as follows: l
l
PayPal All-In-One Payment Solutions
l
The selection of available PayPal solutions varies by merchant location.
and PayPal Payments Standard can be used in all parts of the world. To learn more, see:
.
You cannot have more than one PayPal method enabled at a time, with the exception of PayPal
Express Checkout. PayPal Express Checkout can be used in combination with other PayPal payment methods. except for PayPal Payments Standard. If you change payment solutions, the one used previously is disabled.
Magento Community Edition 2.1 User Guide 785
Other PayPal Solutions CHAPTER 55: Recommended Solutions
PayPal All-In-One Payment Solutions
In the United States, PayPal offers the following PCI-compliant solutions to meet the needs of your growing business.
l
l
l
786
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
l
PayPal Payment Gateways
Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
PayPal Payments Advanced
PayPal Payments Advanced is a
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-In-
One or Payment Gateway solution. If you change payment solutions, the one that was used previously is disabled.
PayPal Payments Advanced cannot be used for orders created from the Admin of your store.
Requirements
PayPal Business Account
If you manage multiple Magento websites, you must have a separate PayPal merchant account for each website.
Magento Community Edition 2.1 User Guide 787
Other PayPal Solutions CHAPTER 55: Recommended Solutions
Checkout Workflow
Customer Chooses Payment Method. During checkout, the customer chooses to pay with PayPal Payments Advanced. The Pay Now button appears instead of the Place
Order button.
Pay Now. The customer taps Pay Now, and a PayPal-hosted form appears. The customer enters the card information, and the card is verified. If successful, the order confirmation page appears.
Pay with PayPal. The form also includes the Pay with PayPal button, which redirects the customer to the PayPal site, where payment can be made with PayPal Express
Checkout.
Troubleshooting. If the transaction fails for any reason, an error message appears on the checkout page and the customer is instructed to try again. Any issues are managed by PayPal.
Order Processing Workflow
Processing orders with PayPal Payments Advanced is the same as for any regular PayPal order.
Orders are invoiced and shipped, and credit memos generated for both online and offline refunds. However, multiple online refunds are not available for orders paid with PayPal
Payments Advanced.
Customer Places Order. In the final stage of checkout, the customer taps the Place
Order button.
PayPal Responds. PayPal evaluates the request. If found to be valid, PayPal processes the transaction.
788 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
Magento Sets Order Status. Magento receives response from PayPal, and sets the order status to one of the following:
Processing
Pending Payment
The transaction was successful.
The system did not receive any response from PayPal.
Canceled
Suspected Fraud
The transaction was not successful for some reason.
The transaction did not pass some of the
The system receives the response from PayPal that the transaction is under review by Fraud Service.
Merchant Fulfills Order. The merchant invoices and ships the order.
Setting Up PayPal Payments Advanced
For step-by-step configuration instructions, see PayPal Payments Advanced in the Magento
Community Edition 2.1online user guide.
Magento Community Edition 2.1 User Guide
Setting Up PayPal Payments Advanced
789
Other PayPal Solutions CHAPTER 55: Recommended Solutions
PayPal Payments Pro
PayPal Payments Pro brings you all the benefits of a merchant account and payment gateway in one, plus the ability to create your own, fully customized checkout experience. PayPal
Express Checkout is automatically enabled with PayPal Payments Pro, so you can tap into more than 110 million active PayPal users.
PayPal Payments Pro
For merchants outside the US, this method is called “PayPal Website Payments Pro.”
You can have two PayPal solutions active at the same time: PayPal Express Checkout, plus any one of the All-In-One solutions. If you change payment solutions, the one used previously is automatically disabled.
Requirements
PayPal Merchant Account (with Direct Payments Activated)
Checkout Workflow
Customer Goes to Checkout. Customer adds products to cart, and taps Proceed to
Checkout.
Customer Chooses Payment Method. During checkout, customer chooses the
PayPal Direct Payment option, and enters the credit card information.
l
If paying with PayPal Payments Pro, the customer stays on your site during the checkout process.
l
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.
790 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
Order Processing Workflow
Order Placed. The order can be processed either the Admin of your store, or from your
PayPal merchant account.
Payment Action. The payment action specified in the configuration is applied to the order. Options include:
Authorize Magento creates a sales order with the “Processing” status. In this case, the amount of money to be authorized is pending approval.
Sale
Capture
Magento creates both a sales order and invoice.
PayPal transfers the order amount from the buyer’s balance, bank account or credit card to the merchant’s account.
Invoicing. An invoice is created in Magento after PayPal sends an instant payment notification message to Magento.
Make sure that instant payment notifications are enabled in your PayPal merchant account.
If required, an order can be partially invoiced for a specified quantity of products. For each partial invoice submitted, a separate Capture transaction with a unique ID becomes available, and a separate invoice is generated.
Authorization-only payment transactions are closed only after the full order amount is captured.
An order can be voided online at any time until the order amount is fully invoiced.
Returns. If for any reason the customer returns the purchased products and claims a refund, as with order amount capturing and invoice creation, you can create an online refund either from the Admin or from your PayPal merchant account.
Magento Community Edition 2.1 User Guide 791
Other PayPal Solutions CHAPTER 55: Recommended Solutions
Setting Up PayPal Payments Pro
For step-by-step configuration instructions, see PayPal Payments Pro in the Magento
Community Edition 2.1 online user guide.
Setting Up PayPal Payment Pro
792 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
PayPal Payments Standard
PayPal Payments Standard is the easiest way to accept payments online. You can offer your customers the convenience of payment both by credit card and PayPal by simply adding a checkout button to your store.
PayPal Payments Standard
For merchants outside the US, this method is called “PayPal Website Payments Standard.”
With PayPal Payments Standard, you can swipe credit cards on mobile devices. There is no monthly fee, and you can get paid on eBay. Supported credit cards include Visa, MasterCard,
Discover, and American Express. In addition, customers can pay directly from their personal
PayPal accounts. PayPal Payments Standard is available in all countries on the PayPal worldwide reference list.
Merchant Requirements
PayPal Business Account
Checkout Workflow
For customers, PayPal Payments Standard is a one-step process if the credit card information the their personal PayPal accounts is up to date.
Customer Places Order. The customer taps the “Pay Now” button to complete the purchase.
PayPal Processes the Transaction. The customer is redirected to the PayPal site to complete the transaction.
Magento Community Edition 2.1 User Guide 793
Other PayPal Solutions CHAPTER 55: Recommended Solutions
Setting Up PayPal Payments Standard
PayPal Payments Standard cannot be used simultaneously with any other PayPal method, including
Express Checkout. If you change payment solutions, the one used previously is disabled.
For step-by-step configuration instructions, see PayPal Payments Standard in the online user guide.
Setting Up PayPal Payments Standard
794 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
PayPal Payflow Pro
PayPal Payflow Pro gateway, formerly known as Verisign, is available for customers of the
United States, Canada, Australia, and New Zealand. Unlike other PayPal payment methods, merchants are charged a fixed monthly fee, plus a fixed fee for each transaction, regardless of their number.
Configure
Requirements
PayPal Business Account
The PayPal Payflow Pro gateway links the merchant account at PayPal with the merchant’s website, and acts both as a gateway and a merchant account.
If you manage multiple Magento websites, you must have a separate PayPal merchant account for each website.
Customer Workflow
Customer Goes to Checkout. During checkout, the customer chooses to pay with
PayPal PayFlow Pro, and enters the credit card information.
Customers are not required to have personal PayPal accounts. However, depending on the merchant country, customers can also use their personal PayPal account to pay for the order.
Customer Submits Order. The customer submits the order, and the order information is sent to PayPal for processing. The customer does not leave the checkout page of your site.
PayPal Completes the Transaction. Payments are accepted at the time the order is placed. Depending on the payment action specified n the configuration, either a sales order or a sales order and an invoice is created.
Magento Community Edition 2.1 User Guide 795
Other PayPal Solutions CHAPTER 55: Recommended Solutions
Online Order Processing Workflow
Administrator Submits Online Invoice. The store administrator submits an online invoice. and as a result a corresponding transaction and an invoice is created.
PayPal Receives the Transaction. The order information is sent to PayPal. A record of the transaction and an invoice is generated. You can view all Payflow Pro Gateway transactions in your PayPal merchant account .
Partial invoices and partial refunds are not supported by PayPal Payflow Pro.
Setting Up PayPal Payflow Pro
For step-by-step configuration instructions, see PayPal Payflow Pro in the Magento Community
Edition 2.1online user guide.
PayPal Payflow Pro
796 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
PayPal Payflow Link
PayPal PayFlow Link is available for merchants in the United States and Canada only.
Customers are not required to have a personal PayPal account, and enter their credit card information in a form that is hosted by PayPal. The information is never stored on your
Magento server. PayFlow Link cannot be used for orders that are created from the Admin.
Configure
Credit memos are supported for both online and offline refunds. However, multiple online refunds are not supported.
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 Community Edition 2.1 User Guide 797
Other PayPal Solutions CHAPTER 55: Recommended Solutions
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.
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
.
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.”
798 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions Other PayPal Solutions
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 Community Edition 2.1 User Guide 799
Other PayPal Solutions CHAPTER 55: Recommended Solutions
Setting Up PayPal Payflow Link
For step-by-step configuration instructions, see PayPal Payflow Link in the Magento
Community Edition 2.1online user guide.
PayPal Payflow Link Setup
800 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Quick Reference
PayPal Quick Reference
PAYPAL SOLUTION
EXPRESS CHECKOUT
PayPal Express Checkout
DESCRIPTION
ALL-IN-ONE SOLUTIONS
PayPal Payments Advanced (Includes Express
Checkout)
PayPal Payments Pro (Includes Express Checkout)
PayPal Website Payments Pro (Outside US)
Allows you to accept payments with a
PCI-compliant checkout that keeps customers on your site.
Allows you to accept payments with a completely customizable checkout.
PayPal Payments Standard (Includes Express
Checkout)
PayPal Website Payments Standard (Outside US)
Adds PayPal as an additional payment method to your checkout page.
PAYMENT GATEWAYS
PayPal Payflow Pro (Includes Express Checkout)
PayPal Payflow Link (Includes Express Checkout)
Connects your merchant account with a fully customizable gateway that lets customers pay without leaving your site.
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 Community Edition 2.1 User Guide 801
PayPal Business Account CHAPTER 55: 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
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.
802 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Business Account
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
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
Flag
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.
If you set the filter action to “Flag”, the suspected order gets the status
”Processing” when it is placed. The corresponding transaction is marked with a “flag” in the list of the merchant account transactions.
Magento Community Edition 2.1 User Guide 803
PayPal Business Account CHAPTER 55: 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
France
Germany
Hong Kong SAR China
Italy
Japan
New Zealand
Spain
PayPal Website Payments Standard
PayPal Website Payments Pro
PayPal Payflow Pro
PayPal Payflow Link (includes Express Checkout)
PayPal Express Checkout
PayPal Integral Evolution
PayPal Website Payments Standard
PayPal Express Checkout
PayPal Express Checkout
PayPal Website Payments Pro Hosted Solution
PayPal Website Payments Standard
PayPal Express Checkout
PayPal Pro
PayPal Payments Standard
PayPal Express Checkout
PayPal Website Payments Plus
PayPal Website Payments Standard
PayPal Express Checkout
PayPal Payflow Pro
PayPal Website Payments Standard
PayPal Express Checkout
PayPal Pasarela Integral
PayPal Website Payments Standard
PayPal Express Checkout
804 Magento Community Edition 2.1 User Guide
CHAPTER 55: Recommended Solutions PayPal Business Account
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 Community Edition 2.1 User Guide 805
806 Magento Community Edition 2.1 User Guide
CHAPTER 56:
Basic Payment Methods
The payment methods covered in this section are built in to Magento, and do not require the services of a third-party payment processing company.
Offline Payments
Magento supports a number of offline payment methods, including payment by
, and
(COD),
Online Payments
is a basic payment method that is included with all Magento stores.
Magento Community Edition 2.1 User Guide 807
Check / Money Order CHAPTER 56: Basic Payment Methods
Check / Money Order
Magento Community Edition 2.1 allows you to accept payments by check or money order. The
Check / Money Order payment method is enabled for your story by default. You can accept checks and money orders from only specific countries, and fine-tune the configuration with minimum and maximum order total limits.
808
Check / Money Order
Magento Community Edition 2.1 User Guide
CHAPTER 56: Basic Payment Methods Check / Money Order
To configure payment by check or money order:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Payment Methods.
3.
Expand the Check / Money Order section. Then, do the following:
a.
To accept payment by check or money order, set Enabled to “Yes.”
b.
Enter a Title to identify the Check / Money Order payment method during checkout.
c.
Set New Order Status to "Pending” until receipt of payment is confirmed.
d.
Set Payment from Applicable Countries to one of the following:
All Allowed
Countries
Customers from all
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.
e.
In the Make Check Payable To field, enter the name of the party to whom the check must be payable.
f.
In the Send Check To field, enter the street address or PO Box where the checks are mailed.
g.
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.
h.
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.)
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 809
Cash On Delivery CHAPTER 56: Basic Payment Methods
Cash On Delivery
Magento Community Edition 2.1 allows you to accept COD payments for purchases. You can accept COD payment from only specific countries, and fine-tune the configuration with minimum and maximum order total limits.
The shipping carrier receives payment from the customer at the time of delivery, which is then transferred to you. You can make an adjustment for any fee charged by the carrier service in your shipping and handling charges.
810
Cash On Delivery Payment
Magento Community Edition 2.1 User Guide
CHAPTER 56: Basic Payment Methods Cash On Delivery
To set up cash on delivery payments:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, select Payment Methods.
3.
Expand the Cash On Delivery Payment section. Then, do the following:
a.
To activate Cash On Delivery Payment, set Enabled to “Yes.”
b.
Enter a Title to identify the COD payment method during checkout.
c.
Set New Order Status to “Pending” until receipt of payment is confirmed.
d.
Set Payment from Applicable Countries to one of the following:
All Allowed
Countries
Customers from all
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.
e.
Enter the Instructions for accepting delivery of a COD order.
f.
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.
g.
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.)
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 811
Bank Transfer CHAPTER 56: Basic Payment Methods
Bank Transfer
Magento Community Edition 2.1 allows you to accept payment that is transferred from a customer’s bank account and deposited into your merchant bank account.
812
Bank Transfer Payment
Magento Community Edition 2.1 User Guide
CHAPTER 56: Basic Payment Methods Bank Transfer
To configure bank transfer payments:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Payment Methods.
3.
Expand the Bank Transfer Payment section. Then, do the following:
a.
To activate bank transfers, set Enabled to “Yes.”
b.
Enter a Title to identify the Bank Transfer Payment method during checkout.
c.
Set New Order Status to “Pending” until payment is authorized.
d.
Set Payment from Applicable Countries to one of the following:
All Allowed
Countries
Customers from all
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.
e.
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 l
Bank account number l
Bank routing code l
Bank name l
Bank address
f.
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.
4.
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.)
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 813
Purchase Order CHAPTER 56: Basic Payment Methods
Purchase Order
A purchase order (PO) allows commercial customers to pay for authorized purchases by referencing the PO number. The purchase order is authorized and issued in advance by the company that is making the purchase. During checkout, the customer chooses Purchase Order as the method of payment. Upon receipt of your invoice, the company processes the payment in their accounts payable system, and pays for the purchase.
Before accepting payment by purchase order, always establish the credit worthiness of the commercial customer.
814
Purchase Order
Magento Community Edition 2.1 User Guide
CHAPTER 56: Basic Payment Methods Purchase Order
To configure payment by purchase order:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Payment Methods.
3.
Expand the Purchase Order section. Then, do the following:
a.
To activate this payment method, set Enabled to “Yes.”
b.
Enter a Title to identify this payment method during checkout.
c.
Set New Order Status to “Pending” until payment is authorized.
d.
Set Payment from Applicable Countries to one of the following:
All Allowed
Countries
Customers from all
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.
e.
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.
f.
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.)
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 815
Zero Subtotal Checkout CHAPTER 56: Basic Payment Methods
Zero Subtotal Checkout
Zero Subtotal Checkout is available only for orders created from the Admin, and can be used for orders with a subtotal of zero that are taxed after a discount is applied. For example, Zero
Subtotal Checkout might be used in the following situations: l
A discount covers the entire price of the purchase, with no additional charge for shipping.
l
The customer adds a
or
product to the shopping cart, and the price equals zero.
l
The price of a
product is zero, and the
method is available.
l
A
covers the full price of products and shipping.
To save time, zero subtotal orders can be set to invoice automatically.
Zero Subtotal Checkout
816 Magento Community Edition 2.1 User Guide
CHAPTER 56: Basic Payment Methods Zero Subtotal Checkout
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, select Payment Methods.
3.
Click to expand the Zero Subtotal Checkout section. Then, do the following:
a.
Enter a Title to identify the Zero Subtotal method during checkout.
b.
Set Enabled to “Yes” to activate Zero Subtotal Checkout.
c.
If orders typically wait for authorization, set New Order Status to “Pending” until payment is authorized.
Pending
Processing
The order is waiting for authorization.
Payment has been authorized, and the transaction is being processed.
d.
Set Automatically Invoice All Items to “Yes” if you want to automatically invoice all items that have a zero balance.
e.
Set Payment from Applicable Countries to one of the following:
All Allowed
Countries
Customers from all
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.
f.
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.)
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 817
818 Magento Community Edition 2.1 User Guide
CHAPTER 57:
Other Payment Methods
Magento Community Edition 2.1 supports the following payment solution that offer merchant services in all parts of the world. Unlike some payment solutions that transfer control to another site to complete the transaction, a payment gateway makes it possible for you to accept credit card payments directly from your store without the customer leaving your site.
l
Magento Community Edition 2.1 User Guide 819
Authorize.Net Direct Post CHAPTER 57: Other Payment Methods
Authorize.Net Direct Post
Authorize.Net handles all steps in the transaction process — such as payment data collection, data submission, and response to the customer — while the customer remains in your store.
Authorize.Net Direct Post can be used with orders created from the Admin as well as from the store.
Customer Workflow
Customer chooses payment method. During checkout, the customer chooses
Authorize.Net Direct Post as the payment method.
Customer submits the order. The customer enters the credit card information, reviews the order, and taps the Place Order button.
Authorize.Net completes the transaction. Authorize.Net validates the card information, and processes the transaction.
l
If successful, the customer is redirected to the order confirmation page.
l
If the transaction fails, an error message appears, and the customer can try a different card, or choose a different payment method.
Setting Up Authorize.Net Direct Post
For step-by-step configuration instructions, see Authorize.Net Direct Post in the Magento
Community Edition 2.1online user guide.
820 Magento Community Edition 2.1 User Guide
Shipping
821
822
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.
CHAPTER 58:
Shipping Settings
The shipping configuration establishes the point of origin for all shipments, your shipping policy, and the handling of shipments to multiple addresses.
l
l
Shipping to Multiple Addresses
l
Shipping Settings
Magento Community Edition 2.1 User Guide 823
Point of Origin CHAPTER 58: Shipping Settings
Point of Origin
The point of origin is used to calculate the charge for shipments made from your store or warehouse, and also determines the tax rate for products sold. When calculating
make sure that the Default Tax Destination Calculation for each store view corresponds to the
Shipping Settings point of origin.
824
Origin
To establish the point of origin:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Shipping Settings.
3.
Expand the Origin section, and complete the following: l
Country l
Region / State l
ZIP / Postal Code l
City l
Street Address (and line 2, if needed)
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 58: Shipping Settings Multiple Addresses
Multiple Addresses
The Multiaddress Shipping options enable customers to ship an order to multiple addresses during checkout, and determine the maximum number of addresses to which an order can be shipped.
To configure multiple address shipping:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Multishipping Settings.
3.
Expand the Options section. Then, do the following:
a.
Set Allow Shipping to Multiple Addresses to “Yes.”
b.
Enter the Maximum Qty Allowed for Shipping to Multiple Addresses.
4.
When complete, tap
Save Config
.
Multiaddress Shipping Options
Magento Community Edition 2.1 User Guide 825
Shipping Policy CHAPTER 58: Shipping Settings
Shipping Policy
To display your shipping policy during checkout, complete the Shipping Policy Parameters in the configuration.
Shipping Policy Parameters
To configure your shipping policy:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Shipping Settings.
3.
Expand the Shipping Policy Parameters section, and do the following:
a.
Set Apply Custom Shipping Policy to “Yes.”
a.
Either paste or enter your Shipping Policy into the text box.
4.
When complete, tap
Save Config
.
826 Magento Community Edition 2.1 User Guide
CHAPTER 59:
Basic Shipping Methods
Magento Community Edition 2.1 supports a wide range of shipping methods and carriers.
In this chapter you will learn how to set up that shipping methods that do not require an account with a third-party provider.
l
l
l
l
Magento Community Edition 2.1 User Guide 827
Free Shipping CHAPTER 59: Basic Shipping Methods
Free Shipping
Free shipping is one of the most effective promotions you can offer. It can be based on a minimum purchase, or set up as a
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.
828
Free Shipping
Step 1:
Configure Free Shipping
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Shipping Methods.
3.
Expand the Free Shipping section. Then, do the following:
a.
Set Enabled to “Yes.”
b.
Enter a Title to identify the Free Shipping method during checkout.
Magento Community Edition 2.1 User Guide
CHAPTER 59: Basic Shipping Methods Free Shipping
c.
Enter a Method Name to describe this shipping method.
d.
Enter the Minimum Order Amount to qualify for free shipping.
To use Free Shipping with
, 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.
e.
In the Displayed Error Message box, type the message to appear if free shipping becomes unavailable.
f.
Set Ship to Applicable Countries to one of the following:
All Allowed
Countries
Customers from all
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.
g.
Set Show Method if Not Applicable to one of the following:
Yes
No
Always shows the Free Shipping method, even when not applicable.
Shows the Free Shipping method only when applicable.
h.
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.)
4.
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.
2.
Expand the UPS section. Then, set Free Method to “Ground.”
3.
To require a minimum order for free shipping, set Free Shipping with Minimum Order
Amount
to “Enable.”
4.
Enter the required amount in the Minimum Order Amount for Free Shipping field.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 829
Flat Rate Shipping CHAPTER 59: Basic Shipping Methods
Flat Rate Shipping
Flat rate is a fixed, predefined charge that can be applied per item, or per shipment. Flat rate is a simple shipping solution, especially when used with the flat-rate packaging that is available from some carriers.
830
Flat Rate
To set up flat rate shipping:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Sales, choose Shipping Methods.
3.
Expand the Flat Rate section. Then, do the following:
a.
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.
Magento Community Edition 2.1 User Guide
CHAPTER 59: Basic Shipping Methods Flat Rate Shipping
b.
Enter a descriptive Title for the Flat Rate method.
c.
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.
d.
To describe how flat rate shipping can be used, set Type to one of the following:
None
Per Order
Per Item
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.
Charges a single flat rate for the entire order.
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.
e.
Enter the Price that you want to charge for flat rate shipping.
f.
If charging an additional handling fee, set Calculate Handling Fee to one of the following: l
Fixed l
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.
h.
Set Ship to Applicable Countries to one of the following:
All Allowed
Countries
Customers from all
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.
i.
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.)
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 831
Table Rates CHAPTER 59: Basic Shipping Methods
Table Rates
The table rate shipping method references a table of data to calculate shipping rates based on a combination of conditions, including: l
Weight v. Destination l
Price v. Destination l
# 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.
832
Table Rate in Shopping Cart
Magento Community Edition 2.1 User Guide
CHAPTER 59: Basic Shipping Methods Table Rates
Process Overview:
Step 1: Complete the Default Settings
Step 2: Prepare the Table Rate Data
Step 3: Import the Table Rate Data
Step 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.
2.
In the panel on the left under Sales, choose Shipping Methods.
3.
Expand the Table Rates section. Then, do the following:
a.
Set Enabled to “Yes.”
If necessary, clear the Use system value checkbox to edit for any field to be edited.
b.
Enter the Title that you want to appear for table rates section during checkout. (The default title is “Best Way.”)
c.
Enter the Method Name that you want to appear as a label next to the calculated rate in the shopping cart.
d.
Set Condition to one of the following calculation methods: l
Weight v. Destination l
Price v. Destination l
# of Items v. Destination
e.
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.
f.
If charging a handling fee, set Calculate Handling Fee to one of the following: l
Fixed l
Percent
Then, enter the Handling Fee rate according to the method used to calculate the fee.
Magento Community Edition 2.1 User Guide 833
Table Rates CHAPTER 59: Basic Shipping Methods
If the handling fee is based on a percent, enter the whole number without the percent sign.
g.
In the Displayed Error Message box, type the message that appears when this method is not available.
h.
Set Ship to Applicable Countries to one of the following:
All Allowed
Countries
Customers from any
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.
i.
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.)
4.
When complete, tap
Save Config
.
834
Table Rates
Magento Community Edition 2.1 User Guide
CHAPTER 59: Basic Shipping Methods Table Rates
Step 2:
Prepare the Table Rate Data
1.
In the upper-left corner, set Store View to “Main Website,” or to any other website where the configuration applies. When prompted to confirm, tap OK.
The Export and Import options now appear in the Table Rates section, with “Use Default” checkboxes to the right of each option.
To change any of the current settings, you must first clear the “Use Default” checkbox next to the field.
2.
To change the Condition, clear the Use Default checkbox. Then, choose another option.
3.
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.
l
The Country column must contain a valid three-character code for each row.
l
Sort the data by Region/State so the specific locations are at the top of the list, and the wildcard locations at the bottom. This will process the rules with the absolute values first, and the wildcard values later.
Magento Community Edition 2.1 User Guide 835
Table Rates CHAPTER 59: Basic Shipping Methods
Weight vs. Destination (Australia)
5.
When complete, save the tablerates.csv file.
Step 3:
Import the Table Rate Data
1.
Return to the Table Rates section of your store configuration.
2.
In the upper-left corner, set Store View to the website where this method will be used.
3.
Next to the Import field, tap
Choose File
. Select your completed tablerates.csv file, and import the rates.
836
4.
When complete, tap
Save Config
.
Import Table Rates
Magento Community Edition 2.1 User Guide
CHAPTER 59: Basic Shipping Methods Table Rates
Step 4:
Verify the Rates
To make sure that the table rate data is correct, go through the payment process with several different addresses to make sure the shipping and handling rates are calculated correctly.
Example 1:
Price v. Destination
USA
USA
USA
USA
USA
USA
USA
USA
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
USA
REGION /
STATE
HI *
ZIP / POSTAL
CODE
ORDER
SUBTOTAL
(and above)
100
SHIPPING
PRICE
10
*
*
AK
*
HI
HI
AK
AK
*
*
*
*
*
*
*
*
0
100
50
0
50
0
100
50
20
5
10
15
15
20
10
15
Magento Community Edition 2.1 User Guide 837
Table Rates CHAPTER 59: Basic Shipping Methods
AUS
AUS
AUS
AUS
AUS
AUS
AUS
Example 2:
Weight v. Destination
This example uses the Weight v. Destination condition to create different shipping rates based on the weight of the order.
COUNTRY
AUS
REGION /
STATE
NT *
ZIP / POSTAL
CODE
WEIGHT
(AND
ABOVE)
9
SHIPPING
PRICE
39.95
WA
*
*
NT
VIC
VIC
WA
*
*
*
*
*
*
*
0
9
0
0
9
0
9
19.95
19.95
5.95
39.95
19.95
29.95
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.
2.
Complete the table rate configuration with the following settings:
SETTING
Condition
VALUE
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.
Set Store View to the main website. Then, tap
Import
to import the tablesrates.csv file.
838 Magento Community Edition 2.1 User Guide
CHAPTER 59: Basic Shipping Methods Dimensional Weight
Dimensional Weight
Dimensional weight, sometimes called volumetric weight, is a common industry practice that bases the transportation price on a combination of weight and package volume. In simple terms, dimensional weight is used to determine the shipping rate based on the amount of space a package occupies in the cargo area of the carrier. Dimensional weight is typically used when a package is relatively light compared to its volume.
All major carriers now apply dimensional weight to some shipments. However, the manner in which dimensional weight pricing is applied varies from one carrier to another.
l
DHL l
FedEx l
UPS l
USPS
We recommend that you become familiar with the method used by each carrier to determine and apply dimensional weight. If your company has a high volume of shipments, even a slight difference in shipping price can translate to thousands of dollars over the course of a year.
Magento’s native shipping configuration does not include support for dimensional weight.
Magento Community Edition 2.1 User Guide 839
840 Magento Community Edition 2.1 User Guide
CHAPTER 60:
Carriers
If you have a commercial account with a supported carrier, you can offer your customers the convenience of choosing that carrier during checkout. The rates are automatically downloaded, so you do not need to look up the information.
Before you can offer your customers a selection of shipping carriers, you must first complete the
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
for additional shipping services for your Magento Community Edition 2.1 installation.
Magento Community Edition 2.1 User Guide 841
842
CHAPTER 60: Carriers
See the online user guide for step-by-step configuration instructions for the following carriers:
UPS
United Parcel Service offers domestic and international shipping services by land and air to more than 220 countries.
USPS
The United States Postal Service is the independent postal service of United States government. USPS offers domestic and international shipping services by land and air.
FedEx
Offers domestic and international shipping services by land and air to more than 220 countries.
DHL
Offers integrated international services and tailored, customer-focused solutions for managing and transporting letters, goods and information.
Magento Community Edition 2.1 User Guide
CHAPTER 61:
Shipping Labels
Magento Community Edition 2.1 includes a high level of integration with major shipping carriers, which gives you access to carrier shipping systems to track orders, create shipping labels, and more. Shipping labels can be created for regular shipments and products with return merchandise authorization. In addition to the information provided by the shipping carrier, the label also includes the Magento order number, number of the package, and the total quantity of packages for the Magento shipment.
USPS Priority Shipping Label
Magento Community Edition 2.1 User Guide 843
Shipping Label Workflow CHAPTER 61: Shipping Labels
Shipping Label Workflow
Shipping labels can be produced at the time a shipment is created, or later. Shipping labels are stored in PDF format and are downloaded to your computer.
Administrator submits shipping label request. The store Administrator completes the information necessary to generate labels, and submits the request.
Request sent to carrier. Magento contacts the shipping carrier, and creates an order in the carrier’s system. A separate order is created for each package that is shipped.
Carrier sends label and tracking number. The carrier sends the shipping label and tracking number for the shipment.
l
A single shipment with multiple packages receives multiple shipping labels.
l
If you generate the same shipping labels multiple times, the original tracking numbers are preserved.
l
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.
844 Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Configuring Shipping Labels
Configuring Shipping Labels
The following settings must be made at the product level, as well as in the configuration of each carrier that is used to print labels. To print labels, all carriers require that you open an account. Then, complete the configuration in your store for each carrier that you plan to use.
Step 1:
Verify the Country of Manufacture
The country of manufacture is required for all products that are shipped internationally by
USPS and FedEx, If you have many products that need to be updated, you can either
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.
b.
In the panel on the left under Advanced Settings, choose Autosettings.
c.
Update the Country of Manufacture field.
d.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide
Country of Manufacture
845
Configuring Shipping Labels CHAPTER 61: Shipping Labels
Method 2: Update Multiple Records
a.
In the grid, mark the checkbox of each product to be updated. For example, all products that are manufactured in China.
b.
Set the Actions control to “Update Attributes.” Then, tap
Submit
.
c.
In the Update Attributes form, find the Country of Manufacture field and mark the
Change
checkbox. Then, choose the country.
d.
When complete, tap
Save
.
Step 2:
Verify the Store Information
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
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
Street Address
Line 2
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.
Any additional address information, such as the floor, entrance and so on. We strongly recommend that you use this field.
846
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: the
Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Configuring Shipping Labels
Secure Gateway
URL
Password
Magento automatically enters the gateway URL.
Length, Width
Height, Girth
The password is provided by USPS, and gives you access to their system through Web Services.
The default dimensions of the package. To make these fields appear, set Size to “Large.”
c.
Expand the FedEx section, and verify that the following fields are complete: l
Meter Number l
Key l
Password
d.
This information is provided by the carrier, and is required to gain access to their system through Web Services.
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
Store Contact
Telephone
Country
VAT Number
The name of the store or store view.
The telephone number of the primary contact for the store or store view.
The country where your store is based.
If applicable the Value Added Tax number of your store. (Not required for stores based in the U.S.)
The street address of the primary contact for the store or store view.
Store Contact
Address
e.
If you have multiple stores, and the contact information differs from the default, set Store
View
for each, and verify that the information is complete. If the information is missing, you’ll get an error when you try to print the labels.
Magento Community Edition 2.1 User Guide 847
Configuring Shipping Labels CHAPTER 61: Shipping Labels
848
Store Information
3.
When complete, tap
Save Config
.
Carrier Requirements
CARRIER
USPS
REQUIREMENTS
Requires a USPS account.
UPS
FedEx
DHL
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.
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
Requires a DHL account. Shipping labels are supported only for shipments that originate in the U.S.
Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Creating Shipping Labels
Creating Shipping Labels
To create shipping labels, you must first set up your shipping carrier account to support labels.
Then, follow the prompts to enter a description of the package and its contents.
Process Overview:
Step 1:
Contact Your Shipping Carriers
Step 2:
Update the Configuration for Each Carrier
Step 3:
Step 4:
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.
2.
Follow the instructions provided by each carrier to add shipping label support to your account.
FedEx
USPS
UPS
DHL
Contact FedEx Web Services regarding their label evaluation process.
Contact [email protected]
to request that API Signature
Confirmation V3 be enabled for your live USPS API Access account.
Contact UPS to confirm your account type supports shipping labels. To generate shipping labels, you must use the UPS XML option.
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
is complete.
2.
Follow the instructions below for each carrier account that has been activated for label printing.
Magento Community Edition 2.1 User Guide 849
Creating Shipping Labels CHAPTER 61: Shipping Labels
UPS Configuration
United Parcel Service ships both domestically and internationally. However, shipping labels can be generated only for shipments that originate within the United States.
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Shipping Methods.
3.
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 following: the USPS section. Then, do
a.
Verify that the Secure Gateway URL is entered. The correct URL should be entered automatically.
b.
Enter the Password provided to you by USPS.
c.
Set Size to “Large.” Then, enter the following dimensions: l
Length l
Width l
Height l
Girth
2.
When complete, tap
Save Config
.
850 Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Creating Shipping Labels
FedEx Configuration
FedEx ships domestically and internationally. Stores located outside the United States can create FedEx labels for international shipments only.
the FedEx section. Then,
1.
Continuing in the Shipping Methods configuration, expand make sure that the following FedEx credentials are correct: l
Meter Number l
Key l
Password
2.
When complete, tap
Save Config
.
DHL Configuration
DHL provides international shipping services.
1.
Continuing in the Shipping Methods configuration, expand following: the DHL section. Then, do the
a.
Verify that the Gateway URL is entered. The correct URL should be entered automatically.
b.
Make sure that the following credentials are complete: l
Access ID l
Password l
Account Number
2.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 851
Creating Shipping Labels CHAPTER 61: Shipping Labels
Step 3:
Create Shipping Labels
Process Overview:
Method 1:
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.
2.
Find the order in the grid, and open the record. The status of the order must be either
“Pending” or “Processing.”
3.
In the upper-right corner, tap
Ship
. Then, confirm the shipping information according to carrier requirements.
4.
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.
b.
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
.
l
To add a new package, tap
Add Package
.
l
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.
5.
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.
l
If the carrier cannot create the label due to the problems with connection, or for any other reason, the shipment is not processed.
852 Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Creating Shipping Labels
Method 2:
Create Label for Existing Shipment
1.
On the Admin sidebar, tap Sales. Then under Operations, choose Orders.
2.
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
.
b.
Distribute the ordered product(s) to the appropriate package(s), and tap
OK
.
c.
To review the package information, tap
Show Packages
.
Magento connects to the shipping carrier system, submits an order, and receives a shipping label and a tracking number.
If a shipping label for this shipment already exists in the system, it is replaced with a new one.
However, existing tracking numbers are not replaced. Any new tracking number is added to the existing one.
Step 4:
Print the Labels
Shipping labels are generated in PDF format, and can be printed from the Admin. Each label includes the order number and package number.
Because an individual shipment order for each package is created, multiple shipping labels might be received for a single shipment.
Process Overview:
Method 1:
Print Label from Shipment Form
Method 2:
Print Labels for Multiple Orders
Magento Community Edition 2.1 User Guide 853
Creating Shipping Labels CHAPTER 61: Shipping Labels
Method 1:
Print Label from Shipment Form
1.
On the Admin sidebar, tap Sales. Then, do one of the following: l
Choose Orders. Find the order in the grid, and open the record. In the panel on the left, choose Shipments. Then, open the shipment record.
l
Choose Shipments. Find the order in the grid, and open the record.
2.
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 l
Shipments
2.
In the grid, mark the checkbox of each order with shipping labels to be printed.
3.
Set the Actions control to "Print Shipping Labels."
4.
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.
Customs Value
Total Weight
Length, Width, Height
(International shipments only) The declared value or sales price of the contents of an international shipment.
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.
(Optional) The package dimensions are used for custom packages only. You can specify the measurements units as inches or centimeters.
854 Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Creating Shipping Labels
Required Carrier Configuration Settings (cont.)
SETTING DESCRIPTION
Not Required
No Signature
Signature Required The shipping carrier obtains the signature of the recipient and provides the store with a printed copy.
Direct
A delivery confirmation without the signature of the recipient is sent to the store by the shipping carrier.
(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
No confirmation of delivery is sent to the store by the shipping carrier.
Contents
(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.
(USPS Only) Select one of the following descriptions of the package:
Gift
Documents
Commercial Sample
Returned Goods
Merchandise
Other
Explanation
Adult Required
(USPS Only) A detailed description of the package contents.
The shipping carrier obtains the signature of an adult recipient and provides the store with a printed copy.
Magento Community Edition 2.1 User Guide 855
Creating Shipping Labels CHAPTER 61: Shipping Labels
Label Packages
The Create Packages window appears when you choose to create a shipping label. You can start configuring the first package immediately.
To configure a package:
1.
Complete the fields as described below.
If you select the non-default value in the Type field or choose to require a signature confirmation, the price of a shipment may differ from the one you charged to the customer.
2.
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.
3.
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.
l
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
.
2.
Enter the additional quantity.
The number is added to the previous quantity of the product in the package.
856 Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Creating Shipping Labels
To decrease the quantity:
1.
Delete the product from the package.
2.
Tap
Add Selection
.
3.
Enter the new, smaller value.
After you distribute all products, the total number of the packages you are going to use equals the number of the last package in the list. The OK button is disabled until all shipped items are distributed to packages, and all necessary information is complete.
4.
When complete, tap
OK
to generate the labels.
If you need to stop the process, tap
Cancel
. The packages are not saved, and the shipping label process is canceled.
Magento Community Edition 2.1 User Guide 857
Creating Shipping Labels
Field Descriptions
FIELD
Type
Total Weight
Length
CHAPTER 61: Shipping Labels
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.
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.
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.
858 Magento Community Edition 2.1 User Guide
CHAPTER 61: Shipping Labels Creating Shipping Labels
Field Descriptions (cont.)
FIELD
Width
DESCRIPTION
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
Signature
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.
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
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)
The shipping carrier obtains the adult recipient’s signature and provides you with its printed copy.
FedEx obtains a signature in one of three ways: (1) from someone at the delivery address; (2) from a neighbor, building manager or other person at a neighboring address; or (3) the recipient can leave a signed FedEx Door Tag authorizing release of the package without anyone present.
Available for residential deliveries only.
The options may vary slightly for different shipping methods. For the most up to date information refer to shipping carrier’s resources.
Magento Community Edition 2.1 User Guide 859
Creating Shipping Labels CHAPTER 61: Shipping Labels
Field Descriptions (cont.)
FIELD
Contents
DESCRIPTION
(Available for USPS shipments only) Description of the package contents. Options:
Gift
Documents
Commercial Sample
Returned Goods
Merchandise
Other
Explanation (USPS shipments only) Detailed description of the package content.
860 Magento Community Edition 2.1 User Guide
REPORTS
861
862
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.
CHAPTER 62:
Reports Menu
Magento Community Edition 2.1 provides a wide selection of reports to keep you informed on your marketing efforts, sales products, and customer activity. The Reports menu provides easy access to current information about your sales, products, customers, and promotions.
To display the Reports menu:
On the Admin sidebar, tap
Reports
.
Reports Menu
Magento Community Edition 2.1 User Guide 863
CHAPTER 62: Reports Menu
Menu Options
Marketing Reports
A selection of marketing reports, including Products in Cart, Search Terms, Abandoned Carts, and
Newsletter Problem Reports.
Review Reports
The selection of product review reports includes By Customer and By Product.
Sales Reports
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and PayPal
Settlement.
Customer Reports
The selection of customer reports includes Order Total, Order Account, and New.
Product Reports
The selection of product reports includes Views, Bestsellers, Low Stock, Ordered, and Downloads.
Statistics
Statistics is a tool that reduces the performance impact of generating reports by calculating and storing statistical data. Rather than recalculate the statistics every time a report is generated, the stored statistics are used until you refresh the statistics.
864 Magento Community Edition 2.1 User Guide
CHAPTER 63:
Marketing Reports
Marketing reports provide information about the status of shopping carts, the use of search terms, and newsletter transmissions.
Products in Cart Report
Magento Community Edition 2.1 User Guide 865
866
Reports
CHAPTER 63: Marketing 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.
Magento Community Edition 2.1 User Guide
CHAPTER 64:
Review Reports
The Review Reports provide information about product reviews by customer and by product.
l
By Customers l
By Products
Review Report by Product
Magento Community Edition 2.1 User Guide 867
Reports
CHAPTER 64: Review 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.
868 Magento Community Edition 2.1 User Guide
CHAPTER 65:
Sales Reports
The selection of sales reports includes Orders, Tax, Invoiced, Shipping, Refunds, Coupons, and PayPal Settlement.
Magento Community Edition 2.1 User Guide
Shipping Report
869
870
Reports
CHAPTER 65: Sales 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.
Magento Community Edition 2.1 User Guide
CHAPTER 65: Sales Reports
Magento Community Edition 2.1 User Guide
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.
871
872 Magento Community Edition 2.1 User Guide
CHAPTER 66:
Customer Reports
Customer reports provide insight into customer activity during a specified period of time or date range.
Order Total Report
Magento Community Edition 2.1 User Guide 873
Reports
CHAPTER 66: Customer 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.
874 Magento Community Edition 2.1 User Guide
CHAPTER 67:
Product Reports
The product reports give you insight regarding products viewed and ordered, bestsellers, stock levels, and downloads.
Product Views Report
Magento Community Edition 2.1 User Guide 875
876
Reports
CHAPTER 67: Product 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.
Magento Community Edition 2.1 User Guide
CHAPTER 67: Product 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 Community Edition 2.1 User Guide 877
Refresh Statistics CHAPTER 67: Product Reports
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.
878
Refresh Statistics
To refresh report statistics:
1.
On the Admin sidebar, tap Reports. Then under Statistics, choose Refresh Statistics.
2.
In the list, mark the checkbox of each report to be refreshed.
3.
Set the Actions control to one of the following: l
Refresh Lifetime Statistics l
Refresh Statistics for the Last Day
4.
When complete, tap
Submit
.
Magento Community Edition 2.1 User Guide
OPERATIONS
879
880
Stores
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,
CHAPTER 68:
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
.
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.
Magento Community Edition 2.1 User Guide 881
882
CHAPTER 68: Stores Menu
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 all attributes that are used in products and product ratings. You can create new attributes, edit existing attributes, manage product templates, and set up product review ratings.
Other Settings
Customer Groups
Customer groups determine which discounts are available, and the tax class that is associated with the group.
Magento Community Edition 2.1 User Guide
CHAPTER 69:
All Stores
When Magento Community Edition 2.1 is installed, a hierarchy that includes a main website, store, and store view is created. You can create additional websites, stores, and store views, as needed. For example, in addition to your main website, you might have a additional websites with a different domain. Within each website, you can have multiple stores, and within each store, separate store views. Many installations have one website and one store, but with multiple store views to support different languages.
Before you begin, plan your store hierarchy in advance because it is referred to throughout the configuration. Each store can have a separate
, which makes it possible to have an entirely different set of main menu options for each store.
Store Hierarchy
Magento Community Edition 2.1 User Guide 883
Adding Store Views CHAPTER 69: All Stores
Adding Store Views
Store views are typically used to make the store available in different
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.
884
All Stores
Magento Community Edition 2.1 User Guide
CHAPTER 69: All Stores
2.
Tap
Create Store View
. Then, do the following:
Adding Store Views
Store View Information
a.
Set Store to the parent store of this view.
b.
Enter a Name for this store view. The name appears in the language chooser in the store header. For example: Spanish.
c.
Enter a Code in lowercase characters to identify the view. For example: spanish.
d.
To activate the view, set Status to “Enabled.”
e.
(Optional) Enter a Sort Order number to determine the sequence in which this view is listed with other views.
3.
When complete, tap
Save Store View
.
Magento Community Edition 2.1 User Guide 885
Adding Store Views CHAPTER 69: 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
Name
ORIGINAL VALUE
Default Store View
UPDATED VALUE
English
Code default english
To edit a store view:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.
2.
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.
886
Editing the Default View
Magento Community Edition 2.1 User Guide
CHAPTER 69: All Stores
3.
Update the following fields as applicable: l
Store (non-default views only) l
Name l
Code (only if not used in index.php) l
Status (non-default views only) l
Sort Order
4.
When complete, tap
Save Store View
.
Adding Store Views
Stores
Magento Community Edition 2.1 User Guide 887
Adding Store Views CHAPTER 69: 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
Step 2:
Create a Store View for the Language
1.
On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.
2.
Tap
Create Store View
. Then, do the following:
a.
Choose the Store that is the parent of the view.
b.
Enter a Name for the store view. For example: Portuguese.
In the header of the store, the name appears in the “language chooser.”
c.
Enter a Code in lowercase characters to identify the view. For example: portuguese.
d.
To activate the view, set Status to “Enabled.”
e.
(Optional) Enter a Sort Order number to determine the sequence in which this view is listed with other views.
3.
When complete, tap
Save Store View
.
888 Magento Community Edition 2.1 User Guide
CHAPTER 69: 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.
2.
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.
3.
Expand the Locale Options section.
4.
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.
5.
When complete, tap
Save Config
.
After you change the language of the locale, the remaining content that you have created, including
names and descriptions, categories,
pages, and blocks must be translated separately for each store view.
Magento Community Edition 2.1 User Guide 889
Adding Store Views CHAPTER 69: 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:
Step 2:
Step 3:
Step 1:
Translate Product Fields
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Catalog.
2.
In the grid, find the product to be translated, and open in edit mode.
3.
In the upper-left corner set Store View to the view for the translation. When prompted to confirm, tap
OK
.
4.
For each field to be edited, do the following:
a.
Clear the Use Default Value checkbox to the right of the field.
b.
Either paste or type the translated text into the field.
Make sure to translate all text fields, including
labels and Alt text, Search Engine
Optimization fields and any
information.
5.
When complete, tap
Save
.
Step 2:
Translate Field Labels
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
2.
In the list, find the attribute to be translated, and open in edit mode.
3.
In the panel on the left, choose Manage Labels.
4.
In the Manage Titles section, enter a translated label for each store view.
890 Magento Community Edition 2.1 User Guide
CHAPTER 69: All Stores Adding Store Views
5.
When complete, tap
Save Attribute
.
Enter Translated Labels
Step 3:
Translate All Categories
1.
On the Admin sidebar, tap Products. Then under Inventory, choose Categories.
2.
In the upper-left corner set Store View to the view for the translation. When prompted to confirm, tap
OK
.
3.
In the tree, find the category to be translated and open in edit mode.
4.
On the General Information tab, translate the following fields: l
Name l
Description l
Page Title l
Meta Keywords l
Meta Description
5.
To translate the URL Key, do the following:
a.
Clear the Use Default Value checkbox to the right of the field.
b.
Enter the translated text.
c.
Make sure that the Create Permanent Redirect for old URL checkbox is selected
Translate URL Key
6.
When complete, tap
Save Category
.
7.
Repeat the process for all categories used in the store.
Magento Community Edition 2.1 User Guide 891
Adding Store Views CHAPTER 69: All Stores
Translating Content
If your store has multiple views in different
, 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.
2.
In the grid, find the page to be translated, and open in edit mode.
3.
Copy the URL Key to the clipboard. Then, press the Back button to return to the Pages grid.
4.
Tap
Add New Page
. Then, do the following:
a.
Enter the translated Page Title.
b.
Paste the URL Key that you copied from the original page.
c.
In the Store View box, choose the store view where the page is to be available.
d.
In the panel on the left, choose Content. Then, complete the translated text for the page.
e.
On the Design tab, set the column Layout of the page.
f.
On the Meta Data tab, enter the translated text for the Keywords and Description.
5.
When complete, tap
Save Page
. Then when prompted, refresh any invalid
6.
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
892 Magento Community Edition 2.1 User Guide
CHAPTER 69: 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
, 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 yourdomain.com/store2 store1.yourdomain.com
store2.yourdomain.com
Each store has a different path, but shares the same domain.
Each store has a different subdomain of the primary domain.
Process Overview:
Step 1:
Step 2:
Step 3:
Step 4:
Magento Community Edition 2.1 User Guide 893
Adding Stores CHAPTER 69: 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.
l
Set up a subdomain of your primary domain.
l
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.
2.
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.”
b.
Enter a Name for the new store. The name is for internal reference only.
c.
Set Root Category to the
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.
3.
When complete, tap
Save Store
.
Store Information
894
New Store
Magento Community Edition 2.1 User Guide
CHAPTER 69: 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.
b.
Enter a Name for the view. For example, "English."
c.
Enter a Code for the view in lowercase characters.
d.
Set Status to "Enabled."
e.
In the Sort Order field, enter a number to determine the store's position when listed with other stores.
2.
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.
2.
In the panel on the left under General, choose Web.
3.
In the upper-left corner, set Store View to the view that you created for the new store. When prompted to confirm
switching, tap
OK
.
Magento Community Edition 2.1 User Guide 895
Adding Stores
Choose the New Store View
4.
Expand the Base URLs section. Then, do the following:
a.
After the Base URL field, clear the Use Website checkbox.
b.
Enter the Base URL for the store.
CHAPTER 69: All Stores
896
Base URLs
5.
Expand the Secure Base URLs section, and repeat the previous step as needed to configure the store’s
.
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 69: 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.
2.
Tap
Create Website
. Then, do the following:
Website Information
Magento Community Edition 2.1 User Guide 897
Adding Websites CHAPTER 69: All Stores
a.
In the Name field, enter the domain of the new website. For example, “domain.com.”
b.
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.
c.
(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.
d.
To make this the default website for your Magento installation, mark the Set as Default checkbox.
3.
When complete, tap
Save Website
.
4.
Set up each
and
that is needed for the new website.
Step 2:
Configure the Store URL
Follow the instructions to configure the
.
898 Magento Community Edition 2.1 User Guide
CHAPTER 69: 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
URL with IP address https://www.yourdomain.com/magento/ 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:
Use Secure Protocol
The base URLs for your store were initially set up during the Web Configuration step of the
Magento installation . If a security certificate was available at the time, you could specify for
secure (https) URLs to be used for the store, Admin, or both. If your Magento installation includes multiple stores, or if you plan to later add more stores, you can include the store code in the URL. All Magento resources and operations can be used with secure protocol.
If a security certificate wasn't available for the domain at the time of the installation, make sure to update the configuration before launching your store. After a security certificate is established for your domain, you can configure either or both base URLs to operate with encrypted Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocol.
Magento strongly recommends for all pages of a production site, including content and product pages, to be transmitted with secure protocol.
Magento can be configured to deliver all pages over https by default. If your store has been running up until now with standard protocol, you can improve security by enabling
HTTP Strict Transport Security (HSTS). and by upgrading any insecure page requests that are received by the store. HSTS is an opt-in protocol that prevents browsers from rendering standard http pages that are transmitted with unsecure protocol for the specificed domain.
Because search engines might have already indexed each page of your store with standard http
URLs, you can configure Magento to automatically upgrade any unsecure page requests to https, so you don't lose any traffic. When Magento is configured to use secure URLs for both the store and Admin, two additional fields appear that allow you to enable HSTS.
Magento Community Edition 2.1 User Guide 899
Store URLs CHAPTER 69: All Stores
To configure the base URL:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under General, choose Web.
3.
Expand the Base URL section, and do the following:
a.
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.
b.
(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}}
c.
(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.
900
Base URLs
Placeholders enclosed in double braces are markup tags for variables.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 69: 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/
b.
Do not change the placeholder in the Secure Base Link URL field. It is used to create relative links to the secure base URL.
c.
(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}}
d.
(Optional) To specify an alternate location for the Secure Base URL for User Media Files, enter the path starting with the following placeholder:
{{secure_base_url}}
Magento Community Edition 2.1 User Guide 901
Store URLs
2.
To enhance security, set both of the following options to "Yes." l
Use Secure URLs on Storefront l
Use Secure URLs in Admin
When the following additional fields appear , do the following:
CHAPTER 69: All Stores
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."
b.
To upgrade any requests for standard unsecured http pages to secure https, set Upgrade
Insecure Requests
to "Yes."
3.
When complete, tap
Save Config
.
902 Magento Community Edition 2.1 User Guide
CHAPTER 69: All Stores
To include the store code in URLs:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under General, choose Web.
3.
Expand the URL Options section.
4.
Set Add Store Code to your preference.
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
Store URLs
URL Options
Magento Community Edition 2.1 User Guide 903
Store URLs CHAPTER 69: All Stores
5.
When complete, tap
Save Config
.
6.
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
904 Magento Community Edition 2.1 User Guide
CHAPTER 69: All Stores Store URLs
Using a Custom Admin UR
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.
2.
In the panel on the left, under Advanced, choose Admin.
3.
Expand the Admin Base URL section. Then, do the following:
a.
Clear the first Use system value checkbox. Then, set Use Custom Admin URL to “Yes”.
b.
Clear the next Use system valuel checkbox. Then, enter the Custom Admin URL in the following format: http://yourdomain.com/magento/
Important! The Admin URL must be in the same Magento installation, and have the same document root as the storefront.
c.
Clear the next Use system valuel checkbox. Then, set Custom Admin Path to “Yes”.
Magento Community Edition 2.1 User Guide 905
Store URLs CHAPTER 69: All Stores
d.
Clear the next Use system valuel checkbox. Then, enter the Custom Admin Path.
The path that you enter is appended to the Custom Admin URL after the last forward slash.
sample_custom_admin
906
Admin Base URL
4.
When complete, tap
Save Config
.
5.
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 <adminhtml> argument in the <admin> section:
Default Admin Path
# <frontName><![CDATA[admin]]></frontName>
New Admin Path
# <frontName><![CDATA[backend]]></frontName>
2.
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
.
l
On the server, navigate to the var/cache folder, and delete the contents of the cache folder.
Magento Community Edition 2.1 User Guide
CHAPTER 70:
Configuration
The Configuration Reference has field descriptions for every configuration setting in
Magento Community Edition 2.1. To learn how to apply configuration settings to specific store views, see:
Configuration Tabs
Configuration
General
Includes basic configuration settings for the store, URLs, theme, currency, email addresses, store contacts, editor, and dashboard reports.
Catalog
Determines product and inventory settings, controls sitemap and RSS feed generation, and specifies the email template that is used to share products with friends.
Magento Community Edition 2.1 User Guide 907
908
CHAPTER 70: 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
GoogleAPI 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.
Magento Community Edition 2.1 User Guide
CHAPTER 71:
Taxes
In this section of the guide, you will learn how to set up taxes according to the requirements of your locale. You can set up tax classes for products and customer groups, and create tax rules that combine product and customer classes, tax zones, and rates. In addition, you'll learn more advanced topics such as setting up fixed product taxes, compound taxes, and displaying consistent prices across international borders. If you are required to collect a value-added tax, you will learn how to set up your store to automatically calculate the appropriate amount with validation.
Magento provides a variety of options to define taxes. Tax classes are used to define “tax rules.” Tax rules are a combination of a Product Class, a Customer Class and a Tax Zone and Rate. Magento also supports the calculation of Value-Added Tax (VAT) for businessto-business transactions in the European Union.
Magento Community Edition 2.1 User Guide 909
Tax Rules CHAPTER 71: Taxes
Tax Rules
Tax rules incorporate a combination of product class, customer class and tax rate. Each customer is assigned to a customer class, and each product is assigned a product class.
Magento analyzes the shopping cart of each customer and calculates the appropriate tax according to the customer and product classes, and the region (based on the customer’s shipping address, billing address or shipping origin).
When numerous taxes must be defined, you can simplify the process by importing them.
910
Tax Rules
Step 1:
Complete the Tax Rule Information
1.
On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Rules.
2.
In the upper-right corner, tap
Add New Tax Rule
.
3.
Under Tax Rule Information, enter a Name for the new rule.
4.
Choose the Tax Rate that applies to the rule. If you need to edit an existing tax rate, do the following:
a.
Hover over the tax rate, and tap the Edit icon.
b.
Update the form as needed, and tap
Save
.
Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes
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
.
2.
Complete the form as needed. For more information, see:
3.
When complete, tap
Save
.
Tax Rules
New Tax Rate
Magento Community Edition 2.1 User Guide 911
Tax Rules CHAPTER 71: Taxes
Method 2:
Import Tax Rates
1.
Scroll down to the section at the bottom of the page.
2.
To import tax rates, do the following:
a.
Tap
Choose File
, and navigate to the CSV file with the tax rates to be imported.
b.
Tap
Import Tax Rates
.
3.
To export tax rates, tap
Export Tax Rates
.
To learn more, see:
912
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
.
b.
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
.
c.
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.
d.
If you want taxes to be based on the order subtotal, mark the Calculate off Subtotal Only checkbox.
e.
In the Sort Order field, enter a number to indicate the order of this tax rule when listed with others.
Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes
5.
When complete, tap
Save Rule
.
Additional Settings
Tax Rules
Magento Community Edition 2.1 User Guide 913
Tax Classes CHAPTER 71: Taxes
Tax Classes
Tax classes can be assigned to customers, products, and shipping. Magento analyzes the shopping cart of each customer and calculates the appropriate tax according to the class of the customer, the class of the products in the cart, and the region (as determined by the customer’s shipping address, billing address or shipping origin). New tax classes can be created when a
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.
914 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Tax Classes
Configuring Tax Classes
The tax class that is used for shipping, and the default tax classes for products and customers are set in the Sales configuration.
Tax Classes
To configure tax classes:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Tax.
3.
Expand the Tax Classes section. Then, choose the tax class for each of the following: l
Set Tax Class for Shipping l
Default Tax Class for Product l
Default Tax Class for Customer
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 915
Tax Classes CHAPTER 71: Taxes
Default Tax Destination
The default tax destination settings determine the country, state, and ZIP or postal code that are used as the basis of tax calculations.
Default Tax Destination Calculation
To configure the default tax destination for calculations:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configure.
2.
In the panel on the left under Sales, choose Tax.
3.
Expand the Default Tax Destination Calculation section. Then, do the following:
a.
Set Default Country to the country upon which tax calculations are based.
b.
Set Default State to the state or province that is used as the basis of tax calculations.
c.
Set Default Post Code to the ZIP or postal code that is used as the basis of local tax calculations.
4.
When complete, tap
Save Config
.
916 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Tax Classes
EU Place of Supply for Digital Goods
European Union (EU) merchants must report their digital goods sold by quarter to each member country. Digital goods are taxed based on the customer's billing address. The law requires merchants to run a tax report and identify the relevant tax amounts for digital goods, as opposed to physical goods.
Merchants must report all digital goods sold by EU member countries on a quarterly basis to a central tax administration, along with payment due for tax collected during the period.
Merchants who have not yet reached the threshold (50k/100k Euro of annual business) must continue to report physical goods sold to the EU states where they have registered VAT numbers.
Merchants who are audited for taxes paid for digital goods, must provide two pieces of supporting information to establish the customer place of residence.
l
The customer’s billing address and a record of a successful payment transaction can be used to establish the customer place of residence. (Payment is accepted only if the billing address matches payment provider information.) l
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.
2.
Create a digital goods product tax class.
3.
Assign all your digital goods to the digital goods product tax class.
4.
Create
for your physical goods, using physical product tax classes, and associate them with the appropriate tax rates.
5.
Create tax rules for your digital goods, using use the product tax class for digital goods, and associate them with the appropriate tax rates for EU member countries.
6.
Run the tax report for the appropriate period, and collect the required digital goods information.
7.
Export the tax amounts that are related to the tax rates for the digital goods product tax class.
See also:
European Commission Taxation and Customs Union
EU 1015 Place of Supply Changes
Magento Community Edition 2.1 User Guide 917
Fixed Product Tax CHAPTER 71: Taxes
Fixed Product Tax
Some tax jurisdictions have a fixed tax that must be added to certain types of products. You can set up a fixed product tax (FPT) as needed for your store's tax calculations. For example, in some countries FPT can be used to set up a Waste Electrical and Electronic Equipment
Directive (WEEE) tax, also known as "ecological tax" or "eco tax," that is collected on certain types of electronics to offset the cost of recycling. This tax is a fixed amount, rather than a percentage of the product price.
Fixed product taxes apply at the item level, based on the product. In some jurisdictions this tax is subject to an additional % tax calculation. Your tax jurisdiction might also have rules about how the product price appears to customers, either with or without tax. Be sure that you understand the rules, and set your FPT display options accordingly.
We recommend that you exercise caution when quoting FPT prices in email, because the difference in price can affect customer confidence in their orders. For example, if you display
Order Review prices without showing FPT, customers who buy items with associated FPT will see a total that includes the FPT tax amount, but without an itemized breakdown. The difference in price might lead some customers to abandon their carts because the total differs from the amount expected.
FPT Display Prices
FPT
Not Taxed
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
Excluding FPT,
FPT Description,
Final Price
FPT is added to the base price of an item; but is not included in tax- rule-based calculations.
Prices appeare without FPT amount or description.
FPT is not included in tax-rule-based calculations.
Taxed
Excluding FPT
Including FPT
Excluding FPT,
FPT Description,
Final Price
FPT appears as a separate row in the cart, and the value is used in appropriate tax calculations.
FPT is included in the price of an item, and no change to tax calculations is required.
Prices appear without the FPT amount or description.
However, FPT is included in tax-rule-based calculations.
918 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Fixed Product Tax
Configuring FPT
The Fixed Product Tax
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:
Process Overview:
Step 1:
Step 2:
Step 3:
Add the FPT Attribute to an Attribute Set
Step 4:
Step 1:
Enable Fixed Product Tax
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Tax.
3.
Expand the Fixed Product Taxes section. Then, do the following:
a.
Set Enable FPT to “Yes.”
b.
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 l
Sales Modules l
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.
d.
Set Include FPT in Subtotal as needed.
Magento Community Edition 2.1 User Guide 919
Fixed Product Tax CHAPTER 71: Taxes
Fixed Product Taxes
4.
When complete, tap
Save Config
.
Step 2:
Create an FPT Attribute
1.
On the Admin sidebar, tap Stores. Then under Attributes choose Product.
2.
In the upper-right corner, tap
Add New Attribute
. Then, do the following:
a.
Enter a Default Label to identify the attribute.
b.
Set Catalog Input for Store Owner to “Fixed Product Tax.”
920
Attribute Properties
3.
Expand the Advanced Attribute Properties section. Then, do the following:
a.
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.
b.
If you want the FPT field to appear in the Inventory
, set Add to Column Options to
“Yes.”
Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Fixed Product Tax
c.
If you want to be able to
products in the grid based on the value of the FPT field, set
Use in Filter Options
to “Yes.”
Advanced Attribute Properties
4.
(Optional) In the panel on the left, choose Manage Labels. Then, enter a label to use instead of the default label for each store view.
Manage Labels
5.
When complete, tap
Save Attribute
. Then when prompted, refresh the
.
Magento Community Edition 2.1 User Guide 921
Fixed Product Tax CHAPTER 71: Taxes
Step 3:
Add the FPT Attribute to an Attribute Set
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Attribute Set.
2.
In the list, tap the attribute set to open the record in edit mode.
3.
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.
922
Edit Attribute Set
Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Fixed Product Tax
4.
When complete, tap
Save
.
5.
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.
2.
Open the product that needs a fixed product tax in edit mode.
3.
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],”
a.
Set Country/State to the region where the fixed product tax applies.
b.
Enter the fixed product tax as a decimal amount in the Tax field.
c.
To add more fixed product taxes, tap
Add Tax
, and repeat the process.
4.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide 923
Price Display Settings CHAPTER 71: Taxes
Price Display Settings
The price display settings determine if product and shipping prices include or exclude tax, or show two versions of the price; one with, and the other without tax.
If the product price includes tax, the tax appears only if there is a tax rule that matches the tax origin, or if a customer address matches the tax rule. Events that can trigger a match include when a customer creates an account, logs in, or generates a tax and shipping estimate from the shopping cart.
Important! Showing prices that include and exclude tax can be confusing to the customer. To avoid triggering a warning message, see the
for your country, and
avoid warning messages.
924
Price Display Settings
Step 1:
Configure Price Display Settings
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Sales, choose Taxes.
3.
Expand the Price Display Settings section. Then, do the following:
a.
Set Display Product Prices in Catalog to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
b.
Set Display Shipping Prices to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Price Display Settings
Step 2:
Configure Shopping Cart Display Settings
1.
Expand the Shopping Cart Display Settings section. Then, do the following:
Shopping Cart Display Settings
a.
Set Display Prices to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
b.
Set Display Subtotal to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
c.
Set Display Shipping Amount to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
d.
Set the following to “Yes” or “No” according to your preference: l
Include Tax in Order Total l
Display Full Tax Summary l
Display Zero Tax Subtotal
Magento Community Edition 2.1 User Guide 925
Price Display Settings CHAPTER 71: Taxes
Step 3:
Configure Order, Invoice & Credit Memo Display Settings
1.
Expand following: the Orders, Invoices, Credit Memos Display Settings section. Then, do the
926
Orders, Invoices, Credit Memos Display Settings
a.
Set Display Prices to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
b.
Set Display Subtotal to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
c.
Set Display Shipping Amount to one of the following: l
Excluding Tax l
Including Tax l
Including and Excluding Tax
d.
Set the following to “Yes” or “No” according to your preference: l
Include Tax in Order Total l
Display Full Tax Summary l
Display Zero Tax Subtotal
2.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Tax Zones and Rates
Tax Zones and Rates
Tax rates generally apply to transactions that take place within a specific geographical area.
The Tax Zones and Rates tool enables you to specify the tax rate for each geographical area from which you collect and remit taxes. Because each tax zone and rate has a unique identifier, you can have multiple tax rates for a given geographic area (such as places that do not tax food or medicine, but do tax other items).
Store tax is calculated based on the store’s address. The actual customer tax for an order is calculated after the customer completes the order information. Magento then calculates the tax based upon the tax configuration of the store.
Tax Zones and Rates
To define a new tax rate:
1.
On the Admin sidebar, tap Stores. Under Taxes, choose Tax Zones and Rates.
2.
In the upper-right corner, tap
Add New Tax Rate
.
3.
Enter a Tax Identifier.
4.
To apply the tax rate to a single ZIP or postal code, enter the code in the Zip/Post Code field.
5.
The asterisk wildcard (*) can be used to match up to ten characters in the code. For example,
90* represents all ZIP codes from 90000 through 90999.
6.
To apply the tax rate to a range of ZIP or postal codes, do the following::
a.
Mark the Zip/Post is Range checkbox.
b.
Enter the first ZIP or postal code in the range.
c.
Enter the last ZIP or postal code in the range.
d.
Choose the State where the tax rate applies.
Magento Community Edition 2.1 User Guide 927
Tax Zones and Rates
e.
Choose the Country where the tax rate applies.
f.
Enter the Rate Percent that is used for the tax rate calculation.
7.
When complete, tap
Save Rate
.
CHAPTER 71: Taxes
New Tax Rate
To edit an existing tax rate:
1.
On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Zones and Rates.
2.
Find the tax rate in the Tax Zones and Rates grid, and open the record in edit mode.
If there are many rates in the list, use the
to find the rate you need.
3.
Make the necessary changes to the Tax Rate Information.
4.
Update the Tax Titles as needed.
5.
When complete, tap
Save Rate
.
928 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Tax Zones and Rates
Import/Export Tax Rates
If you conduct business in several states and ship a large quantity of product, it is more efficient to download tax rates by ZIP code than enter the rates manually. The rates can then be imported into Magento. The following example shows how to import a set of California tax rates that was downloaded from the Avalara website. Avalara is a Magento Technology Partner , and provides tax rate tables that can be downloaded at no charge for every ZIP code in the
United States.
Process Overview:
Step 1:
Export the Magento Tax Rate Data
Step 2:
Step 3:
Step 1:
Export the Magento Tax Rate Data
1.
On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export Tax
Rates
.
2.
Tap
Export Tax Rates
. Look for the download file in the lower-left corner of the browser window.
3.
Save the file, and then open it in a spreadsheet. (In this example, we use OpenOffice Calc.)
The exported Magento tax rate data includes the following columns: l
Code l
Country l
State l
Zip/Post Code l
Rate l
Range From l
Range To l
A column for each store view
Exported Tax Rate Data
4.
Open the new tax rate data in a second instance of the spreadsheet, so you can see both, side by side.
Magento Community Edition 2.1 User Guide 929
Tax Zones and Rates CHAPTER 71: Taxes
In the new tax rate data, take note of any additional tax rate data that you might need to set up in your store before the data is imported. For example, the tax rate data for California also includes: l
TaxRegionName l
CombinedRate l
StateRate l
CountyRate l
CityRate l
SpecialRate
If you need to import additional
, you must first define them from the
Admin of your store, and update the
as needed. Then, export the data, and open the file in OpenOffice Calc, so it can be used for reference. However, to keep this example simple, we will import only the standard tax rate columns.
Step 2:
Prepare the Import Data
You now have two spreadsheets open, side by side. One with the Magento export file structure, and the other with the new tax rate data that you want to import.
1.
To create a place to work in the spreadsheet with the new data, insert as many blank columns at the far left as needed. Then, use cut and paste to rearrange the columns so they match the order of the Magento export data.
2.
Rename the column headers to match the Magento export data.
3.
Delete any columns that have no data. Otherwise, the structure of the import file should match the original Magento export data.
4.
Before saving the file, scroll down and make sure that the tax rate columns contain only numeric data. Any text found in a tax rate column will prevent the data from being imported.
5.
Save the prepared data as a .CSV file. When prompted, verify that a comma is used a Field
delimiter
, and double quotes as the Text delimiter. Then, tap
OK
.
930 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Tax Zones and Rates
Step 3:
Import the Tax Rates
1.
On the Admin sidebar, tap System. Then under Data Transfer, choose Import/Export Tax
Rates
.
2.
Tap
Browse
, and choose the .CSV tax rate file that you prepared to import. Then, tap
Import
Tax Rates
.
It might take several minutes to import the data. When the process is complete, the message,
"The tax rate has been imported" appears. If you receive an error message, correct the problem in the data and try again.
3.
On the Admin sidebar, tap Stores. Then under Taxes, choose Tax Zones and Rates. The imported rates appear in the list. Use the
to view the new tax rates.
Imported Tax Rates
4.
Run some test transactions in your store with customers from different ZIP codes to make sure that the new tax rates work correctly.
Magento Community Edition 2.1 User Guide 931
Value Added Tax (VAT) CHAPTER 71: Taxes
Value Added Tax (VAT)
Some countries charge a value added tax, or VAT, on goods and services. There can be different
VAT rates depending on which stage you as a merchant are at in the manufacture or distribution of the products, materials, or services that you sell to your customers. In this case you may need to use more than one VAT rate in your store for tax calculation purposes.
Configuring VAT
The following instructions include a sample procedure to set up a 20% VAT in the U.K. for sales to retail customers. For other tax rates and countries, follow the general procedure but enter specific information that corresponds to your country, VAT rate, customer types, and so on.
Before proceeding, make sure to find out which rules and regulations apply to VAT in your area.
In certain business-to-business transactions, VAT is not assessed. Magento can validate a customer’s VAT ID to ensure that VAT is assessed (or not assessed) properly. To learn more, see: VAT Validation.
Process Overview:
Step 1: Set Up Customer Tax Classes
Step 2: Set Up Product Tax Classes
Step 3: Set Up Tax Zones and Rates
Step 5: Apply Tax Classes to Products
Step 1:
Set Up Customer Tax Classes
1.
On the Admin sidebar, tap Stores. Then choose, select Tax Zones and Rates.
2.
Ensure that there is a customer tax class that is appropriate to use with the VAT. For this example, ensure that there is a customer tax class named Retail Customer. If Retail Customer does not exist, click the Add New button and add it.
Step 2:
Set Up Product Tax Classes
1.
On the Admin menu, select Sales > Tax > Product Tax Classes.
2.
Click the Add New button and create three new classes:
932 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Value Added Tax (VAT) l
VAT Standard l
VAT Reduced l
VAT Zero
3.
Click the Save Class button for each new class that you add.
Step 3:
Set Up Tax Zones and Rates
1.
On the Admin menu, select Sales > Tax > Manage Tax Zones & Rates.
For this example you can remove the U.S. tax rates, or leave them as they are.
2.
Click the Add New Tax Rate button. Add new rates as follows:
SETTINGS NEW TAX RATE
VAT Standard
Tax Identifier:
Country and State:
Rate Percent:
VAT Standard
United Kingdom
20.00
VAT Reduced
Tax Identifier:
Country and State:
Rate Percent:
VAT Reduced
United Kingdom
5.00
3.
Click the Save Rate button for each rate.
Step 4:
Set Up Tax Rules
A tax rule is a combination of a customer tax class, a product tax class, and a tax rate.
1.
On the Admin menu, select Sales > Tax > Manage Tax Rules.
2.
Add new tax rules as follows:
NEW TAX RULE
VAT Standard
SETTINGS
Name: VAT Standard
Customer Tax Class: Retail Customer
Product Tax Class:
Tax Rate:
VAT Standard
VAT Standard Rate
Magento Community Edition 2.1 User Guide 933
Value Added Tax (VAT) CHAPTER 71: Taxes
NEW TAX RULE
VAT Reduced
SETTINGS
Name: VAT Reduced
Customer Tax Class: Retail Customer
Product Tax Class: VAT Reduced
Tax Rate: VAT Reduced Rate
3.
Click the Save Rule button for each rate.
Step 5:
Apply Tax Classes to Products
1.
On the Admin menu, select Catalog > Manage Products.
2.
Open a product from your catalog in edit mode.
3.
On the General page, find the Tax Class field. Then, select the VAT Class that applies to the product.
4.
When complete, click the Save button.
934 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Value Added Tax (VAT)
VAT Validation
VAT ID Validation automatically calculates the required tax for B2B transactions that take place within the European Union (EU), based on the merchant and customer locale. Magento performs VAT ID validation using the web services of the European Commission server.
VAT-related tax rules do not influence other tax rules, and do not prevent the application of other tax rules. Only one tax rule can be applied at a given time.
l
VAT is charged if the merchant and customer are located in the same EU country.
l
VAT is not charged if the merchant and customer are located in different EU countries, and both parties are EU-registered business entities.
The store administrator creates more than one default customer group that can be automatically assigned to the customer during account creation, address creation or update, and checkout. The result is that different tax rules are used for intra-country (domestic) and intra-EU sales.
Important: If you sell virtual or downloadable products, which by their nature do not require shipping, the VAT rate of a customer’s location country should be used for both intra-union and domestic sales. You must create additional individual tax rules for product tax classes that correspond to the virtual products.
Customer Registration Workflow
If VAT ID Validation is enabled, after registration each customer is proposed to enter the VAT
ID number. However only those who are registered VAT customers are expected to fill this field.
After a customer specifies the VAT number and other address fields, and chooses to save, the system saves the address and sends the VAT ID validation request to the European
Commission server. According to the results of the validation, one of the default groups is assigned to a customer. This group can be changed if a customer or an administrator changes the VAT ID of the default address or changes the whole default address. The group can be temporarily changed (group change will be emulated) in some cases during one-page checkout.
If enabled, you can override VAT ID Validation for individual customers by selecting the checkbox on the Customer Information page.
Magento Community Edition 2.1 User Guide 935
Value Added Tax (VAT) CHAPTER 71: Taxes
Checkout Workflow
If a customer’s VAT validation is performed during checkout, the VAT request identifier and
VAT request date are saved in the Comments History section of the order.
The system behavior concerned with the VAT ID validation and the customer group change during the checkout depends on how the Validate on Each Transaction and the Disable
Automatic Group Change settings are configured. This section describes the implementation of the VAT ID Validation functionality for the checkout on the frontend.
In case a customer uses Google Express Checkout, PayPal Express Checkout or another external checkout method, when the checkout is performed completely on the side of the external payment gateway, the Validate on Each Transaction setting cannot be applied. Thus the customer group cannot change during checkout.
936
VAT Validation Checkout Workflow
Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Value Added Tax (VAT)
Configuring VAT ID Validation
To configure VAT ID validation, you must first set up the customer groups that are needed, and create the related tax classes, rates, and rules. Then, enable VAT ID validation for the store, and complete the configuration.
The following examples show how tax classes and rates are used for VAT ID Validation. Take a look at the examples, and then follow the instructions to set up the tax classes and rules that are needed for your store.
Example:
Minimal Tax Rules Required for VAT ID Validation
TAX RULE #1
Customer Tax Class
Product Tax Class
Tax Rate
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 classes must include a class for products of all types, except bundle and virtual.
The tax rate must include the VAT rate of the merchant’s country.
TAX RULE #2
Customer Tax Class
Product Tax Class
Tax Rate
A class for intra-union customers.
A class for products of all types, except virtual.
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
Tax Rate
A class for virtual products.
VAT rate of the merchant’s country.
TAX RULE #4 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)
Customer Tax Class A class for intra-union customers.
Magento Community Edition 2.1 User Guide 937
Value Added Tax (VAT) CHAPTER 71: Taxes
TAX RULE #4 (REQUIRED FOR VIRTUAL AND DOWNLOADABLE PRODUCTS)
Product Tax Class A class for virtual products.
Tax Rate VAT rates for all EU countries, except merchant’s country. Currently this rate is 0%.
Process Overview:
Step 1:
Create VAT-Related Customer Groups
Step 2:
Create VAT-Related Classes, Rates and Rules
Step 3:
Enable and Configure VAT ID Validation
Step 4:
Set your VAT ID and Location Country
Step 5:
Verify the List of EU Member Countries
Step 1:
Create VAT-Related Customer Groups
VAT ID Validation automatically assigns one of the four default customer groups to customers according to VAT ID validation results: l
Domestic l
Intra-EU l
Invalid VAT ID l
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 l
Product Tax Classes l
Tax Rates
Create the
that you need to use VAT ID Validation effectively.
l
Tax rules include tax rates and
.
l
Tax classes are assigned to
.
938 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Value Added Tax (VAT)
Step 3:
Enable and Configure VAT ID Validation
1.
On the Admin sidebar, tap Stores. Under Settings, choose Configuration.
2.
If necessary, set the Store View for the configuration.
3.
In the panel on the left under Customers, choose Customer Configuration.
4.
Expand the Create New Account Options section.
Create New Account Options
5.
Set Enable Automatic Assignment to Customer Group to “Yes.” Then complete the following fields as needed.
l
Default Group l
Default Value for Disable Automatic Group Changes Based on VAT ID l
Show VAT Number on Frontend
6.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 939
Value Added Tax (VAT)
Step 4:
Set Your VAT ID and Location Country
1.
On the Admin sidebar, tap Stores. Under Settings, choose Configuration.
2.
If needed, set Store View to the applicable store view.
3.
In the panel on the left under General, choose General.
4.
Expand the Store Information section. Then, do the following:
CHAPTER 71: Taxes
Store Information
a.
Select your Country.
b.
Enter your VAT Number. Then, tap
Validate VAT Number
. The result appears immediately.
5.
When complete, tap
Save Config
.
940 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Value Added Tax (VAT)
Step 5:
Verify the List of EU Member Countries
1.
Continuing in the General configuration section, expand the Countries Options section.
Countries Options
2.
In the list of European Union Countries, verify that each member country of the EU is selected.
3.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 941
Tax Quick Reference CHAPTER 71: Taxes
Tax Quick Reference
Some tax settings have a choice of options that determines the way the tax is calculated and presented to the customer. To learn more, see:
International Tax Guidelines .
Tax Calculation Methods
Tax calculation method options include Unit Price, Row Total, and Total. The following table explains how rounding (to two digits) is handled for different settings.
Tax Configuration Options
SETTING
Unit Price
CALCULATION AND DISPLAY
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
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.
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.
942 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Tax Quick Reference
Catalog Prices With or Without Tax
The possible display fields vary depending on the calculation method and whether the catalog prices include or exclude taxes. Display fields have two-decimal precision in normal computations. Some combinations of price settings display prices that both include and exclude tax. When both appear on the same line item, it can be confusing to customers, and triggers a
.
Tax Configuration Options
SETTING
Excluding Tax
CALCULATION AND DISPLAY
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
Excluding Tax
DISPLAY
Appears without tax.
CALCULATION
Normal calculation. Shipping is added to cart total, typically displayed as a separate item.
Including Tax Can be tax inclusive, or tax can be displayed separately.
Shipping is treated as another item in cart with taxes, using the same calculations.
Tax Amounts as Line Items
To display two different tax amounts as separate line items, such as GST and PST for Canadian stores, you must set different priorities for the related tax rules. However, in previous tax calculations, taxes with different priorities would automatically be compounded. To correctly display separate tax amounts without an incorrect compounding of the tax amounts, you can set different priorities, and also select the Calculate off subtotal only checkbox. This produces correctly calculated tax amounts that appear as separate line items.
Magento Community Edition 2.1 User Guide 943
International Tax Guidelines CHAPTER 71: Taxes
International Tax Guidelines
U.S. Tax Configuration
TAX OPTION
Load catalog prices
RECOMMENDED SETTING
Excluding tax
FPT
Tax based on
Tax Calculation
Tax shipping?
Apply Discount
Comment
No, because FPT is not taxed.
Shipping origin
On total
No
Before tax
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
Load catalog prices
RECOMMENDED SETTING
Excluding tax
FPT
Tax based on
Tax Calculation
Tax shipping?
Apply Discount
Comment
Yes, including FPT and description
Shipping address
On total
Yes
Before tax, discount on prices, including tax.
For merchants marking up supplier invoices (including VAT).
U.K. B2B Tax Configuration
TAX OPTION
Load catalog prices
RECOMMENDED SETTING
Excluding tax
FPT
Tax based on
Tax Calculation
Tax shipping?
Yes, including FPT and description
Shipping address
On item
Yes
944 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes International Tax Guidelines
U.K. B2B Tax Configuration (cont.)
TAX OPTION
Apply Discount
RECOMMENDED SETTING
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
Load catalog prices
RECOMMENDED SETTING
Excluding tax
FPT
Tax based on
Tax Calculation
Tax shipping?
Apply Discount
Comment
Yes, including FPT, description, and apply tax to FPT.
Shipping origin
On total
Yes
Before tax
Merchants located in a GST/PST province (Montreal) should create one tax rule and show a combined tax amount.
Be sure to consult a qualified tax authority if you have any questions.
For information about the tax requirements of specific provinces, see the following:
Revenu Québec
Government of Saskatchewan
Manitoba Information for Vendors
Magento Community Edition 2.1 User Guide 945
International Tax Guidelines
U.S. Tax Guidelines
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
Catalog Prices
Shipping Prices
Apply Customer Tax
Apply Discount on Prices
Shipping Origin
Excluding Tax
Excluding Tax
After Discount
Excluding Tax
Default Tax Destination Calculation
SETTING
Default Country
Default State
Default Post Code
RECOMMENDED SETTING
United States
State where business is located.
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
CHAPTER 71: Taxes
946 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes
Shopping Cart Display Settings
SETTING
Display Prices
RECOMMENDED SETTING
Excluding Tax
Display Subtotal
Display Shipping Amount
Excluding Tax
Excluding Tax
Display Gift Wrapping Prices Excluding Tax
Display Printed Card Prices Excluding Tax
Include Tax in Grand Total
Display Full Tax Summary
Display Zero Tax Subtotal
Yes
Yes
Yes
Orders, Invoices, Credit Memos, Display Settings
SETTING
Display Prices
RECOMMENDED SETTING
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
RECOMMENDED SETTING
No, except in California.
International Tax Guidelines
Magento Community Edition 2.1 User Guide 947
International Tax Guidelines CHAPTER 71: Taxes
Canadian Tax Guidelines
The following example shows how to set up GST tax rates for Canada and PST tax rates for
Saskatchewan, with tax rules that calculate and display the two tax rates. Because this is an example configuration, be sure to verify the correct tax rates and rules for your tax jurisdictions. When setting up taxes, set the store scope to apply the configuration to all applicable stores and websites.
l
Fixed product tax is included for relevant goods as a product attribute.
l
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 5: Create a PST Tax Rule for Saskatchewan
Step 6: Save and Test the Results
Step 1:
Complete Tax Calculation Settings
1.
On the Admin menu, select System > Configuration. Then in the panel on the left, under
Sales, select Tax.
2.
Click to expand each section, and complete the following settings:
Tax Calculation Settings
FIELD RECOMMENDED SETTING
Tax Calculation Method Based On Total
Tax Calculation Based On
Catalog Prices
Shipping Prices
Apply Customer Tax
Apply Discount on Prices
Apply Tax On
Shipping Address
Excluding Tax
Excluding Tax
After Discount
Excluding Tax
Custom Price (if available)
948 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes
Tax Classes
FIELD
Tax Class for Shipping
RECOMMENDED SETTING
Shipping (shipping is taxed)
Default Tax Destination Calculation
FIELD
Default Country
RECOMMENDED SETTING
Canada
Default State
Default Postal Code
(as appropriate)
* (asterisk)
Shopping Cart Display Settings
FIELD
Include Tax in Grand Total
RECOMMENDED SETTING
Yes
Display Full Tax Summary Yes
Display Zero in Tax Subtotal Yes
Fixed Product Taxes
FIELD
Enable FPT
All FPT Display Settings
Apply Discounts to FPT
Apply Tax to FPT
Include FPT in Subtotal
RECOMMENDED SETTING
Yes
Including FPT and FPT description
No
Yes
No
International Tax Guidelines
Magento Community Edition 2.1 User Guide 949
International Tax Guidelines CHAPTER 71: Taxes
Step 2:
Set Up Canadian Goods & Services Tax
(GST)
To print the GST number on invoices and other sales documents, include it in the name of the applicable tax rates. The GST will appear as part of the GST amount on any order summary.
Manage Tax Zones & Rates
FIELD
Tax Identifier
RECOMMENDED SETTING
Canada-GST
Country
State
Zip/Post is Range
Zip/Post Code
Rate Percent
Canada
* (asterisk)
No
* (asterisk)
5.0000
Step 3:
Set Up Canadian Provincial Sales Tax
(PST)
Set up another tax rate for the applicable province.
Tax Rate Information
FIELD
Tax Identifier
RECOMMENDED SETTING
Canada-SK-PST
Country
State
Zip/Post is Range
Zip/Post Code
Rate Percent
Canada
Saskatchewan
No
* (asterisk)
5.0000
950 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes International Tax Guidelines
Step 4:
Create a GST Tax Rule
To avoid compounding the tax and to correctly display the calculated tax as separate line items for GST and PST, you must set different priorities for each rule, and select the “Calculate off subtotal only” checkbox. Each tax appears as a separate line item, but the tax amounts are not compounded.
Tax Rule Information
FIELD
Name
RECOMMENDED SETTING
Retail-Canada-GST
Customer Tax Class
Product Tax Class
Retail Customer
Taxable Goods
Shipping
Tax Rate
Priority
Canada-GST
0
Calculate off subtotal only Select this checkbox.
Sort Order 0
Magento Community Edition 2.1 User Guide 951
International Tax Guidelines CHAPTER 71: Taxes
Step 5:
Create a PST Tax Rule for Saskatchewan
For this tax rule, make sure to set the priority to 0 and select the "Calculate off subtotal only" checkbox. Each tax appears as a separate line item, but the tax amounts are not compounded.
Tax Rule Information
FIELD
Name
RECOMMENDED SETTING
Retail-Canada-PST
Customer Tax Class
Product Tax Class
Retail Customer
Taxable Goods
Shipping
Tax Rate
Priority
Canada-SK-PT
1
Calculate off subtotal only Select this checkbox.
Sort Order 0
Step 6:
Save and Test the Results
1.
When complete, click the Save Config button.
2.
Return to your storefront, and create a sample order to test the results.
952 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes International Tax Guidelines
EU Tax Guidelines
The following example depicts a store based in France that sells > 100k Euros in France and >
100k Euros in Germany.
l
Tax calculations are managed at the website level.
l
Currency conversion and tax display options are controlled individually at the store view level, (Click the Use Website checkbox to override the default).
l
By setting the default tax country you can dynamically show the correct tax for the jurisdiction.
l
Fixed product tax is included for relevant goods as a product attribute.
l
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 4: Set Up a Store View for Germany
Step 5: Configure Tax Settings for France
Step 6: Configure Tax Settings for Germany
Step 1:
Create Three Product Tax Classes
For this example, it is assumed that multiple VAT-Reduced product tax classes are not needed.
1.
Create a VAT-Standard product tax class.
2.
Create a VAT-Reduced product tax class.
3.
Create a VAT-Free product tax class.
Magento Community Edition 2.1 User Guide 953
International Tax Guidelines
Step 2:
Create Tax Rates for France and Germany
Create the following tax rates:
Tax Rates
TAX RATE
France-StandardVAT
SETTING
Country: France
State/Region: *
ZIP/Postal Code: *
Rate: 20%
France-ReducedVAT
Country:
State/Region:
France
*
ZIP/Postal Code: *
Rate: 5%
Germany-StandardVAT
Country:
State/Region:
Germany
*
ZIP/Postal Code: *
Rate: 19%
Germany-ReducedVAT
Country: Germany
State/Region: *
ZIP/Postal Code: *
Rate: 7%
CHAPTER 71: Taxes
954 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes International Tax Guidelines
Step 3:
Set Up the Tax Rules
Create the following tax rules:
Tax Rules
TAX RULE
Retail-France-StandardVAT
SETTING
Customer Class: Retail Customer
Tax Class: VAT-Standard
Tax Rate:
Priority:
Sort Order:
France-StandardVAT
0
0
Retail-France-ReducedVAT
Customer Class: Retail Customer
Tax Class: VAT Reduced
Tax Rate: France-ReducedVAT
Priority:
Sort Order:
0
0
Retail-Germany-
StandardVAT
Customer Class: Retail Customer
Tax Class: VAT-Standard
Tax Rate: Germany-StandardVAT
Priority:
Sort Order:
0
0
Retail-Germany-
ReducedVAT
Customer Class: Retail Customer
Tax Class: VAT-Reduced
Tax Rate: Germany-ReducedVAT
Priority:
Sort Order:
0
0
Magento Community Edition 2.1 User Guide 955
International Tax Guidelines CHAPTER 71: Taxes
Step 4:
Set Up a Store View for Germany
1.
On the Admin sidebar, tap Stores. Then under Settings, choose All Stores.
2.
Under the default website, create a store view for Germany. Then, do the following:
a.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
a.
In the upper-left corner, set Default Config to the French store.
b.
On the General page, expand country to “France.” the Countries Options section, and set the default
c.
Complete the locale options as needed.
3.
In the upper-left corner, choose the German Store View. Then, do the following:
a.
On the General page, expand
“Germany.”
Countries Options b.
Complete the locale options as needed.
, and set the default country to
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
Tax Calculation Based On
Catalog Prices
Shipping Prices
Apply Customer Tax
Apply Discount on Prices
Total
Shipping Address
Including Tax
Including Tax
After Discount
Including Tax
956 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes
General Settings (cont.)
FIELD
Apply Tax On
RECOMMENDED SETTING
Custom Price (if available)
DEFAULT TAX DESTINATION CALCULATION
Default Country France
Default State
Default Postal Code * (asterisk)
SHOPPING CART DISPLAY SETTINGS
Include Tax in Grand Total Yes
FIXED PRODUCT TAXES
Enable FPT
All FPT Display Settings
Apply Discounts to FPT
Apply Tax to FPT
Include FPT in Subtotal
Yes
Including FPT and FPT description
No
Yes
Yes
International Tax Guidelines
Magento Community Edition 2.1 User Guide 957
International Tax Guidelines CHAPTER 71: Taxes
Step 6:
Configure Tax Settings for Germany
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the upper-right corner, set Store View to the view to the German store. When prompted to confirm, tap OK.
3.
In the panel on the left, under Sales,choose Tax.
4.
In the Default Tax Destination Calculation section, do the following:
a.
Clear the Use Website checkbox after each field,
b.
Update the following values to match your site's Shipping Settings
l
Default Country l
Default State l
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
.
958 Magento Community Edition 2.1 User Guide
CHAPTER 71: Taxes Warning Messages
Warning Messages
Some combinations of tax-related options might be confusing to customers and trigger a warning. These conditions might occur when the tax calculation method is set to “Row” or
“Total,” and the customer is presented with prices that both exclude and include tax, or a tax on an item basis in the cart. Because the tax calculation is rounded, the amount that appears in the cart might differ from the amount that a customer expects to pay.
If your tax calculation is based on a problematic configuration, the following warnings appear:
Warning. Tax discount configuration might result in different discounts than a customer might expect for store(s); Europe Website (French), Europe Website (German). Please see source for more details.
Warning. Tax configuration can result in rounding errors for store(s): Europe Websites
(French), Europe Websites (German).
Calculation Settings
Use the following tables for reference when configuring tax calculation settings:
Tax Calculation Method Based On: Excluding Tax
Tax Excluded
PRICE DISPLAY UNIT PRICE ROW TOTAL TOTAL
Tax Class for Shipping Shipping (is taxed)
Excluding tax
Including tax
Including and
Excluding tax
OK
OK
OK
OK
OK
OK
OK
OK
Warning
Catalog Prices: Including Tax
Tax Included
PRICE DISPLAY
Excluding tax
UNIT PRICE
OK
Including tax
Including and
Excluding tax
OK
OK
ROW TOTAL
OK
OK
Warning
TOTAL
OK
OK
Warning
Magento Community Edition 2.1 User Guide 959
Warning Messages CHAPTER 71: Taxes
960
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
RECOMMENDED SETTING
After Discount
Apply Discount on Prices
US and Canada
EU
Excluding Tax
Including Tax
Magento Community Edition 2.1 User Guide
CHAPTER 72:
Currency
Magento Community Edition 2.1 gives you the ability to accept currencies from more than two hundred countries around the world. If the store supports multiple currencies, a
Currency Chooser appears in the header after currency rates are
.
If you accept payment in multiple currencies, make sure to monitor the currency rate settings, because any fluctuation can impact your profit margin.
Currency symbols appear in product prices and sales documents such as orders and invoices. You can customize the currency symbols as needed, and also set the display of the price separately for each store or view.
Currency Chooser
Magento Community Edition 2.1 User Guide 961
Currency Configuration CHAPTER 72: 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
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.
962
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:
Magento Community Edition 2.1 User Guide
CHAPTER 72: Currency Currency Configuration
Step 1:
Choose the Accepted Currencies
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Currency Setup.
3.
Expand the Currency Options section, and do the following:
a.
Set Base Currency to the primary currency that you use for online transactions.
b.
Set Default Display Currency to the currency that you use to display pricing in your store.
c.
In the Allowed Currencies list, select all currencies that you accept as payment in your store. Make sure to also select your primary currency. (For multiple currencies, hold down the Ctrl key and select each option.)
Currency Options
4.
When prompted to refresh the cache, tap the Close box in the upper-right corner of the system message. We’ll refresh the cache later.
5.
To define the scope of the base currency, do the following:
a.
In the panel on the left under Catalog, choose Catalog. Then, scroll down and expand the Price section.
b.
Set Catalog Price Scope to either “Global” or “Website.”
Price
Magento Community Edition 2.1 User Guide 963
Currency Configuration CHAPTER 72: 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
.
2.
Expand the WebserviceX section.
3.
In the Connection Timeout in Seconds field, enter the number of seconds of inactivity to allow before the connection times out.
964
WebserviceX
Step 3:
Configure the Scheduled Import Settings
1.
Continuing with Currency Setup, expand the Scheduled Import Settings section.
2.
To automatically update currency rates, set Enabled to "Yes." Then, do the following:
a.
Set Service to the rate provider. The default value is “Webservicex.”
b.
Set Start Time to the hour, minute, and second that the rates will be updated according to the schedule.
c.
To determine how often the rates are updated, set Frequency to one of the following: l
Daily l
Weekly l
Monthy
d.
In the Error Email Recipient field, enter the email address of the person who is to receive email notification if an error occurs during the import process. To enter multiple email addresses, separate each with a comma.
e.
Set Error Email Sender to the
that appears as the sender of the error notification.
f.
Set Error Email Template to the email template used for the error notification.
3.
When complete, tap
Save Config
.
4.
When prompted to update the cache, tap the Cache Management link. Then, refresh the invalid cache.
Magento Community Edition 2.1 User Guide
CHAPTER 72: Currency
Refresh Cache
Currency Configuration
Scheduled Import Settings
Step 4:
Update the Currency Rates
The currency rates must be updated with the current values before they go into effect. Follow the instructions to
manually or to import the rates automatically.
Magento Community Edition 2.1 User Guide 965
Currency Symbols CHAPTER 72: 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.
966
Currency Symbols
To customize currency symbols:
1.
On the Admin sidebar, tap Stores. Then under Currency, choose Currency Symbols.
Each currency that is currently enabled for your store appears in the Currency list.
2.
Enter a custom symbol for each currency you want to use, or mark the Use Standard checkbox to the right of each currency.
3.
To override the default symbol, clear the Use Standard checkbox. Then, enter the symbol that you want to use.
It is not possible to change the alignment of the currency symbol from left to right.
4.
When complete, tap
Save Currency Symbols
.
5.
When prompted to update the cache, tap the Cache Management link. Then, refresh any invalid cache.
Refresh Cache
Magento Community Edition 2.1 User Guide
CHAPTER 72: 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
to specify the currencies that you accept, and to establish the import connection and schedule.
Updating Currency Rates
To manually update a currency rate:
1.
On the Admin sidebar, click Stores. Then under Currency, choose Currency Rates.
2.
Tap the rate you want to change, and enter the new value for each currency supported.
3.
When complete, tap
Save Currency Rates
.
To import currency rates:
1.
On the Admin sidebar, tap Stores. Then under Currency, choose Currency Rates.
2.
Set Import Service to the currency rate provider. WebserviceX is the default provider.
3.
Tap
Import
.
The updated rates appear in the Currency Rates list. If the rates have changed since the last update, the old rate appears below for reference.
4.
When complete, tap
Save Currency Rates
.
Magento Community Edition 2.1 User Guide 967
Updating Currency Rates CHAPTER 72: Currency
5.
When prompted to update the cache, tap the Cache Management link. Then, refresh all invalid caches.
968
Refresh Invalid Caches
To import currency rates on schedule:
1.
Make sure that
is enabled for your store.
2.
Complete the
to specify the currencies that you accept, and to establish the import connection and schedule.
3.
To verify that the rates are imported on schedule, check the Currency Rates list. Then, wait for the duration of the frequency setting established for the schedule, and check the rates again.
Magento Community Edition 2.1 User Guide
CHAPTER 73:
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,
, and email messages. Some attributes are built into the system, and others can be created to address specific needs.
You can find more information about attributes in the
and
sections of this guide. To learn more, see: l
l
l
Magento Community Edition 2.1 User Guide 969
Product Attributes CHAPTER 73: 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
Labels
Storefront
Properties
The Properties section includes both basic and advanced attribute properties.
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.
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 Page
970 Magento Community Edition 2.1 User Guide
CHAPTER 73: 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:
Text Field
Text Area
A single line input field for text.
A multiple-line input field that can display paragraphs of text formatted with HTML.
Date
Yes/No
An input field for date values. The date can be typed directly into the field, or selected from a list or calendar.
A drop-down list with predefined options of
“Yes” and “No.”
Multiple Select
Dropdown
Price
Media Image
Visual Swatch
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.
A drop-down list of options that allows only one selection.
An input type that can be used to create price fields in addition to the predefined attributes: Price, Special Price, Tier Price and Cost.
An additional image that can be included in the attribute set of a product.
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.
Magento Community Edition 2.1 User Guide 971
Product Attributes CHAPTER 73: Attributes
Property Descriptions (cont.)
PROPERTY 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.
Values Required To require that a value to be entered in this field before the record can be saved, set Values Required to “Yes.” Options include: Yes / No
ADVANCED ATTRIBUTE PROPERTIES
Attribute Code (Required) A unique identifier for internal use. The Attribute Code must begin with a letter, but can include a combination of lowercase letters (a-z) and numbers (0-9). The code must be less than thirty characters in length and cannot include any special characters or spaces, although an underscore (_) can be used to indicate a space.
Scope
Default Value
Limits the use of an attribute to a specific store view or website.
Options include:
Store View
Website
Global
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:
.
A default value cannot be set for Multiple Select, Dropdown, or Fixed
Product Tax input types.
Unique Value
Input Validation for Store
Owner
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
Performs a validation check of the data entered in the field, based on the following options:
972 Magento Community Edition 2.1 User Guide
CHAPTER 73: Attributes Product Attributes
Property Descriptions (cont.)
PROPERTY DESCRIPTION
None
Decimal Number
Integer Number
URL
Letters
Letters (a-z, A-Z) or Numbers (0-9)
Add to Column Options
Use in Filter Options
Determines if the column appears in the product grid. Options: Yes /
No
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
Search
Gives shoppers the ability to enter search criteria through a form. Options include: Yes / No
Using too many attributes can slow down search.
Comparable on Storefront Select “Yes” to include this attribute as a row in the Compare
Products report. Options include: Yes / No
Use In Layered Navigation (Dropdown, Multiple Select and Price input types only) Includes the attribute as a filter in the “Shop By” section of layered navigation.
Options include:
Magento Community Edition 2.1 User Guide 973
Product Attributes CHAPTER 73: Attributes
Property Descriptions (cont.)
PROPERTY DESCRIPTION
No
Filterable (with results)
Filterable (no results)
The attribute is not available to be used as a filter in layered navigation.
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.
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
Position
Use for Promo Rule
Conditions
Allow HTML Tags on
Storefront
To include the attribute in the layered navigation for search results, select “Yes.” Options include: Yes / No
Determines the position of the attribute in layered navigation in relation to other filterable attributes.
To make the attribute available for use in price rules, select “Yes.”
Options include: Yes / No
(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
Used in Product Listing
(Simple and virtual products only) To include the attribute on the
Additional Information tab of the product page, select “Yes.” Options include: Yes / No
Depends on the theme. To include the attribute in product summaries that appear in catalog listings, select “Yes.”
Used for Sorting in Product
Listing
Depending on theme, includes the attribute as a “Sort By” option for catalog listings. Options: Yes / No
974 Magento Community Edition 2.1 User Guide
CHAPTER 73: Attributes Product Attributes
Creating Product Attributes
Attributes can be created while working on a product, or from the Product Attributes page. The following example shows how to create attributes from the Stores menu. To learn how to add attributes while working on a product, see:
Any attribute that is used as a drop-down list of values for a
must have the following properties:
PROPERTY VALUE
Catalog Input Type for Store Owner Dropdown
Scope
Global
New Attribute Properties
Process Overview:
Step 1: Describe the Basic Properties
Step 2: Describe the Advanced Properties
Step 4: Describe the Storefront Properties
Magento Community Edition 2.1 User Guide 975
Product Attributes CHAPTER 73: Attributes
Step 1:
Describe the Basic Properties
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Product.
2.
Tap
Add New Attribute
.
Attribute Properties
3.
Under Attribute Properties, enter a Default Label to identify the attribute.
4.
Set Catalog Input Type for Store Owner to the type in input control to be used for data entry.
5.
For Dropdown and Multiple Select input types, do the following:
a.
Under Manage Options, tap
Add Option
.
b.
Enter the first value that you want to appear in the list. You can enter one value for the
Admin, and a translation of the value for each store view. If you have only one store view, you can enter only the Admin value and it will be used for the storefront as well.
c.
Tap
Add Option
and repeat the previous step for each option that you want to include in the list.
d.
Select Is Default to use the option as the default value.
6.
If you want to require the customer to choose an option before the product can be purchased, set Values Required to “Yes.”
976
Manage Options
Magento Community Edition 2.1 User Guide
CHAPTER 73: Attributes
Step 2:
Describe the Advanced Properties
(if needed)
1.
Enter a unique Attribute Code in lowercase characters, and without spaces.
Product Attributes
Advanced Attribute Properties
2.
Set Scope to indicate where in your store hierarchy the attribute can be used.
3.
If you want to prevent duplicate values from being entered, set Unique Value to “Yes.”
4.
To run a validity test of any data entered into a text field, set Input Validation for Store Owner to the type of data that the field should contain. This field is not available for input types with values that are selected. The test can validate any of the following: l
Decimal Number l
Integer Number l
Email l
URL l
Letters l
Letters (a-z, A-Z) or Numbers (0-9)
Input Validation
5.
To add this attribute to the product grid, set the following options to "Yes."
Magento Community Edition 2.1 User Guide 977
Product Attributes CHAPTER 73: Attributes
Add to Column Options
Use in Filter Options
Includes the attribute as a column in the Products grid.
Adds a filter control to the column header in the Products grid.
Step 3:
Enter the Field Label
1.
Expand the Manage titles section.
2.
Enter a Title to be used as a label for the field. If your store is available in different languages, you can enter a translated title for each view.
978
Manage Titles
Step 4:
Describe the Storefront Properties
1.
In the panel on the left, choose Storefront Properties.
2.
If the attribute is to be available for search, set Use in Search to “Yes.”
3.
To include the attribute in Product Compare, set Comparable on Storefront to “Yes.”
4.
For dropdown, multiple select and price fields, do the following:
a.
To use the attribute as a filter in layered navigation, set Use in Layered Navigation to
“Yes.”
b.
to use the attribute in layered navigation on search results pages, set Use in Search
Results Layered Navigation
to “Yes,”
c.
In the Position field, enter a number to indicate the relative position of the attribute in the layered navigation block.
5.
To use the attribute in price rules, set Use for Promo Rule Conditions to “Yes,”
6.
To allow the text to be formatted with HTML, set Allow HTML Tags on Frontend to “Yes.”
This setting makes the WYSIWYG editor available for the field.
To include the attribute in catalog page listings, set Visible on Catalog Pages on Storefront to
“Yes.”
7.
Complete the following settings if supported by your theme:
Magento Community Edition 2.1 User Guide
CHAPTER 73: Attributes Product Attributes
a.
To include the attribute on the product detail page, set Visible on Catalog Pages on
Storefront
to “Yes.”
b.
To include the attribute in product listings, set Used in Product Listing to “Yes.”
c.
To use attribute as a sort parameter for product listings, set Used for Sorting in Product
Listing
to “Yes.”
8.
When complete, tap
Save Attribute
.
Storefront Properties
Magento Community Edition 2.1 User Guide 979
Product Attributes CHAPTER 73: Attributes
Attribute Sets
One of the first steps when creating a product is to choose the attribute set that is used as a template for the product record. The attribute set determines the fields that are available during data entry, and the values that appear to the customer.
The attributes are organized into groups that determine where they appear in the product record. Your store comes with an initial attribute set called “default” which includes a set of commonly-used attributes. If you would like to add only a small number of attributes, you can add them to the default attribute set. However, if you sell products that require specific types of information, such as cameras, it might be better to create a dedicated attribute set that includes the specific attributes that are needed to describe the product.
980
Attribute Sets
To create an attribute set:
1.
On the Admin sidebar, tap Stores. Then under Attributes, choose Attribute Set.
2.
Tap
Add New Set
. Then, do the following:
Magento Community Edition 2.1 User Guide
CHAPTER 73: Attributes Product Attributes
Edit Set Name
a.
Enter a Name for the attribute set.
b.
Set Based On to an existing attribute set to be used as a template.
c.
Tap Save . The next page displays the following: l
The left column shows the name of the attribute set. The name is for internal reference, and can be changed as needed.
l
The center of the page lists the current selection of attribute groups.
l
The right column lists the selection of attributes that are currently not assigned to the attribute set.
d.
To add a new attribute to the set, drag the attribute from the Unassigned Attributes list to the appropriate folder in the Groups column.
System attributes are marked with a dot and cannot be removed from the Groups list. They can however, be dragged to another Group in the attribute set.
3.
When complete, tap
Save
.
Magento Community Edition 2.1 User Guide 981
Product Attributes CHAPTER 73: Attributes
982
Edit Attribute Set
To create a new attribute group:
1.
In the Groups column the attribute set, tap
Add New
.
2.
Enter a Name for the new group, and tap
OK
.
3.
Do either of the following: l
Drag Unassigned Attributes to the new group.
l
Drag attributes from any other group to the new group.
The new group becomes a section of attributes in any product that is based on the attribute set.
Magento Community Edition 2.1 User Guide
System
983
984
Contents
In this section of the guide, you’ll learn how to import and export data, manage security and permissions, install extensions and integrations, and use the many tools that are available to maintain your store at peak performance.
Browser Capabilities Detection
CHAPTER 74:
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.
To display the System menu:
On the Admin sidebar, tap
System
.
System Menu
Magento Community Edition 2.1 User Guide 985
986
Menu Options
CHAPTER 74: System Menu
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.
Integrations
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.
Magento Community Edition 2.1 User Guide
CHAPTER 74: System Menu
Other Settings
Notifications
Your store has an inbox for the messages received from Magento. The messages are rated by importance, and might refer to system updates, patches, new releases, scheduled maintenance, upcoming events, and more.
Custom Variables
If you know a little basic HTML, you can create custom variables and use a
to incorporate them into pages, blocks, banners, and email templates.
Manage Encryption Key
The encryption key is used to protect passwords and other sensitive data. Magento can autogenerate an encryption key, or you can use one from another source.
Magento Community Edition 2.1 User Guide 987
988 Magento Community Edition 2.1 User Guide
CHAPTER 75:
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
l
l
l
l
Magento Community Edition 2.1 User Guide 989
Working with CSV Files CHAPTER 75: 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
Export
CSV and ZIP (a compressed CSV file.)
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.
990
Exported Product CSV in OpenOffice Calc
Magento Community Edition 2.1 User Guide
CHAPTER 75: 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:
Exported Product CSV in Notepad++
CSV Product Structure
COLUMN NAME
_<name>
DESCRIPTION
Column headers that begin with an underscore contain service entity properties or complex data. Service columns are not product attributes.
<attribute name> Column headers with an attribute code or field name identify the column of data. A column might represent a system attribute, or one that was created by the store administrator.
Magento Community Edition 2.1 User Guide 991
Working with CSV Files CHAPTER 75: 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
_<name>
DESCRIPTION
Column headers that begin with an underscore contain service entity properties or complex data. Service columns are not customer attributes.
<attribute name> The names of the columns with values of both system-created attributes, and attributes created by the store administrator.
992 Magento Community Edition 2.1 User Guide
CHAPTER 75: 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
Complex Data
Service Data
Required Values
Separators
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)
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.
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.
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.
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 l
The number of invalid rows l
The number of errors found
If the data is valid, an “Import Success” message appears.
File is Valid!
Magento Community Edition 2.1 User Guide 993
Working with CSV Files CHAPTER 75: 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 l
URL key for specified store already exists l
'7z' file extension is not supported l
'txt' file extension is not supported
ERRORS
l
Wrong field type. Type in the imported file %decimal%, expected type is %text%.
l
Value is not allowed. Attribute value does not exist in the system.
l
Field %column name% is required.
l
Wrong value separator is used.
l
Wrong encoding used. Supported character encoding is UTF-8 and Windows-1252.
l
Imported file does not contain SKU field.
l
SKU does not exist in the system.
l
Column name %column name% is invalid. Should start with a letter. Alphanumeric.
l
Imported file does not contain a header.
l
%website name% website does not exist in the system.
l
%storeview name% storeview does not exist in the system.
l
Imported attribute %attribute name% does not exist in the system.
l
Imported resource (image) could not be downloaded from external resource due to timeout or access permissions.
l
Imported resource (image) does not exist in the local media storage.
l
Product creation error displayed to the user equal to the one seen during manual product save.
l
Advanced Price creation error displayed to the user equal to the one seen during the manual product save.
l
Customer creation error displayed to the user equal to the one seen during the manual customer save.
994 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Import
Import
Data for all product types can be imported into the store. In addition, you can import customer data, customer address data, and product images. Import supports the following operations: l
Add/Update l
Replace Existing Complex Data l
Delete Entities
The size of the import file is determined by the settings in the php.ini file on the server. The system message on the Import page indicates the current size limit.
Process Overview:
Step 2: Choose the Import Behavior
Step 3: Identify the Import File
Import
Magento Community Edition 2.1 User Guide 995
Import CHAPTER 75: Data Transfer
Step 1:
Prepare the Data
1.
On the Admin sidebar, tap System. Then under Data Transfer, choose Import.
2.
Under Import Settings, set Entity Type to one of the following: l
Advanced Pricing l
Products l
Customers and Addresses l
Customers Main File l
Customer Addresses
3.
Tap Download Sample File. Then on the download menu in the lower-left corner of your browser window, choose Open.
996
Download Sample File
The sample file includes column headings with placeholder data for example product types.
Downloaded Sample File
Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Import
4.
Examine the structure of the sample file. As you prepare your CSV import file, make sure that the column headings are spelled correctly.
5.
Verify that the size of your import file does not exceed the limit shown in the message.
6.
If the import data includes paths to product images, make sure that the image files have been uploaded to the appropriate location. The default location on the Magento server is: pub/media/import.
If the images reside on an external server, make sure that you have the full URL to the directory that contains the images.
Step 2:
Choose the Import Behavior
1.
Set Import Behavior to one of the following: l
Add/Update l
Replace Existing Complex Data l
Delete Entities
2.
Do the following:
a.
Accept the default value of a comma (,) for the Field separator.
b.
Accept the default value of a comma (,) for the Multiple value separator.
In a CSV file, a comma is the default separator. To use a different character, make sure that the data in the CSV file matches the character that you specify.
Import Behavior
Step 3:
Identify the Import File
1.
Tap
Choose File
to select the file to import.
2.
Find the CSV file that you prepared to import, and tap
Open
.
Magento Community Edition 2.1 User Guide 997
Import CHAPTER 75: Data Transfer
3.
If the import data includes paths to product images, enter one of the following in the Images
File Directory
field: l
The path to the uploaded images on the Magento server. For example: var/import.
l
The full URL to the images on another server. For example: http://domain.com/images
To learn more about importing product images, see:
.
File to Import
Step 4:
Check the Import Data
1.
In the upper-right corner, tap
Check Data
.
2.
Then, wait a few moments for the validation process to complete. If the import data is valid, the following message appears:
998
File is Valid!
3.
If the file is valid, tap
Import
. Otherwise, correct each problem with the data that is listed in the message, and try to import the file again.
4.
The import process continues to the end of the data, unless an error is encountered.
If an error message appears in the Validation Results, correct the problem in the data, and import the file again. For a list of known errors, see: Import Troubleshooting .
URL Key Already Exists
A message appears when the import is complete.
Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Import
Import Behavior
OPERATION
Add/Update
DESCRIPTION
New product data is added to the existing product data for the existing entries in the database. All fields except sku can be updated.
New tax classes that are specified in the import data are created automatically.
New product categories that are specified in the import file are created automatically.
New SKUs that are specified in the import file are created automatically
Replace Existing Complex
Data
The existing product data is replaced with new data.
Exercise caution when replacing data because the existing product data will be completely cleared and all references in the system will be lost.
Delete Entities
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.
Any entities in the import data that already exist in the database are deleted from the database.
Delete ignores all columns in the import data, except for SKU. You can disregard all other attributes in the data.
An error occurs if the CSV file references a SKU that does not exist in the database. You can Check Data to display error.
Magento Community Edition 2.1 User Guide 999
Import CHAPTER 75: 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.
2.
Under Data Transfer, choose Import History.
Import History
1000 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Import
Importing Product Images
Multiple product images of each type can be imported into Magento, and associated with a specific product. The path and file name of each product image is entered in the CSV file, and the image files to be imported are uploaded to the corresponding path on the Magento server or external server.
Magento creates its own directory structure for product images that is organized alphabetically.
When you export product data with existing images to a CSV file, you can see the alphabetized path before the file name of each image. However, when you import new images, you don’t need to specify a path, because Magento manages the directory structure automatically. Just make sure to enter the relative path to the import directory before the file name of each image to be imported.
To upload images, you must have login credentials and correct permissions to access to the
Magento folder on the server. With the correct credentials, you can use any SFTP utility to upload the files from your desktop computer to the server.
Before you try to import a large amount of images, review the steps in the import method that you want to use, and run through the process with a few products. After you understand how it works, you’ll feel confident importing large quantities of images.
Important! We recommend that you use a program that supports UTF-8 encoding to edit CSV files, such as Notepad++ or OpenOffice Calc . Microsoft Excel inserts additional characters into the column header of the CSV file, which can prevent the data from being imported back into Magento.
Method 1:
Import Images from the Local Server
1.
On the Magento server, upload the image files to the pub/media/import folder. This is the default folder for importing product images.
[magento installation folder]/pub/media/import
You can use a different folder on the Magento server, as long as the path to the folder is specified during the import process.
2.
In the CSV data, enter the name of each image file to be imported on the correct row, by sku, and in the correct column according to image type (base_image, small_image, thumbnail_ image, or additional_images).
For images in the default import folder(/pub/media/import), do not include the path before the filename in the CSV data.
The CSV file must include only the sku column and the related image columns.
Magento Community Edition 2.1 User Guide 1001
Import CHAPTER 75: Data Transfer
CSV Import Image from Default Location
3.
Follow the instructions to
the data.
After selecting the file to import, enter the relative path following Images File Directory:
/pub/media/import
Images File Directory
If importing multiple images for a single sku, insert a blank row below the sku, and enter the additional image file names in the appropriate columns. The additional rows are understood to belong to the parent sku.
Method 2:
Import Images from External Server
1.
Upload the images to be imported to the designated folder on the external server.
2.
In the CSV data, enter the full URL for each image file in the correct column by image type
(base_image, small_image, thumbnail_image, or additional_images).
http://example.com/images/image.jpg
3.
Follow the instructions to
the data.
1002 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Import
Import Guidelines
New Entities
Entities are added with the attribute values specified in the CSV file.
If there is no value, or there is a non-valid value, for a required attribute with no default value set, then the entity (the corresponding row or rows) cannot be imported.
If there is no value, or there is a non-valid value, for a required attribute with the default value set, then the entity (the corresponding row or rows) is imported, and the default value is set for the attribute.
If the complex data is not valid, then the entity (the corresponding row or rows) cannot be imported.
Existing Entities
For attributes that are not complex data, the values from the import file, including the empty values for the non-required attributes, replace the existing values.
If there is no value, or there is a non-valid value, for a required attribute, then the existing value is not replaced.
If the complex data for the entity is invalid, the entity (the corresponding row or rows) cannot be imported, except the case, when Delete Entities was selected in the Import
Behavior drop-down menu.
Magento Community Edition 2.1 User Guide 1003
Import CHAPTER 75: 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 _<non-existing name> heading.
1004 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Export
Export
The best way to become familiar with the structure of your database is to export the data and open it in a spreadsheet. Once you become familiar with the process, you’ll find that it is an efficient way to manage large amounts of information.
To export data:
1.
On the Admin sidebar, tap System. Then under Data Transfer, choose Export.
2.
In the Export Settings section, specify the following:
a.
Set Entity Type to one of the following: l
Products l
Customers Main File l
Customer Addresses
b.
Accept the default Export File Format of “CSV.”
Export Settings
3.
The Entity Attributes section lists all the available attributes in alphabetical order. You can use the standard
to search for specific attributes, and to sort the list. The Search and
Reset Filter controls control the display of the list, but have no effect on the selection of attributes to be included in the export file.
Filtered Entity Attributes
Magento Community Edition 2.1 User Guide 1005
Export CHAPTER 75: Data Transfer
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.
1006 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Export
Export Criteria
Export filters are used to specify the data that you want to in the export file, based on attribute value. In addition, you can specify which attribute data you want to include or exclude from the export.
Export Criteria
Magento Community Edition 2.1 User Guide 1007
Export CHAPTER 75: Data Transfer
Export Filters
You can use filters to determine which SKUs are included in the export file. For example, if you enter a value in the Country of Manufacture filter, the exported CSV file will incude only products manufactured in that country.
The type of filter corresponds to the data type. For date fields, you can choose the date from the
Calendar . To learn more, see:
. The format of the date is determined by the
.
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 FILTER
No
RESULT
The exported file contains each attribute for all existing records.
Yes
No
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.
The export file does not include the column for the excluded attribute, and contains only the records allowed by the filter.
1008 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Product Attribute Reference
The following table lists the attributes from a typical product export, in the default order in which they appear. Each attribute is represented in the CSV file as a column, and product records are represented by rows. Columns that begin with an underscore contain service data such as properties or option values for complex data.
The installation used to export this data has the sample data installed, and has two websites and several store views. Although this list includes all columns that are typically exported, the sku is the only required value. To import data, you can include only the columns with changes.
The sku should be the first column, but the order of the rest of the attributes doesn’t matter.
Simple Product CSV File Structure
ATTRIBUTE
sku
DESCRIPTION
(Required) The Stock-Keeping Unit is a unique, alphanumeric identifier that is used to track inventory. A
SKU can be up to 64 characters in length. For example: sku123
A SKU longer than 64 characters will cause import to fail.
store_view_code attribute_set_code product_type
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
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
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 Community Edition 2.1 User Guide 1009
Product Attribute Reference CHAPTER 75: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
configurable categories product_websites name description virtual bundle
A product with multiple options that the customer must select before making a purchase.
Inventory can be managed for each set of variations because they represent a separate product with a distinct SKU. For example, a combination of color and size for a configurable product is associated with a specific SKU in the catalog.
A non-tangible product that does not require shipping and is not kept in inventory. Examples include services, memberships, and subscriptions.
A customizable product set of simple products that are sold together.
Indicates each category that is assigned to the product.
Separate categories and subcategories with a forward slash. To indicate multiple category paths, separate each path with a pipe “|” symbol. For example:
Default Category/Gear|Default Category/Gear/Bags
The
of each website where the product is available. A single product can be assigned to multiple websites, or limited to one. If specifying multiple websites, separate each with a comma and without a space. For example: base base,website2
The product name appears in all product listings, and is the name that customers use to identify the product.
The product description provides detailed information about the product, and might include simple HTML tags.
1010 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE
short_description
DESCRIPTION
The use of the short product description depends on the theme. It might appear in product listings and is sometimes used in RSS feed listings sent to shopping sites.
weight product_online
The weight of the individual product. The actual product weight is determined by the carrier at the time of shipment.
Determines if the product is available for sale in the store. Values:
1 (Yes) The product is enabled, and available for sale.
2 (No) The product is disabled, and is not available for sale.
tax_class_name visibility
The name of the tax class that is associated with this product.
Determines if the product is visible in the catalog, and made available for search. Values:
Not Visible
Individually
The product is not included in product listings, although it might be available as a variation of another product.
Catalog The product appears in all catalog listings.
Search
Catalog, Search
The product is available for search operations.
The product is included in catalog listings and is also available for search.
price special_price special_price_from_date
The price that the product is offered for sale in your store.
The discounted price of the product during the specified date range.
The beginning date of the time period when the special price is in effect.
Magento Community Edition 2.1 User Guide 1011
Product Attribute Reference CHAPTER 75: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE
special_price_to_date
DESCRIPTION
The last date of the time period when the special price is in effect.
url_key meta_title meta_keywords meta_description base_image base_image_label small_image small_image_label thumbnail_image
The part of the URL that identifies the product. The default value is based on the product name. For example: product-name
The meta title appears in the title bar and tab of the browser and search results lists. The meta title should be unique to the product, incorporate high-value keywords, and be less than 70 characters in length.
Meta keywords are visible only to search engines, and are ignored by some search engines. Choose high-value keywords, separated by a comma. For example: keyword1,keyword2,keyword3.
Meta descriptions provide a brief overview of the product for search results listings. Ideally, a meta description should be between 150-160 characters in length, although the field accepts up to 255 characters.
The relative path for the main image on the product page.
Magento stores files internally in an alphabetical folder structure.You can see the exact location of each image in the exported data. For example:
/sample_data/m/b/mb01-blue-0.jpg
To upload a new image or write over an existing image, enter the file name, preceded by a forward slash. For example: /image.jpg
The label that is associated with the base image.
The file name of the small image that is used on catalog pages, preceded by a forward slash. For example:
/image.jpg
The label associated with the small image. For example:
Small Image 1, Small Image 2
The file names of any thumbnail image to appear in the gallery on the product page, preceded by a forward slash.
For example:
/image.jpg
1012 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE
thumbnail_image_label
DESCRIPTION
The label associated with any thumbnail images. For example:
Thumbnail 1, Thumbnail 2 created_at updated_at new_from_date new_to_date display_product_options_in map_price msrp_price map_enabled
Indicates the date when the product was created. The date is automatically generated when the product is created, but can be edited later.
Indicates the date when the product was last updated.
Specifies the “from” date for new product listings, and determines if the product is featured as a new product.
Specifies the “to” date for new product listings, and determines if the product is featured as a new product.
If the product has multiple options, determines where they appear on the product page. Values:
Product Info Column
Block after Info Column
The minimum advertised price of the product. (Appears only if MAP is enabled.)
The manufacturer’s suggested retail price for the product.
(Appears only if MAP is enabled.)
Determines if Minimum Advertised Price is enabled in the configuration. Values:
1 (Yes) MAP is enabled.
0 (or blank) (No) MAP is not enabled.
gift_message_available custom_design
Determines if a gift message can be included with the product purchase. Values:
1 (Yes) The option to include a gift message is presented to the customer.
0 (or blank) (No) The option to include a gift message is not presented to the customer.
Lists the available themes that can be applied to the product page.
Magento Community Edition 2.1 User Guide 1013
Product Attribute Reference CHAPTER 75: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE
custom_design_from
DESCRIPTION
Specifies the beginning date when the selected theme is applied to the product page.
custom_design_to custom_layout_update page_layout
Specifies the end date when the selected theme is applied to the product page.
Additional XML code that is applied as a layout update to the product page.
Determines the page layout of the product page. Values:
No layout updates No change is made to the page layout.
1 column
2 columns with left bar
Applies a one- column layout to the product page.
Applies a two-column layout with a left sidebar to the product page.
2 columns with right bar
3 columns empty
Applies a two-column layout with a right sidebar to the product page.
Applies a three-column layout to the product page.
Applies a blank layout to the product page.
product_options_container msrp_display_actual_price_type
If the product has multiple options, determines where they appear on the product page. Values:
Product Info Column
Block after Info Column
Determines where the actual price of a product is visible to the customer.Values:
In Cart Displays the actual product price in the shopping cart.
Before Order
Confirmation
Displays the actual product price at the end of the checkout process, just before the order is confirmed.
1014 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
On Gesture country_of_manufacture additional_attributes qty out_of_stock_qty use_config_min_qty
Displays the actual product price in a popup when the customer clicks the “Click for price” or
“What’s this?” link.
Identifies the country where the product was manufactured.
Additional attributes created for the product. For example: has_options=0,required_options=0 color=Black,has_options=0,required_options=0,size_ general=XS
The quantity of the product that is currently in stock.
The stock level that determines the product to be out of stock.
Determines if the default value from the configuration is used, and corresponds to the Use Config Settings checkbox. Values:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
is_qty_decimal allow_backorders use_config_backorders
Determines if the qty attribute has a decimal value.
Values:
1 (Yes) The value of the qty attribute is a decimal value.
0 (or blank) (No) The value of the qty attribute is a whole number (integer).
Determines if your store allows backorders, and how they are managed.
Determines if the default configuration setting for backorders is used, and corresponds to the state of the
Use Config Settings checkbox. Values:
Magento Community Edition 2.1 User Guide 1015
Product Attribute Reference CHAPTER 75: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
min_cart_qty use_config_min_sale_qty max_cart_qty use_config_max_sale_qty is_in_stock notify_on_stock_below use_config_notify_stock_qty
Specifies the minimum quantity of the item that can be purchased in a single order.
Determines if the default configuration setting for minimum quantity is used, and corresponds to the state of the Use Config Settings checkbox.. Values:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
Specifies the maxinum quantity of the product that can be purchased in a single order.
Determines if the default configuration setting for maximum quantity is used, and corresponds to the state of the Use Config Settings checkbox.. Values:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
Indicates if the product is in stock.
Specifies the stock level that triggers an “out of stock” notification.
Determines if the default configuration setting is used to trigger stock level notification, and corresponds to the state of the Use Config Settings checkbox. Values:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
1016 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE
manage_stock
DESCRIPTION
Determines if inventory control is used to manage the product. Values:
1 (Yes) Activates full inventory control to manage stock levels of the product.
0 (or blank) (No) The system does not keep track of the number of items that are currently in stock.
use_config_manage_stock Determines if the default configuration setting for managing stock is used, and corresponds to the state of the Use Config Settings checkbox. Values:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
use_config_qty_increments qty_increments use_config_enable_qty_inc enable_qty_increments
Determines if the default configuration setting for quantity increments is used, and corresponds to the state of the Use Config Settings checkbox.. Values:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
Determines if the product is sold in quantity increments.
Options: Yes / No
Determines if the default configuration setting to enable quantity increments is used, and corresponds to the state of the Use Config Settings checkbox. Values:
1 (Yes) The default configuration setting is used for the value of this attribute.
0 (or blank) (No) The default configuration can be overridden for the value of this attribute.
Determines if quantity increments are enabled for the product.
Magento Community Edition 2.1 User Guide 1017
Product Attribute Reference CHAPTER 75: Data Transfer
Simple Product CSV File Structure (cont.)
ATTRIBUTE
is_decimal_divided
DESCRIPTION
Determines if parts of the product can be shipped separately. Options: Yes / No website_id related_skus crosssell_skus upsell_skus additional_images additional_image_labels custom_options
For installations with multiple websites, identifies a specific website where the product is available. If blank, the product is available in all websites.
Lists the sku of each product that has been identified as a
Related Product . For example:
24-WG080,24-UG03,24-UG01,24-UG02
Lists the sku of each product that has been identified as a
.
Lists the sku of each product that has been identified as an
The file names of any additional image to be associated with the product, preceded by a forward slash. For example:
/image.jpg
The labels associated with any additional images. For example:
Label 1, Label 2
Specifies the propererties and values assigned to each custom option. For example: name=Color,type=drop_down,required=1,price= price_ type=fixed, sku=,option_ title=Black|name=Color,type=drop_ down,required=1,price=, price_type=fixed,sku=,option_ title=White
SERVICE DATA FOR PRODUCT VARIATIONS
_super_products_sku The generated SKU for a configurable product variation.
For example: WB03-XS-Green
Applies to:
Configurable Products
_super_attribute_code The attribute code of a configurable product variation. For example: color
Applies to:
1018 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Simple Product CSV File Structure (cont.)
ATTRIBUTE DESCRIPTION
Configurable Products
_super_attribute_option
_super_attribute_price_corr
_associated_sku
_associated_default_qty
_associated_position
The value of a configurable product variation. For example: green
Applies to:
Configurable Products
A price adjustment that is associated with a configurable product variation.
Applies to:
Configurable Products
The SKU of a product that is associated with a grouped product.
Applies to:
Grouped Products
Bundle Products
Determines the quantity of the associated product that is included. Applies to:
Configurable Products
Grouped Products
Bundle Products
Determines the position of the associated product when listed with other associated products. Applies to:
Configurable Products
Grouped Products
Bundle Products
Magento Community Edition 2.1 User Guide 1019
Product Attribute Reference CHAPTER 75: Data Transfer
Complex Data
The term complex data
1 refers to the data that is associated with multiple product options.
The following product types use data that originates from separate products to create product variations and multiple options.
l
l
l
If you were to export a configurable product, you would find the standard attributes that make up a simple product, plus the additional attributes that are needed to manage complex data.
1020
Exported Configurable Product Data
Complex Data Attributes
ATTRIBUT
E DESCRIPTION
CONFIGURABLE PRODUCTS
configurabl e_ variation_ labels
Labels that identify product variations. For example:
Choose Color:
Choose Size: configurabl e_ variations
Describes the values associated with a product variation. For example: sku=sku-red xs,color=red,size=xs,price=10.99,display=1,image=/pub/media/import/image1.pn
g|sku=sku-redm,color=red,size=m,price=20.88,display=1,image=/pub/media/import/image2.pn
g
1Data that is associated with multiple product options.
Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Complex Data Attributes (cont.)
ATTRIBUT
E DESCRIPTION
GROUPED PRODUCTS
associated_ skus
Identifies the SKUs of the individual products that make up the group.
BUNDLE PRODUCTS
bundle_ price_type
Determines if the price of a bundle item is fixed or dynamic.
bundle_sku_ type
Determines if each item is assigned a variable, dynamic SKU, or if a fixed SKU is used for the bundle. Options include: Fixed / Dynamic.
bundle_ weight_type
Determines if the weight of a bundle item is variable or fixed.
bundle_ values
Describes teach value associated with a bundle option. For example: name=Bundle Option One,type=dropdown; required=1, sku=skuoption2,price=10, price_type=fixed
Magento Community Edition 2.1 User Guide 1021
Product Attribute Reference CHAPTER 75: Data Transfer
Advanced Pricing
Advanced Price Import/Export allows you to quickly update pricing information for product groups and tier prices. The process to
and
advanced price data is the same as any other entity type. The sample CSV file contains tier and group prices for each product type that supports advanced pricing. Making changes to advanced pricing does not affect the rest of the product record.
1022
Advanced Price Sample File
Advanced Pricing Attributes
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.
tier_price_website tier_price_customer_ group tier_price_qty tier_price group_price_website
The
identifies each website where tier pricing is available. For example: website1
All Websites [USD]
Identifies the
where tier pricing is available. For example:
ALL GROUPS
NOT LOGGED IN
General
Wholesale
Retailer
The quantity of the product that must be ordered to receive the tier price discount.
The discounted tier price of the product. For
products, tier price is calculated as a percentage.
The
of each website where group pricing is available. If specifying multiple websites, separate each with a comma and without a space. For example: website1
Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer Product Attribute Reference
Advanced Pricing Attributes (cont.)
ATTRIBUTE DESCRIPTION
All Websites [USD] group_price_customer_ group
Identifies the
where group pricing is available. For example:
NOT LOGGED IN
General
Wholesale
Retailer group_price The discounted group price of the product. For
products, group price is calculated as a percentage.
Magento Community Edition 2.1 User Guide 1023
Customer Attribute Reference CHAPTER 75: Data Transfer
Customer Attribute Reference
The following tables list the attributes from a typical export of the Customers Main File and
Customer Addresses. The installation that was used to export this data has two websites and several store views, with the sample data installed.
Each attribute, or field, is represented in the CSV file as a column, and customer records are represented by rows. Columns that begin with an underscore are service entities that contain properties or complex data.
Customers Main File
ATTRIBUTE
DESCRIPTION
_website
_store confirmation created_at created_in disable_auto_group_change dob firstname gender group_id lastname middlename password_hash prefix rp_token rp_token_created_at store_id suffix
1024 Magento Community Edition 2.1 User Guide
CHAPTER 75: Data Transfer
Customers Main File (cont.)
ATTRIBUTE
taxvat
DESCRIPTION
website_id password
Customer Addresses
ATTRIBUTE
_website
_email
_entity_id city company country_id fax firstname lastname middlename postcode prefix region region_id street suffix telephone vat_id vat_is_valid vat_request_date vat_request_id vat_request_success
DESCRIPTION
Magento Community Edition 2.1 User Guide
Customer Attribute Reference
1025
Customer Attribute Reference CHAPTER 75: Data Transfer
Customer Addresses (cont.)
ATTRIBUTE DESCRIPTION
_address_default_ billing_
Identifies the default billing address. A value of 1 indicates that the address is the default billing address of the customer. Values: 1 / 0
_address_default_ shipping_
Identifies the default shipping address. A value of 1 indicates that the address is the default shipping address of the customer. Values: 1 / 0
1026 Magento Community Edition 2.1 User Guide
CHAPTER 76:
Integrations
Establishes the location of OAuth credentials and redirect URL for third-party integrations, and identifies the available API resources that are needed for the integration.
Integrations
Magento Community Edition 2.1 User Guide 1027
Onboarding Workflow CHAPTER 76: Integrations
Onboarding Workflow
Authorize the integration. Go to the system/integration screen, find the relevant integration, and authorize.
Verify and establish login. When prompted, accept the access requested. If redirected to a third-party, log in to the system, or create a new account. After a successful login, you return to the integration page.
Receive confirmation of authorized integration. The system sends notification that the integration has been authorized successfully. After setting up an integration and receiving the credentials, it is no longer necessary to make calls to access or request tokens.
1028 Magento Community Edition 2.1 User Guide
CHAPTER 76: Integrations Onboarding Workflow
To add a new integration:
1.
On the Admin sidebar, tap System. Then under Extensions, choose Integrations.
2.
Enter the following Integration Info:
a.
Enter the Name of the integration, and the contact Email address.
b.
Enter the Callback URL where OAuth credentials can be sent when using OAuth for token exchange. We strongly recommend using https://.
c.
Enter the Identity Link URL to redirect the users to a third-party account with these
Magento integration credentials.
New Integration
3.
In the panel on the left, choose API. Then, do the following:
a.
Set Resource Access to one of the following: l
All l
Custom
b.
For custom access, mark the checkbox of each resource that is needed:
Magento Community Edition 2.1 User Guide 1029
Onboarding Workflow CHAPTER 76: Integrations
4.
When complete, tap
Save
.
Resources Needed for Custom Access
1030 Magento Community Edition 2.1 User Guide
CHAPTER 76: Integrations Onboarding Workflow
To change the API guest access security setting:
By default, the system does not permit anonymous guest access to CMS, catalog, and other store resources. If you need to change the setting, do the following:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Services, choose Magento Web API.
3.
Expand the Web API Security Setting section.
Web API Security
4.
Set Allow Anonymous Guest Access to “Yes,”
5.
When complete, tap
Save Config
.
To learn more, see: “ Restricting access to anonymous web APIs ” in the Magento developer documentation.
Magento Community Edition 2.1 User Guide 1031
Magento Marketplace CHAPTER 76: Integrations
Magento Marketplace
Magento Marketplace is our next generation application store that offers merchants a curated selection of solutions, and provides qualified developers the tools, platform, and prime location to build a thriving business. To learn more, see the Magento Marketplace User Guide .For
extension installation instructions, see
in this guide, or the Marketplace
Quick Tour .
Magento Marketplace
1032 Magento Community Edition 2.1 User Guide
CHAPTER 76: Integrations Magento Connect
Magento Connect
Magento Connect is Magento’s original marketplace for Magento extensions. There are hundreds of extensions and themes available from all over the world. Magento out-of-the-box supports a few of the most popular ones. However, community members are developing and publishing new extensions in order to extend Magento with various new features.
Magento Connect
Magento Community Edition 2.1 User Guide 1033
1034 Magento Community Edition 2.1 User Guide
CHAPTER 77:
Permissions
Magento uses roles and permissions to create different levels of access to the Admin. When your store is first set up, you receive a set of login credentials for the Administrator role that has full permissions. However, you can restrict the level of permissions on a “need to know” basis for other people who work on your site. For example, a designer can be given access to only the Design tools, but not to areas with customer and order information.
In addition, you can further restrict Admin access to only a specific site, or set of sites and their associated data. If you have multiple brands or business units with separate stores on the same Magento installation, you can provide Admin access to each of your business units but hide and protect their data from other Admin users.
If an Admin user’s access is restricted to specific websites and/or stores, the websites and stores for which they are not authorized will either not be visible to them, or grayed-out as inactive. Only the sales and other data for permitted websites and stores is shown.
All Users
Magento Community Edition 2.1 User Guide 1035
Adding Users CHAPTER 77: Permissions
Adding Users
When your store is first installed, your login credentials give you full administrative access. As a best practice, one of the first things you should do is to create another user account with full
Administrator permissions. That way, you can use one account for your everyday
Administrative activities, and reserve the other as a “Super Admin” account in case you forget your regular credentials or they somehow become unusable.
If there are others on your team, or service providers who need access, you can create a separate user account for each, and assign restricted access. To limit the websites or stores that admin users can access when they log in, you must first create a role with limited scope and access to resources. Then, you can assign the role to a specific user account. Admin users who are assigned to a restricted role can see and change data only for websites or stores that are associated with the role. They cannot make changes to any global settings or data.
Step 1:
Create a New User
1.
On the Admin sidebar tap System. Then under Permissions, choose All Users.
2.
In the upper-right corner, tap
Add New User
.
3.
In the Account Information section, do the following:
1036
New User Account Information
Magento Community Edition 2.1 User Guide
CHAPTER 77: Permissions Adding Users
a.
Enter the User Name for account.
The User Name should be easy to remember. It is not case-sensitive. For example, if your user name is “John,” you can also log in as “john.”
b.
Complete the following information: l
First Name l
Last Name l
Email address
This email address must be different from the one that is associated with your original
Admin account.
c.
Assign a Password to the account.
An Admin password must be seven or more characters long, and include both letters and numbers.
d.
In the Password Confirmation box, repeat the password to make sure it was entered correctly.
e.
If your store has multiple languages, set Interface Locale to the language to be used for the Admin interface.
4.
Set This Account is to “Active.”
5.
Under Current User Identity Verification, enter Your Password.
Current User Identity Verification
Magento Community Edition 2.1 User Guide 1037
Adding Users CHAPTER 77: Permissions
Step 2:
Define the Role
1.
In the panel on the left, choose User Role. The grid lists all the existing roles. For a new store,
Administrators is the only role available.
2.
In the Assigned column, select the
Administrators
option.
3.
Tap
Save User
.
You now have two accounts with Administrator access.
Add New User Role
Admin Password Requirements
FIELD
Password
DESCRIPTION
An Admin password must be seven or more characters long, and include both letters and numbers. For additional password options, see:
.
1038 Magento Community Edition 2.1 User Guide
CHAPTER 77: Permissions Locked Users
Locked Users
For the security of your business, user accounts are locked by default after six failed attempts to
to the Admin. Any user account that is currently locked appears in the Locked Users grid. An account can be unlocked by any other user with full Administrator permissions.
Additional password security measures can be implemented in the Advanced Admin configuration. To learn more, see:
Admin Account Disabled
To unlock an admin account:
1.
On the Admin sidebar, tap System. Then under Permissions, choose Locked Users.
2.
In the grid, mark the checkbox of the locked account.
Locked Users
3.
In the upper-left corner, set the Actions control to “Unlock.”
4.
Tap
Submit
to unlock the account.
Magento Community Edition 2.1 User Guide 1039
User Roles CHAPTER 77: Permissions
User Roles
To give someone restricted access to the Admin, the first step is to create a role that has the appropriate level of permissions. After the role is saved, you can add new users and assign the restricted role to grant them limited access to the Admin.
Roles
1040 Magento Community Edition 2.1 User Guide
CHAPTER 77: Permissions User Roles
Step 1:
Define the Role
1.
On the Admin sidebar, tap System. Then under Permissions, choose User Roles.
2.
In the upper-right corner, tap
Add New Role
.
3.
Under Role Information, enter a descriptive Role Name. Then under Current User Identity
Verification, enter Your Password.
Role Name
Step 2:
Assign Resources
Important! When assigning resources, be sure to disable access to the Permissions tool if you are limiting access for a given role. Otherwise, users will be able to modify their own permissions.
1.
Under Roles Resources, set Resource Access to "Custom."
2.
In the tree, mark the checkbox of each Admin Resource that the role can access.
3.
When complete, tap
Save Role
.
Magento Community Edition 2.1 User Guide
Role Resources Assigned
1041
User Roles CHAPTER 77: Permissions
The role now appears in the grid, and can be assigned to new user accounts.
To edit a role:
1.
In the Roles grid, and tap the row to open the record in edit mode.
2.
Under Current User Identity Verification, enter Your Password.
1042
Editing a Role
3.
In the panel on the left, choose Role Users.
The Role Users option appears only after a new role is saved.
4.
To search for a specific user record, do the following:
a.
Enter the value in the search filter at the top of a column. Then, press Enter.
b.
When you are ready to return to the full list, click Reset Filter.
5.
Mark the checkbox of any user(s) to be assigned to the role.
6.
Tap
Save Role
.
Role Users
Magento Community Edition 2.1 User Guide
CHAPTER 77: Permissions Alternate Media Storage
Alternate Media Storage
Magento Community Edition 2.1 gives you the option to store media files in a database on a database server, or on a Content Delivery Network (CDN), as opposed to storing them on the file system of the web server. The advantage of using alternate storage is that it minimizes the effort required to synchronize media when multiple instances of the system that are deployed on different servers that need access to the same images, CSS files, and other media files.
l
l
(CDN)
Magento Community Edition 2.1 User Guide 1043
Alternate Media Storage CHAPTER 77: Permissions
Using a Database
By default, all images, compiled CSS files, and compiled JavaScript files of the Magento instance are stored in the file system on the web server. You can choose to store these files in a database on a database server. One advantage of this approach is the option of automatic synchronization and reverse synchronization between the web server file system and the database. You can use the default database to store media or create a new one. To be able to use a newly created database as media storage, you must add information about it and its access credentials to the local.xml file.
Database Workflow
Browser requests media. A page from the store opens in the customer’s browser, and the browser requests the media that is specified in the HTML.
System looks for media in file system. The system searches for the media in the file system and if found, passes it to the browser.
System locates media in database. If the media is not found in the file system, a request for the media is sent to the database that is specified in the configuration.
System locates media in database. A PHP script transfers the files from the database to the file system, and sent to the customer’s browser. The browser request for media triggers the script to run as follows: l
If web server
are enabled for Magento and supported by the server, the PHP script runs only when the requested media is not found in the file system.
l
If web server rewrites are disabled for Magento, or not supported by the server, the
PHP script runs anyway, even if the required media is available in the file system.
1044 Magento Community Edition 2.1 User Guide
CHAPTER 77: Permissions Alternate Media Storage
To use a database for media storage:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Advanced, choose System.
3.
In the upper-left corner set Store View to “Default Config,” to apply the configuration at the global level.
4.
Expand the Storage Configuration for Media section. Then, do the following:
Storage Configuration for Media (Database)
a.
Set Media Storage to “Database.”
b.
Set Select Media Database to the database you want to use.
c.
Tap
Synchronize
to transfer the existing media to the newly selected database.
d.
Enter the Environment Update Time in seconds.
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 1045
Alternate Media Storage CHAPTER 77: Permissions
Using a Content Delivery Network
Storing media files in a CDN is another alternative supported in Magento. There is no full integration with a specific CDN, and you are responsible for choosing and configuring a CDN on your own.
After configuring the CDN, you must complete the configuration from the Admin. The changes can be made at either the global or website level. When a CDN is used for media storage, all paths to media on store pages are changed to the CDN paths that are specified in the configuration.
CDN Workflow
Browser requests media. A page from the store opens in the customer’s browser, and the browser requests the media that is specified in the HTML.
Request sent to CDN; images found and served. The request is sent first to the
CDN. If the CDN has the images in storage, it serves the media files to the customer's browser.
Media not found, request sent to Magento web server. If the CDN doesn’t have the media files, the request is sent to the Magento web server. If the media files are found in the file system, the web server sends them to the customer’s browser.
Important! For security, when a CDN is used as media storage, JavaScript may not function properly if the CDN is located outside of your subdomain.
1046 Magento Community Edition 2.1 User Guide
CHAPTER 77: Permissions Alternate Media Storage
To configure a content delivery network:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Web.
3.
In the upper-left corner, set Store View as needed.
4.
Expand the Base URLs section. Then, do the following:
Base URLs
a.
Update the Base URL for Static View Files with the URL of the location on the CDN where static view files are stored.
b.
Update the Base URL for User Media Files with the URL of the JavaScript files on the
CDN.
Both these fields can be left blank, or can start with the placeholder: {{unsecure_base_ url}}
5.
Expand the Base URLs (Secure) section.
Magento Community Edition 2.1 User Guide
Base URLs (Secure)
1047
Alternate Media Storage CHAPTER 77: Permissions
a.
Update the Secure Base URL for Static View Files with the URL of the location on the
CDN where static view files are stored.
b.
Update the Secure Base URL for User Media Files with the URL of the JavaScript files on the CDN.
Both these fields can be left blank, or can start with the placeholder: {{unsecure_base_ url}}
6.
When complete,tap
Save Config
.
1048 Magento Community Edition 2.1 User Guide
CHAPTER 78:
Security
In this section of the guide, you will learn security best practices, how to manage Admin sessions and credentials, implement CAPTCHA, and manage website restrictions.
l
l
l
l
l
Browser Capabilities Detection
l
Stop by the Security Center and sign up for the Security Alert Registry to receive the latest information on potential vulnerabilities and best practices.
Security Center
Magento Community Edition 2.1 User Guide 1049
Security Best Practices CHAPTER 78: Security
Security Best Practices
All eCommerce sites are attractive targets to hackers because of the personal and payment information that is required to complete a sale. Even if the system does not directly process credit card transactions, a compromised site might reroute customers to a false page, or alter an order before it is transmitted to the payment processor.
A compromised site can have long-term consequences for both customers and merchants.
Customers might suffer financial loss and identify theft, while merchants can face damage to their reputations, loss of merchandise, higher processing fees, revoked privileges with financial institutions, and the threat of lawsuits.
This guide outlines a multifaceted approach to improve the security of your Magento installation. Although there is no single way to eliminate all security risks, there are many things that you can do to make your site a less attractive target. It is crucial for hosting providers, system integrators, and merchants to work together to establish and maintain a secure environment, implement methods for early detection, and determine a plan of action in the event of a breach.
Start Right
Work with reliable hosting providers and solution integrators. When evaluating their qualifications, ask about their approach to security. Verify that they have a secure software development life cycle in accord with industry standards such as The Open Web Application
Security Project ( OWASP ), and that they test their code for security issues.
If you are starting a new site, consider launching the entire site over HTTPs. Taking the lead on this issue, Google now uses HTTPs as a ranking factor.
For an existing installation, plan to upgrade the entire site to run over to a securely encrypted,
HTTPs channel. Although you will need to create redirects from HTTP to HTTPs, the effort will future-proof your site. We recommend that you plan to make this change sooner, rather than later.
1050 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security Security Best Practices
Protect the Environment
Protecting the environment is the most critical aspect of ensuring the security of your store.
Keep all software on the server up to date, and apply security patches as recommended. This applies not only to Magento, but to any other software that is installed on the server, including database software and other websites that use the same server. Any system is only as secure as the weakest link.
Server Environment
Make sure that the server operating system is secure. Work with your hosting provider to ensure that there is no unnecessary software running on the server.
Use only secure communications protocol (SSH/SFTP/HTTPS) to manage files, and disable FTP.
Magento includes .htaccess files to protect system files when using the Apache web server. If you use a different web server such as Nginx, make sure that all system files and directories are protected. For an sample Nginx configuration, see: magentonginx.conf
on GitHub.
Use strong and unique passwords, and change them periodically.
Keep the system up to date, and immediately install patches when new security issues are discovered.
Closely monitor any issues that are reported for software components used by your
Magento installation, including the operating system, MySQL database, PHP, Redis (if used), Apache or Nginx, Memcached, Solr, and any other components in your specific configuration.
Limit access to cron.php file to only required users. For example, restrict access by IP address. If possible, block access completely and execute the command using the system cron scheduler.
Advanced Techniques
Automate the deployment process, if possible, and use private keys for data transfer.
Limit access to the Magento Admin by updating the whitelist with the IP address of each computer that is authorized to use the Admin and Magento Connect downloader. For examples of how to whitelist IP addresses, see: Secure Your Magento Admin .
Do not install extensions directly on a production server.
To disable the Magento Connect downloader on the production site, either remove or block access to the /downloader directory. You can also use the same whitelisting methods.
Magento Community Edition 2.1 User Guide 1051
Security Best Practices CHAPTER 78: Security
Advanced Techniques (cont.)
Use two-factor authorization for Admin logins. There are several extensions available that provide additional security by requiring an additional passcode that is generated on your phone, or a token from a special device.
Review your server for “development leftovers.” Make sure there are no accessible log files, publicly visible .git directories, tunnels to execute SQL, database dumps, phpinfo files,or any other unprotected files that are not required, and that might be used in an attack.
Limit outgoing connections to only those that are required, such as for a payment integration.
Use a Web Application Firewall to analyze traffic and discover suspicious patterns, such as credit card information being sent to an attacker.
Server Applications
Make sure that all applications running on the server are secure.
Avoid running other software on the same server as Magento, especially if it is accessible from the Internet. Vulnerabilities in blog applications such as Wordpress can expose private information from Magento. Install such software on a separate server or virtual machine.
Keep all software up to date, and apply patches as recommended.
Admin Desktop Environment
Make sure that the computer that is used to access the Magento Admin is secure.
Keep your antivirus software up to date, and use a malware scanner. Do not install any unknown programs, or click suspicious links.
Use a strong password to log in to the computer, and change it periodically. Use a password manager such as LasstPass , 1Password , or Dashlane to create and manage secure, unique passwords.
Do not save FTP passwords in FTP programs, because they are often harvested by malware and used to infect servers.
1052 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security Security Best Practices
Protect Magento
Your effort to protect your Magento installation starts with the initial setup, and continues with the security-related configuration settings, password management, and ongoing maintenance.
Your Magento Installation
Use the latest version of Magento to ensure that your installation includes the most recent security enhancements.
If for any reason you cannot upgrade to the latest version, make sure to install all security patches as recommended by Magento. Although Magento issues security patches to fix major issues, new product releases include additional improvements to help secure the site.
Use a unique, custom Admin URL instead of the default “admin” or the often-used
“backend,” Although it will not directly protect your site from a determined attacker, it can reduce exposure to scripts that try to break into every Magento site. (Never leave your valuables in plain sight.)
Check with your hosting provider before implementing a custom Admin URL. Some hosting providers require a standard URL to meet firewall protection rules.
Block access to any development, staging, or testing systems. Use IP whitelisting and
.htaccess password protection. When compromised, such systems can produce a data leak or be used to attack the production system.
Use the correct file permissions. Core Magento and directory files should be set to ready only, including app/etc/local.xml files.
Use a strong password for the Magento Admin. To learn more, see: Creating a strong password .
Take advantage of Magento’s security-related configuration settings for Admin Security ,
Password Options , and CAPTCHA .
Don’t be Taken for a Ride
Install extensions only from trusted sources. Never use paid extensions that are published on torrent or other sites. If possible, review extensions for security issues before installing them.
Do not click suspicious links, or open suspicious email.
Do not disclose the password to your server or to the Magento Admin, unless you are required to do so.
Magento Community Edition 2.1 User Guide 1053
Security Best Practices CHAPTER 78: Security
Be Prepared!
Develop a disaster recovery/business continuity plan. Even a basic plan will help you get back on track in the event of a problem.
Ensure that your server and database are automatically backed up to external location. A typical setup requires daily incremental backups, with a full backup on a weekly basis.
Make sure to test the backup regularly to verify that it can be restored.
For a large site, simple text file dumps of the database take an unacceptable amount of time to restore. Work with your hosting provider to deploy a professional database backup solution.
Monitor for Signs of Attack
If your system is not immediately patched after a major security breach, there is a high probability that your site is already compromised. Complete a security review periodically to check for signs of attack, and also when contacted by customers with security-related concerns.
Security Review
Check periodically for unauthorized Admin users.
(Magento Enterprise only) Check the Admin Actions Log for suspicious activity.
Use automated log review tools such as Apache Scalp .
Work with your hosting provider to review server logs for suspicious activity, and to implement an Intrusion Detection System (IDS) on your network.
Use a file and data integrity checking tool such as TripWire to receive notification of any potential malware installation.
Monitor all system logins (FTP, SSH) for unexpected activity, uploads, or commands.
1054 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security Security Best Practices
Follow Your Disaster Recovery Plan
In the event of a compromise, work with your internal IT security team if available, or hosting provider, and system integrator to determine the scope of the attack. Taking into consideration the type of compromise and the size of the store. Then, adjust the following recommendations to your business needs.
1.
Block access to the site, so the attacker cannot remove evidence or steal more information.
2.
Backup the current site, which will include evidence of the installed malware or compromised files.
3.
Try to determine the scope of the attack. Was credit card information accessed? What information was stolen? How much time has elapsed since the compromise? Was the information encrypted? Typically you can expect the following types of attack:
Defacing of Site
Botnetting
Direct Attack on Server
Silent Card Capture
Site access is compromised, but often the payments information is not. User accounts might be compromised.
Your site becomes part of a botnet that sends spam email.
Although data is probably not compromised, your server is blacklisted by spam filters which prevents email that you send to customers from being delivered.
Data is compromised, backdoors and malware are installed, and the site no longer works. Payment information—provided that it is not stored on the server— is probably safe.
In this most disastrous attack, intruders install hidden malware or card capture software, or possibly modify the checkout process to collect and send out credit card data. Such attacks can go unnoticed for extended periods of time, and result in major compromise of customer accounts and financial information.
4.
Try to find the attack vector to determine how the site was compromised, and when. Review server log files and file changes. Note that sometimes there are multiple different attacks on the same system.
5.
If possible, wipe and reinstall everything. In case of virtual hosting, create a new instance.
Malware might be hidden in an unsuspected location, just waiting to restore itself. Remove all unnecessary files. Then, reinstall all required files from a known, clean source such as files from your own version control system, or the original distribution files from magento.com.
6.
Apply all the latest security patches necessary.
7.
Reset all credentials, including the database, file access, payment and shipping integrations, web services, and Admin login.
Magento Community Edition 2.1 User Guide 1055
Security Best Practices CHAPTER 78: Security
8.
If payment information was compromised, it might be necessary to inform your payment processor.
9.
Inform your customers about the attack and the type of information affected. If payment information was compromised, they should look for unauthorized transactions. If personal information, including email addresses was compromised, they might be targeted with phishing attacks or spam.
Acknowledgments
Parts of this article were inspired by real-world solutions that were shared by community members. The resulting article incorporates content from the community, with input from our team.
l
Bryan (BJ) Hoffpauir for sharing his insight on the Magento forum, and for contributing recommendations in the Attack Response Plan section of this article. See the original post by beejhuff for more information.
l
Anna Völkl (@rescueann), Magento developer at LimeSoda.
l
Robert Mangiafico (@robfico) CTO at LexiConn.
l
@dracony_gimp for his security presentation, Being Hacked is Not Fun .
l
Willem de Groot for providing a sample Nginx configuration .
1056 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security Configuring Admin Security
Configuring Admin Security
Magento recommends that you take a multifaceted approach to protect the security of your store. You can begin by using a
that is not easy to ascertain, rather than the obvious “Admin” or “Backend.” .As a best practice , use only strong Admin passwords that include a combination of letters, numbers, and symbols. For increased security, consider implementing two-factor authentication that generates a token on a separate device. To learn more, see the selection of security-related extensions on Magento Marketplace .
The Admin security configuration gives you the ability to add a secret key to URLs, require passwords to be case sensitive, and to limit the length of Admin sessions, the lifetime of passwords, and the number of login attempts that can be made before the Admin user account is
locked . For increased security, you can configure the length of keyboard inactivity before the
current session expires, and require the user name and password to be case-sensitive. For additional security, the Admin login can be configured to require a
Magento Community Edition 2.1 User Guide
Security
1057
Configuring Admin Security CHAPTER 78: Security
To configure Admin security:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Admin.
3.
Expand the Security section. Then, do the following:
a.
To prevent Admin users from logging in from the same account on different devices, set
Admin Account Sharing
to "No."
b.
To determine the method that is used to manage password reset requests, set Password
Reset Protection Type
to one of the following:
By IP and Email
By IP
By Email
The password can be reset online after a response is received from the notification is sent to the email address associated with the Admin account.
The password can be reset online without additional confirmation.
The password can be reset only by responding by email to the notification that is sent to the email address associated with the Admin account.
The password can be reset only by the store administrator.
None
c.
In the Recovery Link Expiration Period (hours) field, enter the number of hours a password recovery link remains valid.
d.
To determine the maximum number of password requests that can be submitted per hour, enter the Max Number of Password Reset Requests.
e.
In the Min Time Between Password Reset Requests field, enter the minimum number of minutes that must pass between password reset requests.
f.
To append a secret key to the Admin URL as a precaution against exploits, set Add Secret
Key to URLs
to “Yes.” This setting is enabled by default.
g.
To require that the use of upper- and lowercase characters in any login credentials entered match what is stored in the system, set Login is Case Sensitive to “Yes.”
h.
To determine the length of an Admin session before it times out, enter the duration of the session in seconds, in the Admin Session Lifetime (seconds) field. The value must be 60 seconds or greater.
i.
In the Maximum Login Failures to Lockout Account field, enter the number of times a user can try to log in to the Admin before the account is locked. By default, six attempts are allowed . Leave the field empty for unlimited login attempts.
j.
In the Lockout Time (minutes) field, enter the number of minutes that an Admin account is locked when the maximum number of attempts is met.
1058 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security Configuring Admin Security
k.
To limit the lifetime of Admin passwords, enter the number of days a password is valid in the Password Lifetime (days) field. /For an unlimited lifetime, leave the field blank.
l.
Set Password Change to one of the following:
Forced
Recommended
Requires that Admin users change their passwords after the account is set up.
Recommends that Admin users change their passwords after account is set up.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 1059
CAPTCHA CHAPTER 78: Security
CAPTCHA
A CAPTCHA is a visual device that ensures that a human being, rather than a computer, is interacting with the site. CAPTCHA is an acronym for “Completely Automated Public Turing test to tell Computers and Humans Apart,” and can be used for both Admin and customer account logins.
You can reload the CAPTCHA as many times as is necessary by clicking the Reload icon in the upper-right corner of the image. The CAPTCHA is fully configurable and can be set appear every time, or only after a number of failed login attempts.
Customer Login with CAPTCHA
1060 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security CAPTCHA
Admin CAPTCHA
For an extra level of security, you can add a CAPTCHA to the Admin Sign In and Forgot
Password page. Administrator users can reload the displayed CAPTCHA by clicking the Reload icon in the upper-right corner of the image. The number of reloads is unlimited.
Admin Sign In with CAPTCHA
To configure an Admin CAPTCHA:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Advanced, choose Admin.
3.
In the upper-right corner, set Store View to “Default.”
4.
Expand the CAPTCHA section, and do the following:
Magento Community Edition 2.1 User Guide 1061
CAPTCHA CHAPTER 78: Security
1062
Admin CAPTCHA Configuration
a.
Set Enable CAPTCHA in Admin to “Yes.”
b.
Enter the name of the Font to be used for the CAPTCHA symbols. Default font:
LinLibertine
To add your own font, the font file must reside in the same directory as your Magento instance, and be declared in the config.xml file of the Captcha module at: app/code/Magento/Captcha/etc
c.
Select the Forms where the CAPTCHA is to be used: l
Admin Login l
Admin Forgot Password
Magento Community Edition 2.1 User Guide
CHAPTER 78: Security CAPTCHA
d.
Set Displaying Mode to one of the following:
Always
After number of attempts to login
CAPTCHA is always required to log in the Admin.
When selected displays the Number of Unsuccessful
Attempts to Login field. Enter the number of login attempts allowed. A value of 0 (zero) is similar to setting Displaying
Mode to Always. This option does not cover the Forgot
Password form. If CAPTCHA is enabled and set to be appear on this form, then it is always included on the form.
e.
Enter the Number of Unsuccessful Attempts to Login before the CAPTCHA appears. If set to zero, the CAPTCHA is always used.
f.
In the CAPTCHA Timeout (minutes) field, enter the number of minutes before the
CAPTCHA expires. When the CAPTCHA expires, the user must reload the page.
g.
Enter the Number of Symbols used in the CAPTCHA, up to eight. For a variable number of symbols that changes with each CAPTCHA, enter a range, such as 5-8.
h.
In the Symbols Used in CAPTCHA field, specify the symbols that can be used in the
CAPTCHA. Only letters (a-z and A-Z) and numbers (0-9) are allowed. The default set of characters does not include similar symbols such as I or 1. For best results, use symbols that users can readily identify.
i.
To require that users enter the characters exactly as shown set Case Sensitive to “Yes.”
5.
When complete, tap
Save Config…
.
Magento Community Edition 2.1 User Guide 1063
CAPTCHA CHAPTER 78: Security
Customer CAPTCHA
Customers can be required to enter a CAPTCHA each time they log in to their accounts, or after several unsuccessful attempts to log in. CAPTCHA can be used for the following forms in the storefront: l
Create User l
Login l
Forgot Password l
Checkout as Guest l
Register During Checkout l
Contact Us
1064
Customer CAPTCHA Configuration
Magento Community Edition 2.1 User Guide
CHAPTER 78: Security CAPTCHA
To configure a Storefront CAPTCHA:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left, under Customers, choose Customer Configuration.
3.
Expand the CAPTCHA section, and do the following:
a.
Set Enable CAPTCHA on Frontend to “Yes.”
b.
Enter the name of the Font to be used for the CAPTCHA symbols.
To add your own font, the font file must reside in the same directory as your Magento instance, and be declared in the config.xml file of the CAPTCHA module.
c.
Choose one of the following Forms where CAPTCHA is to be used.
l
Create User l
Login l
Forgot Password l
Checkout as Guest l
Register during Checkout
d.
Set Displaying Mode to one of the following:
Always CAPTCHA is always required to access the selected form(s).
After number of attempts to login
Enter the number of login attempts before the CAPTCHA appears. A value of 0 (zero) is similar to “Always.” When selected, the number of unsuccessful login attempts appears.
This option does not apply to the Forgot Password form, which always display the CAPTCHA, if enabled,
e.
Enter the Number of Unsuccessful Attempts to Login before the CAPTCHA appears. If set to zero, the CAPTCHA is always used.
f.
In the CAPTCHA Timeout (minutes) field, enter the number of minutes before the
CAPTCHA expires. When the CAPTCHA expires, the user must reload the page to generate a new CAPTCHA.
g.
Enter the Number of Symbols in the CAPTCHA, up to eight. For a variable number of symbols that change with each CAPTCHA, enter a range such as 5-8.
h.
In the Symbols Used in CAPTCHA field, specify the symbols that can be used in the
CAPTCHA. Only letters (a-z and A-Z) and numbers (0-9) are allowed. The default set of characters does not include similar symbols such as I or 1. For best results, use symbols that users can readily identify.
i.
To require that the user enter the upper-and lowercase characters exactly as shown set
Case Sensitive
to “Yes.”
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 1065
Encryption Key CHAPTER 78: Security
Encryption Key
The encryption key is used to protect passwords and other sensitive data. During the
Magento setup , you have the option to generate an encryption key, or use an another.
Encryption Key
To change the encryption key:
1.
On the Admin sidebar, tap System. Then under Other Settings, choose Manage Encryption
Key
.
2.
Set Auto-generate Key to “Yes.”
3.
Tap
Change Encryption Key
.
1066 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security Session Validation
Session Validation
Magento Community 2.1 allows you to validate session variables as a protective measure against possible session fixation attacks, or attempts to poison or hijack user sessions. The
Session Validation Settings determine how session variables are validated during each store visit, and if the session ID is included in the URL of the store.
Session Validation Settings
The validation checks to see that visitors are who they say they are by comparing the value in the validation variables against the session data that is already stored in $_SESSION data for the user. Validation fails if the information is not transmitted as expected, and the corresponding variable is empty. Depending on the session validation settings, if a session variable fails the validation process, the client session immediately terminates.
Enabling all of the validation variables can help prevent attacks, but might also impact the performance of the server. By default, all session variable validation is disabled. We recommend that you experiment with the settings to find the best combination for your Magento installation. Activating all of the validation variables might prove to be unduly restrictive, and prevent access to customers who have Internet connections that pass through a proxy server, or that originate from behind a firewall. To learn more about session variables and their use, see the system administration documentation for your Linux system.
Magento Community Edition 2.1 User Guide 1067
Session Validation CHAPTER 78: Security
To configure the Session Validation Settings:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Web.
3.
Expand the Session Validation Settings section. Then, do the following:
a.
To verify that the IP address of a request matches what is stored in the $_SESSION variable, set Validate REMOTE_ADDR to “Yes.”
b.
To verify that the proxy address of an incoming request matches what is stored in the $_
SESSION variable, set Validate HTTP_VIA to “Yes.”
c.
To verify that the forwarded-for address of a request matches what is stored in the $_
SESSION variable, set Validate HTTP_X_FORWARDED_FOR to “Yes.”
d.
To verify that the browser or device that is used to access the store during a session matches what is stored in the $_SESSION variable, set Validate HTTP_USER_AGENT to
“Yes.”
e.
If you want a user to stay logged in while switching between stores, set Use SID on
Frontend
to “Yes.”
If including SID with analytics, you must configure your analytics software to filter the SID from URLs, so the page visit counts are correct.
4.
When complete, tap
Save Config
.
1068 Magento Community Edition 2.1 User Guide
CHAPTER 78: Security Browser Capabilities Detection
Browser Capabilities Detection
As is true of most websites and applications on the Internet, Magento requires that the visitor’s browser allow both cookies and JavaScript for full operations. However, occasionally a user’s browser is set to the highest privacy setting that prevents both cookies and JavaScript. Your store can be configured to test the capabilities of each visitor’s browser, and to display a notice if the settings need to be changed.
l
If the browser’s privacy settings disallow cookies, you can configure the system to automatically redirect them to the
page, which explains how to make the recommended settings with most browsers.
l
If the browser’s privacy settings disallow JavaScript, you can configure the system to display the following message above the header of every page:
To configure browser capabilities detection:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under General, choose Web.
3.
Expand the Browser Capabilities Detection section, and do the following:
a.
To display instructions that explain how to configure the browser to allow cookies, set
Redirect to CMS-page if Cookies are Disabled
to “Yes.”
b.
To display a banner above the header when JavaScript is disabled in the user’s browser, set
Show Notice if JavaScript is Disabled
to “Yes.”
Browser Capabilities Detection
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 1069
Action Log CHAPTER 78: Security
Action Log
The Action Log tracks the activities of administrators who work in your store. For most events, the available information includes the action, the name of the user who performed it, whether it was a success or failure, and the ID of the object on which the action was performed.
Additionally the IP and date are always logged.
1070
Admin Actions Logging
To configure the Action Log:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Admin.
3.
Expand the Admin Actions Logging section, and do the following: l
To enable admin logging, mark the checkbox.
l
To disable admin logging, clear the checkbox.
4.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide
CHAPTER 79:
Tools
In this section of the guide, you will learn how to perform routine index and cache management operations, back up the system, and use tools that help our Support team troubleshoot and resolve issues.
l
l
l
l
l
l
l
Magento Community Edition 2.1 User Guide 1071
Cache Management CHAPTER 79: Tools
Cache Management
Magento’s cache management system is an easy way to improve the performance of your site.
Whenever a cache needs to be refreshed, a notice appears at the top of the workspace to guide you through the process. Follow the link to Cache Management, and refresh the invalid caches.
Update Cache Message
The Cache Management page shows the status of each primary cache and its associated tag.
The large buttons in the upper-right corner can be used to flush the Magento Cache, or the allinclusive Cache Storage. At the bottom of the page there are additional buttons to flush the catalog product images cache and JavaScript/CSS cache. After clearing a cache, always refresh your browser to make sure that you can see the most recent files.
1072
Cache Management
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Cache Management
To refresh specific caches:
1.
Do one of the following: l
Click the Cache Management link in the message above the workspace.
l
On the Admin sidebar, tap System. Then under Tools, choose Cache Management.
2.
For each cache to be refreshed, mark the checkbox at the beginning of the row.
3.
Set Actions to “Refresh,” and tap
Submit
.
To perform mass actions:
1.
To select a group of caches, set Mass Actions to one of the following: l
Select All l
Select Visible
2.
Mark the checkbox of each cache to be targeted by the action.
3.
Set Actions to “Refresh,” and tap
Submit
.
To flush the product image cache:
1.
From the Cache Storage Management page, under Additional Cache Management, click Flush
Catalog Images Cache
to clear pre-generated product image files.
The message, “Image cache was cleaned” appears at the top of the workspace.
2.
Make sure to also clear the cache of your browser.
To flush the JavaScript/CSS cache:
1.
From the Cache Storage Management page, under Additional Cache Management, click Flush
JavaScript/CSS Cache
to clear any JavaScript and CSS files that have been merged into a single file.
The message, “The JavaScript/CSS cache has been cleaned” appears at the top of the workspace.
2.
Make sure to also clear the cache of your browser.
Magento Community Edition 2.1 User Guide 1073
Cache Management CHAPTER 79: Tools
Control Descriptions
CONTROL
Mass Actions
DESCRIPTION
Marks the checkbox of multiple caches. Options include:
Select All
Unselect All
Marks the checkbox of all caches.
Clears the checkbox of all caches.
Select Visible
Unselect Visible
Marks the checkbox of all visible caches.
Clears the checkbox of all visible caches.
Actions
Submit
Determines the action to be applied to all selected caches. Options include:
Enable
Disable
Enables all selected caches.
Disables all selected caches.
Refresh Refreshes all selected caches.
Applies the action to all selected caches.
Button Descriptions
BUTTON
Flush Magento Cache
Flush Cache Storage
Flush Catalog Images
Cache
Flush JavaScript/CSS
Cache
Flush Static Files Cache
DESCRIPTION
Removes all items in the default Magento cache (var/cache), according to their associated Magento tags.
Removes all items from the cache, regardless of Magento tag. If your system uses an alternate cache location, any cached files used by other applications are removed in the process.
Removes all automatically resized and watermarked catalog images that are stored at: media/catalog/product/cache.
If recently uploaded images aren't reflected in the catalog, try flushing the catalog and refreshing your browser.
Removes the merged copy of JavaScript and CSS files from the cache. If recent changes to the style sheet or JavaScript aren't reflected in the store, try flushing the JavaScript/CSS cache and refreshing your browser.
Removes preprocessed view files and static files.
1074 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Cache Management
Cache Descriptions
CACHE
Configuration
DESCRIPTION
Various XML configurations that were collected across modules and merged. Associated Tag: CONFIG
System: config.xml
local.xml
Module: config.xml
Layouts
Blocks HTML output
EAV types and attributes
Page Cache
Layout building instructions.
Associated Tag: LAYOUT_GENERAL_CACHE_TAG
Page blocks HTML. Associated Tag: BLOCK_HTML
Collections Data Collection data files. Associated Tag: COLLECTION_DATA
Database DDL operations Results of DDL queries, such as describing tables or indexes.
Associated Tag: DB_DDL
Entity types declaration cache. Associated Tag: EAV
Full page caching. Associated Tag: FPC
Integrations Configuration Integration configuration file. Associated Tag: INTEGRATION
Integrations API
Configuration
Integrations API configuration file.
Associated Tag: INTEGRATION_API_CONFIG
Target Rule
Translations
Web Services
Configuration
The target rule index.
Associated Tag: IARGET_RULE
Translation files. Associated Tag: TRANSLATE
REST and SOAP configurations, generated WSDL file.
Associated Tag: WEBSERVICE
Magento Community Edition 2.1 User Guide 1075
Cache Management CHAPTER 79: Tools
Full-Page Cache
Magento Community Edition 2.1 uses full-page caching on the server to quickly display category, product, and CMS pages. Full-page caching improves response time and reduces the load on the server. Without caching, each page might need to run blocks of code and retrieve information from the database. However, with full-page caching enabled, a fully-generated page can be read directly from the cache. For more technical information, see: Configure and Use
Varnish
We recommend Varnish to be used only in a production environment.
Cached content can be used to process the requests from similar types of visits. As a result, pages shown to a casual visitor might differ from those shown to a customer. For the purposes of caching, each visit is one of three types:
Non-sessioned
Sessioned
Customer
During a non-sessioned visit, a shopper views pages, but does not interact with the store. The system caches the content of each page viewed, and serves them to other non-sessioned shoppers.
During a sessioned visit, shoppers who interact with the store—through activities such as comparing products or adding products to the shopping cart—are assigned a session ID. Cached pages that are generated during the session are used only by that shopper during the session.
Customer sessions are created for those who have registered for an account with your store and shop while logged in to their accounts.
During the session, customers can be presented with special offers, promotions, and prices that are based on the customer group to which they are assigned.
To configure the full-page cache:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose System.
3.
Expand the Full Page Cache section.
1076
Full Page Cache
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Cache Management
4.
Set Caching Application to one of the following: l
Built-in Application l
Varnish Caching
5.
To set the time-out for the page cache, enter the TTL for public content. (The default value is
86400)
6.
If using Varnish, complete the Varnish Configuration section as follows:
a.
In the Access list field, enter the IP addresses that can purge the Varnish configuration to generate a config file. Separate multiple entries with a comma. The default value is
“localhost.”
b.
In the Backend host field, enter the IP address of the backend host that generates config files. The default value is “localhost.”
c.
In the Backend port field, identify the backend port that is used to generate config files.
The default value is: “8080.”
d.
To export the configuration as a varnish.vcl file, tap the button for the version of Varnish that you use.
l
Export VCL for Varnish 3 l
Export VCL for Varnish 4
7.
When complete, tap
Save Config
.
Varnish Configuration
Magento Community Edition 2.1 User Guide 1077
Index Management CHAPTER 79: Tools
Index Management
Magento reindexes automatically whenever one or more items change. Actions that trigger reindexing include price changes, creating catalog or shopping cart price rules, adding new categories, and so on. To optimize performance, Magento accumulates data into special tables using indexers. As the data changes, the indexed tables must be updated—or reindexed.
Reindexing is performed as a background process, and your store remains accessible during the processes.
Reindexing data speeds up processing, and reduces the time the customer has to wait. For example, if you change the price of an item from $4.99 to $3.99, Magento reindexes the data to show the price change in the store. Without indexing, Magento would have to calculate the price of every product on the fly—taking into account shopping cart price rules, bundle pricing, discounts, tier pricing, and so on. Loading the price for a product might take longer than the customer is willing to wait.
The indexers can be set to either update on save, or on schedule. Reindexing is performed as a background process that is scheduled as a cron job, and your store remains accessible during the processes. A system message appears if a
is not available to update any indexers that become invalid.
1078
Index Management
Index Management has a slightly different presentation for flat product catalogs.
To avoid problems when multiple Admin users update objects that trigger automatic reindexing, we recommend that you set all indexers to run on schedule as
Otherwise, every time an object is saved, any objects with interdependencies might cause a deadlock. Symptoms of a deadlock include high CPU usage and MySQL errors.
As a best practice, we recommend that you use scheduled indexing .
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Index Management
To change the index mode:
1.
On the Admin sidebar, tap System. Then under Tools, choose Index Management.
2.
Mark the checkbox of each indexer that you want to change.
3.
Set Actions to one of the following: l
Update on Save l
Update by Schedule
4.
Tap
Submit
to apply the change to each selected indexer.
Column Descriptions
COLUMN
Indexer
DESCRIPTION
The name of the indexer.
Description
Mode
A description of the indexer.
Indicates the current update mode for each indexer. Options:
Update on Save The index is set to update whenever a change is saved.
Update on
Schedule
The index is set to update on schedule according to a cron job.
Status
Updated
Displays one of the following:
Ready The index is up-to-date.
Scheduled Reindexing is scheduled to take place.
Running Reindexing is currently running.
Reindex Required A change has been made that requires reindexing, but the indexers cannot be updated automatically. Check to see if
is available and configured correctly.
Indicates the date and time an index was last updated.
Magento Community Edition 2.1 User Guide 1079
Index Management CHAPTER 79: Tools
Index Trigger Events
Reindexing Triggers
INDEX TYPE
Product Prices
REINDEXING EVENT
Add customer group
Change configuration settings
Flat catalog
1 product data Add store
Add store group
Add, edit, or delete attribute (for searching and filtering)
Flat catalog category data Add store
Add store group
Add, edit, or delete attribute (for searching and filtering)
Catalog category/product index
Add, edit, or delete products (single, mass, and import)
Change product-to-category relations
Add, edit, or delete categories
Add or delete stores
Delete store groups
Delete websites
Catalog search index
Stock status index
Category permissions index
Add, edit, or delete products (single, mass, and import)
Add or delete stores
Delete store groups
Delete websites
Change inventory configuration settings.
Add store, add store group, add or delete or update attribute (for searching and filtering)
1080
1 The flat product and category indexers also influence how catalog and shopping cart price rules are indexed. If you have a large number of SKUs (about 500,000 or more), you will notice a dramatic improvement in indexing time for price rules. To take advantage of this improvement, you must enable
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools
Index Actions and Controls
Index Actions
ACTION
Creating a new store, new customer group, or any action listed in “Actions that Cause a Full
Reindex.”
RESULT
Full reindex
Index Management
TO CONTROL
Full reindexing is performed on the schedule determined by your Magento cron job.
Bulk loading of items in the following ways:
Partial reindex (only changed items are reindexed) l
Magento import/export l
Direct SQL query l
Any other method that directly adds, changes, or deletes data.
Changing scope (for example, from global to website)
Partial reindex (only changed items are reindexed)
At the frequency determined by your
Magento cron job.
At the frequency determined by your
Magento cron job.
Events that Trigger Full Reindexing
Full Reindex Triggers
INDEXER
Catalog Category Flat
Indexer
Catalog Product Flat
Indexer
EVENT
Create a new web store
Create a new web store view
Create, or delete an attribute that is any of the following: l
Searchable or visible in advanced search l
Filterable l
Filterable in search l
Used for sorting
Change an existing attribute to be any of the preceding.
Enable flat category storefront options
Create a new web store
Create a new web store view
Create, or delete an attribute that is any of the following:
Magento Community Edition 2.1 User Guide 1081
Index Management CHAPTER 79: Tools
Full Reindex Triggers (cont.)
INDEXER
Stock status indexer
EVENT
l
Searchable or visible in advanced search l
Filterable l
Filterable in search l
Used for sorting
Change an existing attribute to be any of the preceding.
Enable flat category storefront options
When the following Catalog Inventory options change in the system configuration:
Stock Options Display Out of Stock Products
Product Stock
Options
Manage Stock
Price Indexer
Category or Product
Indexer
Adding a new customer group.
When any of the following Catalog Inventory options change in the system configuration:
Stock Options Display Out of Stock Products
Manage Stock Product Stock
Options
Price Catalog Price Scope
Create or delete a store view
Delete a store
Delete a website
1082 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Backups
Backups
Magento Community Edition 2.1 gives you the ability to back up different parts of the system— such as the file system, database, and media files—and to rollback automatically. A record for each backup appears in the grid on the Backups page. Deleting a record from the list deletes the archived file as well. Database backup files are compressed using the .GZ format. For the system backups and database and media backups, the .TGZ format is used. As a best practice, you should restrict access to backup tools, and back up before installing extensions and updates.
Restrict access to backup tools. Access to the Backups and Rollback management tool can be restricted by configuring user permissions for backup and rollback resources. To restrict access, leave the corresponding checkbox unselected. If you need to grant access to rollback resources, you must grant access to backup resources as well.
Back up before installing extensions and updates. Always perform a backup before you install an extension or update.
includes a backup option that you can use before installing an extension or upgrading to a new release.
Backups
Magento Community Edition 2.1 User Guide 1083
Backups CHAPTER 79: Tools
To create a backup:
1.
On the Admin sidebar, tap System. Then under Tools, choose Backups.
2.
In the upper-right corner, tap the button for the type of backup you want to create:
System Backup Creates a complete backup of the database and the file system. During the process, you can choose to include the media folder in the backup.
Creates a backup of the database and the media folder.
Database and
Media Backup
Database Backup Creates a backup of the database.
3.
To put the store into maintenance mode during the backup, mark the checkbox. When the backup is complete, maintenance mode is turned off automatically.
4.
For a system backup, mark the Include Media folder to System Backup checkbox if you want to include the media folder. Then when prompted, confirm the action.
To schedule backups
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose System.
3.
Expand the Scheduled Backup Settings section, and do the following:
4.
When complete, tap
Save Config
.
1084 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Cron (Scheduled Tasks)
Cron (Scheduled Tasks)
Magento performs some operations on schedule by periodically running a script. You can control the execution and scheduling of Magento cron jobs from the Admin. Store operations that run according to a cron schedule include: l
l
l
l
l
In addition, you can configure the following to run according to a cron schedule: l
Order System Grid Updates and Reindexing l
Pending Payment Lifetime
Make sure that the
for the store are set correctly, so the URLs that are generated during cron operations are correct. To learn more, see: Setting Up Cron Jobs .
To configure cron:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose System.
3.
Expand the Cron section.
Cron (Scheduled Tasks)
Magento Community Edition 2.1 User Guide 1085
Cron (Scheduled Tasks) CHAPTER 79: Tools
4.
Then, complete the following settings for the Index and Default groups. The settings are the same in each section.
l
Generate Schedules Every l
Schedule Ahead for l
Missed if not Run Within l
History Cleanup Every l
Success History Lifetime l
Failure History Lifetime l
Use Separate Process
Cron Configuration for Group: Index
5.
When complete, tap
Save Config
.
1086 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Advanced Developer Tools
Advanced Developer Tools
Use the Advanced Developer tools to determine the compilation mode during frontend development, create a whitelist of IP addresses, display template path hints, and make spot changes to text in the interface of the storefront and Admin.
l
l
l
l
l
l
Magento Community Edition 2.1 User Guide 1087
Advanced Developer Tools CHAPTER 79: Tools
Frontend Development Workflow
The Frontend Development Workflow type determines if Less compilation takes place on the clientor server side during development. Less is an extension of CSS that has additional features and conventions, and that produces streamlined code. Client-side Less compilation is recommended for theme development. Server-side compilation is the default mode. The development workflow options are not available for stores in production mode. To learn more, see Client-side LESS compilation vs.
server-side in the developer documentation.
Front-end Development Workflow
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
Expand the Front-end Development Workflow section.
4.
Set Workflow Type to one of the following:
Client side less compilation
Server side less compilation
Compilation takes place in the browser using the native less.js library.
Compilation takes place on the server using the Less PHP library. This is the default mode for production.
5.
When complete, tap
Save Config
.
1088 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Advanced Developer Tools
Using Static File Signatures
Adding a digital signature to the URL of static files makes it possible for browsers to detect when a newer version of the file is available. Static files that can be tracked with digital signatures include JavaScript, CSS, images, and fonts. The signature is appended to the path directly after the base URL. If a file’s signature differs from what is currently stored in the browser’s cache, then the newer version of the file is used. To learn more, see Static File
Processing in the developer documentation.
Static File Settings
To enable signed static files:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
Expand the Static Files Settings section.
4.
Set Sign Static Files to “Yes.”
5.
When complete, tap
Save Config
.
Magento Community Edition 2.1 User Guide 1089
Advanced Developer Tools CHAPTER 79: Tools
Optimizing Resource Files
The time it takes to load resource files can be reduced by merging and bundling files, and by minimizing code.
l
Merging combines separate files of the same type into a single file.
l
Bundling is a technique that groups separate files in order to reduce the number of HTTP requests that are required to load a page.
l
Minification removes spaces, line breaks, and comments, but does not affect the functionality of the code. Because minimized files cannot be edited, the process should be applied only when you are ready to go into production.
By default, Magento does not merge, bundle, or minimize files, and the project developer should determine which file optimization methods should be used. The following operations are supported for each file type:
FILE TYPE
CSS Files
SUPPORTED OPERATIONS
l
Merge l
Minify
JavaScript Files
Template Files l
Merge l
Bundle l
Minify l
Minify
To optimize resource files:
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
To optimize CSS files, do the following:
a.
Expand the CSS Settings section. Then, do the following:
b.
Set Merge CSS Files to “Yes.”
c.
Set Minify CSS Files to “Yes.”
1090
CSS Settings
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Advanced Developer Tools
4.
To optimizeJavaScript files, do the following:
a.
Expand the JavaScript Settings section. Then, do the following:
b.
Set Merge JavaScript Files to “Yes.”
c.
Set Minify JavaScript Files to “Yes.”
JavaScript Settings
5.
To minify PHTML template files, do the following:
a.
Expand the Template Settings section.
b.
Set Minify Html to “Yes.”
6.
When complete, tap
Save Config
.
Template Settings
Magento Community Edition 2.1 User Guide 1091
Advanced Developer Tools CHAPTER 79: Tools
Developer Client Restrictions
Before using a tool such as
, make sure to add your IP address to the
Developer Client Restrictions whitelist to avoid disrupting the shopping experience of customers in the store, .If you don’t know your IP address, you can search for it online.
Add Your IP Address to the Whitelist
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced,choose Developer.
3.
Expand the Developer Client Restrictions section.
Developer Client Restrictions
4.
In the Allow IPs field, enter your IP address. If access is needed from multiple IP addresses, separate each with a comma.
5.
When complete, tap
Save Config
.
6.
When prompted, refresh any invalid caches.
1092 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Advanced Developer Tools
Template Path Hints
Template Path Hints are a diagnostic tool that adds notation with the path to each template that is used on the page. Template path hints can be enabled for either the storefront or the
Admin.
Template Path Hints in Storefront
Step 1:
Whitelist Your IP Address
Before using template path hints, add your IP address to the
, so you won’t interfere with customers who are shopping in the store. When you are finished, make sure to clear the
Magento cache to remove all hints from the store.
Developer Client Restrictions
Magento Community Edition 2.1 User Guide 1093
Advanced Developer Tools CHAPTER 79: Tools
Step 2:
Enable Template Path Hints
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
In the panel on the left under Advanced, choose Developer.
3.
Expand the Debug section. Then, do the following:
Debug
a.
To activate template path hints for the store, set Enabled Template Path Hints for
Storefront
to “Yes.”
b.
To activate template path hints for the Admin, set Enabled Template Path Hints for
Admin
to “Yes.”
c.
To include the names of blocks, set Add Block Names to Hints to “Yes.”
4.
When complete, tap
Save Config
.
5.
When you are finished, return to the Admin to disable the hints and clear the cache.
Step 3:
Clear the Cache
1.
On the Admin sidebar, tap System. Then under Tools, choose Cache Management.
2.
In the upper-right corner, tap
Flush Magento Cache
.
1094 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Advanced Developer Tools
Translate Inline
You can use the Translate Inline tool to touch up the interface text to reflect your voice and brand. When the Translate Inline mode is activated, any text on the page that can be edited is outlined in red. It’s easy to edit field labels, messages, and other text that appears throughout the storefront and Admin. For example, many themes use terminology such as “My Account,”
“My Wishlist,” and “My Dashboard,” to help customers find their way around. However, you might prefer to simply use the words “Account,” “Wishlist,” and “Dashboard.”
Translatable Text
If your store is available in multiple languages, you can make fine adjustments to the translated text for the locale. On the server, interface text is maintained in a separate CSV file for each output block, and is organized by locale. As an alternate approach, rather than use the
Translate Inline tool, you can also edit the CSV files directly on the server.
To use the Translate Inline tool, your browser must allow pop-ups.
Step 1
: Disable Output Caches
1.
On the Admin sidebar, tap System. Then under Tools, choose Cache Management.
2.
Mark the following checkboxes: l
Blocks HTML output l
Page Cache l
Translations
3.
Set the Actions control to “Disable.” Then, tap
Submit
.
Magento Community Edition 2.1 User Guide 1095
Advanced Developer Tools CHAPTER 79: Tools
1096
Disable Output Caches
Step 2:
Enable the Translate Inline Tool
1.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
2.
To work with a specific store view, set the Store View that is to be updated.
3.
In the panel on the left under Advanced, choose Developer.
4.
Expand the Translate Inline section. Then if necessary, clear the Use Website checkbox.
The Enabled for Admin option is not available when editing a specific store view.
Translate Inline
5.
Set Enabled for Storefront to “Yes.”
6.
When complete, tap
Save Config
.
7.
When prompted, refresh the invalid caches, but leave the disabled caches as they are for now.
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Advanced Developer Tools
Step 3:
Update the Text
1.
Open your storefront in a browser, and go to the page that you want to edit. If necessary, use the language chooser to change the store view.
Each string of text that can be translated is outlined in red. When you hover over any text box, a book icon appears.
2.
Tap the book icon to open the Translate window. Then, do the following:
a.
If the change is for the specific store view, mark the Store View Specific checkbox.
b.
Enter the new Custom text.
c.
When complete, tap
Submit
.
Enter Custom Text
3.
To see your changes in the store, press the F5 key to refresh the browser.
4.
Repeat this process for any elements in the store to be changed.
Step 4:
Restore Original Settings
1.
Return to the Admin of your store. On the Admin sidebar, tap Store. Then under Settings, choose Configuration.
a.
Set Store View to the specific view that was edited.
b.
In the panel on the left under Advanced, choose Developer.
c.
Expand the Translate Inline section.
Magento Community Edition 2.1 User Guide 1097
Advanced Developer Tools CHAPTER 79: Tools
Translate Inline
a.
Set Enabled for Frontend to “No.”
b.
When complete, tap
Save Config
.
2.
On the Admin sidebar, tap System. Then under Tools, choose Cache Management.
a.
Mark the checkbox of the following output caches that were previously disabled: l
Blocks HTML output l
Page Cache l
Translations
b.
Set the Actions control to “Enable.” Then, tap
Submit
.
c.
When prompted, refresh any invalid caches.
Step 5:
Verify the Changes in Your Store
Go to your storefront and examine each page that was updated to make sure the changes are correct. In this example, “Customer Login” was changed to “Customer Sign In.” If changes were made to a specific view, use the Language Chooser to switch to the correct view.
1098
Customer Sign In
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Web Setup Wizard
Web Setup Wizard
The Web Setup Wizard can be used to install components, modules,and extensions, upgrade your installation, and change the system configuration.
Magento Community Edition 2.1 User Guide
Web Setup Wizard
Component Manager
Component Manager lists each component that is currently installed, and can be used to synchronize any extensions you have purchased from Magento
Marketplace with your system.
System Upgrade
The System Upgrade tool can be used to upgrade your installation of Magento. During the process, it checks your system for readiness, creates a backup, and then upgrades your system.
System Config
The System Config tool can be synchronized with your
Marketplace account, based on your public and private access keys.
1099
Web Setup Wizard CHAPTER 79: Tools
Component Manager
Installing an extension is a three-step process that should take place during off-peak hours.
Before the extension is installed, your store is put into maintenance mode, checked for readiness, and backed up. After the extension is installed, it must be configured for your store according to the developer’s instructions. To learn more, see: Marketplace User Guide .
Before you begin, make sure that your system meets Component Manager prerequisties. To learn more, see:
Component Manager and System Upgrade Guide in the developer documentation.
To install an extension:
1.
Log in to the Admin of your Magento store as a user with full administrator rights.
2.
On the Admin sidebar, tap System. Then under Tools, choose Web Setup Wizard.
Web Setup Wizard
3.
Tap Component Manager. Then, click the Sign In link in the upper-right corner.
1100
Component Manager
4.
When prompted, paste the Public Access Key and Private Access Key from your Marketplace account. Then, tap
Sign In
. To learn more, see Magento 2 Access Keys in the Marketplace User
Guide.
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Web Setup Wizard
Paste Access Keys
5.
To synchronize Component Manager with your Marketplace purchases, tap
Sync
. It might take a few minutes. When the process is complete, the number of new purchases appears with the date and time the store was last synchronized.
Component Manager
6.
In the Marketplace Purchases section under New Purchases, click Install.
7.
In the Extensions Grid, mark the checkbox of the extension you want to install. Then in the
Action
column, click the Install link for the item.
Extensions Grid
8.
We’re almost done! Follow these steps to complete the installation:
Magento Community Edition 2.1 User Guide 1101
Web Setup Wizard CHAPTER 79: Tools
Step 1:
Readiness Check
1.
Before the installation begins, your store environment must be checked for compatibility. When ready to begin, tap
Start Readiness Check
. The progress indicator shows where you are in the process.
Readiness Check
2.
When the Readiness Check completes successfully, tap
Next
.
Readiness Check Complete
1102 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Web Setup Wizard
Step 2:
Create Backup
1.
Your store will be put in maintenance mode while the backup is created. When you are ready to begin, tap
Create Backup
. Then, wait a few minutes for the backup to complete.
Backup Complete
2.
You can see the path to the backup file at the bottom of the report. When the backup is complete, tap
Next
.
Step 3:
Component Install
1.
When you are ready to begin, tap
Install
. Then, wait a few moments for the installation to complete.
Installation Complete
2.
When complete, tap
Back to Setup Tool
. Then, tap the System Configuration tile.
Setup Wizard
3.
In the upper-right corner of Component Manager, click the Reset link to log out.
Magento Community Edition 2.1 User Guide 1103
Web Setup Wizard CHAPTER 79: Tools
Logged Out
Step 4:
Configure the Extension for Your Store
1.
Log in to the Admin of your store.
2.
On the Admin sidebar, tap Stores. Then under Settings, choose Configuration.
3.
In the panel on the left, find the new tab for the extension you installed. Then, follow the instructions from the extension developer to complete the configuration.
1104 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Web Setup Wizard
Web Setup
The Web Setup is the second part of the Magento installation that checks system readiness, establishes the database connection, and creates the initial Admin account. The following steps give an overview of the process that takes place at the end of the installation.
Step 1:
Readiness Check
1.
To verify that your system meets the system requirements, tap
Start Readiness Check
.
2.
When the results appear, tap Details for more information. Then, do one of the following; l
If your system fails the readiness check, correct the issue and tap
Try Again
.
l
If your system meets the requirements, tap
Next
.
Readiness Check
Step 2:
Add a Database
1.
To change the MySQL database or update the credentials, do the following:
a.
Enter the Database Server Host. If the database resides on the same server as the
Magento code, enter “localhost.”
b.
Enter the Database Server Username.
c.
Enter the Database Server Password.
d.
Enter the Database Name.
e.
If applicable, enter the Table prefix.
2.
When complete, tap
Next
. Your credentials must be correct to continue to the next step.
Magento Community Edition 2.1 User Guide 1105
Web Setup Wizard CHAPTER 79: Tools
Add a Database
Step 3:
Web Configuration
1.
Under Web Configuration, do the following:
a.
In the Your Store Address field, enter the full URL of your Magento store.
b.
In the Magento Admin Address field, enter the full URL of the Magento Admin.
2.
Expand the Advanced Options, and do the following:
a.
Mark the checkbox of the HTTPS Options that apply to your system: l
Use HTTPS for Magento Storefront l
Use HTTPS for Magento Admin
b.
To enable your server to use Apache Rewrites, mark the checkbox.
c.
Mark the checkbox of the Encryption Key setting that applies to your system: l
I want to use a Magento generated key.
l
I want to use my own encryption key.
1106 Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Web Setup Wizard
Web Configuration
Step 4:
Customize Your Store
1.
To install or reinstall the Sample Data, do the following:
a.
To create a sample store with sample products, mark the Use Sample Data checkbox.
b.
If you are reinstalling the sample data, also mark the Clean up automatically checkbox.
2.
Set Store Default Time Zone to the correct time zone for your locale.
3.
Set Store Default Currency to the default currency that you accept as payment.
4.
Set Store Default Language to the primary language of your store.
Magento Community Edition 2.1 User Guide
Customize Your Store
1107
Web Setup Wizard CHAPTER 79: Tools
5.
(Optional) Expand the Advanced Modules Configuration, and do the following:
a.
To install only specific modules, clear the Select All checkbox.
b.
In the list, select the checkbox of each module you want to install.
1108
Advanced Modules Configuration
6.
When complete, tap
Next
.
Step 5:
Create Admin Account
1.
Enter a New Username for the Admin account.
2.
Enter a New E-Mail for the Admin account.
3.
Enter a New Password for the Admin account. Then in the Confirm Password field, enter your new password again.
4.
When complete, tap
Next
.
Magento Community Edition 2.1 User Guide
CHAPTER 79: Tools Web Setup Wizard
Create Admin Account
Step 6:
Install
1.
When you are ready to complete the setup, tap
Install Now
.
Install
2.
When the installation completes, a page appears with your Magento Admin and database credentials, but without the passwords. You can print the page and keep it for your records.
Then, do of the following: l
Launch Magento Storefront l
Launch Magento Admin
3.
If the installation fails to complete, view the Console Log to learn more. Then, correct the problem and try again.
Magento Community Edition 2.1 User Guide 1109
Web Setup Wizard CHAPTER 79: Tools
A little Housekeeping
After Setup is complete, do the following to set the recommended permissions for all files and folders in your Magento2 installation:
1.
Change to the Web user who has full permissions to the Magento2 folder. (For example, apache or root.) su – apache
2.
Change directories to the Magento2 folder, and set the following permissions. You can copy the code, and paste it as a single command.
find . -type d -exec chmod 700 {} \; && find . -type f -exec chmod 600 {} \;
&& chmod +x bin/magento
1110 Magento Community Edition 2.1 User Guide
Appendices
1111
1112
Contents
Release Notes
APPENDIX A:
Release Notes
Release notes provide a detailed description of each product release, with links to additional technical information, installation instructions, and support resources. For details about the most current and past releases, see Release Information .
As a best practice, we recommend that you keep your Magento 2.x installation up to date, so you can benefit from the latest features and advancements.
Magento Community Edition 2.1 User Guide 1113
1114 Magento Community Edition 2.1 User Guide
APPENDIX B:
Change Log
Our documentation is continually updated with new topics, clarifications, and corrections to existing content. The Change Log in the online user guide lists the major updates, organized by month. If you can’t see the most recent changes, refresh your browser or clear the cache. Check back every now and then to see what’s new!
Change Log
Magento Community Edition 2.1 User Guide 1115
1116 Magento Community Edition 2.1 User Guide
APPENDIX C:
Glossary
A above the fold
The web page content that is immediately visible in the browser window; section of a page that is displayed without the need to scroll.
Admin
The password-protected back office of your store where orders, catalog, content, and configurations are managed.
alt text
The text that is displayed in place of an image when the user is unable to view the image.
anchor text
The visible text that is anchored to another page or page section; the literal text of a hyperlink.
API
Application Program Interface: A software interface that lets third-party applications read and write to a system using programming language constructs or statements.
aspect ratio
The proportional relationship between the width and height of an image.
attribute
A characteristic or property of a product; anything that describes a product. Examples of product attributes include color, size, weight, and price.
authorization
To give a service permission to perform certain actions or to access resources.
average inventory cost
Product price, less coupons or discounts, plus freight and applicable taxes. The average is determined by adding the beginning cost of inventory each month, plus the ending cost of inventory for the last month of the period.
Magento Community Edition 2.1 User Guide 1117
1118
APPENDIX C: Glossary
B
B2B
Business to Business: A type of business transaction between two business entities that are not the final consumers of the goods or services.
B2C
Business to Consumer: Business transactions between a business entity and a consumer.
banner
Promotional graphics displayed either horizontally on the top of a web page or vertically on the left or right margins. Website advertisements are often displayed as banners.
base currency
The primary form of currency used in store transactions.
base currency rate
The base currency rate is the default for your store.
batch processing
To perform a task or make a change to multiple items all at once, without manual repetition.
bounce rate
The percentage of visitors to your site that leave without viewing any other pages.
brand
A unique identity that defines a particular product or group of products.
breadcrumb
A navigation aid that helps the user to keep track of their location within your store.
brick and mortar
A retail business with a permanent physical location, as opposed to being entirely virtual.
broken link
A hyperlink that fails to send the user to its intended web page.
C callout
A term that is sometimes used to describe a block that is defined as a layout update using XML code.
canonical URL
The canonical meta tag redirects search engines to the correct URL, when seemingly duplicate content is encountered on the server.
Magento Community Edition 2.1 User Guide
APPENDIX C: Glossary
capture
The process of converting the authorized amount into a billable transaction. Transactions cannot be captured until authorized, and authorizations cannot be captured until the goods or services have been shipped.
cardholder
A person who opens a credit card account and is authorized to make purchases.
cascading style sheet
The markup standard used to apply styles to HTML elements on the page.
category
A set of products that share particular characteristics or attributes.
CCV
Credit Card Verification code. (See CVV)
checkout process
The process of gathering the payment and shipping information that is necessary to complete the purchase of items in the shopping cart. In the final step, the customer reviews and places the order.
CMS
Content Management System: A software system that is used to create, edit, and maintain content on a website.
complex data
Data that is associated with multiple product options.
complex product
A product that requires the customer to choose from a selection of options.
composite product
Any product type that offers customers a choice of options.
Content Delivery Network
A large distributed network of servers that specializes in the high performance delivery of multimedia content.
content marketing
The art of promoting products or services by providing valuable information at no charge.
conversion
A marketing term that indicates a goal has been reached. If the goal is to sell a product, conversion is reached when a visitor to your site becomes a buyer.
conversion rate
The percentage of visitors who are converted into buyers.
Magento Community Edition 2.1 User Guide 1119
1120
APPENDIX C: Glossary
credit memo
A document issued by the merchant to a customer to write off an outstanding balance because of overcharge, rebate, or return of goods.
CSS
Cascading Style Sheets: A style sheet language that controls the appearance of HTML documents; a way to control the appearance of text, graphics, lists, links, and all other elements on a web page.
CSV
Comma Separated Values: A type of file used to store data values which are separated from each other by commas.
CVM
Card Verification Method: A way to verify the identity of the customer by confirming a 3-digit or 4digit credit card security code with the payment processor.
CVV
The Card Verification Value, also known as the Card Security Code, provides an additional level of security for online transactions.
D domain
The address of a website on the web; what the customer types in their browser address bar to access the store.
double opt-in
The process for subscribing email recipients by requiring them to take a secondary step to confirm that they want to receive emails.
dynamic content
A web page that displays different content depending on the user request.
Dynamic Media URL
A link to an image that contains a relative reference to the file location in media storage.
E
EAV
Entity Attribute Value
evergreen content
Content that has a long shelf life.
Magento Community Edition 2.1 User Guide
APPENDIX C: Glossary
F
FAQ
Frequently Asked Questions.
favicon
Short for favorites icon; a 16x16 or 32x32 pixel icon associated with a website; is displayed in the browser address bar and next to the site name in a bookmark list.
feed reader
Software that is used to read syndicated content from RSS feeds.
FOB
Freight On Board: A shipping term indicating who is responsible for paying transportation charges.
frontend properties
Properties that determine the presentation and behavior of an attribute from the standpoint of the customer in your store.
fulfillment
The process of managing customer shipments.
G gateway
A transaction bridge between a customer and a payment processing service that is used to transfer money between the customer and the merchant.
gross margin
The difference between the cost and price of a product.
H handle
In programming, a name used to reference an object.
home page
The first home page a visitor sees when they access your website URL. Considered the most important page on your website according to search engine indexing.
HTML
HyperText Markup Language: A standard for tagging and structuring text, images, videos, and other media on a web page.
Magento Community Edition 2.1 User Guide 1121
1122
APPENDIX C: Glossary
I invoice
A document that provides a detailed description of a purchase, including products purchased, quantity, price, shipping cost, sales tax, and total.
J
JavaScript
A scripting language used with HTML to produce dynamic effects and interactions on web pages.
jQuery
A popular JavaScript library that is often used to create dynamic and responsive effects.
K keyword
A term or phrase used in a search to filter for content that is of significant importance to that term or phrase.
L landing page
A page on your site where a visitor arrives after clicking a link or advertisement.
layout
The visual and structural composition of a page.
layout update
A specific set of XML instructions that determines how the page is constructed.
link juice
The value and authority transferred from one web page to another via hyperlinks (or links). Link juice affects a website’s page rank, a factor used to rank a search engine results page.
liquid layout
A flexible approach to web design that specifies the size and position of elements as percentages rather than as exact measurements in pixels.
load sequence
The order in which scripts are loaded into memory. To work correctly, some scripts must be loaded before others.
locale
A set of configurations that defines the user’s language, country, tax rate, and other settings.
login
The process of signing into an online account.
Magento Community Edition 2.1 User Guide
APPENDIX C: Glossary
M markdown
The amount subtracted from the original price of a product.
markup tag
A snippet of code that can be used to add functionality or content to a page.
media storage
A dedicated space on the content delivery network for your store's assets.
merchant account
An account with a bank or financial institution that makes it possible to accept credit card transactions.
meta tags
Information in a web page that is not displayed on the page itself, but is used by search engines to determine the page title, description, and page keywords.
N navigation
The primary group of web page links that a customer uses to navigate around the website; the navigation links to the most important categories or pages on an online store.
O opt-in
The process by which a user consents to receiving emails from an online store.
P packing slip
A document that is usually included in a shipped package that describes the contents. Packing slips do not include financial or account information.
path to purchase
The path a prospect follows that leads to a sale.
payment bridge
An application that helps merchants meet PCI- DSS requirements.
payment gateway
A service that charges your customers’ credit cards and sends the funds to your merchant account, for deposit into your business bank account.
Payment Gateway
A third-party service that processes transactions for external payment methods.
Magento Community Edition 2.1 User Guide 1123
1124
APPENDIX C: Glossary
Payment Method
A way for the customer to pay for the merchandise in your store. Payment methods can be internal or external. The Payment Methods section of the System Configuration includes all basic payment methods and gateways.
PCI
Payment Card Industry: Refers to debit and credit cards and their associated businesses.
price markup
A percentage added to the cost of an item to determine the retail price.
privacy policy
A document that explains the merchant’s policies for handling customer information.
purchase order (PO)
A written sales contract between a buyer and seller that describes the merchandise or service to be purchased from a vendor.
R redirect
A method used to alert browsers and search engines that a page has been moved. 301 Redirect:
Permanent change 302 Redirect: Temporary change
relative link
A hyperlink that includes only the address of the linked page that is relative to the linking page, rather than the full URL.
return policy
A document that explains the merchant’s rules regarding the return of products by customers.
robots.txt
A file placed on a website that tells search engine crawlers which pages not to index.
RSS feed
Really Simple Syndication: A technology that creates web content syndication and allows web users to subscribe to product feeds, websites, and blogs.
S
SaaS
Software as a Service: A software delivery model where the vendor provides the software and hosting environment, and customers pay for the service by subscription or per use.
Sass/Compass
A CSS pre-compiler that provides organizable, reusable CSS.
security certificate
Information that is used by the SSL protocol to establish a secure connection.
Magento Community Edition 2.1 User Guide
APPENDIX C: Glossary
SEO
Search Engine Optimization: The process of improving a website’s search engine rankings in order to increase valued visitors.
SERP
Search Engine Results Page
settlement
Settlement occurs when the acquiring bank and the issuer exchange funds and the proceeds are deposited into the merchant account.
shipping carrier
A company that transports packages. Common carriers include UPS, FedEx, DHL, and USPS.
shopping cart
A grouping of products that the customer wishes to purchase at the end of their shopping session.
sidebar
The right or left column of a two-column page layout.
sitemap
A page that provides search engines with an efficient, alternate route through your site.
SKU
Stock Keeping Unit: A number or code assigned to a product to identify the product, options, price, and manufacturer.
splash page
A promotional page with a product or advertisement; normally displayed before the home page.
SSL certificate
A validation and security mechanism that identifies the merchant and encrypts credit card and other sensitive information.
static block
A fixed content block that can be displayed on various content pages in a store.
static content
Content that does not change frequently. See also dynamic content.
static files
The collection of assets, such as CSS, fonts, images, and JavaScript that is used by a theme.
T theme
A package that contains graphics and appearance information, and customizes the look and feel of the store.
Magento Community Edition 2.1 User Guide 1125
1126
APPENDIX C: Glossary
transactional email
A notification email sent to the customer when a transaction is processed.
transactional emails
An automated email message that is sent in response to a specific event or transaction.
U
URL
Uniform Resource Locator: The unique address of a page on the internet.
usability
Refers to the degree to which a product or service is easy to use by its customers.
W widget
A prepared snippet of code that adds functionality and/or dynamic effects to your store.
WYSIWYG
What You See Is What You Get: An editor that displays formatted text as it will appear in its final published form.
X
XML
Extensible Markup Language: A markup format derived from SGML that it used to format information for publication and distribution.
Magento Community Edition 2.1 User Guide
APPENDIX D:
Configuration Reference
This reference has field descriptions for every configuration setting in Magento Community
Edition 2.1. To learn how to apply configuration settings to specific store views, see:
From the HTML version of the guide, you can drill down through any section of the reference, and follow the links to corresponding topics in the user guide. From step-by-step instructions, click any linked caption below a screenshot to jump to the field descriptions.
Click any of the following links to go to the corresponding section in the online reference: l
General l
Catalog l
Customers l
Sales l
Services l
Advanced
Configuration
Magento Community Edition 2.1 User Guide 1127
1128 Magento Community Edition 2.1 User Guide
Index
[
1
2
2 Columns
3
4
5
A
Account
Actions
Address
1129
1130
Allow
Approve product review 333-334
Index
Attribute
Attributes
Australia, PayPal solutions 804
Authorize.Net
Automatic
B
Backend See also
Backup
Base
JavaScript URL 1047-1048 media URL 1047-1048
Magento Community Edition 2.1 User Guide
Index
Best practice
Billing
agreement, PayPal Express Checkout 772
Browser Capabilities Detection 1069
C
Canada
Cancel
Capture
Cart
Magento Community Edition 2.1 User Guide 1131
1132
Categories
Category
Category Products 134-135, 287, 301, 539,
JavaScript use 1046 media retrieval 1046
Compare Products 320, 330, 973
Complete, order status 721, 734
Configurable Product, configurations 165
Contact Us
Index
Magento Community Edition 2.1 User Guide
Index
Cookie
Create
Credit
Credit Memo
Magento Community Edition 2.1 User Guide
CSS
structure 990 csv separator 990
Current Configuration Scope 106
Custom
Design
Layout Update
Customer
1133
1134
group
Customer Account
D
Index
Database
and Media Backup 1084 backup 1084
Default
Demo
Developer Client Restrictions 1095
Direct Post Method, Authorize.Net 820
Display
Magento Community Edition 2.1 User Guide
Index
Settings
Dropdown
Duplicate
Dynamic
E
Magento Community Edition 2.1 User Guide
addresses, domain 88 addresses, store 88
Email Template
Enable
Equalize
Price Ranges, layered navigation 469
Product Counts, layered navigation 469
European Union
1135
1136
Expressed consent, cookies 123
F
Filter
Filterable
Flat
Flush
Index
Free
Full
G
General
Global
Magento Community Edition 2.1 User Guide
Index
Grid
Guest
H
Magento Community Edition 2.1 User Guide
Hong Kong, PayPal solutions 804
HTML
I
Image
Import
1137
1138
Include in
Input type
Install
Internet Explorer
Inventory
Index
Invoiced
IP Address, Limit Sending By 322
Iterative splitting, price navigation 468
J
JavaScript
K
L
Label
Layered navigation
Layered Navigation 299, 463, 973
Layered Price Navigation Step 299
Magento Community Edition 2.1 User Guide
Index layout
Layout
Link
M
Magento
Magento Community Edition 2.1 User Guide
Magento Connect, Install Extension 888
Magento Marketplace 620, 1032, 1100
Manage
MAP (Minimum Advertised Price) 244
Marketing
Media
Menu
1139
1140
Message
Meta
Minimum Advertised Price 244, 246
Miscellaneous
Misspelled words
Moderate, product reviews 333-334
Multi-Address Minimum Order 665
Multiple
My
Index
N
New
New Zealand, PayPal solutions 804
No
O
On Hold, order status 702, 721
Magento Community Edition 2.1 User Guide
Index
Online
P
Page Layout 229, 303, 597, 600 examples 600
Magento Community Edition 2.1 User Guide
Pages
Parent
Partial
payment
Payment
Payment Card Industry (PCI) 120
Payment Methods
1141
1142
PayPal In-Context Checkout 770
Pending
Permanent
Permissions
Persistent
Index
PHP script
Price
Price Rule
Price Type
Magento Community Edition 2.1 User Guide
Index
Privacy
Product
Description
Information
by category 442 markup tag 442 new 442
Magento Community Edition 2.1 User Guide
reviews 50, 333 moderate 333-334
type
Product Alerts
Product Field Auto-Generation 151
Product View Page, visible on 974
Products
Promotions
1143
1144
Publish
Q
Quantity
R
Recently Compared Products 576
Recently Viewed Products 332, 576
Redirect
Refresh
report data 878 statistics 878
Refund
Reindex
Related
Remember Me, shopping cart 670, 672
Report
Responsive Web Design (RWD) 618
Reward Points
Rewrite
Role
Root
Run settings, product alerts 266
Index
Magento Community Edition 2.1 User Guide
Index
S
Sales
Sample
Schedule
Search
Search engine
Search Engine Optimization 216
Magento Community Edition 2.1 User Guide
Select
Session
Settlement Report, PayPal Express
SFTP
Ship
Shipping
1145
1146
Index
rates
Shipping Methods 52, 827-828, 830, 832
Shopping
Shopping Cart
SKU
in price rules 348 multiple 348
Slider
Solutions Partners, Magento 51
Special Products, RSS feed 435
Startup Page
Status
Storage
Store
Storefront
Magento Community Edition 2.1 User Guide
Index
Stores
Suspected Fraud, order status 721
Syntax
System
T
Tag
Tags product
Magento Community Edition 2.1 User Guide
Target Path, redirect 508, 512, 517, 521
class
Class
rates
Tax Rate
Tax Rates
Template
Templates, transactional email 401
Temporary (302) redirect 508, 513, 517, 521
1147
1148
Text
Third-party
Top Level Category, RSS feed 435
Translate
U
Index
United Kingdom, PayPal solutions 805
United States
United States, PayPal solutions 805
Universal Analytics, Google 524
Unlock
Unselect
Use
Magento Community Edition 2.1 User Guide
Index
User
V
Virtual
Visit
non-sessioned 1076 sessioned 1076
W
Web server
Magento Community Edition 2.1 User Guide
Websites
Weight
Workflow
X
1149
Y
Z
Index
1150 Magento Community Edition 2.1 User Guide
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement
Key features
Provides online merchants with unparalleled flexibility and control over the look, content, and functionality of their online stores.
Intuitive Admin features powerful marketing, search engine optimization, and product management tools.
Robust and scalable, offering a stable, secure, and customizable solution for your growing business.
Frequently asked questions
The system requirements for Magento Community Edition 2.1 include Linux x86-64, Apache 2.2 or 2.4, PHP 7.0.4, MySQL 5.7 or 5.6.x, and a valid security certificate for HTTPS. You can find the most up-to-date information in System Requirements in the developer documentation.
To install Magento 2 on your server, see the Installation Guide in our technical documentation. For an overview of the second part of the installation process, see Web Setup Wizard in the System Operations section of this guide.
You should check the store URLs, security certificate, store email addresses, email templates, sales communications, Google Analytics integration, cart options, checkout options, taxes, shipping methods, PayPal configuration, payment methods, and Cron job settings before launching your store.
